v1

latestOpenAPI 3.0.1Apache 2.02026-07-248286406.8 KB
KYC

Get a Veriff session link

This GET endpoint is used to obtain a link to a Veriff session for the user with the provided user token. <br> The endpoint will then generate a session link that you can use to initiate an identity verification process for the user through the Veriff platform. <br> To use this endpoint, you need to provide the user_token as a parameter in the URL Path. <br> The response will contain the session link as a URL in a JSON format.

get/payout/user/{user_token}/kyc/veriff

Query parameters

callback_overridestring uri
Example:https://members.masspay.io/?complete_veriff=true

Optional HTTPS URL to redirect the user to after completing their Veriff ID submission, overriding the default callback.

Response

Succesful operation.

session_urlstring required

URL for Veriff session that can be used by the SDKs (https://developers.veriff.com/#integrations) or by redirecting the payee to the URL.

session_idstring required

Veriff Session ID