Criação do Processo

Base URL:

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

Criar Processo

post

Endpoint para criar um novo processo no IDCloudOne.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

callbackUristringRequired

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

flowstringRequired

É a jornada com o conjunto de regras que foi criada. Neste campo você irá inserir o seu fluxo criado e fornecido pela Unico.

Example: onboarding-conta-digital

clientReferencestringOptional

É 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: 1234-abcd

companyBranchIdstringOptional

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

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

bioTokenIdstringOptional

Identificação do token biométrico. Obrigatório para as jornadas com Validação (1:1) e deve-se utilizar um id de um processo concluído de qualquer outra Jornada de quaisquer outros conjuntos de regras.

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

purposestring · enumRequired

Propósito do processo.

Example: creditprocessPossible values:

expiresInstringOptional

É 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

Responses

200

Processo criado com sucesso.

application/json

400

Payload inválido.

application/json

401

Erro no access-token.

application/json

500

Erro inesperado (Erro interno ou problema de parâmetro).

application/json

post

/client/v1/process

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

{
  "callbackUri": "/",
  "flow": "onboarding-conta-digital",
  "flow_config": {
    "biometry_capture": {
      "enabled_back_camera": true
    }
  },
  "clientReference": "1234-abcd",
  "companyBranchId": "60837cd3-ed3c-4038-ad7c-0a85ad64b03a",
  "bioTokenId": "60837cd3-ed3c-4038-ad7c-0a85ad64b03a",
  "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",
    "flow": "onboarding-conta-digital",
    "callbackUri": "/path/to/callback-url/",
    "userRedirectUrl": "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b",
    "state": "PROCESS_STATE_CREATED",
    "result": "PROCESS_RESULT_UNSPECIFIED",
    "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",
    "services": {},
    "authenticationInfo": {},
    "capacities": [
      [
        "PROCESS_CAPACITY_IDCLOUDONE",
        "PROCESS_CAPACITY_IDSERPRO",
        "PROCESS_CAPACITY_IDDOCS",
        "PROCESS_CAPACITY_IDSIGN"
      ]
    ],
    "expiresAt": "2023-10-09T15:15:25.417105Z",
    "token": "eyJhbGciOiJSUzI1[...]d_jhQ",
    "companyData": {
      "branchId": "60837cd3-ed3c-4038-ad7c-0a85ad64b03a",
      "countryCode": "BRA"
    },
    "clientReference": "1234-abcd",
    "webAppToken": "eyJhbGciOiJSUzI1[...]d_jhQ"
  }
}

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

Caso utilize a capacidade Reaproveitamento e Captura de documentos, considere que é possível utilizar os seguintes documentos:

RG, CNH, CIN e Passaporte brasileiro.

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.

Erros

code

message

Descrição

invalid flow

Quando o flow específicado não existe.

invalid purpose

Quando a proposta informada não é valida.

invalid callbackUri: unable to parse callbackUri: parse "": empty url, invalid callbackUri: url:

Quando o callbackUri informado não é válido.

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.

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.

idnsv2/GetPublicID request error: rpc error: code = InvalidArgument desc = invalid dui value

Quando o CPF informado não é válido.

XX ID Apikeys are not set

Quando alguma API Key não foi configurada corretamente.

PreviousAPI Reference NextConsultar Resultado do Processo

Last updated 29 days ago

Was this helpful?