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/companies/{document}/serasa \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/v2/companies/{document}/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/companies/{document}/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/companies/{document}/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/companies/{document}/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/companies/{document}/serasa")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/companies/{document}/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": [
{
"annotation_type": "<string>",
"annotation_label": "<string>",
"origin": "<string>",
"guarantor": "<string>",
"contract": "<string>",
"modality": "<string>",
"value": 123,
"occurrence_date": "<string>",
"currency_type": "<string>",
"under_judge": "<string>",
"under_judge_description": "<string>"
}
],
"has_more": true,
"summary": {
"status_cadastral": "<string>",
"financial_pending_total": 123,
"newest_occurrence": "<string>",
"oldest_occurrence": "<string>",
"bacen_pending_total": 123,
"negative_occurrences_total": 123,
"negative_occurrences_value": 123
},
"sources": {
"serasa_crednet": "<string>"
},
"next_cursor": "<string>",
"type": "<string>",
"raw": {}
}curl --request GET \
--url http://localhost:3000/v2/companies/{document}/serasa \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/v2/companies/{document}/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/companies/{document}/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/companies/{document}/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/companies/{document}/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/companies/{document}/serasa")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/companies/{document}/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": [
{
"annotation_type": "<string>",
"annotation_label": "<string>",
"origin": "<string>",
"guarantor": "<string>",
"contract": "<string>",
"modality": "<string>",
"value": 123,
"occurrence_date": "<string>",
"currency_type": "<string>",
"under_judge": "<string>",
"under_judge_description": "<string>"
}
],
"has_more": true,
"summary": {
"status_cadastral": "<string>",
"financial_pending_total": 123,
"newest_occurrence": "<string>",
"oldest_occurrence": "<string>",
"bacen_pending_total": 123,
"negative_occurrences_total": 123,
"negative_occurrences_value": 123
},
"sources": {
"serasa_crednet": "<string>"
},
"next_cursor": "<string>",
"type": "<string>",
"raw": {}
}OAuth2 Authorization Code flow
Company document (CNPJ)
Items per page (default 1000)
Cursor for next page
Data de referência (YYYY-MM-DD)
Paginated Serasa data
Object type identifier
Array of results for current page
Show child attributes
Whether more results exist beyond this page
Show child attributes
Show child attributes
Opaque cursor for next page. null if no more results.
Type of results (Notion-compatible)