Criação do Processo

URL Base:

• UAT: https://api.cadastro.uat.unico.app.

• Produção: https://api.cadastro.unico.app.

Criar Processo

post

Endpoint para criar um novo processo no by Unico.

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Corpo

application/json

callbackUristringObrigatório

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

Example: /

flowstring · enumObrigatório

Tipo de fluxo. Veja detalhes dos fluxos na seção 'Visão Geral' nesta mesma documentação (alguns fluxos foram depreciados e você pode consultá-los também na seção 'Visão Geral').

Example: idunicosignValores possíveis:

clientReferencestringOpcional

É um identificador não obrigatório que será utilizado como indexador no portal e você pode utilizar como forma de associação (foreign key) entre seu sistema e o IDCloud.

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

companyBranchIdstringOpcional

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

Example: 7807b082-35b6-4bb0-8365-1316d840e725

bioTokenIdstringOpcional

Identificação do token biométrico. Obrigatório para qualquer flow com validação 1:1 (idtoken, idtokentrust, idtokensign, idsmart) 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

useCasestring · enumOpcional

É o caso de uso referente a revalidação inteligente. Obrigatório para o flow "idsmart".

Example: USE_CASE_IDENTITY_REVALIDATION_7_DAYSValores possíveis:

purposestring · enumObrigatório

Propósito do processo.

Example: creditprocessValores possíveis:

expiresInstringOpcional

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

Example: 3600s

Respostas

200

Processo criado com sucesso.

application/json

400

Paylad inválido.

application/json

401

Erro no access-token.

application/json

500

Erro Interno.

application/json

post

/client/v1/process

HTTPcURLJavaScriptPython

POST /client/v1/process HTTP/1.1
Host: api.cadastro.uat.unico.app
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 848

{
  "callbackUri": "/",
  "flow": "idunicosign",
  "flow_config": {
    "biometry_capture": {
      "enabled_back_camera": true
    }
  },
  "clientReference": "60837cd3-ed3c-4038-ad7c-0a85ad64b03a",
  "companyBranchId": "7807b082-35b6-4bb0-8365-1316d840e725",
  "bioTokenId": "60837cd3-ed3c-4038-ad7c-0a85ad64b03a",
  "useCase": "USE_CASE_IDENTITY_REVALIDATION_7_DAYS",
  "person": {
    "duiType": "DUI_TYPE_BR_CPF",
    "duiValue": "12345678909",
    "friendlyName": "Luke Skywalker",
    "phone": "5511912345678",
    "email": "[email protected]",
    "notifications": [
      {
        "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
      }
    ]
  },
  "purpose": "creditprocess",
  "expiresIn": "3600s",
  "contextualization": {
    "currency": "BRL",
    "price": 15990.9,
    "locale": {
      "ptBr": {
        "reason": "Abertura de cadastro"
      }
    }
  },
  "payload": [
    {
      "envelopePayload": {
        "documents": [
          {
            "documentName": "teste",
            "fileContents": "JVBERi0xLjMNCiXi48/[...]DQoNCnN0YXJ0eHJlZg0KMjcxNA0KJSVFT0YNCg=="
          }
        ]
      }
    }
  ]
}

{
  "process": {
    "id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
    "companyBranchId": "f12f7137-1e0d-43e0-8773-3217b260b8e8",
    "flow": "idunicosign",
    "callbackUri": "/path/to/callback-url/",
    "userRedirectUrl": "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b",
    "state": "PROCESS_STATE_CREATED",
    "createdAt": "2023-10-09T15:15:25.417105Z",
    "person": {
      "duiType": "DUI_TYPE_BR_CPF",
      "duiValue": "73689290074",
      "friendlyName": "Luke Skywalker",
      "phone": "5511912345678",
      "email": "[email protected]",
      "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",
    "companyData": {
      "branchId": "5a62ee0b-2b78-493d-9ab7-72126798f00e",
      "countryCode": "BRA"
    },
    "clientReference": "60837cd3-ed3c-4038-ad7c-0a85ad64b03a"
  }
}

• A obrigatoriedade de parâmetros na criação do processo pode mudar a depender dos flows utilizados. Ex:

  • Em flows que possuem Assinatura eletrônica, é obrigatório o envio do objeto payload e todas as suas propriedades.

  • Em flows que possuem Validação (1:1), é obrigatório o envio da propriedade bioTokenId.

• O mesmo ID de processo será retornado na criação caso o usuário ainda não tenha aberto o link, os dados enviados sejam idênticos e haja intervalo de até 2 minutos em relação ao primeiro processo.

Erros

400 Bad Request

code	message	Descrição
3	invalid flow	Quando o flow específicado não existe.
3	invalid person: friendly name exceeds 50 characters.	Quando o nome excede a quantidade máxima de 50 caracteres.
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 o flow utilizado não foi configurado corretamente.

401 Unauthorized

429 Too Many Requests

500 Internal Server Error