App Drop-in guide

This guide provides step-by-step instructions on how to integrate the French Identity Verification solution with the App Drop-in.

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

App Drop-in Setup with your chosen SDK
App UI Customization
French 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.

📖

Create access token

Open Recipe

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.

📖

Create French workflow

Open Recipe

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:

Flow	Statuses
Completed verification	`completed` with a risk score of `200` – `400` (not `500`)
Pending verification	`new`, `pending`, or `completed` with a risk score of `200` – `400` (not `500`)

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:

Status	Description	Action
`pending`	The client is eligible for a signature.	Wait.
`kyc_required`	The client didn't pass one or more eligibility checks.	Create a new workflow that includes `IDV` and `QES`.

Upload identity data

If configured, upload relevant identity data:

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

📖

Upload identity data

Open Recipe

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.

📖

Upload documents to sign

Open Recipe

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.

📖

Upload mobile phone number

Open Recipe

API Reference – Upload mobile phone number

Status: The signature status remains pending.

5. Create SDK session

Create the App Drop-in session:

You provide the workflowId.
You receive a validationCode to pass to the SDK in your backend.

📖

Create App Drop-in SDK session

Open Recipe

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 app, 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	Description	Action
`pending`	The data is valid.	Wait for the next status.
`invalid_data`	We found invalid or missing data.	Create a new workflow.

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

Status	Description	Action
`inconsistent_data`	We found inconsistent data.	Create a new workflow.
`completed`	We 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.

📖

Get case status

Open Recipe

API Reference – Get case status

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

Status	Description	Action
`signed`	The signed documents are available.	Download the signed documents.
`kyc_required`	The client didn't pass one or more eligibility checks.	Create a new workflow that includes `IDV` and `QES`.
`error`	An error occurred. If the system can recover after the error, the status changes to a previous status.	If the system can't recover, create a new workflow for a signature only.

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.

📖

Get signature status

Open Recipe

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.

📖

Get CDD zipfile

Open Recipe

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.

📖

Download signed documents

Open Recipe

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.

📖

Get InfoCert contract

Open Recipe

API Reference – Get InfoCert contract

Success

You have integrated the French solution for your app!

Top of page