Links

Generate Link

Sample Request Body

You must provide a valid token when making this API call. So, make sure you retrieve your token first and then set it here.
{
"options": {
"send_email": true
},
"reference": "CHECKLY TEST",
"token": "{{TOKEN}}",
"fn": "Tom",
"ln": "Canfarotta",
"addr": "707 HAWLEY LANE",
"city": "STRATFORD",
"state": "CT",
"zip": "06614",
"phone": "2015106000",
"dob": "19820821",
"email": "[email protected]",
"email_fallback": false,
"language": "",
"country": "US",
"bypassDesktopIntro": false,
"qr": true,
"additionalData": "{\"value_1\":\"test1\",\"value_2\":\"test2\"}",
"styleToken": "",
"resultMessages": {
"success": {
"verificationSuccessTitle": "",
"verificationSuccessSubTitle": ""
},
"failure": {
"verificationFailureTitle": "",
"verificationFailureSubTitle": ""
},
"error": {
"verificationErrorTokenTitle": "",
"verificationErrorTokenSubTitle": "",
"verificationErrorAlreadyVerifiedTitle": "",
"verificationErrorAlreadyVerifiedSubTitle": "",
"verificationErrorPendingTitle": "",
"verificationErrorPendingSubTitle": "",
"verificationErrorVelocityTitle": "",
"verificationErrorVelocitySubTitle": ""
}
}
}

Responses

Description
Value
action
PASS - the link was generated
ERROR - the link was not generated (see below for all error types
detail
A description of the action result
link
The URL value to provide the end user
email_sent
Will be set to true or false
error_message
The overall error message
error_description
A description of the error that occurred