SMS Deprecated - DO NOT USE
In order to run this scenario you can use the portal or create a request using API.
1. Creating Callback URL
Create the callback URL here to return the user to your site.
The callback will include the query parameter "requestId" which will be able to request the check result through API [GET].
2. Creating Request
You can create a request in two ways: either at the site or using API. If you want to create a request at the site, open this page. Create the request by filling in all the necessary fields. An SMS will be sent to the user automatically. If you want to create a request using API, use the following method:
Request:
POST https://api-onboarding.checkpointid.com/api/ValidationRequests HTTP/1.1
Host: api-onboarding.checkpointid.com
Accept: application/json
Authorization: Bearer <YOU_TOKEN_HERE>
Content-Type: application/json
Content-Length: 106
Request body:
{
"firstName": "First Name",
"lastName": "Last Name",
"phone": "+123456789",
"email": "email@my.com",
"metadata": {
},
"callbackUrl": "https://domain.com",
"sendSms": true
}
There are fields sendSMS
and callbackUrl
in the endpoint of creating the request to perform these steps using API.
Set sendSms = "true"
if you want to send an SMS with the validation link. In this case in order to return back to your site you will need to set your URL into the callbackUrl
field.
This is a URL on your site where the users will be redirected right after the validation.
3. Reviewing Results
You can receive the result by either using API or in the portal https://onboarding.checkpointid.com