Pix

Consultar titular PIX quando a verificação estiver disponível

Consulta auxiliar de titular. Quando desabilitada, retorna HTTP 200 com verified=false, available=false, verification_status=not_performed, source=disabled e dados de titular nulos. Isso não desabilita pagamentos. Quando disponível, retorna dados obtidos do DICT sujeitos a cache e rate limit. Sandbox retorna titular fictício, source=sandbox. Não trate HTTP 200 isoladamente como titular verificado; envie type explícito quando souber o tipo.

get/pix/keys/lookup

Request

  • Base URL: https://api.luniumpay.com
  • URL: https://api.luniumpay.com/pix/keys/lookup
  • Auth: API key in header X-API-Key

Query parameters

keystring required

A chave PIX (CPF, CNPJ, e-mail, telefone com ou sem +55, ou aleatória).

type'cpf' | 'cnpj' | 'phone' | 'email' | 'random'

Opcional. Deduzido do formato quando ausente.

Response

Titular encontrado.

pix_keystring required

A chave, normalizada (telefone em +55…).

pix_key_type'cpf' | 'cnpj' | 'phone' | 'email' | 'random' required

Tipo da chave consultada: "cpf", "cnpj", "phone", "email" ou "random".

owner_namestring nullable required

Nome do titular, como está no DICT.

owner_tax_numberstring nullable

CPF/CNPJ MASCARADO. Nunca vem inteiro.

institution_namestring nullable

Instituição onde a chave está registrada.

ispbstring nullable

ISPB da instituição (8 dígitos).

verifiedboolean required

true quando titular foi consultado ou simulado (source=sandbox); false quando não verificado.

source'dict' | 'sandbox' | 'disabled' required
checked_atstring date-time required
cachedboolean

true quando a resposta veio do cache de 24h.

sandboxboolean

Só em chave de teste: titular fictício.

availableboolean

false quando consulta está indisponível; pode vir com HTTP 200.

optionalboolean

Consulta é auxiliar; não é um requisito de pagamento.

verification_statusstring

not_performed quando a verificação não foi executada.

detailstring

Example response

{
  "owner_name": "João Silva",
  "owner_tax_number": "***.202.745-**",
  "institution_name": "NU PAGAMENTOS - IP",
  "ispb": "18236120"
}

Changes

No recorded changes to this operation across all 3 revisions of this API.