Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
In this section, you will find all available REST APIs for using the by Unico integration method
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:
These evidences can be used to ensure the authenticity of the process.
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 examples of CreateProcess requests in Unico
For detailed verification of the API parameters, please refer to the Parameters Specification section.
To use Postman, follow these steps:
Select the POST method.
Enter the URL https://api.cadastro.uat.unico.app/client/v1/process/
.
Select the Authorization tab.
From the Type dropdown list, choose Bearer Token.
Enter the obtained token in the Token field with the prefix Bearer.
Select the Body tab and enter the data below according to your requirements.
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 all possible response scenarios for completed processes in by Unico
The response examples above consider only processes with state = PROCESS_STATE_FINISHED
and result = PROCESS_RESULT_OK
. To see responses that do not consider only these conditions, refer to the Response Scenarios section
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.
In this section, you will find how to create a process in Unico via the REST API
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.
Production: https://api.cadastro.unico.app/client/v1/process.
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.
In this section, you will find how to obtain the result of a process in by Unico through the REST API
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.
Production: https://api.cadastro.unico.app/client/v1/process.
To implement your business rules, always validate the response from the capabilities by checking the parameters in the following order:
state = PROCESS_STATE_FINISHED
AND result = PROCESS_RESULT_OK
;
THEN, you can proceed with decision-making by analyzing the authenticationInfo
parameter.
If you receive state = PROCESS_STATE_FINISHED
with results result = PROCESS_RESULT_INVALID_IDENTITY
or PROCESS_RESULT_ERROR
, interpret this as an error in the biometric process and attempt the process again.
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.
In this section, you will find instructions on how to obtain the selfie from a process in by Unico via the REST API
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.
Production: https://api.cadastro.unico.app/client/v1/process.
The parameter [?raw=true]
is optional. If your service account has the necessary permission, you can use it to obtain the selfie without the watermark.
For detailed verification of the API parameters, please refer to the Parameters Specification section.
The user’s selfie is only available for consultation via REST API for 8 hours after the biometric process is completed. 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.
In this section, you will find instructions on how to obtain the evidential set from a process in by Unico via the REST API
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.
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.
In this section, you will find how to obtain the signed document of a process in by Unico through the REST API
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.
For detailed verification of the API parameters, please refer to the Parameters Specification section.
In this section, you will find how to obtain the signed document of a process in by Unico through the REST API
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.
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 .
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 retrieve the evidence set from the identity verification process by Unico.
Process ID.
Evidence set obtained successfully.
Evidence content encoded in base64.
"JVBERi0xLjUNCiWDk[...]NCg=="
Type of the evidence content (PDF).
"x-pdf"
Endpoint to retrieve the selfie from the Unico process. The optional raw=true
parameter can be used to obtain the raw file.
Process ID.
Optional flag to return the raw selfie file.
true
Selfie obtained successfully.
Content of the selfie encoded in base64.
"/9j/4AAQSkZJRgABAQA[...]QkeQUjE"
Type of the image content (jpeg or png).
"image/jpeg"
Endpoint to retrieve the signed document in PDF format. Only for flows with electronic signature.
Document ID.
Signed document obtained successfully.
PDF file generated by the system.
Endpoint to create a new identity verification process in by Unico.
Defines where the user will be redirected at the end of the process. Possible values are: an HTTPS URL for web page redirection, a URL schema for redirection in native mobile applications, or no redirection (include only '/').
"/"
Flow type. Possible flows: 'idlive', 'idcheck', 'iddocs', 'idsign', 'iddocssign', 'idcheckserpro', 'idtoken'. See flow details in the 'Overview' section of this documentation.
"iddocssign"
The ID of the branch where the process will be created. If there is only one branch associated with the service account, this parameter does not need to be included.
"60837cd3-ed3c-4038-ad7c-0a85ad64b03a"
Biometric token identification. Required for the 'idtoken' flow, and an ID from a completed process of any other identity verification flow must be used.
"60837cd3-ed3c-4038-ad7c-0a85ad64b03a"
Type of identification document. Use "DUI_TYPE_BR_CPF" for CPF as the identifier.
"DUI_TYPE_BR_CPF"
Identification document value (e.g., CPF number).
"12345678909"
Person's name.
"Luke Skywalker"
Person's phone number. This is required if sending a notification via SMS or WhatsApp.
"5511912345678"
Person's email. This is required if sending a notification via Email.
"teste@teste.com"
Notification channel. Possible values are - NOTIFICATION_CHANNEL_WHATSAPP, NOTIFICATION_CHANNEL_SMS, and NOTIFICATION_CHANNEL_EMAIL (notifications can also be sent to more than one place by specifying more than one.)
"NOTIFICATION_CHANNEL_WHATSAPP"
Process purpose. Possible values are: 'creditprocess', 'biometryonboarding', or 'carpurchase'.
"creditprocess"
This is the process expiration time in seconds. If this information is not provided, the default value of 7 days will be used.
"3600s"
Document name. This is required if using any flow with electronic signature.
"teste"
Document to be signed in base64. This is required if using any flow with electronic signature.
"JVBERi0xLjMNCiXi48/[...]DQoNCnN0YXJ0eHJlZg0KMjcxNA0KJSVFT0YNCg=="
Process successfully created.
Process ID.
"53060f52-f146-4c12-a234-5bb5031f6f5b"
The ID of the branch where the process was created. If no value for companyBranchId was provided, this parameter will not be returned in the response.
"60837cd3-ed3c-4038-ad7c-0a85ad64b03a"
Selected flow.
"iddocssign"
Callback URI.
"/path/to/callback-url/"
URL where the user will complete the process.
"https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b"
Process state.
"PROCESS_STATE_CREATED"
Type of identification document.
"DUI_TYPE_BR_CPF"
Identification document value.
"73689290074"
Person's name.
"Luke Skywalker"
Person's phone number.
"5511912345678"
Person's email.
"teste@teste.com"
Notification channel.
"NOTIFICATION_CHANNEL_WHATSAPP"
Process purpose.
"creditprocess"
Authentication information. It will always be empty when creating the process.
Process capacities.
Process expiration date.
"2023-10-09T15:15:25.417105Z"
Signed token that contains the parameters necessary to initialize the by Unico web SDK, allowing integration via iFrame.
"eyJhbGciOiJSUzI1[...]d_jhQ"
Endpoint to retrieve the evidential set of the signature. Only for flows with electronic signature.
Document ID.
Evidential set obtained successfully.
PDF file generated by the system.