Setup

App Drop-in

Web SDK

API Guide

Web SDK guide

This guide provides step-by-step instructions on how to integrate the French Identity Verification solution with the Web SDK.

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

• Web SDK Setup
• Web UI Customization
• French Solution Setup
  
  

Flow

Click to magnify

Follow these steps:

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

Status: The Identity Verification case status and signature status change to new.

Fourthline checks that the status of the related Identity Verification case is one of the following:

If the Identity Verification case status is valid, we perform the initial ID document check, and (if configured) the sanctions check.

Status: The signature status changes to one of the following:

Upload identity data

If configured, upload relevant identity data:

• You provide the verificationId and relevant data points.
• A successful response is empty.

API Reference – Upload identity data

3. Upload documents to sign

Upload to Fourthline the document(s) you want the client to sign:

• You provide the workflowId, information about the documents, and the files.
• A successful response is empty.

API Reference – Upload documents to sign

Status: The signature status remains pending.

4. Upload mobile number

Upload the client's mobile phone number for them to receive the passcode SMS to confirm the signature:

• You provide the workflowId and the phone number.
• A successful response is empty.

API Reference – Upload mobile phone number

Status: The signature status remains pending.

5. Create SDK session

Create the Web SDK session:

• You provide the workflowId.
• You receive an 8-digit, alphanumerical validationCode to pass to the SDK in your backend.

If the client starts on your website in their:

• Desktop browser: Initialize the Web SDK, display the redirect options, and redirect the client to the workflow in their mobile browser.
• Mobile browser: Display the redirect options and then redirect them to the workflow on your subdomain.

API Reference – Create SDK session

Important

• SDK validation codes are single use and expire after 2 hours.
• If the client stops in the middle of the workflow, you need to create a new SDK session.
• When the client closes the browser, the validationCode is invalidated and cleared from the cache.

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

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

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

Status: The signature status changes to one of the following and we send a webhook notification:

Check signature status

When you receive webhook notifications, we recommend also checking the signature status:

• You provide the signatureId (same value as the workflowId).
• You receive the current status and status code.

API Reference – Get signature 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

7. Download signed documents

When the signature status is signed, download each signed document:

• You provide the signatureId (same value as the workflowId) and relevant documentId.
• You receive a message in plain text and the PDF document.

API Reference – Get signed document

If you have the fallback QTSP option configured, check if an InfoCert contract was generated, which you are required to download and share with the client:

• You provide the signatureId (same value as the workflowId).
• You receive one of the following empty responses:
  • 200: The signature flow was directed to InfoCert and the response returns the contract to share with the client.
  • 204: The signature flow was directed to Namirial so no contract is returned.

API Reference – Get InfoCert contract

Success

You have integrated the French solution for web!

Top of page