1 de 10

APIs

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

CreateProcess

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

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.

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

Responses de erro

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.

CreateProcess separados por flows

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

Requisições separadas por flows

Para uma jornada apenas com validação da prova de vida.

{
  "callbackUri": "/path/to/url",
  "flow": "idlive",
  "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"
}

Para uma jornada com validação da prova de vida + verificação de identidade.

{
  "callbackUri": "/path/to/url",
  "flow": "id",
  "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"
}

Para uma jornada com validação da prova de vida + verificação de identidade + score de risco no caso de inconclusivo do unicoId.

{
  "callbackUri": "/path/to/url",
  "flow": "idcheck",
  "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"
}

Para uma jornada com validação da prova de vida + verificação de identidade + score de risco no caso de inconclusivo do unicoId + captura e reaproveitamento de documentos.

{
  "callbackUri": "/path/to/url",
  "flow": "iddocs",
  "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"
}

Para uma jornada com validação da prova de vida + verificação de identidade + score de risco no caso de inconclusivo do unicoId + assinatura eletrônica.

{
  "callbackUri": "/path/to/url",
  "flow": "idsign",
  "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=="
          }
        ]
      }
    }
  ]
}

Para uma jornada com validação da prova de vida + verificação de identidade + score de risco no caso de inconclusivo do unicoId + captura e reaproveitamento de documentos + assinatura eletrônica.

{
  "callbackUri": "/path/to/url",
  "flow": "iddocssign",
  "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/[...]xNA0KJSVFT0YNCg=="
          }
        ]
      }
    }
  ]
}

Para uma jornada com validação da prova de vida + verificação de identidade + score de risco no caso de inconclusivo do unicoId + retorno de similaridade da Serpro.

{
  "callbackUri": "/path/to/url",
  "flow": "idcheckscore",
  "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"
}

Para uma jornada com validação da prova de vida + validação (1:1)

{
  "callbackUri": "/path/to/url",
  "flow": "idtoken",
  "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"
}

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

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.

GetProcess

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

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.

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 verificar detalhadamente os parâmetros da API, consulte a seção Especificação de parâmetros.

Responses de erro

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

Para uma jornada apenas com validação da prova de vida.

Para uma jornada com validação da prova de vida + verificação de identidade.

Para uma jornada com validação da prova de vida + verificação de identidade + score de risco no caso de inconclusivo do unicoId.

Para uma jornada com validação da prova de vida + verificação de identidade + score de risco no caso de inconclusivo do unicoId + captura e reaproveitamento de documentos.

Para uma jornada com validação da prova de vida + verificação de identidade + score de risco no caso de inconclusivo do unicoId + assinatura eletrônica.

Para uma jornada com validação da prova de vida + verificação de identidade + score de risco no caso de inconclusivo do unicoId + retorno de similaridade da Serpro.

Para uma jornada com validação da prova de vida + validação (1:1)

GetSelfie

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

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.

O parâmetro [?raw=true] é opcional. Caso sua conta de serviço tenha a permissão necessária, você poderá utilizá-lo para obter a selfie sem a marca d'água.

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

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.

Responses de erro

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.

GetEvidenceSet

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

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.

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 verificar detalhadamente os parâmetros da API, consulte a seção Especificação de parâmetros.

Responses de erro

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.

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.

GetDocumentSigned

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

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: .

Exemplo de um documento gerado:

Responses de erro

GetEvidenceSign

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

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.

Exemplo de um documento gerado:

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

Responses de erro

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.

CreateProcess

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

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.

CreateProcess

Endpoint para criar um novo processo de verificação de identidade 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, uma URL Schema para redirecionamento em aplicações móveis nativas ou sem redireciomento (incluir apenas a '/').

Example: "/"

flow*string

Tipo de fluxo. Fluxos possíveis: 'idlive', 'idcheck', 'iddocs', 'idsign', 'iddocssign', 'idcheckserpro', 'idtoken'. Veja detalhes dos fluxos na seção 'Visão Geral' nesta mesma documentação.

Example: "iddocssign"

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.

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

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).

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.

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

notificationChannelstring

Canal de notificação. Pode receber os valores - 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*string

Propósito do processo. Pode receber os valores: 'creditprocess', 'biometryonboarding' ou 'carpurchase'.

Example: "creditprocess"

expiresInstring

É o tempo de expiração do processo em segundos. Caso essa informação não seja informada, será usado o valor default de 7 dias.

Example: "3600s"

payloadarray of object

envelopePayloadobject

documentsarray of object

documentNamestring

Nome do documento. Torna-se obrigatório caso utilize algum flow com assinatura eletrônica.

Example: "teste"

fileContentsstring

Documento que deve ser assinado em base64. Torna-se obrigatório caso utilize algum flow com assinatura eletrônica.

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

Response

Processo criado com sucesso.

Body

processobject

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"

flowstring

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"

statestring

Estado do processo.

Example: "PROCESS_STATE_CREATED"

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"

phonestring

Número de telefone da pessoa.

Example: "5511912345678"

emailstring

E-mail da pessoa.

Example: "teste@teste.com"

notificationsarray of object

notificationChannelstring

Canal de notificação.

Example: "NOTIFICATION_CHANNEL_WHATSAPP"

purposestring

Propósito do processo.

Example: "creditprocess"

authenticationInfoobject

Informações da autenticação. Será sempre vazio na criação do processo.

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"

Request

Response

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

Responses de erro

code

message

Descrição

message

Descrição

code

message

Descrição

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.

CreateProcess separados por flows

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

Requisições separadas por flows

Para uma jornada apenas com validação da prova de vida.

{
  "callbackUri": "/path/to/url",
  "flow": "idlive",
  "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"
}

Para uma jornada com validação da prova de vida + verificação de identidade.

{
  "callbackUri": "/path/to/url",
  "flow": "id",
  "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"
}

Para uma jornada com validação da prova de vida + verificação de identidade + score de risco no caso de inconclusivo do unicoId.

{
  "callbackUri": "/path/to/url",
  "flow": "idcheck",
  "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"
}

Para uma jornada com validação da prova de vida + verificação de identidade + score de risco no caso de inconclusivo do unicoId + captura e reaproveitamento de documentos.

{
  "callbackUri": "/path/to/url",
  "flow": "iddocs",
  "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"
}

Para uma jornada com validação da prova de vida + verificação de identidade + score de risco no caso de inconclusivo do unicoId + assinatura eletrônica.

{
  "callbackUri": "/path/to/url",
  "flow": "idsign",
  "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=="
          }
        ]
      }
    }
  ]
}

{
  "callbackUri": "/path/to/url",
  "flow": "iddocssign",
  "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/[...]xNA0KJSVFT0YNCg=="
          }
        ]
      }
    }
  ]
}

Para uma jornada com validação da prova de vida + verificação de identidade + score de risco no caso de inconclusivo do unicoId + retorno de similaridade da Serpro.

{
  "callbackUri": "/path/to/url",
  "flow": "idcheckscore",
  "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"
}

Para uma jornada com validação da prova de vida + validação (1:1)

{
  "callbackUri": "/path/to/url",
  "flow": "idtoken",
  "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"
}

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

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.

GetProcess

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

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.

GetProcess

Endpoint para buscar o resultado de um processo de verificação de identidade 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

idstring

ID do processo.

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

flowstring

Fluxo utilizado no processo.

Example: "iddocssign"

companyBranchIdstring

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

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

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"

statestring

Estado do processo.

Example: "PROCESS_STATE_FINISHED"

resultstring

Resultado do processo.

Example: "PROCESS_RESULT_OK"

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

notificationChannelstring

Canal de notificação.

Example: "NOTIFICATION_CHANNEL_WHATSAPP"

purposestring

Propósito do processo.

Example: "creditprocess"

authenticationInfoobject

authenticationResultstring

Resultado da autenticação.

Example: "AUTHENTICATION_RESULT_INCONCLUSIVE"

scoreEngineResultobject

scoreEnabledstring

Indica se o score está habilitado.

Example: "SCORE_ENABLED_TRUE"

scorenumber

Score obtido no processo.

Example: 50

authenticationIdstring

ID da autenticação.

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

livenessResultstring

Resultado do teste de liveness.

Example: "LIVENESS_RESULT_LIVE"

capacitiesarray of string

Capacidades do processo.

itemsstring

servicesarray of object

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.datafortress.dev.private.unico.run/url-signer/signature/dmF1bHQ6[...]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"

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",
    "companyBranchId": "60837cd3-ed3c-4038-ad7c-0a85ad64b03a",
    "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",
      "scoreEngineResult": {
        "scoreEnabled": "SCORE_ENABLED_TRUE",
        "score": 50
      },
      "authenticationId": "fd433602-d496-4291-adbb-dda95a3e50b1",
      "livenessResult": "LIVENESS_RESULT_LIVE"
    },
    "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": "2023-10-09T15:15:25.417105Z"
  }
}

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.

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

Responses de erro

code

message

Descrição

message

Descrição

code

message

Descrição

code

message

Descrição

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

Para uma jornada apenas com validação da prova de vida.

Para uma jornada com validação da prova de vida + verificação de identidade.

{
    "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"
        },
        "capacities": [
            "PROCESS_CAPACITY_IDUNICO",
            "PROCESS_CAPACITY_IDLIVE"
        ],        
        "createdAt": "2023-10-05T18:28:58.537985Z",
        "finishedAt": "2023-10-09T15:15:25.417105Z",
        "expiresAt": "2023-10-09T15:15:25.417105Z"
    }
}

Para uma jornada com validação da prova de vida + verificação de identidade + score de risco no caso de inconclusivo do unicoId.

{
    "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"
        },
        "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": "2023-10-09T15:15:25.417105Z"
    }
}

Para uma jornada com validação da prova de vida + verificação de identidade + score de risco no caso de inconclusivo do unicoId + captura e reaproveitamento de documentos.

{
    "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"
        },
        "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": "2023-10-09T15:15:25.417105Z"
    }
}

Para uma jornada com validação da prova de vida + verificação de identidade + score de risco no caso de inconclusivo do unicoId + assinatura eletrônica.

{
    "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"
        },
        "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": "2023-10-09T15:15:25.417105Z"
    }
}

{
    "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"
        },
        "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": "2023-10-09T15:15:25.417105Z"
    }
}

Para uma jornada com validação da prova de vida + verificação de identidade + score de risco no caso de inconclusivo do unicoId + retorno de similaridade da Serpro.

{
    "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",
             "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": "2023-10-09T15:15:25.417105Z"
    }
}

Para uma jornada com validação da prova de vida + validação (1:1)

{
    "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": {
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_FALSE",
                "score": 0
            },
            "authenticationId": "c95ea805-b001-4926-a99e-c0be7ef0b663",
            "livenessResult": "LIVENESS_RESULT_LIVE",
            "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_POSITIVE"
        },
        "capacities": [
            "PROCESS_CAPACITY_IDLIVE",
            "PROCESS_CAPACITY_IDTOKEN"
        ],
        "expiresAt": "2024-11-04T19:54:23.312326Z",
        "companyData": {}
    }
}

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 .

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

Dúvidas?

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

CreateProcess

Endpoint para criar um novo processo de verificação de identidade no by Unico.

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

Authorization

Body

callbackUri*string

Example: "/"

flow*string

Tipo de fluxo. Fluxos possíveis: 'idlive', 'idcheck', 'iddocs', 'idsign', 'iddocssign', 'idcheckserpro', 'idtoken'. Veja detalhes dos fluxos na seção 'Visão Geral' nesta mesma documentação.

Example: "iddocssign"

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.

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

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).

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.

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

notificationChannelstring

Example: "NOTIFICATION_CHANNEL_WHATSAPP"

purpose*string

Propósito do processo. Pode receber os valores: 'creditprocess', 'biometryonboarding' ou 'carpurchase'.

Example: "creditprocess"

expiresInstring

É o tempo de expiração do processo em segundos. Caso essa informação não seja informada, será usado o valor default de 7 dias.

Example: "3600s"

payloadarray of object

envelopePayloadobject

documentsarray of object

documentNamestring

Nome do documento. Torna-se obrigatório caso utilize algum flow com assinatura eletrônica.

Example: "teste"

fileContentsstring

Documento que deve ser assinado em base64. Torna-se obrigatório caso utilize algum flow com assinatura eletrônica.

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

Response

Processo criado com sucesso.

Body

processobject

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"

flowstring

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"

statestring

Estado do processo.

Example: "PROCESS_STATE_CREATED"

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"

phonestring

Número de telefone da pessoa.

Example: "5511912345678"

emailstring

E-mail da pessoa.

Example: "teste@teste.com"

notificationsarray of object

notificationChannelstring

Canal de notificação.

Example: "NOTIFICATION_CHANNEL_WHATSAPP"

purposestring

Propósito do processo.

Example: "creditprocess"

authenticationInfoobject

Informações da autenticação. Será sempre vazio na criação do processo.

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"

Request

Response

GetProcess

Endpoint para buscar o resultado de um processo de verificação de identidade 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

idstring

ID do processo.

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

flowstring

Fluxo utilizado no processo.

Example: "iddocssign"

companyBranchIdstring

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

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

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"

statestring

Estado do processo.

Example: "PROCESS_STATE_FINISHED"

resultstring

Resultado do processo.

Example: "PROCESS_RESULT_OK"

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

notificationChannelstring

Canal de notificação.

Example: "NOTIFICATION_CHANNEL_WHATSAPP"

purposestring

Propósito do processo.

Example: "creditprocess"

authenticationInfoobject

authenticationResultstring

Resultado da autenticação.

Example: "AUTHENTICATION_RESULT_INCONCLUSIVE"

scoreEngineResultobject

scoreEnabledstring

Indica se o score está habilitado.

Example: "SCORE_ENABLED_TRUE"

scorenumber

Score obtido no processo.

Example: 50

authenticationIdstring

ID da autenticação.

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

livenessResultstring

Resultado do teste de liveness.

Example: "LIVENESS_RESULT_LIVE"

capacitiesarray of string

Capacidades do processo.

itemsstring

servicesarray of object

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.datafortress.dev.private.unico.run/url-signer/signature/dmF1bHQ6[...]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"

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",
    "companyBranchId": "60837cd3-ed3c-4038-ad7c-0a85ad64b03a",
    "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",
      "scoreEngineResult": {
        "scoreEnabled": "SCORE_ENABLED_TRUE",
        "score": 50
      },
      "authenticationId": "fd433602-d496-4291-adbb-dda95a3e50b1",
      "livenessResult": "LIVENESS_RESULT_LIVE"
    },
    "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": "2023-10-09T15:15:25.417105Z"
  }
}

APIs

CreateProcess

Antes de começar

Endpoints:

Responses de erro

Dúvidas?​

CreateProcess separados por flows

Requisições separadas por flows

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

Dúvidas?​

GetProcess

Antes de começar

Endpoints:

Para implementar suas regras de negócio, sempre valide o retorno das capacidades analisando os parâmetros do response na seguinte ordem:

Responses de erro

Dúvidas?​

Exemplos de responses por flow

Responses separadas por flows

GetSelfie

Antes de começar

Endpoints:

Responses de erro

Dúvidas?​

GetEvidenceSet

Antes de começar

Endpoints:

Responses de erro

Dúvidas?​

Especificação do conjunto probatório

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

Dúvidas?​

GetDocumentSigned

Antes de começar

Endpoints:

Exemplo de um documento gerado:

Responses de erro

GetEvidenceSign

Antes de começar

Endpoints:

Exemplo de um documento gerado:

Responses de erro

Dúvidas?​

GetEvidenceSign

Antes de começar

Endpoints:

GetEvidenceSign

Exemplo de um documento gerado:

Responses de erro

Dúvidas?​

GetEvidenceSign

CreateProcess

Antes de começar

Endpoints:

CreateProcess

Responses de erro

Dúvidas?​

GetSelfie

Antes de começar

Endpoints:

GetSelfie

Responses de erro

Dúvidas?​

CreateProcess separados por flows

Requisições separadas por flows

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

Dúvidas?​

GetEvidenceSet

Antes de começar

Endpoints:

GetEvidenceSet

Responses de erro

Dúvidas?​

GetProcess

Antes de começar

Endpoints:

GetProcess

Para implementar suas regras de negócio, sempre valide o retorno das capacidades analisando os parâmetros do response na seguinte ordem:

Responses de erro

Dúvidas?​

Especificação do 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?

Dúvidas?

Dúvidas?

Dúvidas?