Setup

API Guide

API-only guide

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

Before you begin, make sure you have completed the UK solution setup

Flow

Click to magnify

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 workflow, providing your unique identifier for the client:

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

API Reference – Create workflow

3. Upload client data

Upload the client's identity data:

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

API Reference – Upload client data

4. Start Identity Verification

Request Fourthline to start the identity verification process:

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

API Reference – Start Identity Verification

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

Success

You have integrated the UK solution!

Top of page