In this section, you will find all the available REST APIs for using the by Client integration method
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
In this section, you will find the specific details on creating a process that includes Document Capture and Reuse as a capability
In this section, you will find detailed documentation about the functionality of the endpoints related to the Document Capture and Reuse capability. The use of Reuse requires that there be a previous Identity Verification process and this must obtain a “YES” response OR the Risk Score equal or more than +50, otherwise it will be necessary to capture the user's document.
This is an asynchronous capability that requires consuming three endpoints, detailed in this documentation, for its full utilization.
The capabilities of the Unico IDCloud platform via Client are managed through API Keys—used as a parameter in the request headers—that define the access scope. As a prerequisite, it is necessary to have an API Key configured exclusively for the Document Capture and Reuse capability, ensuring dedicated and secure access to the resource.
Talk to your project manager to obtain the API Key with this configuration.
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:
Production: https://api.id.unico.app/processes/v1.
If you find a document to be reused, in the process creation endpoint you will enter the ID of this document in the document.documentId parameter and it will not be necessary to capture the document and send the base64 in the document.files parameter.
Important:
To use the Document Capture and Reuse capability, the Identity Verification capability must be used beforehand, as it is necessary to include the processId obtained from the Identity Verification in the document.authProcessId parameter:
The process must have valid biometrics, be used within 24 hours of completion and cannot be reused.
If we are unable to extract a field from the document, it is not listed in the API return;
If an error occurs during biometric processing, the request will return a status code = 200, and the process will return a status = 5, as shown in the example below:
Content returned in document.content based on document.type:
Attention:
When making a GET request for a process with status = 5 (error), the return status code will be 410 (Gone) instead of 200 (Success).
Since there are no drops in the process creation request, document processing errors will be returned in the response of the query endpoint. At this point, you should interpret the returns and, if necessary, guide your user through a retry flow.
Tips:
When implementing your business rules, always validate the final statuses of the processes (3, 4, 5). To validate the response of IDCloud capabilities, only consider status = 3 for your decision-making process;
For more information about possible errors for this endpoint, refer to the Errors 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.
In this section, you will find the specifics of creating a process that has Liveness + Identity Verification + Risk score as a capabilities
In this section, you will find detailed documentation about the functionality of the endpoints related to the Liveness + Identity Verification + Risk Score capabilities, used together.
These consist of two synchronous capabilities (Liveness + Identity Verification) integrated with one asynchronous capability (Risk Score). In other words, while most processes will return synchronous responses, some will be orchestrated with the Risk Score and will require subsequent queries.
For this integration, it will be necessary to consume two endpoints described in this documentation, which can also be combined with the use of Webhooks.
The capabilities of the Unico IDCloud platform via Client are managed through API Keys—used as a parameter in the request headers—that define the access scope. As a prerequisite, it is necessary to have an API Key configured with the Liveness + Identity Verification + Risk Score capabilities, ensuring dedicated and secure access to the resource.
Talk to your project manager to obtain the API Key with this configuration.
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:
Production: https://api.id.unico.app/processes/v1.
Important:
If the response for the Identity Verification capability returns unicoId = yes, this result already includes Liveness (i.e., the liveness parameter will not be included in the response);
To use the Liveness capability, it is mandatory to use our SDKs;
It is possible to use the Identity Verification capability without Liveness. For this use case, the liveness value will always return as liveness = 1. In this scenario, no Liveness validation is performed, not even passive validation.
If the response for the Identity Verification capability is unicoId = inconclusive, orchestration with the Risk Score capability will occur. Therefore, it will be necessary to Get the Process Result (endpoint described below), as the Risk Score response is asynchronous.
If an error occurs during biometric processing, the request will return a status code = 200, and the process will return a status = 5, as shown in the example below:
Tips:
When implementing your business rules, always validate the final statuses of the processes (3, 4, 5). To validate the response of IDCloud capabilities, only consider status = 3 for your decision-making process:
A percentage of your operation will have a conclusive response from the Identity Verification capability (yes or no). For these, you can decide whether to approve or reject the registration without needing to Get the Process Result;
For cases where the response from the Identity Verification capability is inconclusive (inconclusive), it will be necessary to Get the Process Result.
In the v2 endpoint (/processes/v2/{id}), we also return additional user information, as shown in the example below:
Attention:
When making a GET request for a process with status = 5 (error), the return status code will be 410 (Gone) instead of 200 (Success);
There may be cases of drops during orchestration with the Risk Score capability. In this scenario, the process will have the following combination: {status = 3, unicoId = inconclusive, liveness = 1, and NO score in the API response}. Learn more in the Response Scenarios section;
If you query a process with status = 2, implement polling until you receive status = 3 or implement Unico's Webhook to know when to get the result.
Tips:
When implementing your business rules, always validate the final statuses of the processes (3, 4, 5). To validate the response of IDCloud capabilities, only consider status = 3 for your decision-making process;
To improve the performance of your operation, you can use our Webhooks and only query the results of processes that have a finalized status;
For more details on the scenarios you might receive in the response, refer to the Response Scenarios section;
For more information about possible errors for this endpoint, refer to the Errors 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.
In this section, you will find the specifics of creating a process that only has the Liveness capability
In this section, you will find detailed documentation about the functionality of the endpoint related to the "Liveness" capability, used in isolation.
This is a synchronous capability, meaning the entire integration occurs using a single endpoint.
The capabilities of the Unico IDCloud platform via Client are managed through API Keys—used as a parameter in the request headers—that define the access scope. As a prerequisite, it is necessary to have an API Key configured exclusively for the "Liveness" capability, ensuring dedicated and secure access to the resource.
Talk to your project manager to obtain the API Key with this configuration.
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:
Production: https://api.id.unico.app/processes/v1.
Important:
To use the "Liveness" capability, it is mandatory to use our SDKs;
If an error occurs during biometric processing, the request will return a status code = 200, and the process will return a status = 5, as shown in the example below:
Tips:
For this use case, there is no need to Get the Process Result, as the response is synchronous;
When implementing your business rules, always validate the final statuses of the processes (3, 4, 5). To validate the response of IDCloud capabilities, only consider status = 3 for your decision-making process;
For more details on the scenarios you might receive in the response, refer to the Response Scenarios section;
For more information about possible errors for this endpoint, refer to the Errors 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.
In this section, you will find the specifics of creating a process that has Liveness + Identity Verification as a capabilities
In this section, you will find detailed documentation about the functionality of the endpoint related to the "Liveness" + "Identity Verification" capabilities, used together.
These are two synchronous capabilities, meaning the entire integration occurs using a single endpoint.
The capabilities of the Unico IDCloud platform via Client are managed through API Keys—used as a parameter in the request headers—that define the access scope. As a prerequisite, it is necessary to have an API Key configured with the "Liveness" + "Identity Verification" capabilities, ensuring dedicated and secure access to the resource.
Talk to your project manager to obtain the API Key with this configuration.
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:
Production: https://api.id.unico.app/processes/v1.
Important:
If the response for the "Identity Verification" capability returns unicoId = yes, this result already includes the Liveness (i.e., the liveness parameter will not be included in the response);
To use the "Liveness" capability, it is mandatory to use our SDKs:
It is possible to use the "Identity Verification" capability without the "Liveness". For this use case, the liveness value will always return as liveness = 1. In this scenario, no "Liveness" validation is performed, not even passive validation.
If an error occurs during biometric processing, the request will return a status code = 200, and the process will return a status = 5, as shown in the example below:
Tips:
For this use case, there is no need to Get the Process Result, as the response is synchronous;
When implementing your business rules, always validate the final statuses of the processes (3, 4, 5). To validate the response of IDCloud capabilities, only consider status = 3 for your decision-making process;
For more details on the scenarios you might receive in the response, refer to the Response Scenarios section;
For more information about possible errors for this endpoint, refer to the Errors 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.
In this section, you will find the specifics of creating a process that has Liveness + Identity Verification + Behavior Alert as a capabilities
In this section, you will find detailed documentation on the operation of the endpoints related to the capabilities Liveness + Identity Verification + Fraudster Profile Detection, used together.
These are two synchronous capabilities (Liveness + Identity Verification) integrated with one asynchronous capability (Fraudster Profile Detection). In other words, to retrieve all responses, it will be necessary to Get the Process Result.
For this integration, it will be necessary to consume two endpoints described in this documentation, which can also be combined with the use of Webhooks.
The capabilities of the Unico IDCloud platform via Client are managed through API Keys—used as a parameter in the request headers—that define the access scope. As a prerequisite, you must have an API Key configured with the capabilities Liveness + Identity Verification + Behavior Alert, ensuring dedicated and secure access to the resource.
Talk to your project manager to obtain the API Key with this configuration.
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:
Production: https://api.id.unico.app/processes/v1.
Important:
If the response for the Identity Verification capability returns unicoId = yes, this result already includes Liveness (i.e., the liveness parameter will not be included in the response);
At the time of process creation, the response will not return the parameter identityFraudsters.result. This parameter will only be provided when Getting the Process Result, once the process is completed (status = 3);
To use the Liveness capability, it is mandatory to use our SDKs;
It is possible to use the Identity Verification capability without Liveness. For this use case, the liveness value will always return as liveness = 1. In this scenario, no Liveness validation is performed, not even passive validation.
If an error occurs during biometric processing, the request will return a status code = 200, and the process will return a status = 5, as shown in the example below:
Tips:
When implementing your business rules, always validate the final statuses of the processes (3, 4, 5). To validate the response of IDCloud capabilities, only consider status = 3 for your decision-making process.
In the v2 endpoint (/processes/v2/{id}), we also return additional user information, as shown in the example below:
Attention:
When making a GET request for a process with status = 5 (error), the return status code will be 410 (Gone) instead of 200 (Success);
The Identity Verification and Fraudster Profile Detection capabilities are entirely independent. To implement your business rules, make sure to analyze the meaning of each response.
Tips:
When implementing your business rules, always validate the final statuses of the processes (3, 4, 5). To validate the response of IDCloud capabilities, only consider status = 3 for your decision-making process;
To improve the performance of your operation, you can use our Webhooks and only get the results of processes that have a finalized status;
For more details on the scenarios you might receive in the response, refer to the Response Scenarios section;
For more information about possible errors for this endpoint, refer to the Errors 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.
In this section, you will find the specifics of creating a process that has Liveness + Identity Verification + Behavior Alert + Risk Score as a capabilities.
In this section, you will find detailed documentation on the operation of the endpoints related to the capabilities Liveness + Identity Verification + Behavior Alert + Risk Score, used together.
This involves two synchronous capabilities (Liveness + Identity Verification) integrated with two asynchronous capabilities (Behavior Alert + Risk Score). That is, to obtain all the responses, it will be necessary to Get the Process Result.
For this integration, it will be necessary to consume two endpoints described in this documentation, which can also be combined with the use of Webhooks.
The capabilities of the Unico IDCloud platform via by Client are managed through API Keys - used as a parameter in the request headers - which define the access scope. As a prerequisite, it is necessary to have an API Key configured with the capabilities Liveness + Identity Verification + Behavior Alert + Risk Score, ensuring dedicated and secure access to the resource.
Talk to your project manager to obtain the API Key with this configuration.
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:
Production: https://api.id.unico.app/processes/v1.
Important:
If the response from the Identity Verification capability is unicoId = yes, this return already includes the Liveness (i.e., you will not receive the liveness parameter in the response);
To use the Liveness capability, it is essential to use our SDKs.
It is possible to use the Identity Verification capability without Liveness. In this use case, the liveness return will always be liveness = 1. In this scenario, there is no validation of the Liveness, not even passive validation.
If the responses from the Identity Verification and Behavior Alert capabilities are unicoId = inconclusive + identityFraudsters = inconclusive, there will be orchestration with the Risk Score capability. If any of these responses is conclusive, there will be no orchestration with the Risk Score.
If an error occurs during processing, the process will return a status = 5, as shown in the example below:
Tips:
To implement your business rules, always validate the final statuses of the processes (3, 4, 5). To validate the response from the IDCloud capabilities, only consider the status = 3 for your decision-making.
In the v2 endpoint (/processes/v2/{id}), we also return some additional user information, as shown in the example below:
Attention:
When the GET request is for a process with status = 5 (error), the return status code will be 410 (Gone) instead of 200 (Success);
There may be cases of a drop in orchestration with the Risk Score capability. In this scenario, the process will have the combination: {status = 3, unicoId = inconclusive, liveness = 1, identityFraudsters = inconclusive, and NO score in the API response}. Learn more in the "Response Scenarios" section;
If you query a process that is in status = 2, implement polling until you get a status = 3, or implement Unico’s Webhook to know when to query the result.
Tips:
To implement your business rules, always validate the final statuses of the processes (3, 4, 5). To validate the response from the IDCloud capabilities, only consider status = 3 for your decision-making;
To improve the performance of your operation, you can use our Webhooks and only query the result of processes that are in the finalized statuses;
For more information about the scenarios you may receive in the response, refer to the "Response Scenarios" section;
For more information about possible errors for this endpoint, refer to the "Errors" 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.
Type: CNH
Content: Brazilian National Driving License
String numero;
String rgNumero;
String cpfNumero;
String nomeCivil;
List string filiacao;
Datetime dataNascimento;
Datetime data_habilitacao;
Datetime data_expiracao;
Datetime data_emissao;
String local_emissao;
String categoria;
String renachNumero;
Type: RG
Content: Brazilian General Registration
String numero;
String orgao_emissor;
String uf_emissor;
String cpfNumero;
String carteira_profissionalNumero;
String certificado_militarNumero;
String cnsNumero;
String nis_pis_pasepNumero;
String ctpsNumero;
String ctps_serie;
String ctps_uf;
String titulo_eleitorNumero;
String nomeCivil;
String nome_social;
List string filiacao;
Datetime dataNascimento;
String naturalidade;
Datetime data_emissao;
Type: CIN
Content: Brazilian national Identity Card
string rgNumero;
string cpfNumero;
string nomeCivil;
string nome_social;
List string filiacao;
Datetime dataNascimento;
Datetime data_expiracao;
Datetime data_emissao;
string orgao_emissor;
string local_emissao;
string naturalidade;
string nacionalidade;
Type: Passport
Content: Brazilian Passport
string numero;
string nome;
string sobrenome;
string pais_emissor;
string nacionalidade;
string naturalidade;
Datetime data_nascimento;
Datetime data_emissao;
Datetime data_expiracao;
string autoridade.
Type: UNKNOWN
Content: Unknown document.
In this section, you will find the specifics of creating a process that includes the 1:1 Validation capability
In this section, you will find detailed documentation about the functionality of the endpoint related to the Liveness + 1:1 Validation capabilities, used together.
These are two synchronous capabilities, meaning the entire integration occurs using a single endpoint.
The capabilities of the Unico IDCloud platform via Client are managed through API Keys—used as a parameter in the request headers—that define the access scope. As a prerequisite, it is necessary to have an API Key configured with the Liveness + 1:1 Validation capabilities, ensuring dedicated and secure access to the resource.
Talk to your project manager to obtain the API Key with this configuration.
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: ;
Production: .
Important:
To use the "Liveness" capability, it is mandatory to use our SDKs:
It is possible to use the "Validation 91:1)" capability without the "Liveness". For this use case, the liveness value will always return as liveness = 1. In this scenario, no "Liveness" validation is performed, not even passive validation.
Tips:
For this use case, there is no need to Query the Process Result, as the response is synchronous;
For more information about possible errors for this endpoint, refer to the Errors 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 .
Endpoint to get a user's documents for reuse in by Client.
User identifier value (e.g., CPF value).
12345678909Document type (e.g., BR_CPF).
"BR_CPF"Valid access-token.
Valid APIKEY with the capabilitie Document Capture and Reuse enabled.
Process information retrieved successfully.
List of documents associated with the process.
Document type.
"unico.moja.dictionary.br.rg.v2.Rg"Document ID.
"2aaf6037-0153-415d-b9fe-cf7e8198408f"Endpoint to create a new isolated Liveness process via by Client.
Valid access token.
Valid APIKEY with the Liveness capability enabled.
User information.
User's CPF. Must contain 11 characters and be sent without dots or dashes.
"12345678909"User's name.
"Luke Skywalker"The ID of the branch where the process will be created. If there is only one branch associated with the service account, this parameter is not required. If there is a separation of processes by branch, you will receive the branch IDs from the Unico team.
"60837cd3-ed3c-4038-ad7c-0a85ad64b03a"Encrypted file generated by the SDK.
"/9j/4AAQSkZJR..."Process successfully created (User alive).
Process ID.
"80371b2a-3ac7-432e-866d-57fe37896ac6"Process status. Possible values: '3' - Completed; '4' - Canceled (e.g., timeout); '5' - Error.
3Liveness result. Possible values: '1' - Liveness approved; '2' - Liveness denied.
1Endpoint to get the result of an Liveness + Identity Verification + Risk Score process by Client.
Process ID.
Valid access token.
Valid APIKEY with Liveness + Identity Verification + Risk Score capabilities enabled.
Process information successfully retrieved.
Process ID.
"2b034568-dfaf-463f-94fb-18ed93c312e8"Process status. Possible values: '1' - Processing (occurs when forwarded for Risk Score evaluation); '2' - Divergence (occurs when the Risk Score detects a divergence for this face and verification is still in progress); '3' - Completed; '4' - Canceled (e.g., timeout); '5' - Error.
3Information about identity verification.
Identity verification result. Possible values: 'yes' - It is the CPF holder's face; 'no' - It is not the CPF holder's face; 'inconclusive' - Unable to confirm with precision if it is the CPF holder's face.
"inconclusive"Liveness result. Possible values: '1' - Liveness approved; '2' - Liveness rejected.
1Risk score result.
50Endpoint to create a new Document process via Client.
Valid access token.
Valid APIKEY with the capabilitie Document Capture and Reuse enabled.
User information.
User's CPF. Must contain 11 characters and be sent without dots or dashes.
"12345678909"User's name.
"Luke Skywalker"User's email.
"luke@unico.io"User's phone number. It must contain 13 characters and be sent without dots or dashes, in the standard DDI + DDD + Telephone number.
"551972557070"Information about the document to be captured.
Indicates the purpose of the document sharing. Possible values: 'creditprocess'; 'carpurchase'; 'paybypaycheck'; 'onboarding'; 'fgts'.
ID of the biometric process that must have been previously performed through the Identity Verification capability. The ID must belong to a process completed with a valid biometric, used within 24 hours after the process is finished, and cannot be reused.
"80371b2a-3ac7-432e-866d-57fe37896ac6"The identifier of the document to be reused. You will find it when using the endpoint to query documents for reuse. If no document is found for reuse, the document must be captured and sent as base64 in the document.files parameter.
"80371b2a-3ac7-432e-866d-57fe37896ac6"Base64-encoded user document in case no document is found for reuse in the endpoint to query reusable documents. The array can contain 1 file (e.g., entire driver's license) or 2 files (e.g., front and back of the driver's license).
Base64-encoded document image.
"/9j/4AAQSkZJR..."Document process successfully created.
Process ID.
"80371b2a-3ac7-432e-866d-57fe37896ac6"Process status. Possible values: '1': Processing; '3' - Completed; '4' - Canceled (e.g., timeout); '5' - Error.
1Document information.
ID of the created document.
"80371b2a-3ac7-432e-866d-57fe37896ac6"Endpoint to get the result of a Document Capture and Reuse process via by Client.
Process ID.
Valid access token.
Valid APIKEY with the capabilitie Document Capture and Reuse enabled.
Process information successfully retrieved.
Process ID.
"2b034568-dfaf-463f-94fb-18ed93c312e8"Process status. Possible values: '1' - In processing; '3' - Completed; '4' - Canceled (e.g., timeout); '5' - Error.
3Document information.
Document ID.
"b97c3fd9-d95d-413f-bc0a-75eb87304421"Document type.
"Driver's License"Indicates if the CPF on the document matches the CPF provided during process creation.
falseObject containing the fields extracted from the document after the OCR extraction process.
Document number.
"044589731564"RG number.
"123456789 SESP PR"Full name of the holder.
"Homer Simpson"Holder's parents' names.
Holder's date of birth.
"1990-05-12T00:00:00Z"Holder's license issuance date.
"1997-11-18T00:00:00Z"Document expiration date.
"2017-12-07T00:00:00Z"Document issuance date.
"2012-12-07T00:00:00Z"Document issuance location.
"Curitiba PR"Document category.
"B"RENACH number.
"PR904987581"URLs of the document files.
Endpoint to create a new process for Liveness + Identity Verification + Risk Score by Client.
Valid access token.
Valid APIKEY with the capabilities Liveness + Identity Verification + Risk Score enabled.
User information.
User's CPF. Must contain 11 characters and be sent without dots or dashes.
"12345678909"User's name.
"Luke Skywalker"User's email.
"luke@unico.io"User's phone number. It must contain 13 characters and be sent without dots or dashes, in the standard DDI + DDD + Telephone number.
"551972557070"Use case of the operation.
"Onboarding"The ID of the branch where the process will be created. If there is only one branch associated with the service account, this parameter is not required. If there is a separation of processes by branch, you will receive the branch IDs from the Unico team.
"60837cd3-ed3c-4038-ad7c-0a85ad64b03a"Encrypted file generated by the SDK or base64 (if not using Liveness).
"/9j/4AAQSkZJR..."Process created successfully (INCONCLUSIVE for Identity Verification and forwarded to Risk Score).
Process ID.
"80371b2a-3ac7-432e-866d-57fe37896ac6"Process status. Possible values: '1' - In processing (occurs when forwarded to Risk Score); '3' - Completed; '4' - Canceled (e.g., timeout); '5' - Error.
1Information about the identity verification.
Result of the identity verification. Possible values: 'yes' - It is the CPF owner's face; 'no' - It is not the CPF owner's face; 'inconclusive' - We cannot accurately confirm if this is the CPF owner's face.
"inconclusive"Result of Liveness. Possible values: '1' - Liveness approved; '2' - Liveness rejected.
1Endpoint to create a new Liveness + Identity Verification process via by Client.
Valid access token.
Valid APIKEY with Liveness + Identity Verification capabilities enabled.
User information.
User's CPF. Must contain 11 characters and be sent without dots or dashes.
"12345678909"User's name.
"Luke Skywalker"User's email.
"luke@unico.io"User's phone number. It must contain 13 characters and be sent without dots or dashes, in the standard DDI + DDD + Telephone number.
"551972557070"Operation use case.
"Onboarding"The ID of the branch where the process will be created. If there is only one branch associated with the service account, this parameter is not required. If there is a separation of processes by branch, you will receive the branch IDs from the Unico team.
"60837cd3-ed3c-4038-ad7c-0a85ad64b03a"Encrypted file generated by the SDK or base64 (if not using Liveness).
"/9j/4AAQSkZJR..."Process successfully created (Identity Verification INCONCLUSIVE).
Process ID.
"80371b2a-3ac7-432e-866d-57fe37896ac6"Process status. Possible values: '3' - Completed; '4' - Canceled (e.g., timeout); '5' - Error.
3Identity verification information.
Identity verification result. Possible values: 'yes' - Matches the CPF holder's face; 'no' - Does not match the CPF holder's face; 'inconclusive' - Unable to reliably determine if this is the CPF holder's face.
"inconclusive"Liveness result. Possible values: '1' - Liveness approved; '2' - Liveness denied.
1Endpoint to create a new process for Liveness + Identity Verification + Behavior Alert in by Client.
Valid access token.
Valid APIKEY with Liveness + Identity Verification + Behavior Alert capabilities enabled.
User information.
User's CPF. Must contain 11 characters and be sent without dots or dashes.
"12345678909"User's name.
"Luke Skywalker"User's email.
"luke@unico.io"User's phone number. Must contain 13 characters and be sent without dots or dashes, in the format DDI + DDD + Phone Number.
"551972557070"Use case for the operation.
"Onboarding"The ID of the branch where the process will be created. If there is only one branch associated with the service account, this parameter is not required. If there is a separation of processes by branch, you will receive the branch IDs from the Unico team.
"60837cd3-ed3c-4038-ad7c-0a85ad64b03a"Encrypted file generated by the SDK or Base64 (if not using Liveness).
"/9j/4AAQSkZJR..."Process successfully created.
Process ID.
"80371b2a-3ac7-432e-866d-57fe37896ac6"Process status. Possible values: '1' - In processing; '4' - Canceled (e.g., timeout); '5' - Error.
1Information about identity verification.
Identity verification result. Possible values: 'yes' - CPF holder's face; 'no' - Not the CPF holder's face; 'inconclusive' - Unable to confirm if it is the CPF holder's face.
"inconclusive"Liveness result. Possible values: '1' - Liveness approved; '2' - Liveness rejected.
1Endpoint to get the result of a process for Liveness + Identity Verification + Behavior Alert in by Client.
Process ID.
Valid access token.
Valid APIKEY with Liveness + Identity Verification + Behavior Alert capabilities enabled.
Process information successfully retrieved.
Process ID.
"2b034568-dfaf-463f-94fb-18ed93c312e8"Process status. Possible values: '1' - In processing; '3' - Completed; '4' - Canceled (e.g., timeout); '5' - Error.
3Information about identity verification.
Identity verification result. Possible values: 'yes' - CPF holder's face; 'no' - Not the CPF holder's face; 'inconclusive' - Unable to confirm if it is the CPF holder's face.
"inconclusive"Liveness result. Possible values: '1' - Liveness approved; '2' - Liveness rejected.
1Information about Behavior Alert.
Behavior Alert result. Possible values: 'yes' - The face has been involved in a fraudulent identity transaction; 'inconclusive' - No indication that the face has been involved in a fraudulent identity transaction.
"inconclusive"Endpoint to create a new process for Liveness + Identity Verification + Behavior Alert + Risk Score in the by Client.
Valid access token.
Valid APIKEY with the capabilities Liveness + Identity Verification + Behavior Alert + Risk Score enabled.
User information.
User's CPF. Must contain 11 characters and be sent without dots or dashes.
"12345678909"User's name.
"Luke Skywalker"User's email.
"luke@unico.io"User's phone number. Must contain 13 characters and be sent without dots or dashes, in the format DDI + DDD + phone number.
"551972557070"Use case of the operation.
"Onboarding"The ID of the branch where the process will be created. If there is only one branch associated with the service account, this parameter is not required. If there is a separation of processes by branch, you will receive the branch IDs from the Unico team.
"60837cd3-ed3c-4038-ad7c-0a85ad64b03a"Encrypted file generated by the SDK or Base64 (if not using liveness).
"/9j/4AAQSkZJR..."Process successfully created.
Process ID.
"80371b2a-3ac7-432e-866d-57fe37896ac6"Process status. Possible values: '1' - Processing; '4' - Canceled (e.g., timeout); '5' - Error.
1Information about identity verification.
Identity verification result. Possible values: 'yes' - Matches the CPF holder's face; 'no' - Does not match the CPF holder's face; 'inconclusive' - Unable to ensure if this is the CPF holder's face.
"inconclusive"Liveness result. Possible values: '1' - Liveness approved; '2' - Liveness denied.
1Endpoint to get the result of a Liveness + Identity Verification + Behavior Alert + Risk Score process by Client.
Process ID.
Valid access token.
Valid APIKEY with the capabilities Liveness + Identity Verification + Behavior Alert + Risk Score enabled.
Process information successfully retrieved.
Process ID.
"2b034568-dfaf-463f-94fb-18ed93c312e8"Process status. Possible values: '1' - In progress; '2' - Divergence (occurs when the risk score identifies a divergence for this face and is yet to conclude verification); '3' - Completed; '4' - Canceled (e.g., timeout); '5' - Error.
3Identity verification details.
Identity verification result. Possible values: 'yes' - It is the face of the CPF holder; 'no' - It is not the face of the CPF holder; 'inconclusive' - Unable to guarantee with certainty if it is the face of the CPF holder.
"inconclusive"Liveness result. Possible values: '1' - Liveness approved; '2' - Liveness rejected.
1Behavior Alert details.
Behavior Alert result. Possible values: 'yes' - The face has been involved in fraudulent identity transactions; 'inconclusive' - No evidence that the face has been involved in fraudulent identity transactions.
"inconclusive"Risk score result.
50Endpoint to create a new process for Liveness + 1:1 Validation by Client.
Valid access token.
Valid APIKEY with the capabilities Liveness + 1:1 Validation enabled.
User information.
User's CPF. Must contain 11 characters and be sent without dots or dashes.
"12345678909"Identifier of the process generated during the biometric transaction creation, whose photo will be used for comparison.
"80371b2a-3ac7-432e-866d-57fe37896ac6"The ID of the branch where the process will be created. If there is only one branch associated with the service account, this parameter is not required. If there is a separation of processes by branch, you will receive the branch IDs from the Unico team.
"60837cd3-ed3c-4038-ad7c-0a85ad64b03a"Encrypted file generated by the SDK or base64 (if not using Liveness).
"/9j/4AAQSkZJR..."Process created successfully (User authenticated).
Process ID.
"80371b2a-3ac7-432e-866d-57fe37896ac6"Authentication result. Possible values: 'true' - Success. The face in the transaction matches the reference process; 'false' - Failure. The face in the transaction does not match the reference process.
trueLiveness result. Possible values: '1' - Liveness approved; '2' - Liveness rejected.
1