Solicitar código de senha
POST /passwords/send-forgot-password-code — etapa 1 do fluxo de recuperação de senha.
Solicitar código de recuperação de senha
Etapa 1 do fluxo de recuperação de senha (esqueci minha senha): dispara um código de verificação para o e-mail cadastrado. Não exige token JWT — projetado para o cenário em que o usuário não consegue mais autenticar. O X-Tenant-Id continua obrigatório para isolar o tenant.
Endpoint não autenticado (sem Authorization), mas o X-Tenant-Id é obrigatório — um mesmo documento pode existir em vários tenants. A combinação document + email funciona como prova fraca de identidade; a mensagem de erro é genérica de propósito (não confirma se o documento existe) para evitar enumeração. Etapa 2 segue o mesmo padrão do fluxo de PIN: receber o code por e-mail e enviar PUT em outro endpoint com { code, newPassword } para concluir a redefinição.
Headers
- AcceptObrigatóriostringapplication/json
- Content-TypeObrigatóriostringapplication/json
- X-Tenant-IdObrigatóriostring (UUID)Identificador do tenant.
Body
- documentObrigatóriostringCPF (11 dígitos) ou CNPJ (14 dígitos), apenas números.
- emailObrigatóriostringE-mail cadastrado na entidade. Precisa coincidir com entity.email — combinação document + email é validada como prova de identidade.
Exemplo de requisição
curl -X POST https://baas.staterpay.io/passwords/send-forgot-password-code \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "X-Tenant-Id: 00000000-0000-0000-0000-000000000000" \ -d '{ "document": "12345678900", "email": "fulano@example.com" }'Resposta
- messagestringMensagem de confirmação localizada.
// 200 OK — sucesso{ "message": "Código de recuperação de senha enviado com sucesso."}// 400 BAD_REQUEST — document + email não casam, ou não há cadastro{ "code": "BAD_REQUEST", "error": "Não foi possível recuperar a sua senha. Verifique se o e-mail e o documento estão corretos.", "message": "Não foi possível recuperar a sua senha. Verifique se o e-mail e o documento estão corretos."}https://baas.staterpay.io