1 de 2

GetEvidenceSet

In this section, you will find instructions on how to obtain the evidential set from a process in by Unico via the REST API

Getting started

Your API requests are authenticated using an access token. Any request that does not include a valid access token will return an error.

You can learn more about generating an access token here.

Endpoints:

UAT: https://api.cadastro.uat.unico.app/client/v1/process;
Production: https://api.cadastro.unico.app/client/v1/process.

For detailed verification of the API parameters, please refer to the Parameters Specification section.

The evidential set from the biometric capture is only available for consultation via the REST API for 2 hours after the completion of the biometric process. After this period, it is no longer possible to retrieve the user's selfie.

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.

Specification of the evidential set

In this section, you will find all the specifications of the evidential set from by Unico

The evidential set is a .pdf document containing authentication evidence of a user who underwent identity validation at by Unico.

Below, you will see how this document is represented, as well as the specification of its return fields:

Evidence Set Fields (click on each to learn more)

User

Watermarked photo;
Name - indicates the name of the authenticated person. This data is obtained through the person.friendly_name parameter of CreateProcess;
CPF of the holder - indicates the CPF of the authenticated person. This data is obtained through the person.dui_value parameter of CreateProcess;
Contact channel - indicates the communication channel with the authenticated person. This data is obtained through the person.notifications parameter of CreateProcess.

Process

Executed flow - indicates which flow was executed. This data is obtained through the flow parameter of CreateProcess;
Process identifier - indicates the process ID. This data is obtained through the process.id parameter in the CreateProcess response;
URL - indicates the authentication URL of the process;
Creation - indicates the creation date of the process. This data is obtained through the createdAt parameter in the CreateProcess response;
Completion - indicates the completion date of the process. This data is obtained through the finishedAt parameter in the CreateProcess response;
State - indicates the status of the process. This data is obtained through the state parameter in the CreateProcess response.

Validations

Validation type - indicates the type of validation for the authentication process;
Identity - indicates the result of the Identity Verification;
Liveness detection - indicates the result of the Liveness Test.

Navegation data

Operating system and browser - indicates the device data;
IP address - indicates the device's IP address.

Evidence of module usage in the flows iddocs, idsign, and iddocssign

When the process involves the IDDocs and Sign flows, the probative set also returns data from these flows such as: Documents:

Document type - identifies the document shared by the person. Ex: CNH / RG;
Collection module - if Yes, identifies whether a document was captured;
Document validated - if Yes, indicates that the shared/reused document has been validated.

Signature:

Envelope data - indicates the documents and their signers;
Envelope ID - UUID that identifies the envelope in Unico Sign.

These evidences can be used to ensure the authenticity of the process.

Important:

The evidentiary set is only available for completed processes;
The evidentiary set for biometric capture is only available for consultation via REST API for 2 hours after the completion of the biometric process. After this period, it is not possible to retrieve the user's selfie.

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.

Specification of the evidential set

In this section, you will find all the specifications of the evidential set from by Unico

The evidential set is a .pdf document containing authentication evidence of a user who underwent identity validation at by Unico.

Below, you will see how this document is represented, as well as the specification of its return fields:

Evidence Set Fields (click on each to learn more)

User

Watermarked photo;
Name - indicates the name of the authenticated person. This data is obtained through the person.friendly_name parameter of CreateProcess;
CPF of the holder - indicates the CPF of the authenticated person. This data is obtained through the person.dui_value parameter of CreateProcess;
Contact channel - indicates the communication channel with the authenticated person. This data is obtained through the person.notifications parameter of CreateProcess.

Process

Executed flow - indicates which flow was executed. This data is obtained through the flow parameter of CreateProcess;
Process identifier - indicates the process ID. This data is obtained through the process.id parameter in the CreateProcess response;
URL - indicates the authentication URL of the process;
Creation - indicates the creation date of the process. This data is obtained through the createdAt parameter in the CreateProcess response;
Completion - indicates the completion date of the process. This data is obtained through the finishedAt parameter in the CreateProcess response;
State - indicates the status of the process. This data is obtained through the state parameter in the CreateProcess response.

Validations

Validation type - indicates the type of validation for the authentication process;
Identity - indicates the result of the Identity Verification;
Liveness detection - indicates the result of the Liveness Test.

Navegation data

Operating system and browser - indicates the device data;
IP address - indicates the device's IP address.

Evidence of module usage in the flows iddocs, idsign, and iddocssign

When the process involves the IDDocs and Sign flows, the probative set also returns data from these flows such as: Documents:

Document type - identifies the document shared by the person. Ex: CNH / RG;
Collection module - if Yes, identifies whether a document was captured;
Document validated - if Yes, indicates that the shared/reused document has been validated.

Signature:

Envelope data - indicates the documents and their signers;
Envelope ID - UUID that identifies the envelope in Unico Sign.

These evidences can be used to ensure the authenticity of the process.

Important:

The evidentiary set is only available for completed processes;
The evidentiary set for biometric capture is only available for consultation via REST API for 2 hours after the completion of the biometric process. After this period, it is not possible to retrieve the user's selfie.

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.

GetEvidenceSet

In this section, you will find instructions on how to obtain the evidential set from a process in by Unico via the REST API

Getting started

Your API requests are authenticated using an access token. Any request that does not include a valid access token will return an error.

You can learn more about generating an access token here.

Endpoints:

UAT: https://api.cadastro.uat.unico.app/client/v1/process;
Production: https://api.cadastro.unico.app/client/v1/process.

GetEvidenceSet

Endpoint to retrieve the evidence set from the identity verification process by Unico.

GEThttps://api.cadastro.uat.unico.app/client/v1/process/{id}/evidenceset

Authorization

Path parameters

id*string

Process ID.

Response

Evidence set obtained successfully.

Body

fileContentsstring

Evidence content encoded in base64.

Example: "JVBERi0xLjUNCiWDk[...]NCg=="

contentTypestring

Type of the evidence content (PDF).

Example: "x-pdf"

Request

Response

For detailed verification of the API parameters, please refer to the Parameters Specification section.

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.