Overview

In this section you will find all the technical specifications of the by Unico REST APIs

---

An Introdution

---

The by Unico channel provides an infrastructure for identity validation solutions from the IDCloud platform.

It aims to simplify the use of IDCloud's capabilities by offering a solution that can be integrated into your back end and front end, enhancing transaction security.

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 laptops or mobile, respecting 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

---

The by Unico integration for Unico IDCloud allows clients to integrate more easily and connect different capabilities within a single journey. This integration provides the necessary resources for functions such as Liveness, Identity Verification, Risk Scoring, Document Capture and Reuse, and Electronic Signature.

To utilize these functions, simply adjust the flow parameter in the REST API payload, which unlocks various verification journey options.

Please refer to the table below to see the available flows and their respective capabilities:

Flow	Capacidades
idlive	Liveness
id	Liveness + Identity Verification
idlivetrust	Liveness + Behavior Alert
idtrust	Liveness + Identity Verification + Behavior Alert
idcheck	Liveness + Identity Verification + Risk Score
iddocs	Liveness + Identity Verification + Risk Score + Document Capture and Reuse
idsign	Liveness + Identity Verification + Risk Score + Electronic Signature
iddocssign	Liveness + Identity Verification + Risk Score + Document Capture and Reuse + Electronic Signature
idchecktrust	Liveness + Identity Verification + Risk Score + Behavior Alert
idchecktrustdocs	Liveness + Identity Verification + Risk Score + Behavior Alert
idchecktrustsign	Liveness + Identity Verification + Risk Score + Behavior Alert + Electronic Signature
idchecktrustdocssign	Liveness + Identity Verification + Risk Score + Behavior Alert + Document Capture and Reuse + Electronic Signature
idcheckserpro	Liveness + Identity Verification + Risk Score + Serpro Similarity Return
creditoconsignado	Liveness + Identity Verification + Risk Score + Serpro Similarity Return + Electronic Signature This flow works conditionally: 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.
idcheckserprodocssign	Liveness + Identity Verification + Risk Score + Serpro Similarity Return + Document Capture and Reuse + Electronic Signature
idtoken	Liveness + Validation (1:1)
idtokentrust	Liveness + Validation (1:1) + Behavior Alert
idtokensign	Liveness + Validation (1:1) + Electronic Signature

If you use the Document Reuse and Capture capability, consider:

• Reuse: Brazilian ID (RG), Brazilian Driver's License, CIN and Brazilian Passport;

• Capture: Brazilian ID (RG), Brazilian Driver's License and Brazilian Passport.

---

How to integrate

---

1

Authenticate

First, you need a service account and must complete OAuth2 authentication to obtain a valid access token.

Learn more in Authentication.

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 specify the "flow" you want to use).

Learn more in CreateProcess.

3

Define Your User’s Journey

In this step, determine where your user's journey will take place.

• Will the journey be web-based? You can use the browser Redirect or iFrame.

• Will the journey be in your app? You can use a Webview.

• Will the journey be in a messaging flow? You can send notifications via WhatsApp, SMS, and Email (simply provide the corresponding parameter in the CreateProcess request in step 2).

4

Check the Process Result

With the access token from step 1, make a GET request to the endpoint client/v1/process/{id} (here you enter the "id" of the process created in step 2), check the process result, and decide whether to approve the user.

Learn more in GetProcess.

To optimize your integration, you can use a Webhook to be notified when your process result is complete.

---

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 Help Center.