v4

latestOpenAPI 3.0.12026-08-041341,046757.6 KB
AccessTokenResource

post/resources/accessTokens/sdk

Request body

applicantIdstring

A unique identifier of the user who passed user verification (KYC). You can share this identifier with your partners.

externalActionIdstring

A unique applicant action identifier on your side that will be bound to the token. <br><br>⚠️ It is required when you generate an access token for applicant actions.

kytTxnIdstring
levelNamestring

A verification level name. The level determines the verification steps the applicant must complete and the documents that are required for verification. <br><br>⚠️ Mind the following: <ul><li>A level has to be created in the same environment. For example, in the Sandbox mode, you may not be able to use a level configured to be only available in the Production environment.</li><li>A level name is case-sensitive. <code>Kyc-level</code> and <code>kyc-level</code> are considered as completely different level names. The system does not allow creating an applicant with the level name that does not exist.</li><li>If a level name contains reserved characters (e.g., <code>@</code>, <code>+"</code>, white spaces as <code>%20</code>), it should be URL-encoded, otherwise you may get a signature mismatch.</li><li>The system does not allow creating a company profile with a level for individuals and vice versa.</li></ul>

shareTokenstring
ttlInSecsinteger

The lifespan of the generated token in seconds. Default value is 10 mins.

userIdstring

A unique applicant identifier on your side that will be bound to the token. It correlates to the externalUserId of the applicant. <br><br>⚠️ If your userId contains reserved characters (e.g., @, +", white spaces as %20), it should be URL-encoded, otherwise you may get a signature mismatch.

workflowNamestring

Response

default response

applicantIdstring
externalActionIdstring
forClientIdstring
forIpstring
refreshTokenboolean
sharingAllowedboolean
sumsubIdProfileIdstring
tokenstring
type'shareToken' | 'sumsubIdShareToken'
userIdstring