Create a stand-alone link using the API

An easy way to send out a verification link is to generate a personal verification link via the API.

This can be done by sending a POST request to the API endpoint. The response will contain a URL that can be used to start the verification process as a standalone action. This link is normally valid for 12h, but this can be changed in the Dashboard on SDK settings.

An Enriched Link is a personal verification link with some pre-filled parameters, allowing seamless identity verification. It can be generated via the Partner Portal or API and contains hidden parameters visible in the verification results.

The below example contains several parameters that can be added to the creation of the link.

• The name parameter is the name of the flow you want to use.
• The X-API-Key is your API key.
• The profile parameter is optional and contains personal information that will be pre-filled and verified against in the verification process.
• Once completed the user will be redirected to the onComplete URL.
• If an error occurs the user will be redirected to the onError URL.
• metadata is optional and can be added to the link to enrich the data collected, this could be any of your internal data that should be tagged on the application.
• locale is optional and can be used to set the language of the verification process.
• ttl is optional and can be used to set the time to live for the link in seconds.

The response will contain a URL that can be used to start the verification process.

Clicking on the link will open a link to the Checkin Standalone verification page. Once completed the user will be redirected to the onComplete URL. If an error occurs the user will be redirected to the onError URL.

cURL Example

curl -H "X-API-Key: {YourAPIKey}" \
     -H "Content-Type: application/json" \
     -X POST "https://[yourEnvironment].sb.getid.dev/api/v1/tokenized-url?name=FULL&externalId=2222" \
     --data '{
        "redirects": {
            "onComplete": "https://test.com/completed",
            "onError": "https://test.com/errorpage"
        },
        "profile": {
            "First name": "First Name",
            "Last name": "Last Name",
            "Date of birth": "1989-07-22"
        },
        "metadata": {
            "labels": {
                "label1": "key1",
                "label2": "key2"
            }
        },
        "locale": "en",
        "ttl": "7200"
     }'

Response

{
    "url": "https://[yourEnvironment].sb.getid.dev/checkin/verification?token
}