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.
Criação do Processo
Endpoint para criar um novo processo no by Unico.
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 '/').
/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').
idunicosignValores possíveis: É 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.
60837cd3-ed3c-4038-ad7c-0a85ad64b03aÉ 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.
7807b082-35b6-4bb0-8365-1316d840e725Identificaçã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.
60837cd3-ed3c-4038-ad7c-0a85ad64b03aÉ o caso de uso referente a revalidação inteligente. Obrigatório para o flow "idsmart".
USE_CASE_IDENTITY_REVALIDATION_7_DAYSValores possíveis: Propósito do processo.
creditprocessValores possíveis: É 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.
3600sProcesso criado com sucesso.
Payload inválido.
Erro no access-token.
Erro inesperado (Erro interno ou problema de parâmetro).
POST /client/v1/process HTTP/1.1
Host: api.cadastro.uat.unico.app
Authorization: Bearer JWT
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"
}
}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.
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
payloade 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.
Dicas:
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.
Atualizado