APIs
Inicia processo de fluxo ordenado de steps
Fluxo ordenado
POST
Inicia processo de fluxo ordenado de steps
Use
POST /onboarding/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. Tem prioridade sobre o redirecionamento padrão das configurações. Se você não enviar, ou enviar em branco, o padrão é usado. Sem nenhum dos dois, não há redirecionamento.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 para autenticação do webhook. Envie a string
usuario:senha codificada em Base64. Enviamos esse valor ao seu webhook como Basic Auth.Exemplo: dXN1YXJpbzpzZW5oYQ==Response
Retorna o identificador do processo criado, a URL de acompanhamento e a data de criação.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, 422 e 500 (Internal server error). Todo erro tem o mesmo corpo: code, message e, nos erros de validação, details.
string
required
Código do erro. Valores:
BAD_REQUEST, VALIDATION_ERROR, INTERNAL_SERVER_ERROR.string
required
Mensagem do erro.
object[]
Um item por campo inválido. Vem nos erros
422.