Obter Resultado do Processo
Este guia explica como obter resultado de um processo através da API REST.
Faça uma requisição GET para o endpoint https://cadastro.unico.io/v1/process/{process_id}
Através do process_id é possível recuperar todas informações do processo.
Resultado:
No caso de sucesso, um '200 Sucesso' é enviado com as seguintes informações:
| Parâmetro | Descrição |
|---|---|
| id | O identificador do processo. |
| flow | Sinaliza o fluxo do processo criado, por exemplo, id, cadByUnico, idpay, etc. |
| company.code | Sinaliza o código da empresa no ecossistema Unico. |
| company.friendlyName | Sinaliza o nome do cliente exibido ao usuário no fluxo do Cadastro by Unico. |
| company.logoUrl | Sinaliza a logo do cliente exibido ao usuário no fluxo do Cadastro by Unico. |
| callbackUri | Sinaliza para onde o consumidor final será redirecionado no fim do processo. |
| userRedirectUrl | Conjunto de informações necessárias para o cliente redirecionar o usuário |
| state | Sinaliza o estado atual do processo, por ser do tipo: PROCESS_STATE_CREATED, PROCESS_STATE_FINISHED ou PROCESS_STATE_FAILED. |
| result | Sinaliza o resultado do processo de identificação do usuário, podendo ser do tipo: PROCESS_RESULT_OK, PROCESS_RESULT_WARNING, PROCESS_RESULT_ERROR, PROCESS_RESULT_INVALID_IDENTITY. |
| resultMessages | Descreve o resultado do processo de validação de identidade do consumidor. |
| person.duiType | Sinaliza o tipo de identificador do consumidor final, por exemplo, DUI_TYPE_BR_CPF. |
| person.dui_value | Sinaliza o valor do identificador do consumidor final especificado no campo personDuiType. |
| person.friendlyName | Sinaliza o nome do consumidor final, por exemplo, João. |
| createdAt | Sinaliza o momento em que o processo foi criado. |
| finishedAt | Sinaliza o momento em que o processo foi concluído pelo usuário. |
| documents.docId | Sinaliza o id do documento compartilhado pelo consumidor final. |
| documents.doc.code | Sinaliza o tipo de documento compartilhado, por exemplo, RG, CNH, etc. |
| documents.signedUrl | Sinaliza a URL por onde o documento pode ser acessado. |
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.