Criação do Processo

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

---

Introdução

---

Nesta seção, você encontrará a documentação detalhada sobre o funcionamento do endpoint de Criação de Processos no by Unico. Perceba que, para utilizar as capacidades da plataforma IDCloud neste meio de integração, basta alterar o valor do parâmetro "flow" no momento de criar o processo e a Unico será a responsável por orquestrar todas as capacidades que deseja utilizar.

Entenda mais sobre a utilização das capacidades no by Unico na seção Visão Geral.

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.

---

Criação do Processo

---

Criar Processo

Endpoint para criar um novo processo 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 (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: "/"

flow*enum

Tipo de fluxo. Veja detalhes dos fluxos na seção 'Visão Geral' nesta mesma documentação.

Example: "iddocssign"

idliveididlivetrustidtrustidcheckiddocsidsigniddocssignidchecktrustidchecktrustdocsidchecktrustsignidchecktrustdocssignidcheckserprocreditoconsignadoidcheckserprodocssignidtokenidtokensignidtokentrust

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. Caso haja separação de processos por filial, você receberá os IDs das filiais do time Unico.

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

Informações do usuário.

purpose*enum

Propósito do processo.

Example: "creditprocess"

creditprocessbiometryonboardingcarpurchase

expiresInstring

É 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"

contextualizationobject

Informações contextuais sobre o processo. Estes campos são apresentados na jornada para o usuário final, melhorando a conversão por contextualizá-lo do motivo da captura da biometria.

payloadarray of object

Array que contém as informações dos documentos. Todos os itens do array tornam-se obrigatórios caso utilize algum flow com assinatura eletrônica.

Response

200400401500

Processo criado com sucesso.

Body

application/json

processobject

Informações sobre o processo by Unico.

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": {
      "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
      "authenticationId": "",
      "livenessResult": "LIVENESS_RESULT_UNSPECIFIED",
      "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED",
      "identity_fraudsters_result": "TRUST_RESULT_UNSPECIFIED"
    },
    "capacities": [
      [
        "PROCESS_CAPACITY_IDUNICO",
        "PROCESS_CAPACITY_IDCHECK",
        "PROCESS_CAPACITY_IDDOCS"
      ]
    ],
    "expiresAt": "2023-10-09T15:15:25.417105Z",
    "token": "eyJhbGciOiJSUzI1[...]d_jhQ",
    "companyData": {
      "branchId": "60837cd3-ed3c-4038-ad7c-0a85ad64b03a",
      "countryCode": "BRA"
    }
  }
}

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.

Dicas:

• Para mais informações sobre os cenários que pode receber no response, consulte a seção Cenários de response;

• Para mais informações sobre os erros possíveis para este endpoint, consulte a seção Erros.

---

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.