GetProcess - IDdocsign flow

Este artigo explica como obter o resultado de um processo no fluxo do iddocsign 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": "53060f52-f146-4c12-a234-5bb5031f6f5b",
        "flow": "iddocssign",
        "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": {
            "authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE",
            "scoreEngineResult": {
                "scoreEnabled": "SCORE_ENABLED_TRUE",
                "score": 50
            },
            "authenticationId": "fd433602-d496-4291-adbb-dda95a3e50b1",
            "livenessResult": "LIVENESS_RESULT_LIVE"
        },
        "capacities": [
            "PROCESS_CAPACITY_IDUNICO",
            "PROCESS_CAPACITY_IDCHECK",
            "PROCESS_CAPACITY_IDDOCS",
            "PROCESS_CAPACITY_IDSIGN",
            "PROCESS_CAPACITY_IDLIVE"
        ],
        "services": [
            {
                 "documents": [
                    {
                        "doc": {
                            "code": "RG"
                        },
                        "typified": true,
                        "cpf_match": true,
                        "doc_id": "1e61a978-3673-4fdd-8fa8-808d0a26d131",
                        "validate_doc": true,
                        "reused_doc": true,                        
                        "signed_url": "https://api.datafortress.dev.private.unico.run/url-signer/signature/dmF1bHQ6[...]OXc9PQ%3D%3D"
                    }
                ],
                "consent_granted": true
            },
            {
                "envelopeId": "4d4f3d90-04a3-4259-b63b-930ab10d2e47",
                "documentIds": [
                    "03307601-b518-49ca-b368-ae3919e24e54"
                ]
            }
        ],
        "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 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.
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. `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.authenticationResult	Resultado da validação de identidade pelo IDUnico. `AUTHENTICATION_RESULT_UNSPECIFIED`: É retornado quando o cliente utiliza o IDUnico sozinho. Situações de retorno: - Não foi possível encontrar o usuário na base de autenticados; - Inconsistencia encontrada, por exemplo: Não houve retorno da orquestração com o check, cadastros com divergências. `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. `SCORE_ENABLED_UNSPECIFIED`: Não especificado. Ocorre quando authenticationResult também for não especificado.
authenticationInfo.authenticationResult .scoreEngineResult.score	Sinaliza o resultado do score do Check. `0`: Caso esteja desabilitado. `-100 a 100`: Resultado do score.
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
capacities	Capacidades da Unico utilizadas em processos: `PROCESS_CAPACITY_IDUNICO`: com validação de identidade com biometria facial. `PROCESS_CAPACITY_IDCHECK`: com validação de identidade com biometria facial e score no caso de inclonclusivo. `PROCESS_CAPACITY_IDDOCS`: com validação de identidade com captura e reaproveitamento de documentos (RG ou CNH). `PROCESS_CAPACITY_IDSIGN`: com validação de identidade com assinatura eletrônica. `PROCESS_CAPACITY_IDLIVE`: com validação de identidade e prova de vida.
services.docs.documents	service.docs: Apresenta os dados compartilhados pela etapa de documentos. .documents: Lista de documentos compartilhados pelo usuário.
services.docs.documents.doc.code	Quando tipificado retornará RG ou CNH, quando não “Desconhecido `RG`: Sinaliza que o documento compartilhado é do tipo RG. `CNH`: Sinaliza que o documento compartilhado é do tipo CNH. Um documento é tipificado quando é possível identificar o layout desse documento durante a captura da imagem.
services.docs.documents.doc_id	Identificador único do documento compartilhado.
services.docs.documents.signed_url	Sinaliza a URL assinada do documento.
services.docs.documents.validate_doc	Sinaliza se houve (true) ou não (false) validação do documento. Um documento é validado quando é possível identificar que o CPF do documento é o mesmo do usuário.
services.docs.documents.reuse_doc	Sinaliza se houve (true) ou não (false) reaproveitamento do documento. Um documento é reaproveitado quando já existe na base da dados da Unico e o usuário deu permissão para reutilizá-lo sem a necessidade de uma nova captura.
services.docs.documents.typified	Sinaliza se houve (true) ou não (false) a tipificação do documento. Um documento é tipificado quando é possível identificar o seu layout.
services.docs.documents.cpf_match	Sinaliza se o CPF da requisição é o mesmo do documento. Se sim (true), se não (false).
services.docs.consent_granted	Sinaliza se houve (true) ou não (false) consentimento do usuário.
services.sign.signature	Apresenta os dados compartilhados pela etapa de assinatura.
services.sign.signature.envelopeId	Identificador único do envelope assinado.
services.sign.signature.documentIds	Array de identificadores dos documentos do envelope.
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.

Como usar?​

Requisição executada com sucesso​

Erro na Requisição​

Dúvidas?​

Como usar?

Requisição executada com sucesso

Erro na Requisição

Dúvidas?