Docs
EntrarCriar conta
Ambiente
Base URLhttps://api.sancopay.com/api/v1
Arquivo para IA
Saques PixMódulo opcional

Validação da chave

Com a validação de chave ativa, o primeiro envio para um destinatário consulta o titular da chave no DICT antes de pagar. Assim você confere nome e documento e evita mandar Pix para a pessoa errada.

Fluxo

  1. POST /payouts responde 202 com code: "key_verification_required" e o verification.id.
  2. Consulte GET /key-verifications/{id} a cada ~3 segundos enquanto status for validating.
  3. Com status: "completed", confira recipient.name, recipient.tax_id e recipient.bank.
  4. Se estiver certo, confirme o envio reenviando o mesmo corpo com verify_key: false.
GET/key-verifications/{id}

Status e dados do titular da chave.

Parâmetros da URL

CampoTipoDescrição
idobrigatóriostringO verification.id da resposta 202.
Requisição
curl -X GET "https://api.sancopay.com/api/v1/key-verifications/dict-c3e1095975f2690f35bd0e233c6b3447" \  -H "Authorization: Bearer <TOKEN>"
Resposta
{  "id": "dict-c3e1095975f2690f35bd0e233c6b3447",  "status": "completed",  "pix": {    "type": "email",    "key": "[email protected]"  },  "recipient": {    "name": "JOAO PEREIRA",    "tax_id": "***.654.321-**",    "bank": "Banco Exemplo S.A."  },  "updated_at": "2026-11-09T15:04:09.000000Z"}

Status da validação

validating
Consulta em andamento: aguarde e consulte de novo.
completed
Titular encontrado: confira os dados e confirme.
failed
Não foi possível validar a chave. Confira a chave com o destinatário.