POST /api/v1/steps/flow para iniciar um processo de fluxo ordenado de steps do onboarding. A requisição espera os dados do usuário e informações de configuração como URL de redirecionamento e dados do webhook para entrega do resultado.
A API irá iniciar um novo processo de fluxo e retornar o identificador do processo criado, a URL para acompanhar o processo e a data de criação.
Requisito: é necessário enviar o header de autenticação, mais informações aqui
Request Body
string
CPF do indivíduo.Exemplo:
12345678900string
Nome do indivíduo.Exemplo:
João Silvastring
E-mail do usuário.Exemplo:
joao@example.comstring
Celular do usuário (10 ou 11 dígitos). Deve corresponder ao padrão
^\d{10,11}$.Exemplo: 11991234567string
Caminho de redirecionamento do aplicativo após a conclusão.Exemplo:
/onboarding/redirectstring
Identificador externo do processo, definido pelo integrador (máximo de 50 caracteres).Exemplo:
05be75cc-8f8a-414a-891f-434aa9b4e7a5string
URL para notificação de webhook com o resultado final.Exemplo:
https://seusistema.com/webhookstring
Credenciais Basic Auth (
usuario:senha) para autenticação do webhook.Exemplo: usuario:senhaResponse
Retorna o identificador do processo criado, a URL de acompanhamento e a data de criação.Exemplo de sucesso (200 OK)
string
required
ID único da requisição iniciada.
string
required
URL do processo de flow recém-criado.
string
required
Data e hora de criação da requisição.
Respostas de Erro
A API pode retornar os status400 (Bad request), 422 (Validation or semantic error) e 500 (Internal server error), seguindo o modelo padrão de erro da aplicação.
string
required
Código do erro que categoriza o tipo de erro.Exemplo:
VALIDATION_ERRORstring
required
Mensagem de erro.Exemplo:
The request is invalidobject[]
Lista contendo ou não um erro detalhado.
field(string): caminho do campo incorreto ou inválido. Exemplo:namemessage(string): mensagem de erro do campo. Exemplo:The field cannot be blank