1 de 2

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.

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

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": {},
    "capacities": [
      "PROCESS_CAPACITY_IDUNICO",
      "PROCESS_CAPACITY_IDCHECK",
      "PROCESS_CAPACITY_IDDOCS"
    ],
    "expiresAt": "2023-10-09T15:15:25.417105Z",
    "token": "eyJhbGciOiJSUzI1[...]d_jhQ"
  }
}

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.

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

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": {},
    "capacities": [
      "PROCESS_CAPACITY_IDUNICO",
      "PROCESS_CAPACITY_IDCHECK",
      "PROCESS_CAPACITY_IDDOCS"
    ],
    "expiresAt": "2023-10-09T15:15:25.417105Z",
    "token": "eyJhbGciOiJSUzI1[...]d_jhQ"
  }
}

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?​

CreateProcess

Antes de começar

Endpoints:

CreateProcess

Responses de erro

Dúvidas?​

CreateProcess separados por flows

Requisições separadas por flows

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

Dúvidas?​

CreateProcess

Dúvidas?

Dúvidas?

Dúvidas?

Dúvidas?