1 de 15

API

Nesta seção, você encontrará tudo relacionado as APIs REST do meio de integração by Unico

API Reference

Nesta seção, você encontrará todas as APIs REST disponíveis para utilização do meio de integração by Unico

Criação do Processo

Nesta seção, você encontrará como criar um processo no by Unico através da API REST

Introdução

Nesta seção, você encontrará a documentação detalhada sobre o funcionamento do endpoint de Criação de Processos no by Unico. Perceba que, para utilizar as capacidades da plataforma IDCloud neste meio de integração, basta alterar o valor do parâmetro "flow" no momento de criar o processo e a Unico será a responsável por orquestrar todas as capacidades que deseja utilizar.

Entenda mais sobre a utilização das capacidades no by Unico na seção Visão Geral.

Antes de começar

Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.

Você pode ver mais sobre como gerar um access-token aqui.

Endpoints:

UAT: https://api.cadastro.uat.unico.app/client/v1/process;
Produção: https://api.cadastro.unico.app/client/v1/process.

Criação do Processo

Os processos devem ser criados exclusivamente em uma comunicação backend-to-backend, devido à nossa política de CORS, que impede a criação de processos em uma comunicação frontend-to-backend.

Dicas:

Para mais informações sobre os cenários que pode receber no response, consulte a seção Cenários de response;
Para mais informações sobre os erros possíveis para este endpoint, consulte a seção Erros.

Dúvidas?

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.

Criação de processos separados por flows

Nesta seção, você encontrará exemplos de requisições de Ciação de processos no by Unico

Requisições separadas por flows

Este payload é utilizado para criar processos com os seguintes flows:

idlive / id / idlivetrust / idtrust / idcheck / iddocs / idchecktrust / idchecktrustdocs / idcheckserpro.

{
  "callbackUri": "/path/to/url",
  "flow": "idlive", //este é um exemplo de flow
  "person": {
    "duiType": "DUI_TYPE_BR_CPF",
    "duiValue": "73689290074",
    "friendlyName": "Luke Skywalker",
    "phone": "5511974749090",
    "email": "luke@unico.io",
    "notifications":
    [
      {
        "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
      },
      {
        "notificationChannel": "NOTIFICATION_CHANNEL_SMS"
      },
      {
        "notificationChannel": "NOTIFICATION_CHANNEL_EMAIL"
      }
    ]
  },
  "purpose": "biometryonboarding",
  "expiresIn": "3600s"
}

Este payload é utilizado para criar processos com os seguintes flows:

idsign / iddocssign / idchecktrustsign / idchecktrustdocssign / creditoconsignado / idcheckserprodocssign.

{
  "callbackUri": "/path/to/url",
  "flow": "idsign", //este é um exemplo de flow
  "person": {
    "duiType": "DUI_TYPE_BR_CPF",
    "duiValue": "73689290074",
    "friendlyName": "Luke Skywalker",
    "phone": "5511974749090",
    "email": "luke@unico.io",
    "notifications": 
    [
      {
        "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
      },
      {
        "notificationChannel": "NOTIFICATION_CHANNEL_SMS"
      },
      {
        "notificationChannel": "NOTIFICATION_CHANNEL_EMAIL"
      }
    ]
  },
  "purpose": "biometryonboarding",
  "expiresIn": "3600s",
  "payload": [
    {
      "envelopePayload": {
        "documents": [
          {
            "documentName": "teste",
            "fileContents": "JVBERi0xLjMNCiXi48/[...]DKJSVFT0YNCg=="
          }
        ]
      }
    }
  ]
}

Este payload é utilizado para criar processos com os seguintes flows:

idtoken / idtokentrust.

{
  "callbackUri": "/path/to/url",
  "flow": "idtoken", //este é um exemplo de flow
  "bioTokenId": "339f9225-6f09-4303-9688-bf35944787e1",
  "person": {
    "duiType": "DUI_TYPE_BR_CPF",
    "duiValue": "73689290074"
    "friendlyName": "Luke Skywalker",
    "phone": "5511974749090",
    "email": "luke@unico.io",
    "notifications": 
    [
      {
        "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
      },
      {
        "notificationChannel": "NOTIFICATION_CHANNEL_SMS"
      },
      {
        "notificationChannel": "NOTIFICATION_CHANNEL_EMAIL"
      }
    ]
  },
  "purpose": "biometryonboarding",
  "expiresIn": "3600s"
}

Este payload é utilizado para criar processos com os seguintes flows:

idtokensign.

{
  "callbackUri": "/path/to/url",
  "flow": "idtoken", //este é um exemplo de flow
  "bioTokenId": "339f9225-6f09-4303-9688-bf35944787e1",
  "person": {
    "duiType": "DUI_TYPE_BR_CPF",
    "duiValue": "73689290074"
    "friendlyName": "Luke Skywalker",
    "phone": "5511974749090",
    "email": "luke@unico.io",
    "notifications": 
    [
      {
        "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
      },
      {
        "notificationChannel": "NOTIFICATION_CHANNEL_SMS"
      },
      {
        "notificationChannel": "NOTIFICATION_CHANNEL_EMAIL"
      }
    ]
  },
  "purpose": "biometryonboarding",
  "expiresIn": "3600s",
  "payload": [
    {
      "envelopePayload": {
        "documents": [
          {
            "documentName": "teste",
            "fileContents": "JVBERi0xLjMNCiXi48/[...]DKJSVFT0YNCg=="
          }
        ]
      }
    }
  ]

Outras formas de fazer uma requisição (request)

curl -X 'POST' \
  'https://api.cadastro.uat.unico.app/client/v1/process/' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {{TOKEN}}'
  -d '{
    "callbackUri": "/",
    "flow": "id",
    "person": {
        "duiType": "DUI_TYPE_BR_CPF",
        "duiValue": "73689290074",
    "friendlyName": "John Doe"
    },
    "purpose": "creditprocess"
}'

Para utilizar o Postman, siga os passos:

Selecione o método POST.
Insira a URL https://api.cadastro.uat.unico.app/client/v1/process/.
Selecione a aba Authorization.
Na lista de Type, selecione Bearer Token.
Insira o token obtido no campo Token com o prefixo Bearer .
Selecione a aba Body e insira os dados abaixo de acordo com sua necessidade.

{
  "callbackUri": "/paht/callback-url",
  "flow": "id",
  "person": {
    "duiType": "DUI_TYPE_BR_CPF",
    "duiValue": "73689290074",
    "friendlyName": "John Doe"
  },
  "purpose": "creditprocess"
}

const axios = require("axios");

const apiUrl = "https://api.cadastro.uat.unico.app/client/v1/process/";
const token =  "<YOUR_TOKEN_HERE>";

const requestData = {
  callbackUri: "/path/to/url",
  flow: "id",
  person: {
    duiType: "DUI_TYPE_BR_CPF",
    duiValue: "73689290074",
    friendlyName: "John Doe",
  },
  purpose: "creditprocess",
};

const headers = {
  "Content-Type": "application/json",
  Authorization: `Bearer ${token}`,
  accept: "application/json",
};

axios
  .post(apiUrl, requestData, { headers })
  .then((response) => {
    console.log("Resposta da API:", response.data);
  })
  .catch((error) => {
    console.error("Erro:", error);
  });

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.HashMap;
import java.util.Map;

public class Main {
    public static void main(String[] args) {
        String apiUrl = "https://api.cadastro.uat.unico.app/client/v1/process/";
        String token = "<YOUR_TOKEN_HERE>";

        // Crie o corpo da solicitação em formato JSON
        String requestBody = "{\"callbackUri\":\"/\",\"flow\":\"id\",\"person\":{\"duiType\":\"DUI_TYPE_BR_CPF\",\"duiValue\":\"73689290074\"},\"purpose\":\"creditprocess\"}";

        // Configure os cabeçalhos da solicitação
        Map<String, String> headers = new HashMap<>();
        headers.put("Content-Type", "application/json");
        headers.put("Authorization", "Bearer " + token);
        headers.put("accept", "application/json");

        // Crie a instância do HttpClient
        HttpClient httpClient = HttpClient.newBuilder().build();

        // Crie a solicitação HTTP POST
        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create(apiUrl))
                .headers(headers.entrySet().stream()
                        .map(e -> e.getKey() + ":" + e.getValue())
                        .toArray(String[]::new))
                .POST(HttpRequest.BodyPublishers.ofString(requestBody))
                .build();

        try {
            // Envie a solicitação e obtenha a resposta
            HttpResponse<String> response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());

            // Exiba a resposta da API
            System.out.println("Status da resposta: " + response.statusCode());
            System.out.println("Corpo da resposta: " + response.body());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        string apiUrl = "https://api.cadastro.uat.unico.app/client/v1/process/";
        string token = "<YOUR_TOKEN_HERE>";

        // Crie o corpo da solicitação em formato JSON
        string requestBody = "{\"callbackUri\":\"/\",\"flow\":\"id\",\"person\":{\"duiType\":\"DUI_TYPE_BR_CPF\",\"duiValue\":\"73689290074\"},\"purpose\":\"creditprocess\"}";

        // Configure os cabeçalhos da solicitação
        HttpClient client = new HttpClient();
        client.DefaultRequestHeaders.Add("Content-Type", "application/json");
        client.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);
        client.DefaultRequestHeaders.Add("accept", "application/json");

        try
        {
            // Envie a solicitação HTTP POST
            HttpResponseMessage response = await client.PostAsync(apiUrl, new StringContent(requestBody, Encoding.UTF8, "application/json"));

            // Verifique o status da resposta
            if (response.IsSuccessStatusCode)
            {
                string responseBody = await response.Content.ReadAsStringAsync();
                Console.WriteLine("Status da resposta: " + response.StatusCode);
                Console.WriteLine("Corpo da resposta: " + responseBody);
            }
            else
            {
                Console.WriteLine("Erro na solicitação. Status da resposta: " + response.StatusCode);
            }
        }
        catch (Exception e)
        {
            Console.WriteLine("Erro: " + e.Message);
        }
    }
}

package main

import (
    "bytes"
    "fmt"
    "net/http"
)

func main() {
    apiURL := "https://api.cadastro.uat.unico.app/client/v1/process/"
    token := "<YOUR_TOKEN_HERE>";

    // Crie o corpo da solicitação em formato JSON
    requestBody := []byte(`{
        "callbackUri": "/path/to/url",
        "flow": "id",
        "person": {
            "duiType": "DUI_TYPE_BR_CPF",
            "duiValue": "73689290074"
        },
        "purpose": "creditprocess"
    }`)

    // Crie um cliente HTTP
    client := &http.Client{}

    // Crie uma solicitação HTTP POST
    req, err := http.NewRequest("POST", apiURL, bytes.NewBuffer(requestBody))
    if err != nil {
        fmt.Println("Erro ao criar a solicitação HTTP:", err)
        return
    }

    // Defina os cabeçalhos da solicitação
    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Bearer "+token)
    req.Header.Set("accept", "application/json")

    // Faça a solicitação HTTP
    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Erro ao fazer a solicitação HTTP:", err)
        return
    }
    defer resp.Body.Close()

    // Verifique o status da resposta
    if resp.StatusCode == http.StatusOK {
        // Leitura do corpo da resposta
        var responseBody []byte
        _, err := resp.Body.Read(responseBody)
        if err != nil {
            fmt.Println("Erro ao ler o corpo da resposta:", err)
            return
        }

        fmt.Println("Status da resposta:", resp.Status)
        fmt.Println("Corpo da resposta:", string(responseBody))
    } else {
        fmt.Println("Erro na solicitação. Status da resposta:", resp.Status)
    }
}

Dúvidas?

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.

Consultar Resultado do Processo

Nesta seção, você encontrará como obter o resultado de um processo no by Unico através da API REST

Introdução

Nesta seção, você encontrará a documentação detalhada sobre o funcionamento do endpoint de Consulta do Resultado de Processos no by Unico.

Antes de começar

Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.

Você pode ver mais sobre como gerar um access-token .

Endpoints:

UAT: ;
Produção: .

Consulta do Resultado do Processo

Os processos devem ser criados exclusivamente em uma comunicação backend-to-backend, devido à nossa política de CORS, que impede a criação de processos em uma comunicação frontend-to-backend.

O conteúdo retornado no parâmetro process.services.documents.doc.data, referente à tecnologia de OCR Extração, pode ser consultado abaixo:

Caso não consigamos extrair algum campo do documento, ele não é listado no retorno da API.

Dicas:

Para implementar suas regras de negócio, sempre valide o retorno das capacidades analisando os parâmetros do response na seguinte ordem:
- state = PROCESS_STATE_FINISHED E result = PROCESS_RESULT_OK;
  - ENTÃO, pode realizar a tomada de decisão analisando os retornos do parâmetro authenticationInfo.
  - Caso receba o state = PROCESS_STATE_FINISHED com os resultados result = PROCESS_RESULT_INVALID_IDENTITY ou PROCESS_RESULT_ERROR, interprete que houve algum erro na biometria e tente novamente.
Para melhorar a performance da sua operação, você pode utilizar nossos Webhooks e só consultar o resultado de processos que estiverem nos status finalizados;
Para mais informações sobre os cenários que pode receber no response, consulte a seção Cenários de response;
Para mais informações sobre os erros possíveis para este endpoint, consulte a seção Erros.

Exemplos de responses por flow

Nesta seção, você encontrará todos os cenários de response para processos finalizados no by Unico

Responses separadas por flows

{
    "process": {
        "id": "c0dcbf87-76b2-431c-9d8e-e9ac644be642",
        "flow": "idlive",
        "callbackUri": "/",
        "userRedirectUrl": "https://cadastro.unico.app/process/c0dcbf87-76b2-431c-9d8e-e9ac644be642",
        "state": "PROCESS_STATE_FINISHED",
        "result": "PROCESS_RESULT_OK",
        "createdAt": "2024-12-23T13:23:49.540865Z",
        "finishedAt": "2024-12-23T13:24:35.485202Z",
        "person": {
            "duiType": "DUI_TYPE_BR_CPF",
            "duiValue": "12345678909",
            "friendlyName": "",
            "email": "luke@unico.io",
            "phone": "5511999995555",
            "notifications": [
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
                }
            ]
        },
        "purpose": "creditprocess",
        "services": [],
        "authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_FALSE",
                "score": 0
            },
            "authenticationId": "02e2bef1-cad8-435d-9aa9-d4bb7295e7b0",
            "livenessResult": "LIVENESS_RESULT_LIVE",
            "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED",
            "identityFraudstersResult": "TRUST_RESULT_UNSPECIFIED"
        },
        "capacities": [
            "PROCESS_CAPACITY_IDLIVE"
        ],
        "expiresAt": "2024-12-30T13:23:49.540458Z",
        "token": "",
        "companyData": {
            "branchId": "",
            "countryCode": "BRA"
        }
    }
}

{
    "process": {
        "id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
        "flow": "id",
        "callbackUri": "/path/to/callback-url/",
        "userRedirectUrl": "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b",
        "state": "PROCESS_STATE_FINISHED",
        "result": "PROCESS_RESULT_OK",
        "person": {
            "duiType": "DUI_TYPE_BR_CPF",
            "duiValue": "73689290074",
            "friendlyName": "John Doe",
            "notifications": [
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
                },
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_SMS"
                }
            ],
        },
        "purpose": "creditprocess",
        "authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE",
            "authenticationId": "fd433602-d496-4291-adbb-dda95a3e50b1",
            "livenessResult": "LIVENESS_RESULT_LIVE",
            "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED",
            "identityFraudstersResult": "TRUST_RESULT_UNSPECIFIED"
        },
        "capacities": [
            "PROCESS_CAPACITY_IDUNICO",
            "PROCESS_CAPACITY_IDLIVE"
        ],        
        "createdAt": "2023-10-05T18:28:58.537985Z",
        "finishedAt": "2023-10-09T15:15:25.417105Z",
        "expiresAt": "2024-12-30T13:23:49.540458Z",
        "token": "",
        "companyData": {
            "branchId": "",
            "countryCode": "BRA"
        }
    }
}

{
    "process": {
        "id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
        "flow": "idcheck",
        "callbackUri": "/path/to/callback-url/",
        "userRedirectUrl": "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b",
        "state": "PROCESS_STATE_FINISHED",
        "result": "PROCESS_RESULT_OK",
        "person": {
            "duiType": "DUI_TYPE_BR_CPF",
            "duiValue": "73689290074",
            "friendlyName": "John Doe",
            "notifications": [
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
                },
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_SMS"
                }
            ],
        },
        "purpose": "creditprocess",
        "authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_TRUE",
                "score": 50
            },
            "authenticationId": "fd433602-d496-4291-adbb-dda95a3e50b1",
            "livenessResult": "LIVENESS_RESULT_LIVE",
            "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED",
            "identityFraudstersResult": "TRUST_RESULT_UNSPECIFIED"
        },
        "capacities": [
            "PROCESS_CAPACITY_IDLIVE",
            "PROCESS_CAPACITY_IDUNICO",
            "PROCESS_CAPACITY_IDCHECK"
        ],        
        "createdAt": "2023-10-05T18:28:58.537985Z",
        "finishedAt": "2023-10-09T15:15:25.417105Z",
        "expiresAt": "2024-12-30T13:23:49.540458Z",
        "token": "",
        "companyData": {
            "branchId": "",
            "countryCode": "BRA"
        }
    }
}

{
    "process": {
        "id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
        "flow": "iddocs",
        "callbackUri": "/path/to/callback-url/",
        "userRedirectUrl": "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b",
        "state": "PROCESS_STATE_FINISHED",
        "result": "PROCESS_RESULT_OK",
        "person": {
            "duiType": "DUI_TYPE_BR_CPF",
            "duiValue": "73689290074",
            "friendlyName": "John Doe",
            "notifications": [
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
                },
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_SMS"
                }
            ],
        },
        "purpose": "creditprocess",
        "authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_TRUE",
                "score": 50
            },
            "authenticationId": "fd433602-d496-4291-adbb-dda95a3e50b1",
            "livenessResult": "LIVENESS_RESULT_LIVE",
            "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED",
            "identityFraudstersResult": "TRUST_RESULT_UNSPECIFIED"
        },
        "capacities": [
            "PROCESS_CAPACITY_IDLIVE",
            "PROCESS_CAPACITY_IDUNICO",
            "PROCESS_CAPACITY_IDCHECK",
            "PROCESS_CAPACITY_IDDOCS"
        ],        
        "services": [
            {
                 "documents": [
                    {
                        "doc": {
                            "version": 2,
                            "code": "RG",
                            "data": {
                                "dataExpiracao": "2025-10-35T00:00:00Z",
                                "dataHabilitacao": "2022-08-09T00:00:00Z",
                                "dataNascimento": "1950-06-30T00:00:00Z",
                                "nomeCivil": "John Doe",
                                "rgNumero": "5478854",
                                "categoria": "D",
                                "cpfNumero": "73689290074",
                                "dataEmissao": "2020-08-09T00:00:00Z",
                                "localEmissao": "DEREX SP",
                                "numero": "85775532778",
                                "renachNumero": ""
                            },
                        },
                        "typified": true,
                        "cpf_match": true,
                        "face_match": true,
                        "doc_id": "1e61a978-3673-4fdd-8fa8-808d0a26d131",
                        "validate_doc": true,
                        "reused_doc": true,                        
                        "signed_url": "https://api.datafortress.dev.private.unico.run/url-signer/signature/dmF1bHQ6[...]OXc9PQ%3D%3D"
                    }
                ],
                "consent_granted": true
            }
        ],
        "createdAt": "2023-10-05T18:28:58.537985Z",
        "finishedAt": "2023-10-09T15:15:25.417105Z",
        "expiresAt": "2024-12-30T13:23:49.540458Z",
        "token": "",
        "companyData": {
            "branchId": "",
            "countryCode": "BRA"
        }
    }
}

{
    "process": {
        "id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
        "flow": "idsign",
        "callbackUri": "/path/to/callback-url/",
        "userRedirectUrl": "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b",
        "state": "PROCESS_STATE_FINISHED",
        "result": "PROCESS_RESULT_OK",
        "person": {
            "duiType": "DUI_TYPE_BR_CPF",
            "duiValue": "73689290074",
            "friendlyName": "John Doe",
            "notifications": [
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
                },
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_SMS"
                }
            ],
        },
        "purpose": "creditprocess",
        "authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_TRUE",
                "score": 50
            },
            "authenticationId": "fd433602-d496-4291-adbb-dda95a3e50b1",
            "livenessResult": "LIVENESS_RESULT_LIVE",
            "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED",
            "identityFraudstersResult": "TRUST_RESULT_UNSPECIFIED"
        },
        "capacities": [
            "PROCESS_CAPACITY_IDLIVE",
            "PROCESS_CAPACITY_IDUNICO",
            "PROCESS_CAPACITY_IDCHECK",
            "PROCESS_CAPACITY_IDSIGN"
        ],        
        "services": [
            {
                "envelopeId": "4d4f3d90-04a3-4259-b63b-930ab10d2e47",
                "documentIds": [
                    "03307601-b518-49ca-b368-ae3919e24e54"
                ]    
            },
        ],
        "createdAt": "2023-10-05T18:28:58.537985Z",
        "finishedAt": "2023-10-09T15:15:25.417105Z",
        "expiresAt": "2024-12-30T13:23:49.540458Z",
        "token": "",
        "companyData": {
            "branchId": "",
            "countryCode": "BRA"
        }
    }
}

{
    "process": {
        "id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
        "flow": "iddocssign",
        "callbackUri": "/path/to/callback-url/",
        "userRedirectUrl": "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b",
        "state": "PROCESS_STATE_FINISHED",
        "result": "PROCESS_RESULT_OK",
        "person": {
            "duiType": "DUI_TYPE_BR_CPF",
            "duiValue": "73689290074",
            "friendlyName": "John Doe",
            "notifications": [
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
                },
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_SMS"
                }
            ],
        },
        "purpose": "creditprocess",
        "authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_TRUE",
                "score": 50
            },
            "authenticationId": "fd433602-d496-4291-adbb-dda95a3e50b1",
            "livenessResult": "LIVENESS_RESULT_LIVE",
            "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED",
            "identityFraudstersResult": "TRUST_RESULT_UNSPECIFIED"
        },
        "capacities": [
            "PROCESS_CAPACITY_IDUNICO",
            "PROCESS_CAPACITY_IDCHECK",
            "PROCESS_CAPACITY_IDDOCS",
            "PROCESS_CAPACITY_IDSIGN",
            "PROCESS_CAPACITY_IDLIVE"
        ],
        "services": [
            {
                "documents": [
                    {
                        "doc": {
                            "version": 2,
                            "code": "RG",
                            "data": {
                                "dataExpiracao": "2025-10-35T00:00:00Z",
                                "dataHabilitacao": "2022-08-09T00:00:00Z",
                                "dataNascimento": "1950-06-30T00:00:00Z",
                                "nomeCivil": "John Doe",
                                "rgNumero": "5478854",
                                "categoria": "D",
                                "cpfNumero": "73689290074",
                                "dataEmissao": "2020-08-09T00:00:00Z",
                                "localEmissao": "DEREX SP",
                                "numero": "85775532778",
                                "renachNumero": ""
                            },
                        },
                        "typified": true,
                        "cpf_match": true,
                        "face_match": true,
                        "doc_id": "1e61a978-3673-4fdd-8fa8-808d0a26d131",
                        "validate_doc": true,
                        "reused_doc": true,                        
                        "signed_url": "https://api.datafortress.dev.private.unico.run/url-signer/signature/dmF1bHQ6[...]OXc9PQ%3D%3D"
                    }
                ],
                "consent_granted": true
            },
            {
                "envelopeId": "4d4f3d90-04a3-4259-b63b-930ab10d2e47",
                "documentIds": [
                    "03307601-b518-49ca-b368-ae3919e24e54"
                ]
            }
        ],
        "createdAt": "2023-10-05T18:28:58.537985Z",
        "finishedAt": "2023-10-09T15:15:25.417105Z",
        "expiresAt": "2024-12-30T13:23:49.540458Z",
        "token": "",
        "companyData": {
            "branchId": "",
            "countryCode": "BRA"
        }
    }
}

{
    "process": {
        "id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
        "flow": "idcheckserpro",
        "callbackUri": "/path/to/callback-url/",
        "userRedirectUrl": "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b",
        "state": "PROCESS_STATE_FINISHED",
        "result": "PROCESS_RESULT_OK",
        "person": {
            "duiType": "DUI_TYPE_BR_CPF",
            "duiValue": "73689290074",
            "friendlyName": "John Doe",
            "notifications": [
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
                },
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_SMS"
                }
            ],
        },
        "purpose": "creditprocess",
        "authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_TRUE",
                "score": 50
            },
            "authenticationId": "fd433602-d496-4291-adbb-dda95a3e50b1",
            "livenessResult": "LIVENESS_RESULT_LIVE",
            "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED",
            "identityFraudstersResult": "TRUST_RESULT_UNSPECIFIED",
            "serproResult": {
                "score": 50
            }
        },
        "capacities": [
            "PROCESS_CAPACITY_IDLIVE",
            "PROCESS_CAPACITY_IDUNICO",
            "PROCESS_CAPACITY_IDCHECK"
        ],        
        "createdAt": "2023-10-05T18:28:58.537985Z",
        "finishedAt": "2023-10-09T15:15:25.417105Z",
        "expiresAt": "2024-12-30T13:23:49.540458Z",
        "token": "",
        "companyData": {
            "branchId": "",
            "countryCode": "BRA"
        }
    }
}

{
    "process": {
        "id": "ede08bf6-e167-4249-9501-2a93b5d1ffc3",
        "flow": "idtoken",
        "callbackUri": "/",
        "userRedirectUrl": "https://cadastro.uat.unico.app/process/ede08bf6-e167-4249-9501-2a93b5d1ffc3",
        "state": "PROCESS_STATE_FINISHED",
        "result": "PROCESS_RESULT_OK",
        "createdAt": "2024-10-28T19:54:23.313015Z",
        "finishedAt": "2024-10-28T20:02:43.620300Z",
        "person": {
            "duiType": "DUI_TYPE_BR_CPF",
            "duiValue": "12345678909",
            "email": "luke@unico.co",
            "phone": "5521999249999",
            "notifications": [
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
                },
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_EMAIL"
                },
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_SMS"
                }
            ]
        },
        "purpose": "creditprocess",
        "authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
            "authenticationId": "c95ea805-b001-4926-a99e-c0be7ef0b663",
            "livenessResult": "LIVENESS_RESULT_LIVE",
            "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_POSITIVE",
            "identityFraudstersResult": "TRUST_RESULT_UNSPECIFIED",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_FALSE",
                "score": 0
            },
        },
        "capacities": [
            "PROCESS_CAPACITY_IDLIVE",
            "PROCESS_CAPACITY_IDTOKEN"
        ],
        "expiresAt": "2024-12-30T13:23:49.540458Z",
        "token": "",
        "companyData": {
            "branchId": "",
            "countryCode": "BRA"
        }
    }
}

Os exemplos de response acima consideram somente processos que estão com o state = PROCESS_STATE_FINISHED e result = PROCESS_RESULT_OK. Para ver os responses que não consideram somente essas condições, veja a seção Cenários de reponse.

Dúvidas?

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.

Obter Selfie do Usuário

Nesta seção, você encontrará como obter a selfie de um processo no by Unico através da API REST

Introdução

Nesta seção, você encontrará a documentação detalhada sobre o funcionamento do endpoint de Obtenção da Selfie do Usuário no by Unico. Este endpoint fornecerá a selfie, com marca d'água, do usuário final em processos concluídos, permitindo que você a utilize como suporte em casos de contestação por parte do usuário.

Antes de começar

Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.

Você pode ver mais sobre como gerar um access-token .

Endpoints:

UAT: ;
Produção: .

Obtenção da Selfie do Usuário

Os processos devem ser criados exclusivamente em uma comunicação backend-to-backend, devido à nossa política de CORS, que impede a criação de processos em uma comunicação frontend-to-backend.

Pontos importantes:

A liberação da permissão para obter a selfie do usuário dependerá de avaliação interna da Unico. Entenda com o responsável do seu projeto se poderá consumir este serviço;
Só é possível recuperar a selfie com a marca d'água;
A selfie do usuário só fica disponível para consulta via REST API durante 8h após a finalização do processo biométrico. Após este período, não é possível recuperar a selfie do usuário.

Para mais informações sobre os erros possíveis para este endpoint, consulte a seção Erros.

Obter Conjunto Probatório

Nesta seção, você encontrará como obter o conjunto probatório de um processo no by Unico através da API REST

Introdução

Nesta seção, você encontrará a documentação detalhada sobre o funcionamento do endpoint de Obtenção do Conjunto Probatório no by Unico. Este endpoint fornecerá o conjunto probatório da transação biométrica finalizada, permitindo que você o armazene para possíveis contestações futuras por parte do usuário final.

Para entender mais sobre o conjunto probatório, veja a seção .

Antes de começar

Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.

Você pode ver mais sobre como gerar um access-token .

Endpoints:

UAT: ;
Produção: .

Obtenção do Conjunto Probatório

Os processos devem ser criados exclusivamente em uma comunicação backend-to-backend, devido à nossa política de CORS, que impede a criação de processos em uma comunicação frontend-to-backend.

O conjunto probatório da captura biométrica só fica disponível para consulta via REST API durante 2h após a finalização do processo biométrico. Após este período, não é possível recuperar a selfie do usuário.

Para mais informações sobre os erros possíveis para este endpoint, consulte a seção Erros.

Especificação do conjunto probatório

Nesta seção, você encontrará todas as especificações do conjunto probatório do by Unico

O conjunto probatório é um documento em .pdf contendo evidências de autenticação de um usuário que realizou a validação de identidade no by Unico.

A seguir, veja como este documento é representado, bem como a especificação de seus campos de retorno:

Campos do Conjunto Probatório (clique em cada um para saber mais)

Usuário

Foto com marca d'água;
Nome - indica o nome da pessoa autenticada. Esse dado é obtido através do parâmetro person.friendly_name do CreateProcess;
CPF do titular - indica o CPF da pessoa autenticada. Esse dado é obtido através do parâmetro person.dui_value do CreateProcess;
Canal de contato - indica o canal de comunicação com a pessoa autenticada. Esse dado é obtido através do parâmetro person.notifications do CreateProcess.

Processo

Fluxo executado - indica qual fluxo foi executado. Esse dado é obtido através do parâmetro flow do CreateProcess;
Identificador do processo - indica o id do processo. Esse dado é obtido através do parâmetro procees.id no retorno do CreateProcess;
URL - indica a URL de autenticação do processo;
Criação - indica a data da criação do processo. Esse dado é obtido através do parâmetro createdAt no retorno do CreateProcess;
Finalização - indica a data de finalização do processo. Esse dado é obtido através do parâmetro finishedAt no retorno do CreateProcess;
Estado - indica o status do processo. Esse dado é obtido através do parâmetro state no retorno do CreateProces;
Empresa - indica a empresa.

Validações

Tipo de validação - indica o tipo de validação da autenticação do processo;
Identidade - indica resultado da Verificação de Identidade;
Detecção de vida - indica resultado da Prova de vida.

Dados de navegação

Sistema operacional e navegador - indica os dados do dispositivo;
Endereço do IP - indica o IP do dispositivo.

Evidências de uso dos módulos nos flows iddocs, idsign e iddocssign

Quando o processo envolve os fluxos de IDDocs e Sign, o conjunto probatório também retorna dados desses fluxos como:

Documentos:

Tipo de documento - identifica o documento compartilhado pela pessoa. Ex: CNH / RG;
Modulo de coleta - caso Sim, identifica se houve a captura de um documento;
Documento validado - caso Sim, identifica que o documento compartilhado/reutilizado foi validado.

Assinatura:

Dados do Envelope - indica os documentos e seus assinantes;
ID do envelope - UUID que identifica o envelope no Unico Sign

Essas evidências podem ser utilizadas para garantir a autenticidade do processo.

O conjunto probatório só está disponível para os processos finalizados;
O conjunto probatório da captura biométrica só fica disponível para consulta via REST API durante 2h após a finalização do processo biométrico. Após este período, não é possível recuperar a selfie do usuário.

Dúvidas?

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.

Obter Documento Assinado

Nesta seção, você encontrará como obter o documento assinado de um processo no by Unico através da API REST

Introdução

Nesta seção, você encontrará a documentação detalhada sobre o funcionamento do endpoint de Obtenção do Documento Assinado no by Unico. Este endpoint fornecerá o documento assinado do usuário final em fluxos que possuem a capacidade Assinatura Eletrônica.

Antes de começar

Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.

Você pode ver mais sobre como gerar um access-token .

Endpoints:

UAT: ;
Produção: .

Obtenção do Documento Assinado

Exemplo de um documento gerado:

Caso o retorno do documento assinado via by Unico apresente atraso no processamento, recomendamos aguardar pelo menos um minuto após a conclusão do processo antes de realizar a consulta. Adicionalmente, é importante configurar uma política de tentativa automática (retry) para os casos em que o documento assinado ainda não esteja disponível, como realizar até 10 tentativas com intervalos de 1 a 5 minutos entre elas.

Para mais informações sobre os erros possíveis para este endpoint, consulte a seção Erros.

Obter Conjunto Probatório do Documento Assinado

Nesta seção, você encontrará como obter o conjunto probatório do Sign de um processo no by Unico através da API REST

Introdução

Nesta seção, você encontrará a documentação detalhada sobre o funcionamento do endpoint de Obtenção do Conjunto Probatório do Documento Assinado no by Unico. Este endpoint fornecerá o conjunto probatório da assinatura do usuário final em fluxos que possuem a capacidade Assinatura Eletrônica.

Antes de começar

Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.

Você pode ver mais sobre como gerar um access-token aqui.

Endpoints:

UAT: https://signhom.acesso.io/api/v1/service/evidence;
Produção: https://sign.acesso.io/api/v1/service/evidence.

Obtenção do Conjunto Probatório do Documento Assinado

Exemplo de um documento gerado:

Para mais informações sobre os erros possíveis para este endpoint, consulte a seção Erros.

Dúvidas?

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.

Cenários de response

Nesta seção, você encontrará todos os cenários de response do by Unico, independentemente se os processos estão finalizados ou não

Flow id

Cenário: Processo criado

Ocorre quando o processo foi criado, porém ainda não foi finalizado pelo usuário.

state

result

PROCESS_STATE_CREATED

PROCESS_RESULT_UNSPECIFIED

CreateProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_UNSPECIFIED",
                "score": 0
            },
            "authenticationId": "",
            "livenessResult": "LIVENESS_RESULT_UNSPECIFIED"
        }

GetProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_UNSPECIFIED",
                "score": 0
            },
            "authenticationId": "",
            "livenessResult": "LIVENESS_RESULT_UNSPECIFIED"
        }

Cenário: Processo criado com erro

Ocorre quando o processo foi criado, porém houve algum erro no serviço.

state

result

PROCESS_STATE_FAILED

PROCESS_RESULT_ERROR

CreateProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_UNSPECIFIED",
                "score": 0
            },
            "authenticationId": "",
            "livenessResult": "LIVENESS_RESULT_UNSPECIFIED"
        }

GetProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_UNSPECIFIED",
                "score": 0
            },
            "authenticationId": "",
            "livenessResult": "LIVENESS_RESULT_UNSPECIFIED"
        }

Cenário: Processo finalizado e aprovado no IDUnico

Ocorre quando o processo foi criado, finalizado pelo usuário e teve retorno POSITIVO do IDUnico.

state

result

PROCESS_STATE_FINISHED

PROCESS_RESULT_OK

GetProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_POSITIVE",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_FALSE",
                "score": 0
            },
            "authenticationId": "652f8864-c364-4cc7-9abb-d38a86d21d66",
            "livenessResult": "LIVENESS_RESULT_LIVE"
        }

Cenário: Processo finalizado e inconclusivo no IDUnico

Ocorre quando o processo foi criado, finalizado pelo usuário, mas teve retorno INCONCLUSIVO do IDUnico.

state

result

PROCESS_STATE_FINISHED

PROCESS_RESULT_OK

GetProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_FALSE",
                "score": 0
            },
            "authenticationId": "652f8864-c364-4cc7-9abb-d38a86d21d66",
            "livenessResult": "LIVENESS_RESULT_LIVE"
        }

Cenário: Processo finalizado e recusado no IDUnico

Ocorre quando o processo foi criado, finalizado pelo usuário e teve retorno NEGATIVO do IDUnico.

state

result

PROCESS_STATE_FINISHED

PROCESS_RESULT_INVALID_IDENTITY

GetProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_NEGATIVE",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_FALSE",
                "score": 0
            },
            "authenticationId": "652f8864-c364-4cc7-9abb-d38a86d21d66",
            "livenessResult": "LIVENESS_RESULT_LIVE"
        }

Cenário: Processo finalizado e com falha na Prova de Vida

Ocorre quando o processo foi criado, finalizado pelo usuário, mas teve retorno de falha na prova de vida.

state

result

PROCESS_STATE_FINISHED

PROCESS_RESULT_INVALID_IDENTITY

GetProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_UNSPECIFIED",
                "score": 0
            },
            "authenticationId": "",
            "livenessResult": "LIVENESS_RESULT_NOT_LIVE"
        }

Flow idcheck

Cenário: Processo criado

Ocorre quando o processo foi criado, porém ainda não foi finalizado pelo usuário.

state

result

PROCESS_STATE_CREATED

PROCESS_RESULT_UNSPECIFIED

CreateProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_UNSPECIFIED",
                "score": 0
            },
            "authenticationId": "",
            "livenessResult": "LIVENESS_RESULT_UNSPECIFIED"
        }

GetProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_UNSPECIFIED",
                "score": 0
            },
            "authenticationId": "",
            "livenessResult": "LIVENESS_RESULT_UNSPECIFIED"
        }

Cenário: Processo criado com erro

Ocorre quando o processo foi criado, porém houve algum erro no serviço.

state

result

PROCESS_STATE_FAILED

PROCESS_RESULT_ERROR

CreateProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_UNSPECIFIED",
                "score": 0
            },
            "authenticationId": "",
            "livenessResult": "LIVENESS_RESULT_UNSPECIFIED"
        }

GetProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_UNSPECIFIED",
                "score": 0
            },
            "authenticationId": "",
            "livenessResult": "LIVENESS_RESULT_UNSPECIFIED"
        }

Cenário: Processo finalizado e aprovado no IDUnico

Ocorre quando o processo foi criado, finalizado pelo usuário e teve retorno POSITIVO do IDUnico.

state

result

PROCESS_STATE_FINISHED

PROCESS_RESULT_OK

GetProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_POSITIVE",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_TRUE",
                "score": 0
            },
            "authenticationId": "8b2516fa-0c83-44ef-a365-3269e425166d",
            "livenessResult": "LIVENESS_RESULT_LIVE"
        }

Cenário: Processo finalizado com sucesso, inconclusivo no IDUnico e com score no IDCheck

Ocorre quando o processo foi criado, finalizado pelo usuário, teve retorno INCONCLUSIVO do IDUnico e teve um Score válido no IDCheck.

state

result

PROCESS_STATE_FINISHED

PROCESS_RESULT_OK

GetProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_TRUE",
                "score": 10
            },
            "authenticationId": "09f14518-e083-44c2-bd32-2d0a56426711",
            "livenessResult": "LIVENESS_RESULT_LIVE"
        }

Cenário: Processo finalizado com sucesso, inconclusivo no IDUnico e descartado por divergência no IDCheck

Ocorre quando o processo foi criado, finalizado pelo usuário, teve retorno INCONCLUSIVO do IDUnico e gerou uma divergência no IDCheck, que por sua vez demorou mais do que 60s para ser resolvida pelos motores de divergência.

state

result

PROCESS_STATE_FINISHED

PROCESS_RESULT_INVALID_IDENTITY

GetProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_UNSPECIFIED",
                "score": 0
            },
            "authenticationId": "",
            "livenessResult": "LIVENESS_RESULT_UNSPECIFIED"
        }

Cenário: Processo finalizado e recusado no IDUnico

Ocorre quando o processo foi criado, finalizado pelo usuário e teve retorno NEGATIVO do IDUnico.

state

result

PROCESS_STATE_FINISHED

PROCESS_RESULT_INVALID_IDENTITY

GetProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_NEGATIVE",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_FALSE",
                "score": 0
            },
            "authenticationId": "652f8864-c364-4cc7-9abb-d38a86d21d66",
            "livenessResult": "LIVENESS_RESULT_LIVE"
        }

Cenário: Processo finalizado com sucesso e com falha na Prova de Vida

Ocorre quando o processo foi criado, finalizado pelo usuário, porém não foi possível validar que usuário que capturou a face estava ao vivo no momento da captura.

state

result

PROCESS_STATE_FINISHED

PROCESS_RESULT_INVALID_IDENTITY

GetProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_UNSPECIFIED",
                "score": 0
            },
            "authenticationId": "",
            "livenessResult": "LIVENESS_RESULT_NOT_LIVE"
        }

Para verificar detalhadamente os parâmetros da API, consulte a seção Especificação de parâmetros.

Dúvidas?

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.

Erros

Nesta seção, você encontrará a visão geral sobre os erros que pode receber nos endpoints da plataforma Unico IDCloud

Introdução

A plataforma IDCloud utiliza códigos de resposta HTTP convencionais para indicar o sucesso ou falha de uma solicitação de API.

Como regra geral:

Códigos no intervalo 2xx indicam sucesso na requisição;
Códigos no intervalo 4xx indicam parâmetros incorretos ou incompletos (por exemplo, um parâmetro obrigatório foi omitido ou uma operação falhou com terceiros, etc.);
Códigos no intervalo 5xx indicam que houve um erro nos servidores da plataforma Unico IDCloud.

A plataforma Unico IDCloud também gera uma mensagem de erro e um código de erro formatado em JSON:

{
    "error": {
        "code": "0000",
        "description": "error description"
    }
}

Erros possíveis

Neste tópico, você encontrará os possíveis erros dos endpoints, separados por seu HTTP response.

Criar Processo

Consultar Resultado do Processo

Obter Selfie do Usuário

Obter Conjunto Probatório

Obter Documento Assinado

Obter Conjunto Probatório do Documento Assinado

Dúvidas?

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.

Recursos adicionais

Nesta seção, você encontrará os recursos adicionais relacionados ao meio de integração by Unico

Postman Collection

Nesta seção, você encontrará você encontrará a collection do Postman com as APIs REST do by Unico

Dúvidas?

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.

Criação do Processo

Nesta seção, você encontrará como criar um processo no by Unico através da API REST

Introdução

Entenda mais sobre a utilização das capacidades no by Unico na seção Visão Geral.

Antes de começar

Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.

Você pode ver mais sobre como gerar um access-token aqui.

Endpoints:

UAT: https://api.cadastro.uat.unico.app/client/v1/process;
Produção: https://api.cadastro.unico.app/client/v1/process.

Criação do Processo

Criar Processo

Endpoint para criar um novo processo no by Unico.

POSThttps://api.cadastro.uat.unico.app/client/v1/process/

Authorization

Body

callbackUri*string

Define para onde o usuário será redirecionado ao fim do processo. Valores possíveis são: Uma URL https para redirecionar páginas web (ex: https://developers.unico.io/callback), uma URL Schema para redirecionamento em aplicações móveis nativas (ex: br.com.meupacote.app://callback - o callback precisa estar registrado em sua aplicação móvel) ou sem redireciomento (incluir apenas a '/').

Example: "/"

flow*enum

Tipo de fluxo. Veja detalhes dos fluxos na seção 'Visão Geral' nesta mesma documentação.

Example: "iddocssign"

idliveididlivetrustidtrustidcheckiddocsidsigniddocssignidchecktrustidchecktrustdocsidchecktrustsignidchecktrustdocssignidcheckserprocreditoconsignadoidcheckserprodocssignidtokenidtokensignidtokentrust

companyBranchIdstring

É o ID da filial onde o processo será criado. Caso haja somente uma filial associada a conta de serviço, não há a necessidade de passar este parâmetro. Caso haja separação de processos por filial, você receberá os IDs das filiais do time Unico.

Example: "60837cd3-ed3c-4038-ad7c-0a85ad64b03a"

bioTokenIdstring

Identificação do token biométrico. Obrigatório para o flow "idtoken" e deve-se utilizar um id de um processo concluído de qualquer outro flow de verificação de identidade.

Example: "60837cd3-ed3c-4038-ad7c-0a85ad64b03a"

personobject

Informações do usuário.

duiType*string

Tipo de documento de identificação. Deve-se utilizar "DUI_TYPE_BR_CPF" ter o CPF como identificador.

Example: "DUI_TYPE_BR_CPF"

duiValue*string

Valor do documento de identificação (ex: número do CPF). Deve conter 11 caracteres e ser enviado sem pontos ou traços.

Example: "12345678909"

friendlyNamestring

Nome da pessoa.

Example: "Luke Skywalker"

phonestring

Número de telefone da pessoa. Torna-se obrigatório caso envie a notificação via SMS ou WhatsApp. Deve conter 13 caracteres e ser enviado sem pontos ou traços, no padrão DDI + DDD + Número de telefone.

Example: "5511912345678"

emailstring

E-mail da pessoa. Torna-se obrigatório caso envie a notificação via E-mail.

Example: "teste@teste.com"

notificationsarray of object

Informações sobre as notificações. Caso não precise enviar notificações este parâmetro não é necessário.

notificationChannelstring

Canal de notificação. Valores possíveis: NOTIFICATION_CHANNEL_WHATSAPP, NOTIFICATION_CHANNEL_SMS e NOTIFICATION_CHANNEL_EMAIL (também é possível enviar as notificações em mais de um lugar, basta informar mais de um.)

Example: "NOTIFICATION_CHANNEL_WHATSAPP"

purpose*enum

Propósito do processo.

Example: "creditprocess"

creditprocessbiometryonboardingcarpurchase

expiresInstring

É o tempo de expiração do processo em segundos a partir de sua criação. Deve ser passado um valor no padrão "10080s", com "s" no fim. Caso este parâmetro não seja informado, será usado o valor default de 7 dias.

Example: "3600s"

contextualizationobject

Informações contextuais sobre o processo. Estes campos são apresentados na jornada para o usuário final, melhorando a conversão por contextualizá-lo do motivo da captura da biometria.

currencystring

Esse campo define a moeda que será usada para formatação do campo price. Para processos feitos no Brasil, utilizar a moeda "BRL".

Example: "BRL"

pricenumber

Esse campo define o valor que será exibido na contextualização do processo.

Example: 15990.9

localeobject

Localização e idioma do processo.

ptBrobject

Informações localizadas para o português do Brasil.

reasonstring

Esse campo define a informação que será exibida no campo de Motivo do processo.

Example: "Validação de identidade para contratação de empréstimo pessoal."

payloadarray of object

Array que contém as informações dos documentos. Todos os itens do array tornam-se obrigatórios caso utilize algum flow com assinatura eletrônica.

envelopePayloadobject

Objeto que contém as informações do documento. Só é possível ter um envelope por payload, mas é possível ter mais de um documento no mesmo envelope.

documentsarray of object

Informações do documento. É possível ter mais de um documento no mesmo envelope.

documentNamestring

Nome do documento que será assinado.

Example: "teste"

fileContentsstring

Documento que será assinado codificado em base64.

Example: "JVBERi0xLjMNCiXi48/[...]DQoNCnN0YXJ0eHJlZg0KMjcxNA0KJSVFT0YNCg=="

Response

Processo criado com sucesso.

Body

processobject

Informações sobre o processo by Unico.

idstring

ID do processo.

Example: "53060f52-f146-4c12-a234-5bb5031f6f5b"

companyBranchIdstring

É o ID da filial onde o processo foi criado. Caso não tenha sido passado nenhum valor de companyBranchId, este parêmtro não irá retornar no response.

Example: "60837cd3-ed3c-4038-ad7c-0a85ad64b03a"

flowenum

Fluxo escolhido.

Example: "iddocssign"

callbackUristring

URI de callback.

Example: "/path/to/callback-url/"

userRedirectUrlstring

URL que o usuário fará a jornada.

Example: "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b"

stateenum

Estado do processo. Valores possíveis: 'PROCESS_STATE_CREATED' - Processo criado; 'PROCESS_STATE_FAILED' - Processo com falha

Example: "PROCESS_STATE_CREATED"

PROCESS_STATE_CREATEDPROCESS_STATE_FAILED

personobject

Informações sobre o usuário.

duiTypestring

Tipo de documento de identificação.

Example: "DUI_TYPE_BR_CPF"

duiValuestring

Valor do documento de identificação.

Example: "73689290074"

friendlyNamestring

Nome da pessoa.

Example: "Luke Skywalker"

phonestring

Número de telefone da pessoa.

Example: "5511912345678"

emailstring

E-mail da pessoa.

Example: "teste@teste.com"

notificationsarray of object

Informações sobre as notificações.

notificationChannelstring

Canal de notificação.

Example: "NOTIFICATION_CHANNEL_WHATSAPP"

purposeenum

Propósito do processo.

Example: "creditprocess"

creditprocessbiometryonboardingcarpurchase

authenticationInfoobject

Informações da autenticação.

authenticationResultstring

Informações da verificação de identidade.

Example: "AUTHENTICATION_RESULT_UNSPECIFIED"

authenticationIdstring

ID da autenticação.

Example: ""

livenessResultstring

Informações da prova de vida.

Example: "LIVENESS_RESULT_UNSPECIFIED"

bioTokenEngineResultstring

Informações da validação 1:1.

Example: "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED"

identity_fraudsters_resultstring

Informações do alerta de comportamento.

Example: "TRUST_RESULT_UNSPECIFIED"

capacitiesarray of string

Capacidades do processo.

itemsstring

expiresAtstring

Data de expiração do processo.

Example: "2023-10-09T15:15:25.417105Z"

tokenstring

Token assinado que contém os parâmetros necessários para inicializar o SDK web do by Unico, permitindo integração via iFrame.

Example: "eyJhbGciOiJSUzI1[...]d_jhQ"

companyDataobject

Informações da empresa onde o processo foi criado. Referente ao campo 'companyBranchId'.

branchIdstring

Example: "60837cd3-ed3c-4038-ad7c-0a85ad64b03a"

countryCodestring

Example: "BRA"

Request

const response = await fetch('https://api.cadastro.uat.unico.app/client/v1/process/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "callbackUri": "/",
      "flow": "iddocssign",
      "purpose": "creditprocess"
    }),
});
const data = await response.json();

Response

{
  "process": {
    "id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
    "companyBranchId": "60837cd3-ed3c-4038-ad7c-0a85ad64b03a",
    "flow": "iddocssign",
    "callbackUri": "/path/to/callback-url/",
    "userRedirectUrl": "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b",
    "state": "PROCESS_STATE_CREATED",
    "person": {
      "duiType": "DUI_TYPE_BR_CPF",
      "duiValue": "73689290074",
      "friendlyName": "Luke Skywalker",
      "phone": "5511912345678",
      "email": "teste@teste.com",
      "notifications": [
        {
          "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
        }
      ]
    },
    "purpose": "creditprocess",
    "authenticationInfo": {
      "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
      "authenticationId": "",
      "livenessResult": "LIVENESS_RESULT_UNSPECIFIED",
      "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED",
      "identity_fraudsters_result": "TRUST_RESULT_UNSPECIFIED"
    },
    "capacities": [
      [
        "PROCESS_CAPACITY_IDUNICO",
        "PROCESS_CAPACITY_IDCHECK",
        "PROCESS_CAPACITY_IDDOCS"
      ]
    ],
    "expiresAt": "2023-10-09T15:15:25.417105Z",
    "token": "eyJhbGciOiJSUzI1[...]d_jhQ",
    "companyData": {
      "branchId": "60837cd3-ed3c-4038-ad7c-0a85ad64b03a",
      "countryCode": "BRA"
    }
  }
}

Os processos devem ser criados exclusivamente em uma comunicação backend-to-backend, devido à nossa política de CORS, que impede a criação de processos em uma comunicação frontend-to-backend.

Dicas:

Para mais informações sobre os cenários que pode receber no response, consulte a seção Cenários de response;
Para mais informações sobre os erros possíveis para este endpoint, consulte a seção Erros.

Dúvidas?

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.

Exemplos de responses por flow

Nesta seção, você encontrará todos os cenários de response para processos finalizados no by Unico

Responses separadas por flows

{
    "process": {
        "id": "c0dcbf87-76b2-431c-9d8e-e9ac644be642",
        "flow": "idlive",
        "callbackUri": "/",
        "userRedirectUrl": "https://cadastro.unico.app/process/c0dcbf87-76b2-431c-9d8e-e9ac644be642",
        "state": "PROCESS_STATE_FINISHED",
        "result": "PROCESS_RESULT_OK",
        "createdAt": "2024-12-23T13:23:49.540865Z",
        "finishedAt": "2024-12-23T13:24:35.485202Z",
        "person": {
            "duiType": "DUI_TYPE_BR_CPF",
            "duiValue": "12345678909",
            "friendlyName": "",
            "email": "luke@unico.io",
            "phone": "5511999995555",
            "notifications": [
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
                }
            ]
        },
        "purpose": "creditprocess",
        "services": [],
        "authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_FALSE",
                "score": 0
            },
            "authenticationId": "02e2bef1-cad8-435d-9aa9-d4bb7295e7b0",
            "livenessResult": "LIVENESS_RESULT_LIVE",
            "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED",
            "identityFraudstersResult": "TRUST_RESULT_UNSPECIFIED"
        },
        "capacities": [
            "PROCESS_CAPACITY_IDLIVE"
        ],
        "expiresAt": "2024-12-30T13:23:49.540458Z",
        "token": "",
        "companyData": {
            "branchId": "",
            "countryCode": "BRA"
        }
    }
}

{
    "process": {
        "id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
        "flow": "id",
        "callbackUri": "/path/to/callback-url/",
        "userRedirectUrl": "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b",
        "state": "PROCESS_STATE_FINISHED",
        "result": "PROCESS_RESULT_OK",
        "person": {
            "duiType": "DUI_TYPE_BR_CPF",
            "duiValue": "73689290074",
            "friendlyName": "John Doe",
            "notifications": [
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
                },
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_SMS"
                }
            ],
        },
        "purpose": "creditprocess",
        "authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE",
            "authenticationId": "fd433602-d496-4291-adbb-dda95a3e50b1",
            "livenessResult": "LIVENESS_RESULT_LIVE",
            "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED",
            "identityFraudstersResult": "TRUST_RESULT_UNSPECIFIED"
        },
        "capacities": [
            "PROCESS_CAPACITY_IDUNICO",
            "PROCESS_CAPACITY_IDLIVE"
        ],        
        "createdAt": "2023-10-05T18:28:58.537985Z",
        "finishedAt": "2023-10-09T15:15:25.417105Z",
        "expiresAt": "2024-12-30T13:23:49.540458Z",
        "token": "",
        "companyData": {
            "branchId": "",
            "countryCode": "BRA"
        }
    }
}

{
    "process": {
        "id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
        "flow": "idcheck",
        "callbackUri": "/path/to/callback-url/",
        "userRedirectUrl": "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b",
        "state": "PROCESS_STATE_FINISHED",
        "result": "PROCESS_RESULT_OK",
        "person": {
            "duiType": "DUI_TYPE_BR_CPF",
            "duiValue": "73689290074",
            "friendlyName": "John Doe",
            "notifications": [
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
                },
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_SMS"
                }
            ],
        },
        "purpose": "creditprocess",
        "authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_TRUE",
                "score": 50
            },
            "authenticationId": "fd433602-d496-4291-adbb-dda95a3e50b1",
            "livenessResult": "LIVENESS_RESULT_LIVE",
            "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED",
            "identityFraudstersResult": "TRUST_RESULT_UNSPECIFIED"
        },
        "capacities": [
            "PROCESS_CAPACITY_IDLIVE",
            "PROCESS_CAPACITY_IDUNICO",
            "PROCESS_CAPACITY_IDCHECK"
        ],        
        "createdAt": "2023-10-05T18:28:58.537985Z",
        "finishedAt": "2023-10-09T15:15:25.417105Z",
        "expiresAt": "2024-12-30T13:23:49.540458Z",
        "token": "",
        "companyData": {
            "branchId": "",
            "countryCode": "BRA"
        }
    }
}

{
    "process": {
        "id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
        "flow": "iddocs",
        "callbackUri": "/path/to/callback-url/",
        "userRedirectUrl": "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b",
        "state": "PROCESS_STATE_FINISHED",
        "result": "PROCESS_RESULT_OK",
        "person": {
            "duiType": "DUI_TYPE_BR_CPF",
            "duiValue": "73689290074",
            "friendlyName": "John Doe",
            "notifications": [
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
                },
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_SMS"
                }
            ],
        },
        "purpose": "creditprocess",
        "authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_TRUE",
                "score": 50
            },
            "authenticationId": "fd433602-d496-4291-adbb-dda95a3e50b1",
            "livenessResult": "LIVENESS_RESULT_LIVE",
            "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED",
            "identityFraudstersResult": "TRUST_RESULT_UNSPECIFIED"
        },
        "capacities": [
            "PROCESS_CAPACITY_IDLIVE",
            "PROCESS_CAPACITY_IDUNICO",
            "PROCESS_CAPACITY_IDCHECK",
            "PROCESS_CAPACITY_IDDOCS"
        ],        
        "services": [
            {
                 "documents": [
                    {
                        "doc": {
                            "version": 2,
                            "code": "RG",
                            "data": {
                                "dataExpiracao": "2025-10-35T00:00:00Z",
                                "dataHabilitacao": "2022-08-09T00:00:00Z",
                                "dataNascimento": "1950-06-30T00:00:00Z",
                                "nomeCivil": "John Doe",
                                "rgNumero": "5478854",
                                "categoria": "D",
                                "cpfNumero": "73689290074",
                                "dataEmissao": "2020-08-09T00:00:00Z",
                                "localEmissao": "DEREX SP",
                                "numero": "85775532778",
                                "renachNumero": ""
                            },
                        },
                        "typified": true,
                        "cpf_match": true,
                        "face_match": true,
                        "doc_id": "1e61a978-3673-4fdd-8fa8-808d0a26d131",
                        "validate_doc": true,
                        "reused_doc": true,                        
                        "signed_url": "https://api.datafortress.dev.private.unico.run/url-signer/signature/dmF1bHQ6[...]OXc9PQ%3D%3D"
                    }
                ],
                "consent_granted": true
            }
        ],
        "createdAt": "2023-10-05T18:28:58.537985Z",
        "finishedAt": "2023-10-09T15:15:25.417105Z",
        "expiresAt": "2024-12-30T13:23:49.540458Z",
        "token": "",
        "companyData": {
            "branchId": "",
            "countryCode": "BRA"
        }
    }
}

{
    "process": {
        "id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
        "flow": "idsign",
        "callbackUri": "/path/to/callback-url/",
        "userRedirectUrl": "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b",
        "state": "PROCESS_STATE_FINISHED",
        "result": "PROCESS_RESULT_OK",
        "person": {
            "duiType": "DUI_TYPE_BR_CPF",
            "duiValue": "73689290074",
            "friendlyName": "John Doe",
            "notifications": [
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
                },
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_SMS"
                }
            ],
        },
        "purpose": "creditprocess",
        "authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_TRUE",
                "score": 50
            },
            "authenticationId": "fd433602-d496-4291-adbb-dda95a3e50b1",
            "livenessResult": "LIVENESS_RESULT_LIVE",
            "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED",
            "identityFraudstersResult": "TRUST_RESULT_UNSPECIFIED"
        },
        "capacities": [
            "PROCESS_CAPACITY_IDLIVE",
            "PROCESS_CAPACITY_IDUNICO",
            "PROCESS_CAPACITY_IDCHECK",
            "PROCESS_CAPACITY_IDSIGN"
        ],        
        "services": [
            {
                "envelopeId": "4d4f3d90-04a3-4259-b63b-930ab10d2e47",
                "documentIds": [
                    "03307601-b518-49ca-b368-ae3919e24e54"
                ]    
            },
        ],
        "createdAt": "2023-10-05T18:28:58.537985Z",
        "finishedAt": "2023-10-09T15:15:25.417105Z",
        "expiresAt": "2024-12-30T13:23:49.540458Z",
        "token": "",
        "companyData": {
            "branchId": "",
            "countryCode": "BRA"
        }
    }
}

{
    "process": {
        "id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
        "flow": "iddocssign",
        "callbackUri": "/path/to/callback-url/",
        "userRedirectUrl": "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b",
        "state": "PROCESS_STATE_FINISHED",
        "result": "PROCESS_RESULT_OK",
        "person": {
            "duiType": "DUI_TYPE_BR_CPF",
            "duiValue": "73689290074",
            "friendlyName": "John Doe",
            "notifications": [
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
                },
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_SMS"
                }
            ],
        },
        "purpose": "creditprocess",
        "authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_TRUE",
                "score": 50
            },
            "authenticationId": "fd433602-d496-4291-adbb-dda95a3e50b1",
            "livenessResult": "LIVENESS_RESULT_LIVE",
            "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED",
            "identityFraudstersResult": "TRUST_RESULT_UNSPECIFIED"
        },
        "capacities": [
            "PROCESS_CAPACITY_IDUNICO",
            "PROCESS_CAPACITY_IDCHECK",
            "PROCESS_CAPACITY_IDDOCS",
            "PROCESS_CAPACITY_IDSIGN",
            "PROCESS_CAPACITY_IDLIVE"
        ],
        "services": [
            {
                "documents": [
                    {
                        "doc": {
                            "version": 2,
                            "code": "RG",
                            "data": {
                                "dataExpiracao": "2025-10-35T00:00:00Z",
                                "dataHabilitacao": "2022-08-09T00:00:00Z",
                                "dataNascimento": "1950-06-30T00:00:00Z",
                                "nomeCivil": "John Doe",
                                "rgNumero": "5478854",
                                "categoria": "D",
                                "cpfNumero": "73689290074",
                                "dataEmissao": "2020-08-09T00:00:00Z",
                                "localEmissao": "DEREX SP",
                                "numero": "85775532778",
                                "renachNumero": ""
                            },
                        },
                        "typified": true,
                        "cpf_match": true,
                        "face_match": true,
                        "doc_id": "1e61a978-3673-4fdd-8fa8-808d0a26d131",
                        "validate_doc": true,
                        "reused_doc": true,                        
                        "signed_url": "https://api.datafortress.dev.private.unico.run/url-signer/signature/dmF1bHQ6[...]OXc9PQ%3D%3D"
                    }
                ],
                "consent_granted": true
            },
            {
                "envelopeId": "4d4f3d90-04a3-4259-b63b-930ab10d2e47",
                "documentIds": [
                    "03307601-b518-49ca-b368-ae3919e24e54"
                ]
            }
        ],
        "createdAt": "2023-10-05T18:28:58.537985Z",
        "finishedAt": "2023-10-09T15:15:25.417105Z",
        "expiresAt": "2024-12-30T13:23:49.540458Z",
        "token": "",
        "companyData": {
            "branchId": "",
            "countryCode": "BRA"
        }
    }
}

{
    "process": {
        "id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
        "flow": "idcheckserpro",
        "callbackUri": "/path/to/callback-url/",
        "userRedirectUrl": "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b",
        "state": "PROCESS_STATE_FINISHED",
        "result": "PROCESS_RESULT_OK",
        "person": {
            "duiType": "DUI_TYPE_BR_CPF",
            "duiValue": "73689290074",
            "friendlyName": "John Doe",
            "notifications": [
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
                },
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_SMS"
                }
            ],
        },
        "purpose": "creditprocess",
        "authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_TRUE",
                "score": 50
            },
            "authenticationId": "fd433602-d496-4291-adbb-dda95a3e50b1",
            "livenessResult": "LIVENESS_RESULT_LIVE",
            "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED",
            "identityFraudstersResult": "TRUST_RESULT_UNSPECIFIED",
            "serproResult": {
                "score": 50
            }
        },
        "capacities": [
            "PROCESS_CAPACITY_IDLIVE",
            "PROCESS_CAPACITY_IDUNICO",
            "PROCESS_CAPACITY_IDCHECK"
        ],        
        "createdAt": "2023-10-05T18:28:58.537985Z",
        "finishedAt": "2023-10-09T15:15:25.417105Z",
        "expiresAt": "2024-12-30T13:23:49.540458Z",
        "token": "",
        "companyData": {
            "branchId": "",
            "countryCode": "BRA"
        }
    }
}

{
    "process": {
        "id": "ede08bf6-e167-4249-9501-2a93b5d1ffc3",
        "flow": "idtoken",
        "callbackUri": "/",
        "userRedirectUrl": "https://cadastro.uat.unico.app/process/ede08bf6-e167-4249-9501-2a93b5d1ffc3",
        "state": "PROCESS_STATE_FINISHED",
        "result": "PROCESS_RESULT_OK",
        "createdAt": "2024-10-28T19:54:23.313015Z",
        "finishedAt": "2024-10-28T20:02:43.620300Z",
        "person": {
            "duiType": "DUI_TYPE_BR_CPF",
            "duiValue": "12345678909",
            "email": "luke@unico.co",
            "phone": "5521999249999",
            "notifications": [
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
                },
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_EMAIL"
                },
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_SMS"
                }
            ]
        },
        "purpose": "creditprocess",
        "authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
            "authenticationId": "c95ea805-b001-4926-a99e-c0be7ef0b663",
            "livenessResult": "LIVENESS_RESULT_LIVE",
            "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_POSITIVE",
            "identityFraudstersResult": "TRUST_RESULT_UNSPECIFIED",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_FALSE",
                "score": 0
            },
        },
        "capacities": [
            "PROCESS_CAPACITY_IDLIVE",
            "PROCESS_CAPACITY_IDTOKEN"
        ],
        "expiresAt": "2024-12-30T13:23:49.540458Z",
        "token": "",
        "companyData": {
            "branchId": "",
            "countryCode": "BRA"
        }
    }
}

Dúvidas?

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.

Cenários de response

Nesta seção, você encontrará todos os cenários de response do by Unico, independentemente se os processos estão finalizados ou não

Flow id

Cenário: Processo criado

Ocorre quando o processo foi criado, porém ainda não foi finalizado pelo usuário.

state

result

PROCESS_STATE_CREATED

PROCESS_RESULT_UNSPECIFIED

CreateProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_UNSPECIFIED",
                "score": 0
            },
            "authenticationId": "",
            "livenessResult": "LIVENESS_RESULT_UNSPECIFIED"
        }

GetProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_UNSPECIFIED",
                "score": 0
            },
            "authenticationId": "",
            "livenessResult": "LIVENESS_RESULT_UNSPECIFIED"
        }

Cenário: Processo criado com erro

Ocorre quando o processo foi criado, porém houve algum erro no serviço.

state

result

PROCESS_STATE_FAILED

PROCESS_RESULT_ERROR

CreateProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_UNSPECIFIED",
                "score": 0
            },
            "authenticationId": "",
            "livenessResult": "LIVENESS_RESULT_UNSPECIFIED"
        }

GetProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_UNSPECIFIED",
                "score": 0
            },
            "authenticationId": "",
            "livenessResult": "LIVENESS_RESULT_UNSPECIFIED"
        }

Cenário: Processo finalizado e aprovado no IDUnico

Ocorre quando o processo foi criado, finalizado pelo usuário e teve retorno POSITIVO do IDUnico.

state

result

PROCESS_STATE_FINISHED

PROCESS_RESULT_OK

GetProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_POSITIVE",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_FALSE",
                "score": 0
            },
            "authenticationId": "652f8864-c364-4cc7-9abb-d38a86d21d66",
            "livenessResult": "LIVENESS_RESULT_LIVE"
        }

Cenário: Processo finalizado e inconclusivo no IDUnico

Ocorre quando o processo foi criado, finalizado pelo usuário, mas teve retorno INCONCLUSIVO do IDUnico.

state

result

PROCESS_STATE_FINISHED

PROCESS_RESULT_OK

GetProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_FALSE",
                "score": 0
            },
            "authenticationId": "652f8864-c364-4cc7-9abb-d38a86d21d66",
            "livenessResult": "LIVENESS_RESULT_LIVE"
        }

Cenário: Processo finalizado e recusado no IDUnico

Ocorre quando o processo foi criado, finalizado pelo usuário e teve retorno NEGATIVO do IDUnico.

state

result

PROCESS_STATE_FINISHED

PROCESS_RESULT_INVALID_IDENTITY

GetProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_NEGATIVE",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_FALSE",
                "score": 0
            },
            "authenticationId": "652f8864-c364-4cc7-9abb-d38a86d21d66",
            "livenessResult": "LIVENESS_RESULT_LIVE"
        }

Cenário: Processo finalizado e com falha na Prova de Vida

Ocorre quando o processo foi criado, finalizado pelo usuário, mas teve retorno de falha na prova de vida.

state

result

PROCESS_STATE_FINISHED

PROCESS_RESULT_INVALID_IDENTITY

GetProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_UNSPECIFIED",
                "score": 0
            },
            "authenticationId": "",
            "livenessResult": "LIVENESS_RESULT_NOT_LIVE"
        }

Flow idcheck

Cenário: Processo criado

Ocorre quando o processo foi criado, porém ainda não foi finalizado pelo usuário.

state

result

PROCESS_STATE_CREATED

PROCESS_RESULT_UNSPECIFIED

CreateProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_UNSPECIFIED",
                "score": 0
            },
            "authenticationId": "",
            "livenessResult": "LIVENESS_RESULT_UNSPECIFIED"
        }

GetProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_UNSPECIFIED",
                "score": 0
            },
            "authenticationId": "",
            "livenessResult": "LIVENESS_RESULT_UNSPECIFIED"
        }

Cenário: Processo criado com erro

Ocorre quando o processo foi criado, porém houve algum erro no serviço.

state

result

PROCESS_STATE_FAILED

PROCESS_RESULT_ERROR

CreateProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_UNSPECIFIED",
                "score": 0
            },
            "authenticationId": "",
            "livenessResult": "LIVENESS_RESULT_UNSPECIFIED"
        }

GetProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_UNSPECIFIED",
                "score": 0
            },
            "authenticationId": "",
            "livenessResult": "LIVENESS_RESULT_UNSPECIFIED"
        }

Cenário: Processo finalizado e aprovado no IDUnico

Ocorre quando o processo foi criado, finalizado pelo usuário e teve retorno POSITIVO do IDUnico.

state

result

PROCESS_STATE_FINISHED

PROCESS_RESULT_OK

GetProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_POSITIVE",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_TRUE",
                "score": 0
            },
            "authenticationId": "8b2516fa-0c83-44ef-a365-3269e425166d",
            "livenessResult": "LIVENESS_RESULT_LIVE"
        }

Cenário: Processo finalizado com sucesso, inconclusivo no IDUnico e com score no IDCheck

Ocorre quando o processo foi criado, finalizado pelo usuário, teve retorno INCONCLUSIVO do IDUnico e teve um Score válido no IDCheck.

state

result

PROCESS_STATE_FINISHED

PROCESS_RESULT_OK

GetProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_TRUE",
                "score": 10
            },
            "authenticationId": "09f14518-e083-44c2-bd32-2d0a56426711",
            "livenessResult": "LIVENESS_RESULT_LIVE"
        }

Cenário: Processo finalizado com sucesso, inconclusivo no IDUnico e descartado por divergência no IDCheck

state

result

PROCESS_STATE_FINISHED

PROCESS_RESULT_INVALID_IDENTITY

GetProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_UNSPECIFIED",
                "score": 0
            },
            "authenticationId": "",
            "livenessResult": "LIVENESS_RESULT_UNSPECIFIED"
        }

Cenário: Processo finalizado e recusado no IDUnico

Ocorre quando o processo foi criado, finalizado pelo usuário e teve retorno NEGATIVO do IDUnico.

state

result

PROCESS_STATE_FINISHED

PROCESS_RESULT_INVALID_IDENTITY

GetProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_NEGATIVE",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_FALSE",
                "score": 0
            },
            "authenticationId": "652f8864-c364-4cc7-9abb-d38a86d21d66",
            "livenessResult": "LIVENESS_RESULT_LIVE"
        }

Cenário: Processo finalizado com sucesso e com falha na Prova de Vida

Ocorre quando o processo foi criado, finalizado pelo usuário, porém não foi possível validar que usuário que capturou a face estava ao vivo no momento da captura.

state

result

PROCESS_STATE_FINISHED

PROCESS_RESULT_INVALID_IDENTITY

GetProcess

"authenticationInfo": {
            "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_UNSPECIFIED",
                "score": 0
            },
            "authenticationId": "",
            "livenessResult": "LIVENESS_RESULT_NOT_LIVE"
        }

Para verificar detalhadamente os parâmetros da API, consulte a seção Especificação de parâmetros.

Dúvidas?

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.

Consultar Resultado do Processo

Endpoint para buscar o resultado de um processo no by Unico.

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

Authorization

Path parameters

processId*string

ID do processo.

Response

Detalhes do processo obtidos com sucesso.

Body

processobject

Informações do processo by Unico.

idstring

ID do processo.

Example: "53060f52-f146-4c12-a234-5bb5031f6f5b"

flowenum

Fluxo utilizado no processo.

Example: "iddocssign"

callbackUristring

URI de callback.

Example: "/path/to/callback-url/"

userRedirectUrlstring

URL de redirecionamento do usuário.

Example: "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b"

stateenum

Estado do processo. Valores possíveis: 'PROCESS_STATE_CREATED' - Processo criado; 'PROCESS_STATE_FINISHED' - Processo finalizado; PROCESS_STATE_FAILED' - Processo com falha.

Example: "PROCESS_STATE_FINISHED"

PROCESS_STATE_CREATEDPROCESS_STATE_FAILEDPROCESS_STATE_FINISHED

resultenum

Resultado do processo. Valores possíveis: 'PROCESS_RESULT_OK' - Processo finalizado com sucesso; 'PROCESS_RESULT_ERROR' - Processo finalizado com erro; 'PROCESS_RESULT_INVALID_IDENTITY' - Processo finalizado com com falha no liveness, ou resultado de inconclusivo/no quando flow = ID, ou quando no flow = IDCheck, houver uma divergência demorando mais que o tempo estabelecido; 'PROCESS_RESULT_UNSPECIFIED' - É retornado quando o cliente utiliza o flow ID. Processo finalizado com resultado não especificado; 'PROCESS_RESULT_REFUSED' - Quando o cliente não reconhece a transação.

Example: "PROCESS_RESULT_OK"

PROCESS_RESULT_OKPROCESS_RESULT_ERRORPROCESS_RESULT_INVALID_IDENTITYPROCESS_RESULT_UNSPECIFIEDPROCESS_RESULT_REFUSED

personobject

duiTypestring

Tipo de documento de identificação.

Example: "DUI_TYPE_BR_CPF"

duiValuestring

Valor do documento de identificação.

Example: "73689290074"

friendlyNamestring

Nome da pessoa.

Example: "Luke Skywalker"

notificationsarray of object

Informações sobre as notificações.

notificationChannelstring

Canal de notificação.

Example: "NOTIFICATION_CHANNEL_WHATSAPP"

purposeenum

Propósito do processo.

Example: "creditprocess"

creditprocessbiometryonboardingcarpurchase

authenticationInfoobject

Informações da autenticação.

authenticationResultenum

Resultado da capacidade Verificação de Identidade. Valores possíveis: 'AUTHENTICATION_RESULT_UNSPECIFIED' - retorno caso não use o flow com Verificação de Identidade ou alguma falha; 'AUTHENTICATION_RESULT_INCONCLUSIVE' - não conseguimos afirmar com precisão se a face é a titular do CPF. Único retorno onde haverá a orquestração com o Score de risco; 'AUTHENTICATION_RESULT_POSITIVE' - a face é a do titular do CPF; AUTHENTICATION_RESULT_NEGATIVE - a face não é a do titular do CPF.

Example: "AUTHENTICATION_RESULT_INCONCLUSIVE"

AUTHENTICATION_RESULT_UNSPECIFIEDAUTHENTICATION_RESULT_INCONCLUSIVEAUTHENTICATION_RESULT_POSITIVEAUTHENTICATION_RESULT_NEGATIVE

authenticationIdstring

ID da autenticação.

Example: "fd433602-d496-4291-adbb-dda95a3e50b1"

livenessResultenum

Resultado da capacidade Prova de vida. Valores possíves: 'LIVENESS_RESULT_UNSPECIFIED' - está associado a alguma falha; 'LIVENESS_RESULT_LIVE' - o usuário estava ao vivo no momento da captura; 'LIVENESS_RESULT_NOT_LIVE' - o usuário não estava ao vivo no momento da captura.

Example: "LIVENESS_RESULT_LIVE"

LIVENESS_RESULT_UNSPECIFIEDLIVENESS_RESULT_LIVELIVENESS_RESULT_NOT_LIVE

bioTokenEngineResultenum

Resultado da capacidade Validação 1:1. Valores possíveis: 'BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED' - retorno caso não use o flow com Validação 1:1 ou alguma falha; 'BIO_TOKEN_ENGINE_RESULT_POSITIVE' - a face do usuário é a mesma do processo de referência; 'BIO_TOKEN_ENGINE_RESULT_NEGATIVE' - a face do usuário não é a mesma do processo de referência

Example: "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED"

BIO_TOKEN_ENGINE_RESULT_UNSPECIFIEDBIO_TOKEN_ENGINE_RESULT_POSITIVEBIO_TOKEN_ENGINE_RESULT_NEGATIVE

identityFraudstersResultenum

Resultado da capacidade Alerta de Comportamento. Valores possíveis: 'TRUST_RESULT_UNSPECIFIED' - retorno caso não use o flow com Alerta de comportamento ou alguma falha; 'TRUST_RESULT_INCONCLUSIVE' - não encontramos nenhum indicativo de fraude com esta face; 'TRUST_RESULT_YES' - encontramos fraudes associadas a esta face.

Example: "TRUST_RESULT_UNSPECIFIED"

TRUST_RESULT_UNSPECIFIEDTRUST_RESULT_INCONCLUSIVETRUST_RESULT_YES

scoreEngineResultobject

Informações da capacidade Score de risco.

scoreEnabledenum

Indica se o score está habilitado.

Example: "SCORE_ENABLED_TRUE"

SCORE_ENABLED_TRUESCORE_ENABLED_FALSE

scorenumber

Resultado da capacidade Score de risco. Só é devolvido um score que deva ser interpretado nos casos onde o authenticatioResult é AUTHENTICATION_RESULT_INCONCLUSIVE.

Example: 50

serproResultobject

Informações do score de similaridade da Serpro. Só é devolvido para os flows com idSerpro.

scorenumber

Resultado da funcionalidade Score de similaridade da Serpro.

Example: 50

capacitiesarray of string

Capacidades do processo.

itemsstring

servicesarray of object

Informações do uso de documentos e/ou assinatura eletrônica.

documentsarray of object

docobject

versionnumber

Versão do documento.

Example: 2

codestring

Código do documento.

Example: "RG"

dataobject

dataExpiracaostring

Data de expiração do documento.

Example: "2025-10-35T00:00:00Z"

dataHabilitacaostring

Data de habilitação do documento.

Example: "2022-08-09T00:00:00Z"

dataNascimentostring

Data de nascimento da pessoa.

Example: "1950-06-30T00:00:00Z"

nomeCivilstring

Nome civil da pessoa.

Example: "John Doe"

rgNumerostring

Número do RG.

Example: 5478854

categoriastring

Categoria.

Example: "D"

cpfNumerostring

Número do CPF.

Example: 73689290074

dataEmissaostring

Data de emissão do documento.

Example: "2020-08-09T00:00:00Z"

localEmissaostring

Local de emissão do documento.

Example: "DEREX SP"

numerostring

Número do documento.

Example: 85775532778

renachNumerostring

Número do RENACH.

Example: ""

typifiedboolean

Indica se o documento foi tipificado.

Example: true

cpf_matchboolean

Indica se o CPF confere com o documento.

Example: true

face_matchboolean

Indica se o rosto confere com o documento.

Example: true

doc_idstring

ID do documento.

Example: "1e61a978-3673-4fdd-8fa8-808d0a26d131"

validate_docboolean

Indica se o documento foi validado.

Example: true

reused_docboolean

Indica se o documento foi reutilizado.

Example: true

signed_urlstring

URL assinada para o documento.

Example: "https://api.datafortre[...]OXc9PQ%3D%3D"

consent_grantedboolean

Indica se o consentimento foi concedido.

Example: true

envelopeIdstring

ID do envelope de documentos.

Example: "4d4f3d90-04a3-4259-b63b-930ab10d2e47"

documentIdsarray of string

IDs dos documentos.

itemsstring

createdAtstring

Data de criação do processo.

Example: "2023-10-05T18:28:58.537985Z"

finishedAtstring

Data de finalização do processo.

Example: "2023-10-09T15:15:25.417105Z"

expiresAtstring

Data de expiração do processo.

Example: "2023-10-09T15:15:25.417105Z"

companyDataobject

Informações da empresa onde o processo foi criado. Referente ao campo 'companyBranchId', utilizado na criação do processo.

branchIdstring

Example: "60837cd3-ed3c-4038-ad7c-0a85ad64b03a"

countryCodestring

Example: "BRA"

Request

const response = await fetch('https://api.cadastro.uat.unico.app/client/v1/process/{processId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

{
  "process": {
    "id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
    "flow": "iddocssign",
    "callbackUri": "/path/to/callback-url/",
    "userRedirectUrl": "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b",
    "state": "PROCESS_STATE_FINISHED",
    "result": "PROCESS_RESULT_OK",
    "person": {
      "duiType": "DUI_TYPE_BR_CPF",
      "duiValue": "73689290074",
      "friendlyName": "Luke Skywalker",
      "notifications": [
        {
          "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
        }
      ]
    },
    "purpose": "creditprocess",
    "authenticationInfo": {
      "authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE",
      "authenticationId": "fd433602-d496-4291-adbb-dda95a3e50b1",
      "livenessResult": "LIVENESS_RESULT_LIVE",
      "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED",
      "identityFraudstersResult": "TRUST_RESULT_UNSPECIFIED",
      "scoreEngineResult": {
        "scoreEnabled": "SCORE_ENABLED_TRUE",
        "score": 50
      },
      "serproResult": {
        "score": 50
      }
    },
    "capacities": [
      "PROCESS_CAPACITY_IDUNICO",
      "PROCESS_CAPACITY_IDCHECK",
      "PROCESS_CAPACITY_IDDOCS",
      "PROCESS_CAPACITY_IDSIGN",
      "PROCESS_CAPACITY_IDLIVE"
    ],
    "services": [
      {
        "documents": [
          {
            "doc": {
              "version": 2,
              "code": "RG",
              "data": {
                "dataExpiracao": "2025-10-35T00:00:00Z",
                "dataHabilitacao": "2022-08-09T00:00:00Z",
                "dataNascimento": "1950-06-30T00:00:00Z",
                "nomeCivil": "John Doe",
                "rgNumero": 5478854,
                "categoria": "D",
                "cpfNumero": 73689290074,
                "dataEmissao": "2020-08-09T00:00:00Z",
                "localEmissao": "DEREX SP",
                "numero": 85775532778,
                "renachNumero": ""
              }
            },
            "typified": true,
            "cpf_match": true,
            "face_match": true,
            "doc_id": "1e61a978-3673-4fdd-8fa8-808d0a26d131",
            "validate_doc": true,
            "reused_doc": true,
            "signed_url": "https://api.datafortre[...]OXc9PQ%3D%3D"
          }
        ],
        "consent_granted": true,
        "envelopeId": "4d4f3d90-04a3-4259-b63b-930ab10d2e47",
        "documentIds": [
          "03307601-b518-49ca-b368-ae3919e24e54"
        ]
      }
    ],
    "createdAt": "2023-10-05T18:28:58.537985Z",
    "finishedAt": "2023-10-09T15:15:25.417105Z",
    "expiresAt": "2023-10-09T15:15:25.417105Z",
    "companyData": {
      "branchId": "60837cd3-ed3c-4038-ad7c-0a85ad64b03a",
      "countryCode": "BRA"
    }
  }
}

Criar Processo

Endpoint para criar um novo processo no by Unico.

POSThttps://api.cadastro.uat.unico.app/client/v1/process/

Authorization

Body

callbackUri*string

Example: "/"

flow*enum

Tipo de fluxo. Veja detalhes dos fluxos na seção 'Visão Geral' nesta mesma documentação.

Example: "iddocssign"

companyBranchIdstring

Example: "60837cd3-ed3c-4038-ad7c-0a85ad64b03a"

bioTokenIdstring

Identificação do token biométrico. Obrigatório para o flow "idtoken" e deve-se utilizar um id de um processo concluído de qualquer outro flow de verificação de identidade.

Example: "60837cd3-ed3c-4038-ad7c-0a85ad64b03a"

personobject

Informações do usuário.

duiType*string

Tipo de documento de identificação. Deve-se utilizar "DUI_TYPE_BR_CPF" ter o CPF como identificador.

Example: "DUI_TYPE_BR_CPF"

duiValue*string

Valor do documento de identificação (ex: número do CPF). Deve conter 11 caracteres e ser enviado sem pontos ou traços.

Example: "12345678909"

friendlyNamestring

Nome da pessoa.

Example: "Luke Skywalker"

phonestring

Example: "5511912345678"

emailstring

E-mail da pessoa. Torna-se obrigatório caso envie a notificação via E-mail.

Example: "teste@teste.com"

notificationsarray of object

Informações sobre as notificações. Caso não precise enviar notificações este parâmetro não é necessário.

notificationChannelstring

Example: "NOTIFICATION_CHANNEL_WHATSAPP"

purpose*enum

Propósito do processo.

Example: "creditprocess"

creditprocessbiometryonboardingcarpurchase

expiresInstring

Example: "3600s"

contextualizationobject

Informações contextuais sobre o processo. Estes campos são apresentados na jornada para o usuário final, melhorando a conversão por contextualizá-lo do motivo da captura da biometria.

currencystring

Esse campo define a moeda que será usada para formatação do campo price. Para processos feitos no Brasil, utilizar a moeda "BRL".

Example: "BRL"

pricenumber

Esse campo define o valor que será exibido na contextualização do processo.

Example: 15990.9

localeobject

Localização e idioma do processo.

ptBrobject

Informações localizadas para o português do Brasil.

reasonstring

Esse campo define a informação que será exibida no campo de Motivo do processo.

Example: "Validação de identidade para contratação de empréstimo pessoal."

payloadarray of object

Array que contém as informações dos documentos. Todos os itens do array tornam-se obrigatórios caso utilize algum flow com assinatura eletrônica.

envelopePayloadobject

Objeto que contém as informações do documento. Só é possível ter um envelope por payload, mas é possível ter mais de um documento no mesmo envelope.

documentsarray of object

Informações do documento. É possível ter mais de um documento no mesmo envelope.

documentNamestring

Nome do documento que será assinado.

Example: "teste"

fileContentsstring

Documento que será assinado codificado em base64.

Example: "JVBERi0xLjMNCiXi48/[...]DQoNCnN0YXJ0eHJlZg0KMjcxNA0KJSVFT0YNCg=="

Response

Processo criado com sucesso.

Body

processobject

Informações sobre o processo by Unico.

idstring

ID do processo.

Example: "53060f52-f146-4c12-a234-5bb5031f6f5b"

companyBranchIdstring

É o ID da filial onde o processo foi criado. Caso não tenha sido passado nenhum valor de companyBranchId, este parêmtro não irá retornar no response.

Example: "60837cd3-ed3c-4038-ad7c-0a85ad64b03a"

flowenum

Fluxo escolhido.

Example: "iddocssign"

callbackUristring

URI de callback.

Example: "/path/to/callback-url/"

userRedirectUrlstring

URL que o usuário fará a jornada.

Example: "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b"

stateenum

Estado do processo. Valores possíveis: 'PROCESS_STATE_CREATED' - Processo criado; 'PROCESS_STATE_FAILED' - Processo com falha

Example: "PROCESS_STATE_CREATED"

PROCESS_STATE_CREATEDPROCESS_STATE_FAILED

personobject

Informações sobre o usuário.

duiTypestring

Tipo de documento de identificação.

Example: "DUI_TYPE_BR_CPF"

duiValuestring

Valor do documento de identificação.

Example: "73689290074"

friendlyNamestring

Nome da pessoa.

Example: "Luke Skywalker"

phonestring

Número de telefone da pessoa.

Example: "5511912345678"

emailstring

E-mail da pessoa.

Example: "teste@teste.com"

notificationsarray of object

Informações sobre as notificações.

notificationChannelstring

Canal de notificação.

Example: "NOTIFICATION_CHANNEL_WHATSAPP"

purposeenum

Propósito do processo.

Example: "creditprocess"

creditprocessbiometryonboardingcarpurchase

authenticationInfoobject

Informações da autenticação.

authenticationResultstring

Informações da verificação de identidade.

Example: "AUTHENTICATION_RESULT_UNSPECIFIED"

authenticationIdstring

ID da autenticação.

Example: ""

livenessResultstring

Informações da prova de vida.

Example: "LIVENESS_RESULT_UNSPECIFIED"

bioTokenEngineResultstring

Informações da validação 1:1.

Example: "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED"

identity_fraudsters_resultstring

Informações do alerta de comportamento.

Example: "TRUST_RESULT_UNSPECIFIED"

capacitiesarray of string

Capacidades do processo.

itemsstring

expiresAtstring

Data de expiração do processo.

Example: "2023-10-09T15:15:25.417105Z"

tokenstring

Token assinado que contém os parâmetros necessários para inicializar o SDK web do by Unico, permitindo integração via iFrame.

Example: "eyJhbGciOiJSUzI1[...]d_jhQ"

companyDataobject

Informações da empresa onde o processo foi criado. Referente ao campo 'companyBranchId'.

branchIdstring

Example: "60837cd3-ed3c-4038-ad7c-0a85ad64b03a"

countryCodestring

Example: "BRA"

Request

const response = await fetch('https://api.cadastro.uat.unico.app/client/v1/process/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "callbackUri": "/",
      "flow": "iddocssign",
      "purpose": "creditprocess"
    }),
});
const data = await response.json();

Response

{
  "process": {
    "id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
    "companyBranchId": "60837cd3-ed3c-4038-ad7c-0a85ad64b03a",
    "flow": "iddocssign",
    "callbackUri": "/path/to/callback-url/",
    "userRedirectUrl": "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b",
    "state": "PROCESS_STATE_CREATED",
    "person": {
      "duiType": "DUI_TYPE_BR_CPF",
      "duiValue": "73689290074",
      "friendlyName": "Luke Skywalker",
      "phone": "5511912345678",
      "email": "teste@teste.com",
      "notifications": [
        {
          "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
        }
      ]
    },
    "purpose": "creditprocess",
    "authenticationInfo": {
      "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
      "authenticationId": "",
      "livenessResult": "LIVENESS_RESULT_UNSPECIFIED",
      "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED",
      "identity_fraudsters_result": "TRUST_RESULT_UNSPECIFIED"
    },
    "capacities": [
      [
        "PROCESS_CAPACITY_IDUNICO",
        "PROCESS_CAPACITY_IDCHECK",
        "PROCESS_CAPACITY_IDDOCS"
      ]
    ],
    "expiresAt": "2023-10-09T15:15:25.417105Z",
    "token": "eyJhbGciOiJSUzI1[...]d_jhQ",
    "companyData": {
      "branchId": "60837cd3-ed3c-4038-ad7c-0a85ad64b03a",
      "countryCode": "BRA"
    }
  }
}

Consultar Resultado do Processo

Endpoint para buscar o resultado de um processo no by Unico.

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

Authorization

Path parameters

processId*string

ID do processo.

Response

Detalhes do processo obtidos com sucesso.

Body

processobject

Informações do processo by Unico.

idstring

ID do processo.

Example: "53060f52-f146-4c12-a234-5bb5031f6f5b"

flowenum

Fluxo utilizado no processo.

Example: "iddocssign"

callbackUristring

URI de callback.

Example: "/path/to/callback-url/"

userRedirectUrlstring

URL de redirecionamento do usuário.

Example: "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b"

stateenum

Estado do processo. Valores possíveis: 'PROCESS_STATE_CREATED' - Processo criado; 'PROCESS_STATE_FINISHED' - Processo finalizado; PROCESS_STATE_FAILED' - Processo com falha.

Example: "PROCESS_STATE_FINISHED"

PROCESS_STATE_CREATEDPROCESS_STATE_FAILEDPROCESS_STATE_FINISHED

resultenum

Example: "PROCESS_RESULT_OK"

PROCESS_RESULT_OKPROCESS_RESULT_ERRORPROCESS_RESULT_INVALID_IDENTITYPROCESS_RESULT_UNSPECIFIEDPROCESS_RESULT_REFUSED

personobject

duiTypestring

Tipo de documento de identificação.

Example: "DUI_TYPE_BR_CPF"

duiValuestring

Valor do documento de identificação.

Example: "73689290074"

friendlyNamestring

Nome da pessoa.

Example: "Luke Skywalker"

notificationsarray of object

Informações sobre as notificações.

notificationChannelstring

Canal de notificação.

Example: "NOTIFICATION_CHANNEL_WHATSAPP"

purposeenum

Propósito do processo.

Example: "creditprocess"

creditprocessbiometryonboardingcarpurchase

authenticationInfoobject

Informações da autenticação.

authenticationResultenum

Example: "AUTHENTICATION_RESULT_INCONCLUSIVE"

AUTHENTICATION_RESULT_UNSPECIFIEDAUTHENTICATION_RESULT_INCONCLUSIVEAUTHENTICATION_RESULT_POSITIVEAUTHENTICATION_RESULT_NEGATIVE

authenticationIdstring

ID da autenticação.

Example: "fd433602-d496-4291-adbb-dda95a3e50b1"

livenessResultenum

Example: "LIVENESS_RESULT_LIVE"

LIVENESS_RESULT_UNSPECIFIEDLIVENESS_RESULT_LIVELIVENESS_RESULT_NOT_LIVE

bioTokenEngineResultenum

Example: "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED"

BIO_TOKEN_ENGINE_RESULT_UNSPECIFIEDBIO_TOKEN_ENGINE_RESULT_POSITIVEBIO_TOKEN_ENGINE_RESULT_NEGATIVE

identityFraudstersResultenum

Example: "TRUST_RESULT_UNSPECIFIED"

TRUST_RESULT_UNSPECIFIEDTRUST_RESULT_INCONCLUSIVETRUST_RESULT_YES

scoreEngineResultobject

Informações da capacidade Score de risco.

scoreEnabledenum

Indica se o score está habilitado.

Example: "SCORE_ENABLED_TRUE"

SCORE_ENABLED_TRUESCORE_ENABLED_FALSE

scorenumber

Resultado da capacidade Score de risco. Só é devolvido um score que deva ser interpretado nos casos onde o authenticatioResult é AUTHENTICATION_RESULT_INCONCLUSIVE.

Example: 50

serproResultobject

Informações do score de similaridade da Serpro. Só é devolvido para os flows com idSerpro.

scorenumber

Resultado da funcionalidade Score de similaridade da Serpro.

Example: 50

capacitiesarray of string

Capacidades do processo.

itemsstring

servicesarray of object

Informações do uso de documentos e/ou assinatura eletrônica.

documentsarray of object

docobject

versionnumber

Versão do documento.

Example: 2

codestring

Código do documento.

Example: "RG"

dataobject

dataExpiracaostring

Data de expiração do documento.

Example: "2025-10-35T00:00:00Z"

dataHabilitacaostring

Data de habilitação do documento.

Example: "2022-08-09T00:00:00Z"

dataNascimentostring

Data de nascimento da pessoa.

Example: "1950-06-30T00:00:00Z"

nomeCivilstring

Nome civil da pessoa.

Example: "John Doe"

rgNumerostring

Número do RG.

Example: 5478854

categoriastring

Categoria.

Example: "D"

cpfNumerostring

Número do CPF.

Example: 73689290074

dataEmissaostring

Data de emissão do documento.

Example: "2020-08-09T00:00:00Z"

localEmissaostring

Local de emissão do documento.

Example: "DEREX SP"

numerostring

Número do documento.

Example: 85775532778

renachNumerostring

Número do RENACH.

Example: ""

typifiedboolean

Indica se o documento foi tipificado.

Example: true

cpf_matchboolean

Indica se o CPF confere com o documento.

Example: true

face_matchboolean

Indica se o rosto confere com o documento.

Example: true

doc_idstring

ID do documento.

Example: "1e61a978-3673-4fdd-8fa8-808d0a26d131"

validate_docboolean

Indica se o documento foi validado.

Example: true

reused_docboolean

Indica se o documento foi reutilizado.

Example: true

signed_urlstring

URL assinada para o documento.

Example: "https://api.datafortre[...]OXc9PQ%3D%3D"

consent_grantedboolean

Indica se o consentimento foi concedido.

Example: true

envelopeIdstring

ID do envelope de documentos.

Example: "4d4f3d90-04a3-4259-b63b-930ab10d2e47"

documentIdsarray of string

IDs dos documentos.

itemsstring

createdAtstring

Data de criação do processo.

Example: "2023-10-05T18:28:58.537985Z"

finishedAtstring

Data de finalização do processo.

Example: "2023-10-09T15:15:25.417105Z"

expiresAtstring

Data de expiração do processo.

Example: "2023-10-09T15:15:25.417105Z"

companyDataobject

Informações da empresa onde o processo foi criado. Referente ao campo 'companyBranchId', utilizado na criação do processo.

branchIdstring

Example: "60837cd3-ed3c-4038-ad7c-0a85ad64b03a"

countryCodestring

Example: "BRA"

Request

const response = await fetch('https://api.cadastro.uat.unico.app/client/v1/process/{processId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

{
  "process": {
    "id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
    "flow": "iddocssign",
    "callbackUri": "/path/to/callback-url/",
    "userRedirectUrl": "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b",
    "state": "PROCESS_STATE_FINISHED",
    "result": "PROCESS_RESULT_OK",
    "person": {
      "duiType": "DUI_TYPE_BR_CPF",
      "duiValue": "73689290074",
      "friendlyName": "Luke Skywalker",
      "notifications": [
        {
          "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
        }
      ]
    },
    "purpose": "creditprocess",
    "authenticationInfo": {
      "authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE",
      "authenticationId": "fd433602-d496-4291-adbb-dda95a3e50b1",
      "livenessResult": "LIVENESS_RESULT_LIVE",
      "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED",
      "identityFraudstersResult": "TRUST_RESULT_UNSPECIFIED",
      "scoreEngineResult": {
        "scoreEnabled": "SCORE_ENABLED_TRUE",
        "score": 50
      },
      "serproResult": {
        "score": 50
      }
    },
    "capacities": [
      "PROCESS_CAPACITY_IDUNICO",
      "PROCESS_CAPACITY_IDCHECK",
      "PROCESS_CAPACITY_IDDOCS",
      "PROCESS_CAPACITY_IDSIGN",
      "PROCESS_CAPACITY_IDLIVE"
    ],
    "services": [
      {
        "documents": [
          {
            "doc": {
              "version": 2,
              "code": "RG",
              "data": {
                "dataExpiracao": "2025-10-35T00:00:00Z",
                "dataHabilitacao": "2022-08-09T00:00:00Z",
                "dataNascimento": "1950-06-30T00:00:00Z",
                "nomeCivil": "John Doe",
                "rgNumero": 5478854,
                "categoria": "D",
                "cpfNumero": 73689290074,
                "dataEmissao": "2020-08-09T00:00:00Z",
                "localEmissao": "DEREX SP",
                "numero": 85775532778,
                "renachNumero": ""
              }
            },
            "typified": true,
            "cpf_match": true,
            "face_match": true,
            "doc_id": "1e61a978-3673-4fdd-8fa8-808d0a26d131",
            "validate_doc": true,
            "reused_doc": true,
            "signed_url": "https://api.datafortre[...]OXc9PQ%3D%3D"
          }
        ],
        "consent_granted": true,
        "envelopeId": "4d4f3d90-04a3-4259-b63b-930ab10d2e47",
        "documentIds": [
          "03307601-b518-49ca-b368-ae3919e24e54"
        ]
      }
    ],
    "createdAt": "2023-10-05T18:28:58.537985Z",
    "finishedAt": "2023-10-09T15:15:25.417105Z",
    "expiresAt": "2023-10-09T15:15:25.417105Z",
    "companyData": {
      "branchId": "60837cd3-ed3c-4038-ad7c-0a85ad64b03a",
      "countryCode": "BRA"
    }
  }
}

API

API Reference

Criação do Processo

Introdução

Antes de começar

Criação do Processo

Dúvidas?​

Criação de processos separados por flows

Requisições separadas por flows

Outras formas de fazer uma requisição (request)

Dúvidas?​

Consultar Resultado do Processo

Introdução

Antes de começar

Consulta do Resultado do Processo

Exemplos de responses por flow

Responses separadas por flows

Dúvidas?​

Obter Selfie do Usuário

Introdução

Antes de começar

Obtenção da Selfie do Usuário

Obter Conjunto Probatório

Introdução

Antes de começar

Obtenção do Conjunto Probatório

Especificação do conjunto probatório

Campos do Conjunto Probatório (clique em cada um para saber mais)

Dúvidas?​

Obter Documento Assinado

Introdução

Antes de começar

Obtenção do Documento Assinado

Exemplo de um documento gerado:

Obter Conjunto Probatório do Documento Assinado

Introdução

Antes de começar

Obtenção do Conjunto Probatório do Documento Assinado

Exemplo de um documento gerado:

Dúvidas?​

Cenários de response

Flow id

Cenário: Processo criado

CreateProcess

GetProcess

Cenário: Processo criado com erro

CreateProcess

GetProcess

Cenário: Processo finalizado e aprovado no IDUnico

GetProcess

Cenário: Processo finalizado e inconclusivo no IDUnico

GetProcess

Cenário: Processo finalizado e recusado no IDUnico

GetProcess

Cenário: Processo finalizado e com falha na Prova de Vida

GetProcess

Flow idcheck

Cenário: Processo criado

CreateProcess

GetProcess

Cenário: Processo criado com erro

CreateProcess

GetProcess

Cenário: Processo finalizado e aprovado no IDUnico

GetProcess

Cenário: Processo finalizado com sucesso, inconclusivo no IDUnico e com score no IDCheck

Cenário: Processo finalizado com sucesso, inconclusivo no IDUnico e descartado por divergência no IDCheck

GetProcess

Cenário: Processo finalizado e recusado no IDUnico

GetProcess

Cenário: Processo finalizado com sucesso e com falha na Prova de Vida

GetProcess

Dúvidas?​

Erros

Introdução

Erros possíveis

Criar Processo

Consultar Resultado do Processo

Obter Selfie do Usuário

Obter Conjunto Probatório

Dúvidas?

Dúvidas?

Dúvidas?

Dúvidas?

Dúvidas?

Dúvidas?

Dúvidas?

Dúvidas?

Dúvidas?

Dúvidas?

Dúvidas?