Pular para o conteúdo principal

Obtendo o resultado do processo

Este guia explica como criar um processo através da API REST para obter o resultado de um processo em nossa plataforma.

Exemplo de requisição

Através do ID do processo é possível recuperar todas informações do processo.

curl -X 'GET' \
'https://api.cadastro.uat.unico.app/client/v1/process/{processId}' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {{TOKEN}}'
ATENÇÃO

Lembre-se de trocar o processId pelo id do processo desejado.

Exemplo de resposta

No caso de sucesso, um 200 OK é enviado com as seguintes informações:

{
"process": {
// ID do processo criado.
"id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
// Tipo de jornada criada.
"flow": "iddocssign",
// Dados da empresa visualizado pelo consumidor.
"company": {
// Código da empresa.
"code": "unico",
// Nome fantasia da empresa.
"friendlyName": "Acesso QA Digital",
// URL da imagem da empresa.
"logoUrl": "https://unico.io/wp-content/themes/theme_unico/img/logo/unico-color.svg"
},
// URL de redirecionamento cadastrada no processo.
"callbackUri": "https://unico.io",
// URL de navegação do consumidor final. Veja mais em
"userRedirectUrl": "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b",
// Estado atual do processo
"state": "PROCESS_STATE_FINISHED",
// Resultado atual do processo.
"result": "PROCESS_RESULT_OK",
// Dados do consumidor no processo.
"person": {
// Tipo de identificador utilizado.
"duiType": "DUI_TYPE_BR_CPF",
// Identificador do consumidor final.
"duiValue": "73689290074",
// Nome do consumidor final.
"friendlyName": "Fulano",
},
// Propósito cadastrado no processo.
"purpose": "creditprocess",
// Resultados da etapa de autenticação.
"authenticationInfo": {
// Resultado da autenticação com o ID.
"authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE",
// Resultado da autenticação com o Check.
"scoreEngineResult": {
// Apresenta se o Check está habilitado ou desabilitado.
"scoreEnabled": "SCORE_ENABLED_TRUE",
// Resultado do score.
"score": 50
}
},
// Dados referentes a outras etapas do processo.
"services": {
// Dados referentes a etapa de documentos.
"docs": {
// Lista de documentos compartilhados.
"documents": [
{
// Informações sobre o documentos.
"doc": {
// Tipo de documento.
"code": "RG"
},
// ID do documentos.
"docId": "1e61a978-3673-4fdd-8fa8-808d0a26d131",
// URL assinada do documento.
"signedUrl": "https://api.datafortress.dev.private.unico.run/url-signer/signature/dmF1bHQ6[...]OXc9PQ%3D%3D"
}
],
"consentGranted": true
},
// Dados referentes a etapa de assinatura.
"sign": {
"signature": {
// ID do envelope.
"envelopeId": "4d4f3d90-04a3-4259-b63b-930ab10d2e47",
// Lista de ID dos documentos do envelope.
"documentIds": [
"03307601-b518-49ca-b368-ae3919e24e54"
]
}
}
},
// Momento em que o processo foi criado.
"createdAt": "2023-10-05T18:28:58.537985Z"
// Momento em que o processo foi finalizado.
"finishedAt": "2023-08-09T15:15:25.417105Z"
}
}
ParâmetroDescrição
idO identificador do processo.
flowDefine a jornada que foi criada.

id: Fluxo de validação de identidade com biometria facial.
idcheck: Fluxo de validação de identidade com biometria facial com score no caso de inclonclusivo.
iddocs: Fluxo de validação de identidade com captura e reaproveitamento de documentos (RG ou CNH).
idsign: Fluxo de validação de identidade com assinatura eletrônica.
iddocssign: Fluxo de validação de identidade, captura/reaproveitamento de documentos (RG ou CNH) e assinatura eletrônica.
callbackUriDefine para onde o consumidor final será redirecionado no fim do processo.

Para mais detalhes volte para criando um processo.
company.codeSinaliza o código da empresa no ecossistema Unico.
company.friendlyNameSinaliza o nome do cliente exibido na jornada do consumidor final.
company.logoUrlSinaliza a logo do cliente exibido na jornada do consumidor final.
userRedirectUrlURL para onde você deverá redirecionar o consumidor final para finalização da jornada
stateSinaliza o estado atual do processo, por ser do tipo:

PROCESS_STATE_CREATED: Processo criado e ainda não finalizado pelo consumidor final.

PROCESS_STATE_FINISHED: Processo finalizado pelo consumidor final com sucesso.

PROCESS_STATE_FAILED: Processo criado ou finalizado com erro.
resultSinaliza o resultado do processo da jornada do consumidor, podendo ser do tipo:

PROCESS_RESULT_OK: Processo finalizado com sucesso.

PROCESS_RESULT_WARNING: Processo finalizado com alerta.

PROCESS_RESULT_ERROR: Processo finalizado com algum tipo de erro.
person.personDuiTypeDefine o tipo de identificador do consumidor final.

DUI_TYPE_BR_CPF: Para CPF como identificador.
person.personDuiValueDefine o valor do identificador do consumidor final especificado no campo personDuiType.
person.friendlyNameDefine o nome do consumidor final, por exemplo, Fulano.
authenticationInfo.authenticationResultResultado da validação de identidade pelo ID.

AUTHENTICATION_RESULT_UNSPECIFIED: Aguardando o retorno do processo de autenticação.

AUTHENTICATION_RESULT_INCONCLUSIVE: Resultado de autenticação inconclusivo.

AUTHENTICATION_RESULT_POSITIVE: Resultado de autenticação positivo.
authenticationInfo.authenticationResult

.scoreEngineResult.scoreEnabled
Sinaliza se o processo está com o Check habilitado no caso de inconclusivo do ID.

SCORE_ENABLED_TRUE: Habilitado.

SCORE_ENABLED_FALSE: Desabilitado.
authenticationInfo.authenticationResult

.scoreEngineResult.score
Sinaliza o resultado do score do Check.

0: Caso esteja desabilitado.

-100 a 100: Resultado do score.
services.docs

.documents

.doc.code

.docId

.signedUrl
service.docs: Apresenta os dados compartilhados pela etapa de documentos.

.documents: Lista de documentos compartilhados pelo consumidor final.

.doc.code:
RG: Sinaliza que o documento compartilhado é do tipo RG.
CNH: Sinaliza que o documento compartilhado é do tipo CNH.

.docId: Identificador único do documento compartilhado.

.signedUrl: URL assinada com a foto do documento compartilhado.
services.sign.signature

.envelopeId

.documentIds
services.sign.signature:Apresenta os dados compartilhados pela etapa de assinatura.

.envelopeId: Identificador único do envelope assinado.

.documentIds: Array de identificadores dos documentos do envelope.
createdAtSinaliza o momento em que o processo foi criado.
finishedAtSinaliza o momento em que o processo foi concluído pelo consumidor final.
API Reference

Para mais informações sobre este endpoint, consulte a API Reference.

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.