Criar Processo
Este guia explica como criar um processo através da API REST.
Faça uma requisição POST para o endpoint https://cadastro.unico.io/v1/process
Parâmetro | Descrição | Obrigatório |
---|---|---|
flow | Define o fluxo do processo a ser criado, por exemplo, id, cadByUnico, idpay, etc. | Sim |
callbackUri | Define para onde o consumidor final será redirecionado no fim do processo. | Sim |
person.personDuiType | Define o tipo de identificador do consumidor final, por exemplo, DUI_TYPE_BR_CPF. | Sim |
person.personDuiValue | Define o valor do identificador do consumidor final especificado no campo personDuiType. | Sim |
person.friendlyName | Define o nome do consumidor final, por exemplo, João. | Não |
purpose | Define o propósito de uso e coleta de dados do consumidor final. Serve para dar transparência e garantir o tratamento de dados correto pela LGPD, por exemplo, Abertura de conta. | Sim |
Resultado:
No caso de sucesso, um '201 Created' é 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. |
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.