GetProcess - IDToken flow

Este artigo explica como obter o resultado de um processo no fluxo do idtoken através da API REST.

Como usar?

Faça uma requisição GET para o endpoint:

• Homologação: https://api.cadastro.uat.unico.app/client/v1/process/{id}
• Produção: https://api.cadastro.unico.app/client/v1/process/{id}

Com o token de acesso válido, faça uma requisição para o endpoint passando o parâmetro {id} que deve ser o mesmo que foi gerado durante a criação do processo (CreateProcess).

Parametros:

• PATH PARAMETERS

Nome	Tipo	Mandatorio/Opcional	Descrição
id	String	Mandatório	Numero do processo

Requisição executada com sucesso

Se a requisição foi executada com sucesso, a resposta de retorno é um 200 OK e um JSON contendo os seguintes parâmetros:

{
    "process": {
        "id": "e05c9e06-81b9-4b22-a96a-4e5942017804",
        "flow": "idtoken",
        "bioTokenId": "d943f674-ddb9-4cb1-8beb-ef921da650b4",
        "callbackUri": "/path/to/callback-url/",
        "userRedirectUrl": "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b",
        "state": "PROCESS_STATE_FINISHED",
        "result": "PROCESS_RESULT_OK",
        "person": {
            "duiType": "DUI_TYPE_BR_CPF",
            "duiValue": "73689290074",
            "friendlyName": "John Doe",
            "notifications": [
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
                },
                {
                    "notificationChannel": "NOTIFICATION_CHANNEL_SMS"
                }
            ],
        },
        "purpose": "creditprocess",
        "authenticationInfo": {
            "authenticationId": "3cdaeb71-a14a-4078-bf6e-6000c52fbaec",
            "livenessResult": "LIVENESS_RESULT_LIVE",
            "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_POSITIVE"
        },
        "capacities": [
            "PROCESS_CAPACITY_IDLIVE",
            "PROCESS_CAPACITY_IDTOKEN"
        ],        
        "createdAt": "2023-10-05T18:28:58.537985Z",
        "finishedAt": "2023-10-09T15:15:25.417105Z",
        "expiresAt": "2023-10-09T15:15:25.417105Z"
    }
}

Parâmetro	Descrição
id	O identificador do processo.
flow	Define a jornada que a ser executada. 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. idtoken: Fluxo para verificar a autenticidade de uma biometria facial em relação a um processo já realizado anteriormente.
callbackUri	Define para onde o usuário será redirecionado no fim do processo. Para mais detalhes volte para criando um processo.
company.code	Sinaliza o código da empresa no ecossistema Unico.
company.friendlyName	Sinaliza o nome do cliente exibido na jornada do usuário.
company.logoUrl	Sinaliza a logo do cliente exibido na jornada do usuário.
userRedirectUrl	URL para onde você deverá redirecionar o usuário para finalização da jornada
state	Sinaliza o estado atual do processo, por ser do tipo: PROCESS_STATE_CREATED: Processo criado e ainda não finalizado pelo usuário. PROCESS_STATE_FINISHED: Processo finalizado pelo usuário com sucesso. PROCESS_STATE_FAILED: Processo criado ou finalizado com erro.
result	Sinaliza o resultado do processo da jornada do usuário, podendo ser do tipo: PROCESS_RESULT_OK: Processo finalizado com sucesso. PROCESS_RESULT_ERROR: Processo finalizado com algum tipo de erro. PROCESS_RESULT_INVALID_IDENTITY: Processo finalizado com com falha no liveness, ou resultado de inconclusivo quando flow = ID, ou quando no flow = IDCheck, houver uma divergência demorando mais que o tempo estabelecido. PROCESS_RESULT_UNSPECIFIED: É retornado quando o cliente utiliza o IDUnico sozinho. Processo finalizado com resultado não especificado.
person.personDuiType	Define o tipo de identificador do usuário. DUI_TYPE_BR_CPF: Para CPF como identificador.
person.personDuiValue	Define o valor do identificador do usuário especificado no campo personDuiType.
person.friendlyName	Define o nome do usuário, por exemplo, John Doe.
authenticationInfo.livenessResult	Enumerado que sinaliza o resultado do liveness. LIVENESS_RESULT_UNSPECIFIED: Retorno inesperado. LIVENESS_RESULT_NOT_LIVE: O usuário não passou na checagem de prova de vida LIVENESS_RESULT_LIVE: Foi verificada a prova de vida do usuário.
authenticationInfo.authenticationId	id do processo IDCloud que gerou a autenticação do usuário do processo By Unico
authenticationInfo.bioTokenEngineResult	Sinaliza o resultado do token biométrico. BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED: Caso esteja desabilitado ou processo ainda não tenha sido finalizado. BIO_TOKEN_ENGINE_RESULT_POSITIVE: Resultado positivo do token. BIO_TOKEN_ENGINE_RESULT_NEGATIVE: Resultado negativo do token.
capacities	Capacidades da Unico utilizadas em processos: PROCESS_CAPACITY_IDLIVE: com validação de identidade e prova de vida. PROCESS_CAPACITY_IDTOKEN: com verificação de autenticidade.
createdAt	Sinaliza o momento em que o processo foi criado.
finishedAt	Sinaliza o momento em que o processo foi concluído pelo usuário.
expiresAt	Sinaliza o momento em que o processo será/foi expirado, o valor desse campo é calculado a partir do campo expires_in informado na criação do processo com a data de criação do process, created_at.

Erro na Requisição

Para infomações sobre os erros retornados, consulte a lista disponível no artigo Response Errors.

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.