link

# ReadID

ReadID (opens new window) is a third party eIDV provider integrated with Assure API.

# Supported features

Signicat supports the following identity verification features from ReadID:

  • ID document check
  • NFC reading of ID document's chip.

# User flow example

More information will follow soon.

# SDKs

The aim of this topic is to help a developer integrating with the Assure API using ReadID's SDKs.

Please, keep in mind that the following descriptions do not contain all the necessary steps for production mode. In addition, you must add validations, tests and error handling, which is outside the scope of this documentation.

Using the third-party SDKs means that the end-user will see ReadID's user interface when performing the identity verification on their mobile or desktop.

Check end-user's ID document

The main aim of ReadID's user interface is to check the end-user's ID document.

Before you start the SDK integration, we recommend to familiarise yourself with the general steps in the Assure Integration guide.

# Requirements

Before you start the SDK integration, you should be aware of the following requirements for ReadID's SDKs:

  • Always use the latest ReadID SDK version.

    SDK version

    You should keep your app up to date by using the latest ReadID SDK version. Since ReadID's SDKs are not publicly available, please contact Signicat at support@signicat.com.

  • Ensure you implement for ReadID's supported device versions (iOS/Android). Please, contact Signicat at support@signicat.com to get this information.

  • The mobile device must have NFC support.

  • The app needs camera permission. Access to a microphone is not a requirement.

  • Your app must always communicate with your own server and never directly with the Assure API. See more details about this requirement and other recommendations on the developer pages.

  • Since you are integrating with the Assure API in a native app context, you should choose the eIDV generic flow.

# Mobile SDKs (Android and iOS)

# Integration steps overview

This diagram provides an abstraction of the client-side implementation.

click-to-zoom

The next sections describe all the needed steps, including the integration with Assure before and after the ReadID SDK integration in step 3. Here is an overview of all the needed steps:

  1. Create a dossier.
  2. Create a process.
  3. Integrate with the ReadID mobile SDK to check the ID document.
  4. Get result.

Note:

All the steps are similar for iOS and Android except the SDK integration in step 3, which is described below in different tabs for iOS and Android.

# Create a dossier

  • Use the Create dossier endpoint to create a placeholder for all of your end-user’s data.
  • Save the dossierId you get in the response.

Note:

Ensure you use one dossier per end-user.

# Create a process

  • Use the Create process endpoint to create an identity verification process in that dossier. Ensure you give it the dossierId you got in the previous step. Also, enter the ReadID provider in the request body:
{
    "provider":"readid",
    "processType":"sdk"
} 
  • When you have created the ReadID process, you should get a backend response like this:
{
    "processId": "7c0a2a82-0aac-49d7-a118-7e14e46a143f",
    "status": "pending",
    "createdAt": "2021-01-11T10:29:17Z",
    "updatedAt": "2021-01-11T10:29:17Z",
    "authorization": "someAuthorizationString",
    "providerApiUrl": "someProviderApiUrl",
    "provider": "readid",
    "processType": "sdk"
}
  • Save the information from the response. You will need it in the next SDK integration steps.

# Integrate with the ReadID mobile SDK to check the ID document

To check the ID document of the end-user, you must now integrate with the ReadID SDK for either Android or iOS:

# Get result

When the verification is finished, you can call the Get process result to get the result of the identity verification.

For result examples, see ReadID results.

Download full result

You can also get a zip file with the packaged process by calling the Download full result endpoint.

# Web SDK

ReadID does not provide a web SDK since it requires using the NFC technology of a mobile phone via a native mobile app.

Last updated: 21/09/2022 10:38 UTC