In this section you will find all the technical specifications of the by Unico REST APIs
Introduction
by Unico is a channel that provides an infrastructure of identity validation solutions from the IDCloud platform.
Its goal is to simplify the use of the capabilities of the IDCloud platform by offering a solution that can be integrated into your back-end and front-end, enhancing the security of transactions.
Compatible devices
Android
iOS
Compatible with all devices with front camera, Android 8+, armv7 or arm64.
Compatible with all iOS devices version 11 or higher.
Web
Compatible with all devices with a front camera, whether on laptops or mobile devices, adhering to the list of officially supported browsers below:
Native browsers
Mobile browsers
Computer/notebook browsers
iOS:
version greater than or equal to 12.
Android:
version greater than or equal to 5.
Android:
Chrome: version greater than or equal to 90.
iOS:
Safari: version greater than or equal to 14.1;
Chrome: version greater than or equal to 90 (only for IOS version equal to or greater than 14.4).
Chrome:
version greater than or equal to 85.
Firefox:
version greater than or equal to 94.
Safari:
version greater than or equal to 11.
Other browsers are not supported.
Possible Flows
To do this, you will only need to change the flowparameter in the REST API payload, which will give you several verification journey possibilities. See below the table relating the available flows and their respective capabilities:
Flow
Liveness
Identity Verification
Behavior Alert
Document Capture and Reuse
Electronic Signature
Validation (1:1)
Serpro Similarity Return
idlive
id
idlivetrust
idtrust
idunicodocs
idunicosign
idunicodocssign
idunicoserprodocssign
idtrustdocs
idtrustsign
idtrustdocssign
idtoken
idtokentrust
idtokensign
If you use the Document Reuse and Capture capability, consider the following documents:
Brazilian ID (RG), Brazilian Driver's License, CIN and Brazilian Passport.
If the similarity result from Serpro is positive, we request the electronic signature;
If the similarity result from Serpro is negative, we ask for the user's documents to perform the facematch:
If the facematch result is positive, we request the electronic signature;
If the facematch result is negative, we end the journey without requesting the electronic signature.
The Risk Score capability is being discontinued and can only be used in special cases.
How to integrate
1
Authenticate
First, you must have a service account and perform OAuth2 authentication to obtain a valid access token.
2
Create a Process
With the access token obtained in the previous step, make a POST request to the endpoint client/v1/process (here you will specify the "flow" you wish to use).
3
Define Your User’s Journey
In this step, you will define where your user's journey will take place.
4
Check the Process Result
With the access token obtained in step 1, make a GET request to the endpoint client/v1/process/{id}(here you will provide the "id" of the process created in step 2), check the process result, and decide whether to approve or reject the user.
by Unico is an integration method of Unico IDCloud that allows clients to integrate more easily and connect different in a single journey. This integration method provides the necessary resources to perform Liveness, Identity Verification, Risk Score, Document Capture and Reuse, and Electronic Signature.
Learn more in .
Learn more in
Will the journey be on the web? You can use the browser's or the .
Will the journey be in your app? You can use a .
Will the journey be in the messaging flow? You can send notifications via WhatsApp and SMS (for this, simply provide the corresponding parameter in the request in step 2).
Learn more in .
To optimize your integration, you can use the to know when the result of your process is completed.
Still need help?
Didn't find something or still need help? If you're already a client or partner, you can reach out through our .
