Overview

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.

With by Unico, you will have a team of security experts and UX design best practices to ensure the best possible conversion in your operation. It can be used responsively on both Desktop and Mobile. Offering the following usage possibilities:

Channel
Redirect
Open.window()
iFrame
Webview
Mensagens

Desktop

Supported

Supported

Supported

Not supported

Supported

Webmobile

Supported

Supported

Supported

Not supported

Supported

App mobile

Not supported

Not supported

Not supported

Supported

Supported

For the message flow, it is possible to send notifications through the channels of WhatsApp and/or SMS.

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.

Possible Flows


by Unico is an integration method of Unico IDCloud that allows clients to integrate more easily and connect different capabilities 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.

To do this, you will only need to change the flow parameter 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 Verificationde Identidade
Behavior Alert
Risk Score
Document Capture and Reuse
Electronic Signature
Validation (1:1)
Smart Revalition
Serpro Similarity Return

idlive

Supported

Not supported

Not supported

Not supported

Not supported

Not supported

Not supported

Not supported

Not supported

id

Supported

Supported

Not supported

Not supported

Not supported

Not supported

Not supported

Not supported

Not supported

idlivetrust

Supported

Not supported

Supported

Not supported

Not supported

Not supported

Not supported

Not supported

Not supported

idcheck

Supported

Supported

Not supported

Supported

Not supported

Not supported

Not supported

Not supported

Not supported

iddocs

Supported

Supported

Not supported

Supported

Supported

Not supported

Not supported

Not supported

Not supported

idsign

Supported

Supported

Not supported

Supported

Not supported

Supported

Not supported

Not supported

Not supported

iddocssign

Supported

Supported

Not supported

Supported

Supported

Supported

Not supported

Not supported

Not supported

idchecktrust

Supported

Supported

Supported

Supported

Not supported

Not supported

Not supported

Not supported

Not supported

idchecktrustdocs

Supported

Supported

Supported

Supported

Supported

Not supported

Not supported

Not supported

Not supported

idchecktrustsign

Supported

Supported

Supported

Supported

Not supported

Supported

Not supported

Not supported

Not supported

idchecktrustdocssign

Supported

Supported

Supported

Supported

Supported

Supported

Not supported

Not supported

Not supported

idcheckserpro

Supported

Supported

Not supported

Supported

Not supported

Not supported

Not supported

Not supported

Supported

idcheckserprodocs

Supported

Supported

Not supported

Supported

Supported

Not supported

Not supported

Not supported

Supported

idcheckserprodocssign

Supported

Supported

Not supported

Supported

Supported

Supported

Not supported

Not supported

Supported

creditoconsignado

Supported

Supported

Not supported

Supported

Supported

Supported

Not supported

Not supported

Supported

idtrust

Supported

Supported

Supported

Not supported

Not supported

Not supported

Not supported

Not supported

Not supported

idunicodocs

Supported

Supported

Not supported

Not supported

Supported

Not supported

Not supported

Not supported

Not supported

idunicosign

Not supported

Not supported

idunicodocssign

Supported

Supported

Not supported

Not supported

Supported

Supported

Not supported

Not supported

Not supported

idunicoserprodocssign

Not supported

Not supported

idtrustdocs

Supported

Supported

Supported

Not supported

Supported

Not supported

Not supported

Not supported

Not supported

idtrustsign

Supported

Supported

Supported

Not supported

Not supported

Supported

Not supported

Not supported

Not supported

idtrustdocssign

Supported

Supported

Supported

Not supported

Supported

Supported

Not supported

Not supported

Not supported

idtoken

Supported

Not supported

Not supported

Not supported

Not supported

Not supported

Supported

Not supported

Not supported

idtokentrust

Supported

Not supported

Supported

Not supported

Not supported

Not supported

Supported

Not supported

Not supported

idtokensign

Supported

Not supported

Not supported

Not supported

Not supported

Supported

Supported

Not supported

Not supported

idsmart

Not supported

Not supported

Not supported

Not supported

Not supported

Not supported

Not supported

Supported

Not supported

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

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

How to integrate


1

Authenticate

First, you must have a service account and perform 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 will specify the "flow" you wish to use).

Learn more in CreateProcess.

3

Define Your User’s Journey

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

  • Will the journey be on the web? You can use the browser's Redirect or the SDK.

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

  • 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 CreateProcess request in step 2).

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.

Learn more in GetProcess.


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.

Last updated