# Electronic IDentification

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

# Supported features

Signicat supports the following identity verification features from Electronic IDentification (eID):

ID document check
Face match between ID document and selfie
Liveness check of live video recording
Manual review or live interview by a support agent

# User flow example

More information will follow soon.

# Integration use cases

This section assumes you already have done the initial integration steps with the Assure API, i.e. set up client credentials and OIDC token.

# UC 1: Use EID and integrate with EID’s SDK (web or mobile usage)

I want to allow the same end-user from the previous use case to verify their identity, but now using Electronic IDentification (opens new window) (EID).

In the end, I want to receive a final result with the same structure as the one from the test case before (despite having used a different provider).

I also want to see the information about all processes from this end-user.

Note: This use case seamlessly fits both web (JS) and mobile (Android/iOS) applications.

Remember that EID always requires that the ID images are captured and uploaded using their SDK.

click-to-zoom

The colour codes illustrate the flow decision:

Green = Must
Grey = Optional
White = Not used

Note: Do not create a new dossier. Since this is the same end-user, use the same dossierId as in the previous use cases.

Use the dossierId from the previous use cases on the next steps.

# Step B: Get document types

When integrating with EID’s SDK, you must specify the ID of the document that will be used to verify the identity. To get that document ID you must use this endpoint to get the list of documents supported by Electronic IDentification on your environment.

Tip: EID supports more documents than the ones shown on that list, but they must be explicitly enabled. If you need to enable more documents, please contact Signicat Support at support@signicat.com.

# Step C: Create process

Use the example JSON in the request body.

{
  "provider": "eid"
}

At this point, you can also request to receive a notification of when the verification is finished – check Use Case 1 for details on how to do that.
Save the authorizationToken and the processId to be used in the next step.

# Step D1: Launch provider’s SDK

Now you must launch Electronic’s SDK in your app. For more details about how to use the different providers’ SDKs, please contact Signicat Supporat at support@signicat.com.

# Step E: Start verification

EID requires that a manual approval of each verification request is performed using their Registration Authority Application (RA App).

Access EID’s Registration Authority App. If you don’t have the link to that app, use the Get Manual Approval URL endpoint to get it.
Select Start to work.
Accept a verification request. Go through the indicated steps and register the verification. Note: It is important to register the verification since it marks the process as “accepted“. If you reject it, the process status in the next step will be returned as “rejected” and you will not get a finalResult element in the response body.

# Step F: Get process

Use the dossierId and processId from the previous steps (or from the callback notification, in case you use it).
The process status is now accepted and the response body contains data about the process final result (for more details about the process structure, see Response structure).
All information is normalised and the finalResult element contains the same fields of information as the final result of the accepted Onfido requests in the previous use cases.
Get dossier: Finally, to check the information about all processes regarding this end-user, call the Get dossier endpoint.

# UC 2: Use EID and integrate only with Assure API (web usage only)

I want to allow an end-user to verify their identity using the Electronic IDentification (EID) provider in my website.

I want the required ID images to be captured and uploaded using EID’s SDK but I don’t want to integrate with it.

I also want to be able to retrieve the video of the verification process.

In the end, I want to see all the information regarding the verification process. Afterwards, I want to delete the dossier (including all the end-user information).

Note: This use case only fits web (JS) applications.

In this use case, you integrate only with the Assure API. However, the end-user experience is the same as in Use Case 3, since EID’s Web (JS) SDK is embedded in the Assure API’s Capture Flow service.

click-to-zoom

The colour codes illustrate the flow decision:

Green = Must
Grey = Optional
White = Not used

# Step A: Create dossier

Save the dossierId from the response body to use in the next requests.

# Step G: Start Capture flow

Use the dossierId from step A in the Start Capture flow request.
In the request, you must also indicate the redirectUrl to redirect the user to the required page after the verification is finished.
It is recommended to send a notificationUrl to receive a callback after the process is finished.

Notification URL

In order to receive notifications in production, you must request Signicat to whitelist your URL. To get help with this, send an email to support@signicat.com. To perform tests in pre-production, use one of the following options:

Webhook URL (opens new window) (see example below)
Hookbin (opens new window)

Code example:

{
    "providers": [
        {
            "provider": "eid"
        }
    ],
    "notificationUrl": "https://webhook.site/#!/705bcdd5-72dc-4018-832f-5b64ba26b5d8",
    "redirectUrl": "https://my-redirect-url.com/"
}

For other optional parameters in this request, see the OpenAPI documentation > Start Capture flow.
In the response, you will get a URL, e.g.

{
    "url": "https://preprod.signicat.com/capture/#/artifact=4pwgyft1874rqzt8ww9z3v0r5xmqeodro3wy2nin3hgcdvy96g"
}

You must use this URL to redirect the end-user to the web page where they will be asked to verify their identity.
After the end-user has identified themselves, they will be redirected to the specified redirectURLyou sent in the request.
Then wait for the callback notification to arrive before you proceed to the Get process step (see below).

# Step F: Get process

After you get the notification in the URL you provided in step G (above), you know that the verification result is ready. You can then use the following requests to get information about the process:

Get process: Use the dossierId and processId in the callback notification. The process now contains data about the process final result (for more information, see Get process > Response structure).
Get video: Use the Get video endpoint to get a video of the end-user capturing images of the identity document.
Download full result: Use the Download full result endpoint to download all the information regarding the process.

After you have finished the end-user verification, you can delete the dossier:

Use the Delete dossier endpoint to delete the dossier. Note: This will also delete all the information about this end-user.

# SDKs

To get help with using the SDKs from Electronic IDentification, please contact Signicat Support at support@signicat.com.

← Integration guide (common for all providers) FaceTec →