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

bearerAuth

Body

application/json

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

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

Response

200400401500

Processo criado com sucesso.

Body

application/json

processobject

Request

JavaScriptCurlPython

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

200400401500

{
  "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": "[e-mail]",
      "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

---

400 Bad Request

code	message	Descrição
3	invalid flow	Quando o flow específicado não existe.
3	invalid purpose	Quando a proposta informada não é valida.
3	invalid callbackUri: unable to parse callbackUri: parse "": empty url, invalid callbackUri: url:	Quando o callbackUri informado não é válido.
3	invalid person: email required for notification channel NOTIFICATION_CHANNEL_EMAIL, invalid email address for notification channel NOTIFICATION_CHANNEL_EMAIL	Quando o e-mail informado não é válido, mas há a notificação via e-mail.
3	invalid person: phone number required for notification channel NOTIFICATION_CHANNEL_WHATSAPP, phone number does not contain 13 chars for notification channel NOTIFICATION_CHANNEL_WHATSAPP	Quando o telefone informado não é válido, mas há a notificação via SMS ou WhatsApp.
3	idnsv2/GetPublicID request error: rpc error: code = InvalidArgument desc = invalid dui value	Quando o CPF informado não é válido.
9	XX ID Apikeys are not set	Quando alguma API Key não foi configurada corretamente.

401 Unauthorized

message	Descrição
Jwt header is an invalid JSON	Quando o access-token utilizado contém caracteres errados.
Jwt is expired	Quando o access-token utilizado expirou

500 Internal Server Error

code	message	Descrição
99999	Internal failure! Try again later	Quando há algum erro interno.

---

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.