Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
curl --request GET \
--url http://localhost:3000/v2/entities/{id}/serasa \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/v2/entities/{id}/serasa"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/v2/entities/{id}/serasa', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v2/entities/{id}/serasa",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/v2/entities/{id}/serasa"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/v2/entities/{id}/serasa")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/entities/{id}/serasa")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "list",
"results": [
{
"sourceDataset": "serasa_relato",
"observedAt": "2026-05-08T12:30:00.000Z",
"data": {
"status": true,
"message": "<string>",
"total_occurrences": 123,
"total_occurrences_value": "<string>",
"cadastral_summary": {
"name": "<string>",
"document": "<string>",
"rfb_status": "<string>",
"rfb_status_description": "<string>",
"update_date": "<string>",
"company_alias": "<string>",
"phone": "<string>",
"company_url": "<string>",
"partnership": "<string>",
"company_register": "<string>",
"company_register_date": "<string>",
"company_foundation": "<string>",
"number_employees": 123,
"tax_option": "<string>",
"economic_activity": "<string>",
"import_purchases": "<string>",
"export_sales": "<string>",
"cnae": "<string>",
"serasa_active_code": "<string>",
"branch_offices": "<string>",
"nire_number": "<string>",
"legal_nature_code": "<string>"
},
"financial_pending": {
"message": "<string>",
"total_occurrences": 123,
"newest_occurrence": "<string>",
"oldest_occurrence": "<string>",
"total_occurrences_value": "<string>",
"financial_pending_details": [
{
"value": "<string>",
"origin": "<string>",
"acronym": "<string>",
"contract": "<string>",
"modality": "<string>",
"cadus": "<string>",
"guarantor": "<string>",
"under_judge": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
],
"internal_pending_details": [
{
"value": "<string>",
"origin": "<string>",
"acronym": "<string>",
"contract": "<string>",
"modality": "<string>",
"cadus": "<string>",
"guarantor": "<string>",
"under_judge": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
],
"collection_details": [
{
"value": "<string>",
"origin": "<string>",
"acronym": "<string>",
"contract": "<string>",
"modality": "<string>",
"cadus": "<string>",
"guarantor": "<string>",
"under_judge": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
]
},
"internal_pending": {
"message": "<string>",
"total_occurrences": 123,
"newest_occurrence": "<string>",
"oldest_occurrence": "<string>",
"total_occurrences_value": "<string>",
"financial_pending_details": [
{
"value": "<string>",
"origin": "<string>",
"acronym": "<string>",
"contract": "<string>",
"modality": "<string>",
"cadus": "<string>",
"guarantor": "<string>",
"under_judge": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
],
"internal_pending_details": [
{
"value": "<string>",
"origin": "<string>",
"acronym": "<string>",
"contract": "<string>",
"modality": "<string>",
"cadus": "<string>",
"guarantor": "<string>",
"under_judge": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
],
"collection_details": [
{
"value": "<string>",
"origin": "<string>",
"acronym": "<string>",
"contract": "<string>",
"modality": "<string>",
"cadus": "<string>",
"guarantor": "<string>",
"under_judge": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
]
},
"collections": {
"message": "<string>",
"total_occurrences": 123,
"newest_occurrence": "<string>",
"oldest_occurrence": "<string>",
"total_occurrences_value": "<string>",
"financial_pending_details": [
{
"value": "<string>",
"origin": "<string>",
"acronym": "<string>",
"contract": "<string>",
"modality": "<string>",
"cadus": "<string>",
"guarantor": "<string>",
"under_judge": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
],
"internal_pending_details": [
{
"value": "<string>",
"origin": "<string>",
"acronym": "<string>",
"contract": "<string>",
"modality": "<string>",
"cadus": "<string>",
"guarantor": "<string>",
"under_judge": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
],
"collection_details": [
{
"value": "<string>",
"origin": "<string>",
"acronym": "<string>",
"contract": "<string>",
"modality": "<string>",
"cadus": "<string>",
"guarantor": "<string>",
"under_judge": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
]
},
"bacen_pending": {
"message": "<string>",
"total_occurrences": 123,
"newest_occurrence": "<string>",
"oldest_occurrence": "<string>",
"total_occurrences_value": "<string>",
"bacen_pending_details": [
{
"city": "<string>",
"state": "<string>",
"agency": "<string>",
"bank_code": "<string>",
"bank_name": "<string>",
"check_line": "<string>",
"check_number": "<string>",
"occurrence_date": "<string>",
"bank_ccf_quantity": "<string>"
}
]
},
"protests": {
"message": "<string>",
"total_occurrences": 123,
"newest_occurrence": "<string>",
"oldest_occurrence": "<string>",
"total_occurrences_value": "<string>",
"protest_details": [
{
"value": "<string>",
"city": "<string>",
"state": "<string>",
"notary": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
],
"lawsuit_details": [
{
"value": "<string>",
"city": "<string>",
"state": "<string>",
"notary": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
],
"bankruptcy_details": [
{
"value": "<string>",
"city": "<string>",
"state": "<string>",
"notary": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
]
},
"lawsuits": {
"message": "<string>",
"total_occurrences": 123,
"newest_occurrence": "<string>",
"oldest_occurrence": "<string>",
"total_occurrences_value": "<string>",
"protest_details": [
{
"value": "<string>",
"city": "<string>",
"state": "<string>",
"notary": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
],
"lawsuit_details": [
{
"value": "<string>",
"city": "<string>",
"state": "<string>",
"notary": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
],
"bankruptcy_details": [
{
"value": "<string>",
"city": "<string>",
"state": "<string>",
"notary": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
]
},
"bankruptcies": {
"message": "<string>",
"total_occurrences": 123,
"newest_occurrence": "<string>",
"oldest_occurrence": "<string>",
"total_occurrences_value": "<string>",
"protest_details": [
{
"value": "<string>",
"city": "<string>",
"state": "<string>",
"notary": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
],
"lawsuit_details": [
{
"value": "<string>",
"city": "<string>",
"state": "<string>",
"notary": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
],
"bankruptcy_details": [
{
"value": "<string>",
"city": "<string>",
"state": "<string>",
"notary": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
]
},
"document_alerts": {
"message": "<string>",
"total_messages": "<string>",
"contact_phones": [
{
"phone": "<string>"
}
],
"document_type": "<string>",
"document_number": "<string>",
"occurrence_reason": "<string>",
"occurrence_date": "<string>"
},
"risk_score": {
"pessoa_juridica": {
"pontuacao": 123,
"modelo": "<string>",
"faixa": "<string>",
"probabilidade_inadimplencia": 123,
"codigo_mensagem": 123,
"mensagem": "<string>"
}
},
"inquiries": {
"actual": 123,
"historical": [
{
"inquiry_date": "<string>",
"occurrences": 123
}
]
},
"commercial_payment_history": {
"titles_quantity": [
{
"range_code": "<string>",
"name": "<string>",
"range": "<string>",
"range_value_from": "<string>",
"range_value_to": "<string>",
"percentage": "<string>",
"percentage_from": "<string>",
"percentage_to": "<string>"
}
],
"months": [
{
"month": "<string>",
"period_list": [
{
"range_code": "<string>",
"name": "<string>",
"range": "<string>",
"range_value_from": "<string>",
"range_value_to": "<string>",
"percentage": "<string>",
"percentage_from": "<string>",
"percentage_to": "<string>"
}
]
}
],
"average_delay_periods": [
{
"range_code": "<string>",
"name": "<string>",
"range": "<string>",
"range_value_from": "<string>",
"range_value_to": "<string>",
"percentage": "<string>",
"percentage_from": "<string>",
"percentage_to": "<string>"
}
],
"main_suppliers_last_update_date": "<string>",
"main_suppliers": [
{
"supplier_name": "<string>",
"supplier_document": "<string>"
}
],
"relationship_suppliers_last_update_date": "<string>",
"relationship_suppliers_periods": [
{
"relationship_period_description": "<string>",
"relationship_source_quantity": 123
}
],
"relationship_suppliers_summary": {
"sources_total": 123,
"payment_history_sources": 123,
"payment_history_values_sources": 123,
"evolution_commitments_sources": 123,
"business_references_sources": 123,
"spot_payment_business_references_sources": 123
},
"evolution_commitments_last_update_date": "<string>",
"evolution_commitments": [
{
"year_commitment": "<string>",
"month_commitment": "<string>",
"description_month_commitment": "<string>",
"expired_track_description": "<string>",
"value_overdue_commitments_from": "<string>",
"value_overdue_commitments_to": "<string>",
"track_description_to_expire": "<string>",
"value_commitments_due_from": "<string>",
"value_commitments_due_to": "<string>",
"total_month_range_description": "<string>",
"total_monthly_range_value_from": "<string>",
"total_monthly_range_value_to": "<string>",
"segment_information": "<string>"
}
],
"business_references_last_update_date": "<string>",
"business_references": [
{
"business_description": "<string>",
"year_potential_date": "<string>",
"month_potential_date": "<string>",
"potential_value_range_description": "<string>",
"potential_value_from": "<string>",
"potential_value_to": "<string>",
"potential_midrange_description": "<string>",
"potential_midrange_value_from": "<string>",
"potential_midrange_value_to": "<string>"
}
],
"segment_description": "<string>"
}
}
}
],
"has_more": true,
"metadata": {
"status": "NOT_QUERIED",
"provenance": {
"datasets": [
{
"datasetSlug": "<string>",
"requirement": "required",
"visible": true,
"onRefresh": true,
"sourcePriority": 123,
"status": "NOT_QUERIED",
"queryId": "<string>",
"observedAt": "<string>",
"recordedAt": "<string>",
"errorCode": "upstream_error"
}
]
},
"summary": "<string>"
},
"next_cursor": "<string>",
"type": "<string>"
}curl --request GET \
--url http://localhost:3000/v2/entities/{id}/serasa \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/v2/entities/{id}/serasa"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/v2/entities/{id}/serasa', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v2/entities/{id}/serasa",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/v2/entities/{id}/serasa"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/v2/entities/{id}/serasa")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/entities/{id}/serasa")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "list",
"results": [
{
"sourceDataset": "serasa_relato",
"observedAt": "2026-05-08T12:30:00.000Z",
"data": {
"status": true,
"message": "<string>",
"total_occurrences": 123,
"total_occurrences_value": "<string>",
"cadastral_summary": {
"name": "<string>",
"document": "<string>",
"rfb_status": "<string>",
"rfb_status_description": "<string>",
"update_date": "<string>",
"company_alias": "<string>",
"phone": "<string>",
"company_url": "<string>",
"partnership": "<string>",
"company_register": "<string>",
"company_register_date": "<string>",
"company_foundation": "<string>",
"number_employees": 123,
"tax_option": "<string>",
"economic_activity": "<string>",
"import_purchases": "<string>",
"export_sales": "<string>",
"cnae": "<string>",
"serasa_active_code": "<string>",
"branch_offices": "<string>",
"nire_number": "<string>",
"legal_nature_code": "<string>"
},
"financial_pending": {
"message": "<string>",
"total_occurrences": 123,
"newest_occurrence": "<string>",
"oldest_occurrence": "<string>",
"total_occurrences_value": "<string>",
"financial_pending_details": [
{
"value": "<string>",
"origin": "<string>",
"acronym": "<string>",
"contract": "<string>",
"modality": "<string>",
"cadus": "<string>",
"guarantor": "<string>",
"under_judge": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
],
"internal_pending_details": [
{
"value": "<string>",
"origin": "<string>",
"acronym": "<string>",
"contract": "<string>",
"modality": "<string>",
"cadus": "<string>",
"guarantor": "<string>",
"under_judge": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
],
"collection_details": [
{
"value": "<string>",
"origin": "<string>",
"acronym": "<string>",
"contract": "<string>",
"modality": "<string>",
"cadus": "<string>",
"guarantor": "<string>",
"under_judge": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
]
},
"internal_pending": {
"message": "<string>",
"total_occurrences": 123,
"newest_occurrence": "<string>",
"oldest_occurrence": "<string>",
"total_occurrences_value": "<string>",
"financial_pending_details": [
{
"value": "<string>",
"origin": "<string>",
"acronym": "<string>",
"contract": "<string>",
"modality": "<string>",
"cadus": "<string>",
"guarantor": "<string>",
"under_judge": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
],
"internal_pending_details": [
{
"value": "<string>",
"origin": "<string>",
"acronym": "<string>",
"contract": "<string>",
"modality": "<string>",
"cadus": "<string>",
"guarantor": "<string>",
"under_judge": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
],
"collection_details": [
{
"value": "<string>",
"origin": "<string>",
"acronym": "<string>",
"contract": "<string>",
"modality": "<string>",
"cadus": "<string>",
"guarantor": "<string>",
"under_judge": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
]
},
"collections": {
"message": "<string>",
"total_occurrences": 123,
"newest_occurrence": "<string>",
"oldest_occurrence": "<string>",
"total_occurrences_value": "<string>",
"financial_pending_details": [
{
"value": "<string>",
"origin": "<string>",
"acronym": "<string>",
"contract": "<string>",
"modality": "<string>",
"cadus": "<string>",
"guarantor": "<string>",
"under_judge": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
],
"internal_pending_details": [
{
"value": "<string>",
"origin": "<string>",
"acronym": "<string>",
"contract": "<string>",
"modality": "<string>",
"cadus": "<string>",
"guarantor": "<string>",
"under_judge": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
],
"collection_details": [
{
"value": "<string>",
"origin": "<string>",
"acronym": "<string>",
"contract": "<string>",
"modality": "<string>",
"cadus": "<string>",
"guarantor": "<string>",
"under_judge": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
]
},
"bacen_pending": {
"message": "<string>",
"total_occurrences": 123,
"newest_occurrence": "<string>",
"oldest_occurrence": "<string>",
"total_occurrences_value": "<string>",
"bacen_pending_details": [
{
"city": "<string>",
"state": "<string>",
"agency": "<string>",
"bank_code": "<string>",
"bank_name": "<string>",
"check_line": "<string>",
"check_number": "<string>",
"occurrence_date": "<string>",
"bank_ccf_quantity": "<string>"
}
]
},
"protests": {
"message": "<string>",
"total_occurrences": 123,
"newest_occurrence": "<string>",
"oldest_occurrence": "<string>",
"total_occurrences_value": "<string>",
"protest_details": [
{
"value": "<string>",
"city": "<string>",
"state": "<string>",
"notary": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
],
"lawsuit_details": [
{
"value": "<string>",
"city": "<string>",
"state": "<string>",
"notary": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
],
"bankruptcy_details": [
{
"value": "<string>",
"city": "<string>",
"state": "<string>",
"notary": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
]
},
"lawsuits": {
"message": "<string>",
"total_occurrences": 123,
"newest_occurrence": "<string>",
"oldest_occurrence": "<string>",
"total_occurrences_value": "<string>",
"protest_details": [
{
"value": "<string>",
"city": "<string>",
"state": "<string>",
"notary": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
],
"lawsuit_details": [
{
"value": "<string>",
"city": "<string>",
"state": "<string>",
"notary": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
],
"bankruptcy_details": [
{
"value": "<string>",
"city": "<string>",
"state": "<string>",
"notary": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
]
},
"bankruptcies": {
"message": "<string>",
"total_occurrences": 123,
"newest_occurrence": "<string>",
"oldest_occurrence": "<string>",
"total_occurrences_value": "<string>",
"protest_details": [
{
"value": "<string>",
"city": "<string>",
"state": "<string>",
"notary": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
],
"lawsuit_details": [
{
"value": "<string>",
"city": "<string>",
"state": "<string>",
"notary": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
],
"bankruptcy_details": [
{
"value": "<string>",
"city": "<string>",
"state": "<string>",
"notary": "<string>",
"occurrence_date": "<string>",
"annotation_type": "<string>",
"annotation_type_description": "<string>"
}
]
},
"document_alerts": {
"message": "<string>",
"total_messages": "<string>",
"contact_phones": [
{
"phone": "<string>"
}
],
"document_type": "<string>",
"document_number": "<string>",
"occurrence_reason": "<string>",
"occurrence_date": "<string>"
},
"risk_score": {
"pessoa_juridica": {
"pontuacao": 123,
"modelo": "<string>",
"faixa": "<string>",
"probabilidade_inadimplencia": 123,
"codigo_mensagem": 123,
"mensagem": "<string>"
}
},
"inquiries": {
"actual": 123,
"historical": [
{
"inquiry_date": "<string>",
"occurrences": 123
}
]
},
"commercial_payment_history": {
"titles_quantity": [
{
"range_code": "<string>",
"name": "<string>",
"range": "<string>",
"range_value_from": "<string>",
"range_value_to": "<string>",
"percentage": "<string>",
"percentage_from": "<string>",
"percentage_to": "<string>"
}
],
"months": [
{
"month": "<string>",
"period_list": [
{
"range_code": "<string>",
"name": "<string>",
"range": "<string>",
"range_value_from": "<string>",
"range_value_to": "<string>",
"percentage": "<string>",
"percentage_from": "<string>",
"percentage_to": "<string>"
}
]
}
],
"average_delay_periods": [
{
"range_code": "<string>",
"name": "<string>",
"range": "<string>",
"range_value_from": "<string>",
"range_value_to": "<string>",
"percentage": "<string>",
"percentage_from": "<string>",
"percentage_to": "<string>"
}
],
"main_suppliers_last_update_date": "<string>",
"main_suppliers": [
{
"supplier_name": "<string>",
"supplier_document": "<string>"
}
],
"relationship_suppliers_last_update_date": "<string>",
"relationship_suppliers_periods": [
{
"relationship_period_description": "<string>",
"relationship_source_quantity": 123
}
],
"relationship_suppliers_summary": {
"sources_total": 123,
"payment_history_sources": 123,
"payment_history_values_sources": 123,
"evolution_commitments_sources": 123,
"business_references_sources": 123,
"spot_payment_business_references_sources": 123
},
"evolution_commitments_last_update_date": "<string>",
"evolution_commitments": [
{
"year_commitment": "<string>",
"month_commitment": "<string>",
"description_month_commitment": "<string>",
"expired_track_description": "<string>",
"value_overdue_commitments_from": "<string>",
"value_overdue_commitments_to": "<string>",
"track_description_to_expire": "<string>",
"value_commitments_due_from": "<string>",
"value_commitments_due_to": "<string>",
"total_month_range_description": "<string>",
"total_monthly_range_value_from": "<string>",
"total_monthly_range_value_to": "<string>",
"segment_information": "<string>"
}
],
"business_references_last_update_date": "<string>",
"business_references": [
{
"business_description": "<string>",
"year_potential_date": "<string>",
"month_potential_date": "<string>",
"potential_value_range_description": "<string>",
"potential_value_from": "<string>",
"potential_value_to": "<string>",
"potential_midrange_description": "<string>",
"potential_midrange_value_from": "<string>",
"potential_midrange_value_to": "<string>"
}
],
"segment_description": "<string>"
}
}
}
],
"has_more": true,
"metadata": {
"status": "NOT_QUERIED",
"provenance": {
"datasets": [
{
"datasetSlug": "<string>",
"requirement": "required",
"visible": true,
"onRefresh": true,
"sourcePriority": 123,
"status": "NOT_QUERIED",
"queryId": "<string>",
"observedAt": "<string>",
"recordedAt": "<string>",
"errorCode": "upstream_error"
}
]
},
"summary": "<string>"
},
"next_cursor": "<string>",
"type": "<string>"
}OAuth2 Authorization Code flow
CPF, CNPJ, or company id (cmp_*)
Maximum number of domain snapshots to return
Data de referência (YYYY-MM-DD)
Comma-separated optional response fields. Supports "summary.short", "summary.long", and "summary.mdx". Without summary.* the metadata.summary field is omitted.
Object type identifier
Array of results for current page
Show child attributes
Whether more results exist beyond this page
Show child attributes
Opaque cursor for next page. null if no more results.
Type of results (Notion-compatible)