CNPJ API
ReferenceP G F N

Listar inscrições em dívida ativa

A credencial fica somente na memória desta página.
GET/v1/cnpjs/{cnpj}/dividas-pgfn

Autenticação

APIKeyHeader
X-API-Key<token>

Chave pública fornecida ao cliente

In: header

Parâmetros de caminho

cnpj*Cnpj

CNPJ completo com 14 dígitos, sem máscara.

Match^\d{14}$

Parâmetros de consulta

categoria?Categoria
Default"nao_previdenciario"

Value in

  • "nao_previdenciario"
  • "fgts"
  • "previdenciario"
limite?Limite
Range1 <= value <= 100
Default20
offset?Offset
Range0 <= value
Default0

Corpo da resposta

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/cnpjs/00000000000191/dividas-pgfn"
{  "fonte": {    "status": "string",    "versao": "string"  },  "itens": [    {      "cpf_cnpj": "string",      "data_inscricao": "string",      "dataset_trimester": "string",      "entidade_responsavel": "string",      "indicador_ajuizado": "string",      "nome_devedor": "string",      "numero_inscricao": "string",      "receita_principal": "string",      "situacao_inscricao": "string",      "tipo_credito": "string",      "tipo_devedor": "string",      "tipo_pessoa": "string",      "tipo_situacao_inscricao": "string",      "uf_unidade_responsavel": "string",      "unidade_inscricao": "string",      "unidade_responsavel": "string",      "valor_consolidado": "string"    }  ],  "paginacao": {    "limite": 1,    "offset": 0,    "total": 0  }}
{  "detail": "string"}
{  "detail": "string"}
{  "detail": [    {      "ctx": {},      "input": null,      "loc": [        "string"      ],      "msg": "string",      "type": "string"    }  ]}
{  "detail": "string"}
{  "detail": "string"}