Parameter Specification

In this section, you will find the specification of all the parameters for the by Client integration REST API

CreateProcess - Request Payload

Name Type Mandatory / Optional Description

Name	Type	Mandatory / Optional	Description
`subject.code`	string	Mandatory	Valid CPF of the user
`subject.name`	string	Mandatory	User's name.
`subject.email`	string	Optional	User's email.
`subject.phone`	string	Optional	User's phone number.Ex.: `5511900000000`
`useCase`	string	Optional	It is the use case for the biometric operation. E.g., "Account opening."
`imagebase64`	string	Mandatory	It is the user's selfie. The image must be in base64 (png, jpg, jpeg). If you use the Liveness Check with Unico's SDK, the file must be sent encrypted. The encrypted file must be sent within 10 minutes to avoid image expiration. This .jwt can only be used once.
`referenceProcessId`	string	Mandatory	Identificador do processo que foi Identifier of the process that was generated during the creation of the biometric transaction, whose photo will be used for comparison. This parameter is mandatory only when using the Validation (1:1) capability.

subject.code

string

Mandatory

Valid CPF of the user

subject.name

string

Mandatory

User's name.

subject.email

string

Optional

User's email.

subject.phone

string

Optional

User's phone number.Ex.: 5511900000000

useCase

string

Optional

It is the use case for the biometric operation. E.g., "Account opening."

imagebase64

string

Mandatory

It is the user's selfie. The image must be in base64 (png, jpg, jpeg). If you use the Liveness Check with Unico's SDK, the file must be sent encrypted. The encrypted file must be sent within 10 minutes to avoid image expiration. This .jwt can only be used once.

referenceProcessId

string

Mandatory

Identificador do processo que foi Identifier of the process that was generated during the creation of the biometric transaction, whose photo will be used for comparison. This parameter is mandatory only when using the Validation (1:1) capability.

{
  "subject": {
    "Code": "12345678909",
    "Name": "Luke Skywalker",
    "Email": "luke@gmail.com",
    "Phone": "5511999998888"
  },
  "useCase": "Abertura de conta",
  "imagebase64": "/9j/4AAQSkZJRg[...]p6qtRUZeUQf//Z"
}

GetProcess (Liveness + Identity verification and more) - Request response

Nome Tipo Descrição

Nome	Tipo	Descrição
`id`		The identifier of the process.
`status`	string	Indicates the status of the process. It can receive the values: 1: Indicates that the process is in progress. It may have one or more capabilities that have not yet been completed; 2: Indicates that the process is in divergence (only occurs when using the Risk Score capability); 3: Indicates that the process has been completed. All capabilities associated with the process have been completed; 4: Indicates that the process has been canceled. This occurs when the request is canceled by the client (e.g., timeout) before it is properly processed; 5: Indicates that there was an error in processing. It is recommended to make at least 3 new attempts, and if the error persists, refer to a contingency flow and contact us through support channels. For the correct development of your business rule, only validate the results of the IDCloud capabilities when the status = 3.
`unicoId.result`	string	Indicates the result of the Identity Verification capability. It can receive the values: yes: Indicates that the face is that of the real holder of the CPF. no: Indicates that the face is not that of the real holder. If this response is received, there will be no orchestration with the Risk Score capability, regardless of whether the API key is configured with both capabilities. inconclusive: Indicates that it was not possible to determine if the face is that of the real holder of the CPF. If there is orchestration with the Risk Score, we will return a probability score.
`liveness`	integer	Indica o resultado da capacidade Prova de viIndicates the result of the Liveness capability. It can receive the values: 1: Indicates that the user was alive at the time of capturing the selfie. 2: Indicates that the user was not alive at the time of capturing the selfie. If the solution is used without the Liveness capability, the return will always be 1.
`score`	integer	Indicates the result of the Risk Score capability. It can receive values between -90 and +95. The score will only return in the API response if the API key is properly configured with the capability and the response of the Identity Verification capability is affirmative.
`identityFraudsters.result`	string	Indicates the result of the Fraud Profile Detection capability. It can receive the values: yes: Indicates that the user has been involved in fraudulent identity transactions; inconclusive: Indicates that it was not possible to find fraudulent transactions associated with this user. If used together with the Risk Score, a "yes" response will prevent the registration from being passed to the score.
`authenticated`	boolean	It is the result of the authentication when using the Validation (1:1) capability. It can be true or false.
`government.serpro`	integer	Indicates the result of the similarity score from Serpro.
`processAdditionalInfo.transactionId`	string	Indicates the transaction ID of the created process. This ID is related to the user's selfie and is not the same as the process ID (first item related in this description).
`processAdditionalInfo.personName`	string	Indicates the name of the user of the created process
`processAdditionalInfo.personDocument`	string	Indicates the identification document of the user of the created process.
`processAdditionalInfo.personImage`	string	Indicates the image of the user of the created process.
`processAdditionalInfo.finishedAt`	string	Indicates the date and time of the completion of the created process.

id

The identifier of the process.

status

string

Indicates the status of the process. It can receive the values:

1: Indicates that the process is in progress. It may have one or more capabilities that have not yet been completed;
2: Indicates that the process is in divergence (only occurs when using the Risk Score capability);
3: Indicates that the process has been completed. All capabilities associated with the process have been completed;
4: Indicates that the process has been canceled. This occurs when the request is canceled by the client (e.g., timeout) before it is properly processed;
5: Indicates that there was an error in processing. It is recommended to make at least 3 new attempts, and if the error persists, refer to a contingency flow and contact us through support channels.

For the correct development of your business rule, only validate the results of the IDCloud capabilities when the status = 3.

unicoId.result

string

Indicates the result of the Identity Verification capability. It can receive the values:

yes: Indicates that the face is that of the real holder of the CPF.
no: Indicates that the face is not that of the real holder. If this response is received, there will be no orchestration with the Risk Score capability, regardless of whether the API key is configured with both capabilities.
inconclusive: Indicates that it was not possible to determine if the face is that of the real holder of the CPF. If there is orchestration with the Risk Score, we will return a probability score.

liveness

integer

Indica o resultado da capacidade Prova de viIndicates the result of the Liveness capability. It can receive the values:

1: Indicates that the user was alive at the time of capturing the selfie.
2: Indicates that the user was not alive at the time of capturing the selfie.

If the solution is used without the Liveness capability, the return will always be 1.

score

integer

Indicates the result of the Risk Score capability. It can receive values between -90 and +95. The score will only return in the API response if the API key is properly configured with the capability and the response of the Identity Verification capability is affirmative.

identityFraudsters.result

string

Indicates the result of the Fraud Profile Detection capability. It can receive the values:

yes: Indicates that the user has been involved in fraudulent identity transactions;
inconclusive: Indicates that it was not possible to find fraudulent transactions associated with this user.

If used together with the Risk Score, a "yes" response will prevent the registration from being passed to the score.

authenticated

boolean

It is the result of the authentication when using the Validation (1:1) capability. It can be true or false.

government.serpro

integer

Indicates the result of the similarity score from Serpro.

processAdditionalInfo.transactionId

string

Indicates the transaction ID of the created process. This ID is related to the user's selfie and is not the same as the process ID (first item related in this description).

processAdditionalInfo.personName

string

Indicates the name of the user of the created process

processAdditionalInfo.personDocument

string

Indicates the identification document of the user of the created process.

processAdditionalInfo.personImage

string

Indicates the image of the user of the created process.

processAdditionalInfo.finishedAt

string

Indicates the date and time of the completion of the created process.

{
  "id": "2b034568-dfaf-463f-94fb-18ed93c312e8",
  "status": 3,
  "unicoId": {
    "result": "inconclusive"
  },
  "liveness": 1,
  "identityFraudsters": {
    "result": "inconclusive"
  },
  "score": 50,
  "government"{
    "serpro": 50
  },
  "processAdditionalInfo": {
      "transactionId": "2ed76ac5-8fd7-4477-839d-92bedd7e9fd5",
      "personName": "Luke Skywalker",
      "personDocument": "12345678909",
      "personImage": "https://api.datafortress.private.unico[...]OXc93D",
      "finishedAt": "2024-10-04T18:53:17.028228"
  }
}

GetProcess (Document capture) - Request response

Nome Tipo Descrição

Nome	Tipo	Descrição
`id`	string	Indicates the ID of the process created with the photo submission.
`status`	integer	Indicates the status of the process. It can receive the values: 1: Indicates that the process is in processing; 3: Indicates that the process has been completed; 4: Indicates that the process has been canceled. This occurs when the request is canceled by the client (e.g., timeout) before it has been properly processed; 5: Indicates that there was an error in processing. It is recommended to make at least 3 new attempts, and if the error persists, redirect to a contingency flow and contact us through support channels. For the correct development of your business rule, only validate the results of the IDCloud capabilities when the status = 3.
`document.id`	string	Indicates the ID of the document created.
`document.type`	string	Indicates the type of document returned by the classification.
`document.cpfMatch`	string	Returns whether the provided CPF is equal to the one contained in the document. If the submitted CPF is invalid (e.g., 123.456.789-12), this field is automatically returned as false before the comparison.
`document.content`	list	List of information contained in the document. It will always be returned when the quality of the document allows for data extraction. The content returned in `document.content` will vary according to the `document.type` parameter. More details in the next table.
`document.fileUrls`	integer	Signed URLs of the files that make up the document. To access the document images, simply use these URLs, which have a 10-minute expiration time.

id

string

Indicates the ID of the process created with the photo submission.

status

integer

Indicates the status of the process. It can receive the values:

1: Indicates that the process is in processing;
3: Indicates that the process has been completed;
4: Indicates that the process has been canceled. This occurs when the request is canceled by the client (e.g., timeout) before it has been properly processed;
5: Indicates that there was an error in processing. It is recommended to make at least 3 new attempts, and if the error persists, redirect to a contingency flow and contact us through support channels.

For the correct development of your business rule, only validate the results of the IDCloud capabilities when the status = 3.

document.id

string

Indicates the ID of the document created.

document.type

string

Indicates the type of document returned by the classification.

document.cpfMatch

string

Returns whether the provided CPF is equal to the one contained in the document. If the submitted CPF is invalid (e.g., 123.456.789-12), this field is automatically returned as false before the comparison.

document.content

list

List of information contained in the document. It will always be returned when the quality of the document allows for data extraction. The content returned in document.content will vary according to the document.type parameter. More details in the next table.

document.fileUrls

integer

Signed URLs of the files that make up the document. To access the document images, simply use these URLs, which have a 10-minute expiration time.

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": 3,
  },
  "document": {
    "id": "b97c3fd9-d95d-413f-bc0a-75eb87304421",
    "type": "CNH",
    "cpfMatch": false,
    "content": {
      "numero": "044589731564",
      "rgNumero": "123456789 SESP PR",
      "nomeCivil": "Homer Simpson",
      "filiacao": [
        "Monasimpson",
        "Monasimpson"
      ],
      "dataNascimento": "1990-05-12T00:00:00Z",
      "dataHabilitacao": "1997-11-18T00:00:00Z",
      "dataExpiracao": "2017-12-07T00:00:00Z",
      "dataEmissao": "2012-12-07T00:00:00Z",
      "localEmissao": "Curitiba PR",
      "categoria": "B",
      "renachNumero": "PR904987581"
    },
    "fileUrls": [
            "https://url-signer-1",
            "https://url-signer-2"
        ]
  }
}

GetReusableDocuments - Request response

Nome Tipo Descrição

Nome	Tipo	Descrição
`items.documentType`	string	Type of document found.
`items.documentId`	string	ID of the document found. To reuse, this ID must be used in the Create Process request.

items.documentType

string

Type of document found.

items.documentId

string

ID of the document found. To reuse, this ID must be used in the Create Process request.

{
    "items": [{
        "documentType": "unico.moja.dictionary.br.rg.v2.Rg",
        "documentId": "2aaf6037-0153-415d-b9fe-cf7e8198408f"
    }]
}

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.

AnteriorResponse Scenarios PróximoAdditional Resources

Atualizado há 22 dias