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
Exemplo de sucesso (
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
required
Caminho de redirecionamento do aplicativo após a conclusão.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
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
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 (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
Previous
Inicia processo de upload de arquivoInicie o processo de upload de arquivo informando o CPF do usuário e os dados de configuração do webhook para entrega do resultado.
Next
Inicia processo de verificação de MFA