Pular para o conteúdo principal

Get Process

Este artigo explica como obter o resultado de um processo na plataforma usando o método GetProcess através da REST API.

Importante

Atenção!

Atualização no retorno dos fluxos IDUnico e IDCheck(IDUnico + Check).

O retorno do resultado para todos os processos com fluxo IDUnico e IDCheck foi atualizado, generalizando o resultado com os outros fluxos.

Quando o processo IDUnico finaliza com o resultado inconclusivo ou falha de liveness, retornamos o resultado PROCESS_RESULT_INVALID_IDENTITY.

Atenção!

Busca de processo atrelado a alguma filial

Caso você tenha um processo atrelado a uma filial, é necessário que a conta de serviço usada tenha permissão para buscar esse processo.

Exemplo do antigo retorno do resultado de processo quando o usuário era autenticado:

{
"process": {
...
// Estado atual do processo.
"state": "PROCESS_STATE_FINISHED",
// Resultado atual do processo.
"result": "PROCESS_RESULT_OK",
...
}
}

Exemplo do antigo retorno do resultado do processo quando a autenticação era inconclusiva ou falha de liveness:

{
"process": {
...
// Estado do processo
"state": "PROCESS_STATE_FINISHED",
// Resultado do processo.
"result": "PROCESS_RESULT_INVALID_IDENTITY",
...
}
}
Novo retorno no resultado

Quando o processo finaliza com sucesso no liveness e inconclusivo do IDUnico, devolveremos o resultado PROCESS_RESULT_OK e incluiremos AUTHENTICATION_RESULT_INCONCLUSIVE no campo authenticationResult de authenticationInfo.

Exemplo do novo retorno do resultado do processo quando o usuário for AUTENTICADO:

{
"process": {
...
// Estado atual do processo
"state": "PROCESS_STATE_FINISHED",
// Resultado atual do processo.
"result": "PROCESS_RESULT_OK",
// Resultados da etapa de autenticação.
"authenticationInfo": {
// Id da autenticação do processo.
"authenticationId": "cf9e618e-e7a4-4340-b745-b228383c927f",
// Resultado da autenticação com o ID.
"authenticationResult": "AUTHENTICATION_RESULT_POSITIVE",
// Resultado do Liveness.
"livenessResult": "LIVENESS_RESULT_LIVE"
},
...
}
}

Exemplo do novo retorno do resultado do processo quando a autenticação do usuário for INCONCLUSIVO:

{
"process": {
...
// Estado atual do processo
"state": "PROCESS_STATE_FINISHED",
// Resultado atual do processo.
"result": "PROCESS_RESULT_OK",
// Resultados da etapa de autenticação.
"authenticationInfo": {
// id da autenticação do processo.
"authenticationId": "cf9e618e-e7a4-4340-b745-b228383c927f",
// Resultado da autenticação com o IDUnico.
"authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE",
// Resultado do Liveness.
"livenessResult": "LIVENESS_RESULT_LIVE"
},
...
}
}
Atenção

Não há alteração no retorno quando o processo finalizar com falha de liveness.

Exemplo de retorno do resultado do processo quando o usuário NÃO passar no liveness:

{
"process": {
...
// Estado atual do processo
"state": "PROCESS_STATE_FINISHED",
// Resultado atual do processo.
"result": "PROCESS_RESULT_INVALID_IDENTITY",
// Resultados da etapa de autenticação.
"authenticationInfo": {
// id da autenticação do processo.
"authenticationId": "cf9e618e-e7a4-4340-b745-b228383c927f",
// Resultado da autenticação com o IDUnico.
"authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
// Resultado do Liveness.
"livenessResult": "LIVENESS_RESULT_NOT_LIVE"
},
...
}
}

Formas de fazer uma requisição GET

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.

Fluxos

O resultado é exibido de acordo com o fluxo.

1 - ID flow

2 - IDCheck flow (IDUnico + Check)

3 - IDDocs flow (IDUnico + Check + Docs)

4 - IDSign flow (IDUnico + Check + Sign)

5 - IDdocsign flow (IDUnico + Check + Docs + Sign)

6 - IDToken flow (IDToken)

7 - IDCheckSerpro flow (IDToken)

8 - IDLive flow