1 de 1

Overview

Nesta seção, você encontrará todas as especificações técnicas das APIs REST do by Unico

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.

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

How to integrate

Authenticate

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

Learn more in Authentication.

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.

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).

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.

Compatibilities

Web SDK

Compatible with all devices with a front camera, whether laptops or mobile, respecting the list of officially supported browsers below:

Other browsers are not supported.

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.

Overview

Nesta seção, você encontrará todas as especificações técnicas das APIs REST do by Unico

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.

Possible Flows

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

How to integrate

Authenticate

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

Learn more in Authentication.

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.

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).

Check the Process Result

Learn more in GetProcess.

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

Compatibilities

Android SDK

iOS SDK

Web SDK

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

Other browsers are not supported.

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.