curl --request POST \
--url https://api.croma.run/br/pgfn/debtor/v1 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"document_number": "33.000.167/0001-01"
}
'import requests
url = "https://api.croma.run/br/pgfn/debtor/v1"
payload = { "document_number": "33.000.167/0001-01" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({document_number: '33.000.167/0001-01'})
};
fetch('https://api.croma.run/br/pgfn/debtor/v1', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.croma.run/br/pgfn/debtor/v1",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'document_number' => '33.000.167/0001-01'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.croma.run/br/pgfn/debtor/v1"
payload := strings.NewReader("{\n \"document_number\": \"33.000.167/0001-01\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.croma.run/br/pgfn/debtor/v1")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"document_number\": \"33.000.167/0001-01\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.croma.run/br/pgfn/debtor/v1")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"document_number\": \"33.000.167/0001-01\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"found": true,
"document_number": "<string>",
"as_of": "<string>",
"reference_month": "<string>",
"debtor_name": "<string>",
"totals": {
"debts": 123,
"principal_debts": 123,
"principal_amount": 123,
"in_court_amount": 123,
"by_regime": {
"nao_previdenciario": {
"debts": 123,
"amount": 123
},
"previdenciario": {
"debts": 123,
"amount": 123
},
"fgts": {
"debts": 123,
"amount": 123
}
},
"complete": true
},
"debts": [
{
"id": "<string>",
"regime": "nao_previdenciario",
"inscription_number": "<string>",
"document_number": "<string>",
"document": "<string>",
"cnpj_root": "<string>",
"debtor_name": "<string>",
"debtor_type": "principal",
"state": "<string>",
"responsible_unit": "<string>",
"registering_unit": "<string>",
"collecting_entity": "pgfn",
"status_type": "in_collection",
"status": "<string>",
"revenue_type": "<string>",
"registered_on": "<string>",
"in_court": true,
"amount": 123,
"reference_month": "<string>"
}
]
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"details": {}
}
}PGFN Debtor
Total what one Brazilian company owes the Union in the dívida ativa (Procuradoria-Geral da Fazenda Nacional), by CNPJ or by its 8-character root for every establishment: the number of debts, the amount owed as principal debtor, the part in court, a breakdown by regime (federal taxes, social security, FGTS), and the 50 largest debts. found: false when PGFN has inscribed nothing. Served by Croma (as_of says how current the data is), refreshed with each quarterly release.
Dataset endpoint: answers from the whole source in milliseconds and carries as_of.
curl --request POST \
--url https://api.croma.run/br/pgfn/debtor/v1 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"document_number": "33.000.167/0001-01"
}
'import requests
url = "https://api.croma.run/br/pgfn/debtor/v1"
payload = { "document_number": "33.000.167/0001-01" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({document_number: '33.000.167/0001-01'})
};
fetch('https://api.croma.run/br/pgfn/debtor/v1', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.croma.run/br/pgfn/debtor/v1",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'document_number' => '33.000.167/0001-01'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.croma.run/br/pgfn/debtor/v1"
payload := strings.NewReader("{\n \"document_number\": \"33.000.167/0001-01\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.croma.run/br/pgfn/debtor/v1")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"document_number\": \"33.000.167/0001-01\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.croma.run/br/pgfn/debtor/v1")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"document_number\": \"33.000.167/0001-01\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"found": true,
"document_number": "<string>",
"as_of": "<string>",
"reference_month": "<string>",
"debtor_name": "<string>",
"totals": {
"debts": 123,
"principal_debts": 123,
"principal_amount": 123,
"in_court_amount": 123,
"by_regime": {
"nao_previdenciario": {
"debts": 123,
"amount": 123
},
"previdenciario": {
"debts": 123,
"amount": 123
},
"fgts": {
"debts": 123,
"amount": 123
}
},
"complete": true
},
"debts": [
{
"id": "<string>",
"regime": "nao_previdenciario",
"inscription_number": "<string>",
"document_number": "<string>",
"document": "<string>",
"cnpj_root": "<string>",
"debtor_name": "<string>",
"debtor_type": "principal",
"state": "<string>",
"responsible_unit": "<string>",
"registering_unit": "<string>",
"collecting_entity": "pgfn",
"status_type": "in_collection",
"status": "<string>",
"revenue_type": "<string>",
"registered_on": "<string>",
"in_court": true,
"amount": 123,
"reference_month": "<string>"
}
]
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"details": {}
}
}Authorizations
Use Authorization: Bearer YOUR_API_KEY
Headers
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.
255"0f8e9a42-6b7c-4d1e-9a3f-2c5d7e8f9a0b"
Body
CNPJ de la empresa, con o sin puntuación, p. ej. 12.345.678/0001-90, o su raíz de 8 caracteres para sumar todos sus establecimientos.
^(?:[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})?)$Response
Successful response
Show child attributes
Show child attributes