# Integration flows
Page contents
This topic provides an overview of the flows for integrating with the Assure API and the use of its services.
Important
Your mobile/web app must always communicate with your own server and never directly with the Assure API.
# eIDV generic flow
By integrating with the Assure API, you enable an end-user to perform electronic identity verification using their identity document on your web/native mobile app.
The generic flow for integrating this service can be illustrated as follows:
# Step 1: Initial setup
You must set up the necessary resources, i.e. create a dossier (opens new window) and then create a process (opens new window) inside that dossier.
The dossier is where all the information about the end-user is kept. The process allows you to request an eIDV provider to perform the verification of an identity document. It is also where all information about the verification result is kept.
# Step 2: Upload ID images
Now that you have a dossier and a process, you must provide images of the identity document and of the end-user.
You can do this either by using the provider’s SDK to capture and upload the images or by uploading the images directly using the Assure API.
See also Images.
# Step 3: Request verification
Now that all the necessary information has been provided, you should request the verification (opens new window).
Can I upload new ID images to the same process?
Every time you upload images to a process, they will replace the previous ones.
However, as soon as you request the verification to be performed, no more images should be uploaded. If you need to change the images or any other data, you should discard the current process and create a new one.
# Step 4: Get verification result
At this point, we must wait for a response from the provider with the final result.
Since this response is obtained asynchronously, you may subscribe to Assure events to be notified when the result is available. Still, at any time you can see all the available information about an identity document verification by checking the information in the process (opens new window).
Must I subscribe to Assure events to get the final result?
You are not required to subscribe to the Assure events. However, we strongly recommend that you do this, instead of polling Signicat's services.
WARNING
Using polling instead of subscribing to events, may put your service at risk due to rate limiting of requests.
The final result information is always kept inside the process whether you asked to be notified or not. The event notification only informs you that the verification is finished.
An important feature of the Assure API is that, regardless of the provider you use to perform the identity verification, you always get a normalised final result on any process that is “accepted”. For more information about the process results, see Get process.
# eIDV alternative flow (web only)
If you prefer using the provider’s SDK to capture and upload the ID images and you are integrating with the Assure API in a web environment, you can deflect integrating with their SDK and alternatively use the Assure API Capture (opens new window) service.
These services encapsulate the providers’ JS SDKs, making it quicker and easier for you to integrate with the Assure API in a web context:
This flow is a simplification of the generic eIDV integration flow. You don’t need to create a process (step 1 in the generic flow), integrate with the provider’s SDK / upload the images (step 2 in the generic flow) nor request to start the verification (step 3 in the generic flow). All of these steps are encapsulated in the Start capture flow service.
Here are the guidelines on how to use this alternative flow:
# Step 1: Initial setup
As in any flow, you must create a dossier (opens new window) to contain the information about the end-user.
After you have the dossier, you just have to call the Start capture flow (opens new window) endpoint, giving it the dossierId, the provider that will perform the verification and a redirectUrl, which is where the end-user is redirected when they have finished capturing and uploading the ID images. You must prepare this redirectUrl to receive parameters since the dossierId, processId and status will be appended to it.
Example of a redirect URL
https://myredirecturl.com/?dossierId=c03e66c7-8230-4020-a084-5a34a925d5fe&processId=8a303665-c94a-47c1-be8d-5df65f64a0ad&status=processing
Optionally, if you want to be notified when the verification is finished, either successfully or not, you can subscribe to Assure events.
In this service’s response, you will find a URL that you need in the next step.
# Step 2: Image upload and verification
Now you must redirect the end-user to the URL you received in the previous step. That will load the provider’s JS SDK and allows the end-user to capture/upload the required ID images and perform the verification.
After the end-user is finished performing the verification, they are redirected to the redirectUrl indicated in the Start capture flow request. The dossierId, processId and status of the process are appended to the redirectUrl.
# Step 3: Get result
It is recommended to subscribe to Assure events to be notified when the result is available. The Assure event will contain information about the dossierId, processId and status of the process.
You can use that information to call the Get process (opens new window) endpoint and get all the data regarding the verification result.
If you did not register to be notified when the verification is finished, you can poll the Get process (opens new window) endpoint and wait for the process status to be one of the final possible values (e.g. accepted, rejected etc.). At that point, the response will also contain all the data regarding the verification result.
As in the generic flow, you get a normalised final result for processes that were accepted. For more information about the process results, see the Get process section.