Iniciar verificação de chave
POST /accounts/:accountId/pix/keys/verifications — etapa 1 do cadastro EMAIL/PHONE.
Iniciar verificação de chave
Etapa 1 do cadastro de chaves EMAIL/PHONE: dispara o envio do código OTP (e-mail ou SMS) e devolve um verificationId. Use esse verificationId + o otpCode recebido em POST /pix/keys pra finalizar o cadastro. EVP/CPF/CNPJ não passam por aqui — cadastre direto em POST /pix/keys.
POST/accounts/:accountId/pix/keys/verifications
Etapa 1 de 2 do cadastro de chaves EMAIL/PHONE. EVP/CPF/CNPJ pulam essa etapa. O código OTP chega por e-mail (EMAIL) ou SMS (PHONE) no valor da key informado. expiresAt costuma ser curto (~10 minutos) — se estourar, dispare outro POST /verifications. Tentar registrar EMAIL/PHONE em POST /pix/keys sem um verificationId válido retorna 4xx.
Path params
- accountIdObrigatóriostring (UUID)ID da conta que vai receber a chave.
Headers
- AcceptObrigatóriostringapplication/json
- Content-TypeObrigatóriostringapplication/json
- AuthorizationObrigatóriostringBearer <token> — JWT de /authenticate.
- X-Tenant-IdObrigatóriostring (UUID)Identificador do tenant.
Body
- keyObrigatóriostringValor da chave a verificar: e-mail (ex.: fulano@example.com) ou telefone E.164 (ex.: +5511999999999).
- keyTypeObrigatório"EMAIL" | "PHONE"Tipo da chave. Apenas EMAIL e PHONE exigem verificação OTP.
Exemplo de requisição
curl -X POST https://baas.staterpay.io/accounts/00000000-0000-0000-0000-000000000010/pix/keys/verifications \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.<payload>.<signature>" \ -H "X-Tenant-Id: 00000000-0000-0000-0000-000000000000" \ -d '{ "key": "fulano@example.com", "keyType": "EMAIL" }'Resposta
- verificationIdstring (UUID)ID da verificação iniciada. Passe junto com o otpCode em POST /pix/keys pra finalizar o cadastro.
- expiresAtstring (ISO 8601 UTC)Quando o verificationId/OTP expiram. Após esse momento é preciso iniciar nova verificação.
json
{ "verificationId": "00000000-0000-0000-0000-0000000000b2", "expiresAt": "2026-05-15T18:24:51.920Z"}URL base:
https://baas.staterpay.io