Pular para o conteúdo principal

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âmetroDescriçãoObrigatório
flowDefine o fluxo do processo a ser criado, por exemplo, id, cadByUnico, idpay, etc.Sim
callbackUriDefine para onde o consumidor final será redirecionado no fim do processo.Sim
person.personDuiTypeDefine o tipo de identificador do consumidor final, por exemplo, DUI_TYPE_BR_CPF.Sim
person.personDuiValueDefine o valor do identificador do consumidor final especificado no campo personDuiType.Sim
person.friendlyNameDefine o nome do consumidor final, por exemplo, João.Não
purposeDefine 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âmetroDescrição
idO identificador do processo.
flowSinaliza o fluxo do processo criado, por exemplo, id, cadByUnico, idpay, etc.
company.codeSinaliza o código da empresa no ecossistema Unico.
company.friendlyNameSinaliza o nome do cliente exibido ao usuário no fluxo do Cadastro by Unico.
company.logoUrlSinaliza a logo do cliente exibido ao usuário no fluxo do Cadastro by Unico.
callbackUriSinaliza para onde o consumidor final será redirecionado no fim do processo.
userRedirectUrlConjunto de informações necessárias para o cliente redirecionar o usuário
stateSinaliza o estado atual do processo, por ser do tipo: PROCESS_STATE_CREATED, PROCESS_STATE_FINISHED ou PROCESS_STATE_FAILED.
resultSinaliza 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.
resultMessagesDescreve o resultado do processo de validação de identidade do consumidor.
person.duiTypeSinaliza o tipo de identificador do consumidor final, por exemplo, DUI_TYPE_BR_CPF.
person.dui_valueSinaliza o valor do identificador do consumidor final especificado no campo personDuiType.
person.friendlyNameSinaliza o nome do consumidor final, por exemplo, João.
createdAtSinaliza o momento em que o processo foi criado.
finishedAtSinaliza 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.