Pular para o conteúdo principal
POST
Consulta restrição de crédito

Autorizações

x-api-key
string
header
obrigatório

Corpo

application/json
document
string
obrigatório

CPF ou CNPJ do titular consultado, com ou sem máscara. Separadores (incluindo a barra do CNPJ) são aceitos e ignorados. O dígito verificador é validado antes da consulta.

Exemplo:

"52998224725"

Resposta

Relatório de restrição de crédito do documento informado. Cada seção (protesto_sintetico, pend_financeiras, ch_sem_fundos_bacen, cadin) traz quantidade_ocorrencia e a lista ocorrencias, vazia quando não há aquela restrição. Um documento sem restrições é 200 com as listas vazias — não 404. Todos os valores são strings, no formato do fornecedor. O shape é o mesmo para CPF e CNPJ.

The response is of type object.