Extend recipient tokens

AI Tools

The Yoti sign API has an endpoint that refreshes the expiry of the recipient token. An array of tokens is passed in the body of the request. If refreshing multiple tokens, the tokens must belong to the same envelope, and this can be done for any envelope regardless of whether it is an embedded one or not.

HTTP
    
 
Sandbox: POST https://demo.api.yotisign.com/v2/envelopes/:envelopeId/extend-tokens
Copy

HTTP
    
 
Production: POST https://api.yotisign.com/v2/envelopes/:envelopeId/extend-tokens
Copy

Headers Explained

The following elements are needed:

Headers	Content
Authorization	API Key to call the Yoti Sign API. This should be sent as a bearer token.
Content-Type	application/json

Request Body

JSON
    
 
{   recipient_tokens: ["<recipient_token_uuid>", "<recipient_token_uuid>"] }
Copy

Example Code

Javascript
Java
PHP
C#
Go
    
​x
 
const rp = require("request-promise");const extendToken = () => {  const request = {    method: "POST",    uri: "<BASE_URL>/v2/envelopes/:envelopeId/extend-tokens",    body: JSON.stringify({      "recipient_tokens": [        <id>,        <id>     ]    }),    headers: {      authorization: "Bearer <API_KEY>",    },  };​  return rp(request)    .then((body) => body)    .catch((err) => err);};​//send requestlet result = await extendToken();
Copy

Last updated on

Was this page helpful?