Skip to main content
POST
PGFN Debts Search

Authorizations

Authorization
string
header
required

Use Authorization: Bearer YOUR_API_KEY

Headers

Idempotency-Key
string

Optional client-chosen key for this request (any string up to 255 characters, e.g. a UUID). Every Croma operation is an idempotent lookup: repeating a request with the same body returns the same result and creates nothing, so retrying after a timeout or network failure is always safe. The key is echoed back in the Idempotency-Key response header so you can correlate a retry with its first attempt. Each attempt that reaches the API counts against the rate limit.

Maximum string length: 255
Example:

"0f8e9a42-6b7c-4d1e-9a3f-2c5d7e8f9a0b"

Body

application/json
query
string
default:""

Palabras a buscar en los nombres (opcional).

Maximum string length: 200
document_number
string
default:""

CNPJ de la empresa deudora, con o sin puntuación, p. ej. 12.345.678/0001-90, o su raíz de 8 caracteres para todos sus establecimientos (opcional).

Pattern: ^(?:[A-Za-z0-9]{8}|[A-Za-z0-9]{12}\d{2}|[A-Za-z0-9]{2}\.[A-Za-z0-9]{3}\.[A-Za-z0-9]{3}(?:\/[A-Za-z0-9]{4}-\d{2})?)?$
regime
enum<string>
default:""

Tipo de deuda: nao_previdenciario (tributos y demás), previdenciario (contribuciones a la seguridad social) o fgts (opcional).

Available options:
,
nao_previdenciario,
previdenciario,
fgts
state
string
default:""

Sigla del estado (UF) de la empresa deudora, p. ej. SP (opcional).

Pattern: ^(?:[A-Za-z]{2})?$
status_type
enum<string>
default:""

Situación: in_collection (en cobro), tax_benefit (beneficio fiscal), guaranteed (garantizada), suspended_by_court (suspendida por decisión judicial), in_negotiation (en negociación) (opcional).

Available options:
,
in_collection,
tax_benefit,
guaranteed,
suspended_by_court,
in_negotiation
debtor_type
enum<string>
default:""

Papel de la empresa en la deuda: principal, co_responsible (corresponsable) o joint (solidaria) (opcional).

Available options:
,
principal,
co_responsible,
joint
in_court
enum<string>
default:any

yes solo deudas en ejecución judicial, no solo las que no, any ambas.

Available options:
any,
yes,
no
amount_min
number
default:0

Monto mínimo de la deuda en reales (opcional).

Required range: x >= 0
amount_max
number
default:0

Monto máximo de la deuda en reales; 0 sin límite (opcional).

Required range: x >= 0
page
integer
default:1

1-based page number for paginated results.

Required range: 1 <= x <= 1000
per_page
integer
default:20

Resultados por página (1-50).

Required range: 1 <= x <= 50

Response

Successful response

data
object
required