Identity Verification Integration

Integration guide

API-only guide

This guide provides step-by-step instructions on how to integrate the European Identity Verification solution via our API.

Before you begin, make sure you have completed the following:


Flow

Click to magnify

European solution API flow

European solution API flow



1. Authenticate

Create an access token to authenticate in our API:

  • You provide your Fourthline API key.
  • You receive an access_token.

API Reference – Create access token

Important
For security, access tokens are valid for 1 hour only.
If your token expires, make another Create access token request.


2. Create workflow

Create a European Identity Verification workflow:

  • You specify the workflowName and provide your unique identifier for the client.
  • You receive a workflowId and a Fourthline clientId.

API Reference – Create workflow

Status: The Identity Verification case status changes to new.


3. Upload identity data

Upload the client's identity data:

  • You provide the verificationId (same value as the workflowId) and always the person, address, and emailAndPhone objects.
  • A successful response is empty.

API Reference – Upload identity data

Tip
To update already uploaded data, make another request with the same verificationId.

Status: The Identity Verification case status remains new.


4. Upload identity files

Upload the client's ID document and supporting identity files:

  • You provide the verificationId (same value as the workflowId).
  • A successful response is empty.
Important
For detailed instructions on how to use this request, see the user guide.

API Reference – Upload identity files


Status: The case status changes to one of the following and we send the relevant webhook notification:

StatusDescriptionAction
pendingThe data is valid.Wait for the next status.
invalid_dataWe found invalid or missing data.Create a new workflow.


5. Start case processing

Request Fourthline to start case processing:

  • You provide the verificationId.
  • A successful response is empty.

API Reference – Start case processing

Status: The case status changes to one of the following and we send the relevant webhook notification:

StatusDescriptionAction
inconsistent_dataWe found inconsistent data.Create a new workflow.
completedWe have processed the case.
For our recommendation to accept or reject the client, see the risk code.
Download the CDD Report.

Check case status

When you receive webhook notifications, we recommend also requesting the full case details:

  • You provide the verificationId (same value as the workflowId).
  • You receive all the data on the case.

API Reference – Get case status


6. Download CDD Report

When the case status is completed, download the CDD Report zipfile:

  • You provide the workflowId.
  • A successful response is empty and the report is downloaded.

API Reference – Get CDD zipfile

Success
Success
You have integrated Identity Verification!

Top of page