APIs
Inicia processo de verificação de MFA
Inicie a verificação de MFA (autenticação multifator) informando o CPF do usuário e, opcionalmente, celular e/ou e-mail para envio do código.
POST
Inicia processo de verificação de MFA
Use
POST /onboarding/api/v1/steps/mfa para iniciar o processo de verificação de MFA (autenticação multifator). A requisição espera receber o CPF do usuário e, opcionalmente, celular e/ou e-mail para envio do código. Além dessas informações é possível configurar a URL de redirecionamento e os dados do webhook para entrega do resultado.
A API irá iniciar um novo processo de verificação de MFA 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
required
CPF do indivíduo.Exemplo:
12345678900string
Caminho ou URL para onde a pessoa vai depois de concluir a etapa. É opcional: se você não enviar, a pessoa fica na tela de sucesso, sem redirecionamento. Não envie em branco:
"" retorna 422.Exemplo: /onboarding/redirectstring
Celular do usuário (10 ou 11 dígitos) para envio do código MFA.Exemplo:
11991234567string
E-mail do usuário para envio do código MFA.Exemplo:
test@test.comstring
Seu identificador do processo (máximo de 50 caracteres). Volta no webhook (
externalId) e na consulta de resultado (requestData.externalId), e permite buscar o resultado em GET /onboarding/api/v1/steps/result/external-id/{externalId}.Exemplo: order-12345string
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
URL para a próxima etapa ou visualização do recurso.
string
required
ID único da requisição iniciada.
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.