Loading...
Loading...
In this section, you will find all available REST APIs for using the by Unico integration method
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
In this section, you will find the components that can be used with by Unico
Loading...
Loading...
Loading...
Loading...
Loading...
In this section, you will find additional resources related to the by Unico integration method
Loading...
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 all technical specifications for the Unico IDCloud platform's REST APIs, using the by Unico integration method.
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.
For detailed verification of the API parameters, please refer to the Parameters Specification section.
Nesta seção, você encontrará todas as especificações técnicas das APIs REST do by Unico
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.
| Flow | Capacidades |
|---|
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).
To optimize your integration, you can use a Webhook to be notified when your process result is complete.
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 .
| Android SDK | iOS SDK |
|---|
| Native browsers | Mobile browsers | Computer/notebook browsers |
|---|
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 .
idlive | Liveness |
id | Liveness + Identity Verification |
idcheck | Liveness + Identity Verification + Risk Scoringco |
iddocs | Liveness + Identity Verification + Risk Scoring +Document Capture and Reuse |
idsign | Liveness + Identity Verification + Risk Scoring + Electronic Signature |
iddocssign | Liveness + Identity Verification + Risk Scoring + Document Capture and Reuse +Electronic Signatureca |
idcheckserpro | Liveness + Identity Verification + Risk Scoring + Serpro similarity return |
idtoken | Liveness + Validation (1:1) |
Compatible with all devices with front camera, Android 8+, armv7 or arm64. | Compatible with all iOS devices version 11 or higher. |
|
|
|
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 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 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.
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.
In this section, you will find information on how to redirect a user in your applications within the by Unico experience
he userRedirectUrl field is used to direct the user. This field is received in the success response of the process creation when making the CreateProcess request.
Here you will find three ways to manage the user experience in web applications:
It is recommended to follow these steps:
In your common flow (which includes the by Unico Registration), you will redirect the client to the link generated through the API;
After that, the client within the platform carries out the necessary procedures to continue the flow;
When completed, they are redirected to your page (using the redirectUrl provided during the process creation).
window.open():The window.open() option consists of opening a new tab in the user's browser so that they can complete the process. At the end, this tab is closed and redirected to your application.
For this, it is recommended to:
ollow the public documentation on this, which can be found ;
Monitorar se houve alteração de URL (para a redirectUrl) e então fechar a aba utilizando window.close().
1 - Add the necessary dependency for using CustomTabs in your app/build.gradle:
Add the necessary permissions and intents in the AndroidManifest.xml for the Activity that you want to receive the callback_uri.
It is necessary to include the attribute android:launchMode="singleTop" as well as the <data> tag providing the URI data.
The following permissions are necessary for it to function correctly:
Camera
Geolocation
o retrieve redirect information with the provided data, you can use the following code in the onNewIntent method of your Activity:
1 - O primeiro passo é criar o controlador de autenticação, e, para isso crie uma classe chamada UnicoAuthenticationController (ou como preferir chamar).
2 - Na sequência, importe o framework AuthenticationServices no topo da classe.
3 - Declare a classe como NSObject e implemente o protocolo ASWebAuthenticationPresentationContextProviding.
O resultado deve ser:
1 - Abra o arquivo onde você executa a autenticação e adicione as importações necessárias (como exemplo, o ContentView.swift é usado).
2 - Para controlar o estado do fluxo é preciso criar a propriedade @State.
3 - Crie uma instância da classe UnicoAuthenticationController fora do corpo da estrutura ContentView.
4 - Para a validação do processo, crie uma função chamada redirectUser.
Ambientes:
Lembre-se de alterar a url URL_AUTHENTICATION para a URL de autenticação recebida em seu processo e também o callbackURLScheme BUNDLE para o redirect informado na criação do processo (o uso do Bundle Identifier de seu aplicativo é recomendado).
Autenticação única:
É importante setar prefersEphemeralWebBrowserSession para true para garantir uma autenticação única por processo.
Our support is limited to applications developed directly on the native Android and iOS platforms, using their respective native modules. At this time, we do not offer support for applications developed in hybrid frameworks, such as React Native, Ionic, or other cross-platform development technologies.
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.
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.
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 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.
In this section, you will find information on how to implement the opening of by Unico through an iFrame in web journeys
The iFrame is widely used in web scenarios. To use by Unico through an iFrame, the first step is to register the domains that will be used as hosts to display the user journey iFrame in by Unico.
Please inform the person responsible for your integration project or the Unico support team to carry out this configuration.
To start using the iFrame, we must begin with the installation of the Unico web SDK. by Unico uses the same SDK that is used for IDPay:
This method initializes the SDK by preloading assets, creating a smoother experience for the end user. At this point, it is necessary to send the token received as a result of the CreateProcess.
Parameters:
options - an object with the following configuration properties:
type
The type of flow to be initialized. In by Unico, we use the "IFRAME" option.
token
Receives the token of the created process. This token is important to authenticate the journey and ensure that only authorized domains can use it (can be obtained when creating the process via API).
This method opens the by Unico experience. For the IFRAME flow, this function displays the already preloaded iFrame and initiates the messaging flow between the client page and the by Unico experience.
Parameters:
options - an object with configuration properties:
processId
Receives the ID of the created process. This ID is important to obtain the process details and carry out the entire flow correctly (can be obtained when creating the process via API).
token
Receives the token of the created process. This token is important to authenticate the journey and ensure that only authorized domains can use it (can be obtained when creating the process via API).
onFinish(process)
Receives a callback function that will be executed at the end of the by Unico journey, passing the process object with the following data: { captureConcluded, concluded, id }.
The sequence diagram below demonstrates how to use the SDK and the API result from by Unico to configure the iFrame:
After careful analysis of our needs and challenges, we have decided to adopt a solution based on iframes with authentication tokens rather than implementing a Content Security Policy (CSP). This choice was motivated by various considerations related to the security and flexibility required to meet our clients' demands.
Content Security Policy (CSP) is a powerful tool for protecting web applications against various types of attacks, such as Cross-Site Scripting (XSS) and code injection. However, when configuring a CSP policy, it is necessary to define a strict list of trusted domains. This approach is effective when the domains are fixed and predictable. However, for our clients, who often use dynamic and variable domains, this rigid configuration presents significant challenges.
Dynamic domains pose a substantial security risk when using CSP. When a client has domains that frequently change or are created dynamically, it would be necessary to constantly update the CSP policy to include these new domains. This not only increases maintenance efforts but also exposes the domains to which the CSP policy applies. Each domain added to the CSP policy is potentially a vulnerability point if not adequately managed.
To mitigate these risks and meet the flexibility required by our clients, we opted to use iframes combined with authentication tokens. This solution provides an additional layer of security and avoids the need to expose or manage an extensive and dynamic list of domains.
Secure Authentication: Each iframe is loaded with a unique authentication token for each transaction, ensuring that only authorized users can access the content. This token is verified in real-time, providing an additional layer of security and control.
Content Isolation: The use of iframes allows for the isolation of content in a separate context, reducing the risk of interference between different origins and mitigating potential attacks.
Flexibility for Dynamic Domains: By not relying on a static CSP policy, our solution easily adapts to our clients' dynamic domains without the need for constant updates to security policies.
In this section, you will find all the customizations available in by Unico
By Unico provides some customizations in its interface, adapting to customer preferences to deliver a personalized and meaningful experience.
It is possible to customize the logo displayed to the end user, as shown in the image below:
To request the inclusion of this logo, it is necessary to send the Unico team a URL of the logo, ensuring that it is hosted in an online directory (meaning this logo must be accessible via a URL in the browser).
It is not possible to register a URL that is in base64 format (usually, these URLs start with "data:image/jpeg;base64,/9j/4AAQ...").
During the implementation process, it is possible to request the configuration of the button color and shape in the By Unico interface according to the company's visual identity, as shown in the images below:
To configure this, simply send the following information to the Unico team:
Hexadecimal code of the background color on the button.
Ex: #000000.
Hexadecimal code of the text color on the button.
Ex: #ffffff.
Corner rounding of the button in pixels.
Ex: 10px.
It is possible to customize the contextualization screen presented to the end user at the beginning of the journey, as shown in the image below:
To customize the information on the contextualization screen, you should modify the values of the parameters contained in the contextualization object at the time of making the CreateProcess call. The section in the request that should be altered is as follows:
To understand in detail what each parameter means, be sure to consult the corresponding section here.
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 .
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 .
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 .
Ex: .
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 .
In this section, you will find the Postman collection with the REST APIs of by Unico
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 response scenarios for by Unico, regardless of whether the processes are completed or not
It occurs when the process has been created but has not yet been completed by the user.
| state | result |
|---|---|
It occurs when the process has been created, but there was an error in the service.
It occurs when the process was created, finalized by the user, and received a POSITIVE response from IDUnico.
It occurs when the process was created, finalized by the user, but received an INCONCLUSIVE response from IDUnico.
It occurs when the process was created, completed by the user, but received a failure response for the Liveness.
It occurs when the process has been created but has not yet been completed by the user.
It occurs when the process has been created, but there was an error in the service.
It occurs when the process was created, finalized by the user, and received a POSITIVE response from IDUnico.
It occurs when the process was created, completed by the user, received an inconclusive response from IDUnico, but still returned a score from IDCheck.
GetProcess
It occurs when the process was created, completed by the user, received an inconclusive response from IDUnico, and generated a divergence in IDCheck, which took longer than 60 seconds to be resolved by the divergence engines.
It occurs when the process was created, completed by the user, but received a failure response for the Liveness.
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 the specification of all the parameters for the REST API of the by Unico integration
| Name | Type | Mandatory/ Optional | Description |
|---|---|---|---|
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.
| state | result |
|---|---|
| state | result |
|---|---|
| state | result |
|---|---|
| state | result |
|---|---|
| state | result |
|---|---|
| state | result |
|---|---|
| state | result |
|---|---|
| state | result |
|---|---|
| state | result |
|---|---|
| state | result |
|---|---|
| Name | Type | Description |
|---|---|---|
| Nome | Tipo | Descrição |
|---|---|---|
| Nome | Tipo | Descrição |
|---|---|---|
PROCESS_STATE_CREATED
PROCESS_RESULT_UNSPECIFIED
PROCESS_STATE_FAILED
PROCESS_RESULT_ERROR
PROCESS_STATE_FINISHED
PROCESS_RESULT_OK
PROCESS_STATE_FINISHED
PROCESS_RESULT_OK
PROCESS_STATE_FINISHED
PROCESS_RESULT_INVALID_IDENTITY
PROCESS_STATE_CREATED
PROCESS_RESULT_UNSPECIFIED
PROCESS_STATE_FAILED
PROCESS_RESULT_ERROR
PROCESS_STATE_FINISHED
PROCESS_RESULT_OK
PROCESS_STATE_FINISHED
PROCESS_RESULT_OK
PROCESS_STATE_FINISHED
PROCESS_RESULT_INVALID_IDENTITY
PROCESS_STATE_FINISHED
PROCESS_RESULT_INVALID_IDENTITY
flow
string
Mandatory
Define the journey to be executed.
idlive: Flow with liveness, without identity validation.
id: Identity validation flow with facial biometrics.
idcheck: Identity validation flow with facial biometrics and scoring in case of inconclusive results.
iddocs: Identity validation flow with document capture and reuse (RG or CNH).
idsign: Identity validation flow with electronic signature.
iddocssign: Identity validation flow, document capture/reuse (RG or CNH), and electronic signature.
idcheckserpro: SERPRO consultation flow and identity validation with facial biometrics and scoring in case of inconclusive results.
idtoken: Flow to verify the authenticity of facial biometrics in relation to a previously conducted process.
callbackUri
string
Mandatory
Define where the user will be redirected at the end of the process.
URL: You can use a URL to a web page in your flow. Example: https://developers.unico.io/callback. You can customize it as desired.
URL Scheme: You can also redirect to native mobile applications. Example: br.com.myapp.app://callback. This callback must be registered in your mobile application.
No Redirection: If you are using the solution in a messaging flow, use the value / to avoid redirection at the end of the flow.
To learn more about how to redirect the user, see the section "Redirecting the User" here.
person.personDuiType
string
Mandatory
Define the type of user identifier.
DUI_TYPE_BR_CPF: To use CPF (Cadastro de Pessoas Físicas) as the identifier.
person.personDuiValue
string
Mandatory
Define the value of the user identifier specified in the personDuiType field.
Example: In the case of using the identifier DUI_TYPE_BR_CPF, provide a valid CPF without formatting: 73689290074.
Note: This is mandatory for SMS and WhatsApp flows.
person.friendlyName
string
Optional
DDefine the name of the user. Ex.: Luke Skywalker.
person.phone
string
Optional(*)
Define the user's phone number. Ex.: 5511900000000
person.email
string
Optional(*)
Define the user's email address.
notifications.notificationChannel
string
Optional
notifications: This is an array that defines the channels for sending notifications. This field should be filled with the desired notification types: SMS, WhatsApp, or both channels.
If you are only sending a URL, do not include the notifications field.
Make sure to choose the appropriate channels based on user preferences and the requirements of your integration process.
purpose
string
Mandatory
Define the purpose of use and data collection for the user. This is aimed at providing transparency and ensuring the proper handling of data according to LGPD (General Data Protection Law).
creditprocess: If you are using the solution to offer credit to the user.
biometryonboarding: If you are using the solution for user onboarding.
carpurchase: If you are using the solution related to the purchase of a vehicle.
Ensure that the purpose is clearly stated and relevant to the user’s interaction with your service.
This information should be included in the data processing agreement to comply with LGPD regulations.
bioTokenId
string
Optional(**)
Define the ID of the transaction you want to compare with the validation of the idtoken flow.
The value of this field can be the value of the id field or the authenticationInfo.authenticationId from the process returned when performing the GetProcess of an idcheck process.
payload
array
Mandatory
The payload field is an array that provides a location for inserting files necessary for specific flows, such as idsign.
Within the payload array, another array can be used to create signature flow envelopes.
The documents field is an array that receives the documents that make up each envelope, which can be one or more.
Each document object has:
documentName: Name of the document.
fileContents: Base64 of the PDF to be signed.
This field is mandatory when using the electronic signature capability.
expiresIn
string
Optional
This field defines the time in seconds for the expiration of the process, based on the created_at date. For example, for the expiration to occur in 7 days, it is necessary to specify as "expires_in": "10080s". If no value is provided, the default value set for the client will be used; if this value does not exist, the default value of 7 days will be applied.
contextualization.price
float
Optional
This field defines the value that will be displayed in the process contextualization.
contextualization.currency
string
Optional(***)
Esse campo define a moeda que será uThis field defines the currency that will be used for formatting the price field.
contextualization.locale.ptBr.Reason
string
Optional
This field defines the information that will be displayed in the Reason field of the process when the pt-br language is selected.
contextualization.locale.enUs.Reason
string
Optional
This field defines the information that will be displayed in the Reason field of the process when the en-us language is selected.
contextualization.locale.esMx.Reason
string
Optional
This field defines the information that will be displayed in the Reason field of the process when the es-mx language is selected.
id
string
The identifier of the process.
flow
string
Indicates the journey that was created.
idlive: Flow with liveness, without identity validation.
id: Identity validation flow with facial biometrics.
idcheck: Identity validation flow with facial biometrics and a score in case of inconclusive results.
iddocs: Identity validation flow with document capture and reuse (RG or CNH).
idsign: Identity validation flow with electronic signature.
iddocssign: Identity validation flow, document capture/reuse (RG or CNH), and electronic signature.
idcheckserpro: Consultation flow in SERPRO and identity validation with facial biometrics and a score in case of inconclusive results.
idtoken: Flow to verify the authenticity of a facial biometrics in relation to a previously completed process.
callbackUri
string
Indicates where the user will be redirected at the end of the process.
userRedirectUrl
string
Indicates the URL to which you should redirect the user to complete the journey.
state
string
Indicates the current state of the process, which can be of the type:
PROCESS_STATE_CREATED: Process created and not yet completed by the user.
PROCESS_STATE_FINISHED: Process successfully completed by the user.
PROCESS_STATE_FAILED: Process encountered an error.
result
string
IIndicates the result of the user's journey process, which can be of the type:
PROCESS_RESULT_OK: Process successfully completed.
PROCESS_RESULT_ERROR: Process completed with some type of error.
PROCESS_RESULT_INVALID_IDENTITY: Process completed with a failure in liveness, or inconclusive result when flow = ID, or when in flow = IDCheck, there was a divergence taking longer than the established time.
PROCESS_RESULT_UNSPECIFIED: Returned when the client uses IDUnico alone. Process completed with unspecified result.
createdAt
string
Indicates the moment when the process was created.
finishedAt
string
Indicates the moment when the process was completed.
person.personDuiType
string
Indicates the type of identifier for the user.
DUI_TYPE_BR_CPF: For CPF as the identifier.
person.personDuiValue
string
Indicates the value of the user identifier specified in the personDuiType field.
person.email
string
Indicates the email value of the user specified in the email field during the process creation.
person.phone
string
IndiIndicates the phone number value of the user specified in the phone field during the process creation.
person.friendlyName
string
IIndicates the name of the user, for example, Luke Skywalker.
notifications.notificationChanell
string
Indicates the channel used for sending notifications during the creation of the process.
purpose
string
Indicates the purpose of collecting the user's data at the time the process was created.
authenticationInfo.authenticationResult
string
It refers to the Identity Verification capability.
AUTHENTICATION_RESULT_UNSPECIFIED: This is returned when the client uses Identity Verification alone. Possible return situations include:
The user could not be found in the authenticated database.
There was no timely response from the orchestration with the risk score (by Unico waits up to 60 seconds for conflict resolutions).
AUTHENTICATION_RESULT_INCONCLUSIVE: Result of an inconclusive authentication.
AUTHENTICATION_RESULT_POSITIVE: Result of a positive authentication.
authenticationInfo.scoreEngineResult.scoreEnabled
string
Indicates whether the Risk Score capability is enabled in this journey.
authenticationInfo.scoreEngineResult.score
integer
Indicates the Risk Score for cases where the Identity Verification response was inconclusive.
authenticationInfo.authenticationId
string
Indicates the ID of the process that derived to the Risk Score. It can be used in the idtoken flow as a value for the bioTokenId parameter.
authenticationInfo.livenessResult
string
Indicates the result of the liveness check.
LIVENESS_RESULT_UNSPECIFIED: Unexpected return.
LIVENESS_RESULT_NOT_LIVE: The user did not pass the liveness check.
LIVENESS_RESULT_LIVE: The user's liveness check was verified.
serproResult.score
integer
Indicates the result of the similarity score from SERPRO. Currently available only for the idcheckserpro flow.
services.documents.reused_doc
boolean
Indicates whether there was (true) or not (false) reuse of the document. A document is reused when it already exists in Unico's database and the user has granted permission to reuse it without the need for a new capture.
services.documents.cpf_match
boolean
Indicates whether the CPF in the request is the same as the document's CPF. If yes, (true); if no, (false).
services.documents.typified
boolean
Indicates whether the document was classified (true) or not (false). A document is classified when its layout can be identified.
services.documents.doc_id
string
Unique identifier of the shared document.
services.documents.signed_url
string
Indicates the signed URL of the document.
services.documents.validate_doc
boolean
Indicates whether the document was validated (true) or not (false).
services.documents.face_match
boolean
Indicates whether the person in the request photo is the same as the one on the document. If yes (true), if no (false).
services.documents.doc.version
integer
Indicates the version of document.
services.documents.doc.data
object
When the document is typed, it will return the extracted data from the document:
RG: numero, orgaoEmissor, ufEmissor, cpfNumero, carteiraProfissionalNumero, certificadoMilitarNumero, cnsNumero, nisPisPasepNumero, ctpsNumero, ctpsSerie, ctpsUf, tituloEleitorNumero, nomeCivil, nomeSocial, filiacao, dataNascimento, naturalidade, dataEmissao.
CIN: rgNumero, cpfNumero, nomeCivil, nomeSocial, filiacao, dataNascimento, dataExpiracao, dataEmissao, orgaoEmissor, localEmissao, naturalidade, nacionalidade.
CNH: numero, rgNumero, cpfNumero, nomeCivil, filiacao, dataNascimento, dataHabilitacao, dataExpiracao, dataEmissao, localEmissao, categoria, renachNumero.
services.documents.doc.code
string
When typed, it will return RG, CIN, or CNH; if not, it will return "Unknown."
RG: Indicates that the shared document is of type RG.
CIN: Indicates that the shared document is of type CIN.
CNH: Indicates that the shared document is of type CNH.
A document is typed when it is possible to identify the layout of that document during the image capture.
services.consent_granted
boolean
Indicates whether there was (true) or was not (false) user consent.
services.envelope_id
string
Indicates the identifier of the electronic signature envelope.
services.document_ids
string
Indicates the identifier of the document that was signed during the journey.
capacities
string
Indicates which IDCloud capabilities were used in the respective process flow. It can have the following returns:
PROCESS_CAPACITY_IDLIVE;
PROCESS_CAPACITY_IDUNICO;
PROCESS_CAPACITY_IDCHECK;
PROCESS_CAPACITY_IDDOCS;
PROCESS_CAPACITY_IDSIGN;
PROCESS_CAPACITY_IDTOKEN;
PROCESS_CAPACITY_IDSERPRO.
expiresAt
string
Indicates the moment when the process will have expired or has expired. The value of this field is calculated from the expires_in field provided during the process creation, along with the creation date of the process, created_at.
fileContents
string
It is a Base64-encoded string that should be converted to an image file in your application.
contentType
string
Indicates that the content in fileContents is a jpeg or png image.
fileContents
string
It is a Base64-encoded string that should be converted to an image file in your application.
contentType
string
Indicates that the content in fileContents is a .pdf.
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.
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.
trueSelfie 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 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 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"
