Discover companies using canonical Receita Federal filters
curl --request POST \
--url http://localhost:3000/v2/search/companies \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "<string>",
"filters": {
"matchMode": "all",
"mainCnae": {
"include": [
"<string>"
],
"exclude": [
"<string>"
]
},
"secondaryCnae": {
"include": [
"<string>"
],
"exclude": [
"<string>"
]
},
"companySize": {
"include": [
"<string>"
],
"exclude": [
"<string>"
]
},
"states": {
"include": [
"<string>"
],
"exclude": [
"<string>"
]
},
"cities": {
"include": [
{
"state": "<string>",
"city": "<string>"
}
],
"exclude": [
{
"state": "<string>",
"city": "<string>"
}
]
},
"legalNature": {
"include": [
"<string>"
],
"exclude": [
"<string>"
]
},
"registrationStatus": {
"include": [
"<string>"
],
"exclude": [
"<string>"
]
},
"capital": {
"include": {
"min": "<string>",
"max": "<string>"
},
"exclude": {
"min": "<string>",
"max": "<string>"
}
},
"headquarters": true
},
"page_size": 20,
"start_cursor": "<string>"
}
'import requests
url = "http://localhost:3000/v2/search/companies"
payload = {
"query": "<string>",
"filters": {
"matchMode": "all",
"mainCnae": {
"include": ["<string>"],
"exclude": ["<string>"]
},
"secondaryCnae": {
"include": ["<string>"],
"exclude": ["<string>"]
},
"companySize": {
"include": ["<string>"],
"exclude": ["<string>"]
},
"states": {
"include": ["<string>"],
"exclude": ["<string>"]
},
"cities": {
"include": [
{
"state": "<string>",
"city": "<string>"
}
],
"exclude": [
{
"state": "<string>",
"city": "<string>"
}
]
},
"legalNature": {
"include": ["<string>"],
"exclude": ["<string>"]
},
"registrationStatus": {
"include": ["<string>"],
"exclude": ["<string>"]
},
"capital": {
"include": {
"min": "<string>",
"max": "<string>"
},
"exclude": {
"min": "<string>",
"max": "<string>"
}
},
"headquarters": True
},
"page_size": 20,
"start_cursor": "<string>"
}
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({
query: '<string>',
filters: {
matchMode: 'all',
mainCnae: {include: ['<string>'], exclude: ['<string>']},
secondaryCnae: {include: ['<string>'], exclude: ['<string>']},
companySize: {include: ['<string>'], exclude: ['<string>']},
states: {include: ['<string>'], exclude: ['<string>']},
cities: {
include: [{state: '<string>', city: '<string>'}],
exclude: [{state: '<string>', city: '<string>'}]
},
legalNature: {include: ['<string>'], exclude: ['<string>']},
registrationStatus: {include: ['<string>'], exclude: ['<string>']},
capital: {
include: {min: '<string>', max: '<string>'},
exclude: {min: '<string>', max: '<string>'}
},
headquarters: true
},
page_size: 20,
start_cursor: '<string>'
})
};
fetch('http://localhost:3000/v2/search/companies', 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/search/companies",
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([
'query' => '<string>',
'filters' => [
'matchMode' => 'all',
'mainCnae' => [
'include' => [
'<string>'
],
'exclude' => [
'<string>'
]
],
'secondaryCnae' => [
'include' => [
'<string>'
],
'exclude' => [
'<string>'
]
],
'companySize' => [
'include' => [
'<string>'
],
'exclude' => [
'<string>'
]
],
'states' => [
'include' => [
'<string>'
],
'exclude' => [
'<string>'
]
],
'cities' => [
'include' => [
[
'state' => '<string>',
'city' => '<string>'
]
],
'exclude' => [
[
'state' => '<string>',
'city' => '<string>'
]
]
],
'legalNature' => [
'include' => [
'<string>'
],
'exclude' => [
'<string>'
]
],
'registrationStatus' => [
'include' => [
'<string>'
],
'exclude' => [
'<string>'
]
],
'capital' => [
'include' => [
'min' => '<string>',
'max' => '<string>'
],
'exclude' => [
'min' => '<string>',
'max' => '<string>'
]
],
'headquarters' => true
],
'page_size' => 20,
'start_cursor' => '<string>'
]),
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 := "http://localhost:3000/v2/search/companies"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"filters\": {\n \"matchMode\": \"all\",\n \"mainCnae\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"secondaryCnae\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"companySize\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"states\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"cities\": {\n \"include\": [\n {\n \"state\": \"<string>\",\n \"city\": \"<string>\"\n }\n ],\n \"exclude\": [\n {\n \"state\": \"<string>\",\n \"city\": \"<string>\"\n }\n ]\n },\n \"legalNature\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"registrationStatus\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"capital\": {\n \"include\": {\n \"min\": \"<string>\",\n \"max\": \"<string>\"\n },\n \"exclude\": {\n \"min\": \"<string>\",\n \"max\": \"<string>\"\n }\n },\n \"headquarters\": true\n },\n \"page_size\": 20,\n \"start_cursor\": \"<string>\"\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("http://localhost:3000/v2/search/companies")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"filters\": {\n \"matchMode\": \"all\",\n \"mainCnae\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"secondaryCnae\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"companySize\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"states\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"cities\": {\n \"include\": [\n {\n \"state\": \"<string>\",\n \"city\": \"<string>\"\n }\n ],\n \"exclude\": [\n {\n \"state\": \"<string>\",\n \"city\": \"<string>\"\n }\n ]\n },\n \"legalNature\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"registrationStatus\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"capital\": {\n \"include\": {\n \"min\": \"<string>\",\n \"max\": \"<string>\"\n },\n \"exclude\": {\n \"min\": \"<string>\",\n \"max\": \"<string>\"\n }\n },\n \"headquarters\": true\n },\n \"page_size\": 20,\n \"start_cursor\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/search/companies")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"filters\": {\n \"matchMode\": \"all\",\n \"mainCnae\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"secondaryCnae\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"companySize\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"states\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"cities\": {\n \"include\": [\n {\n \"state\": \"<string>\",\n \"city\": \"<string>\"\n }\n ],\n \"exclude\": [\n {\n \"state\": \"<string>\",\n \"city\": \"<string>\"\n }\n ]\n },\n \"legalNature\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"registrationStatus\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"capital\": {\n \"include\": {\n \"min\": \"<string>\",\n \"max\": \"<string>\"\n },\n \"exclude\": {\n \"min\": \"<string>\",\n \"max\": \"<string>\"\n }\n },\n \"headquarters\": true\n },\n \"page_size\": 20,\n \"start_cursor\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"object": "list",
"results": [
{
"document": "<string>",
"legalName": "<string>",
"tradeName": "<string>",
"city": "<string>",
"state": "<string>",
"mainCnae": "<string>",
"mainCnaeDescription": "<string>",
"secondaryCnaes": [
"<string>"
],
"companySize": "<string>",
"legalNature": "<string>",
"legalNatureDescription": "<string>",
"capital": "<string>",
"registrationStatus": "<string>",
"headquarters": true,
"periodRef": "<string>"
}
],
"next_cursor": "<string>",
"has_more": true
}search
Discover companies using canonical Receita Federal filters
POST
/
v2
/
search
/
companies
Discover companies using canonical Receita Federal filters
curl --request POST \
--url http://localhost:3000/v2/search/companies \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "<string>",
"filters": {
"matchMode": "all",
"mainCnae": {
"include": [
"<string>"
],
"exclude": [
"<string>"
]
},
"secondaryCnae": {
"include": [
"<string>"
],
"exclude": [
"<string>"
]
},
"companySize": {
"include": [
"<string>"
],
"exclude": [
"<string>"
]
},
"states": {
"include": [
"<string>"
],
"exclude": [
"<string>"
]
},
"cities": {
"include": [
{
"state": "<string>",
"city": "<string>"
}
],
"exclude": [
{
"state": "<string>",
"city": "<string>"
}
]
},
"legalNature": {
"include": [
"<string>"
],
"exclude": [
"<string>"
]
},
"registrationStatus": {
"include": [
"<string>"
],
"exclude": [
"<string>"
]
},
"capital": {
"include": {
"min": "<string>",
"max": "<string>"
},
"exclude": {
"min": "<string>",
"max": "<string>"
}
},
"headquarters": true
},
"page_size": 20,
"start_cursor": "<string>"
}
'import requests
url = "http://localhost:3000/v2/search/companies"
payload = {
"query": "<string>",
"filters": {
"matchMode": "all",
"mainCnae": {
"include": ["<string>"],
"exclude": ["<string>"]
},
"secondaryCnae": {
"include": ["<string>"],
"exclude": ["<string>"]
},
"companySize": {
"include": ["<string>"],
"exclude": ["<string>"]
},
"states": {
"include": ["<string>"],
"exclude": ["<string>"]
},
"cities": {
"include": [
{
"state": "<string>",
"city": "<string>"
}
],
"exclude": [
{
"state": "<string>",
"city": "<string>"
}
]
},
"legalNature": {
"include": ["<string>"],
"exclude": ["<string>"]
},
"registrationStatus": {
"include": ["<string>"],
"exclude": ["<string>"]
},
"capital": {
"include": {
"min": "<string>",
"max": "<string>"
},
"exclude": {
"min": "<string>",
"max": "<string>"
}
},
"headquarters": True
},
"page_size": 20,
"start_cursor": "<string>"
}
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({
query: '<string>',
filters: {
matchMode: 'all',
mainCnae: {include: ['<string>'], exclude: ['<string>']},
secondaryCnae: {include: ['<string>'], exclude: ['<string>']},
companySize: {include: ['<string>'], exclude: ['<string>']},
states: {include: ['<string>'], exclude: ['<string>']},
cities: {
include: [{state: '<string>', city: '<string>'}],
exclude: [{state: '<string>', city: '<string>'}]
},
legalNature: {include: ['<string>'], exclude: ['<string>']},
registrationStatus: {include: ['<string>'], exclude: ['<string>']},
capital: {
include: {min: '<string>', max: '<string>'},
exclude: {min: '<string>', max: '<string>'}
},
headquarters: true
},
page_size: 20,
start_cursor: '<string>'
})
};
fetch('http://localhost:3000/v2/search/companies', 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/search/companies",
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([
'query' => '<string>',
'filters' => [
'matchMode' => 'all',
'mainCnae' => [
'include' => [
'<string>'
],
'exclude' => [
'<string>'
]
],
'secondaryCnae' => [
'include' => [
'<string>'
],
'exclude' => [
'<string>'
]
],
'companySize' => [
'include' => [
'<string>'
],
'exclude' => [
'<string>'
]
],
'states' => [
'include' => [
'<string>'
],
'exclude' => [
'<string>'
]
],
'cities' => [
'include' => [
[
'state' => '<string>',
'city' => '<string>'
]
],
'exclude' => [
[
'state' => '<string>',
'city' => '<string>'
]
]
],
'legalNature' => [
'include' => [
'<string>'
],
'exclude' => [
'<string>'
]
],
'registrationStatus' => [
'include' => [
'<string>'
],
'exclude' => [
'<string>'
]
],
'capital' => [
'include' => [
'min' => '<string>',
'max' => '<string>'
],
'exclude' => [
'min' => '<string>',
'max' => '<string>'
]
],
'headquarters' => true
],
'page_size' => 20,
'start_cursor' => '<string>'
]),
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 := "http://localhost:3000/v2/search/companies"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"filters\": {\n \"matchMode\": \"all\",\n \"mainCnae\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"secondaryCnae\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"companySize\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"states\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"cities\": {\n \"include\": [\n {\n \"state\": \"<string>\",\n \"city\": \"<string>\"\n }\n ],\n \"exclude\": [\n {\n \"state\": \"<string>\",\n \"city\": \"<string>\"\n }\n ]\n },\n \"legalNature\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"registrationStatus\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"capital\": {\n \"include\": {\n \"min\": \"<string>\",\n \"max\": \"<string>\"\n },\n \"exclude\": {\n \"min\": \"<string>\",\n \"max\": \"<string>\"\n }\n },\n \"headquarters\": true\n },\n \"page_size\": 20,\n \"start_cursor\": \"<string>\"\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("http://localhost:3000/v2/search/companies")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"filters\": {\n \"matchMode\": \"all\",\n \"mainCnae\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"secondaryCnae\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"companySize\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"states\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"cities\": {\n \"include\": [\n {\n \"state\": \"<string>\",\n \"city\": \"<string>\"\n }\n ],\n \"exclude\": [\n {\n \"state\": \"<string>\",\n \"city\": \"<string>\"\n }\n ]\n },\n \"legalNature\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"registrationStatus\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"capital\": {\n \"include\": {\n \"min\": \"<string>\",\n \"max\": \"<string>\"\n },\n \"exclude\": {\n \"min\": \"<string>\",\n \"max\": \"<string>\"\n }\n },\n \"headquarters\": true\n },\n \"page_size\": 20,\n \"start_cursor\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/search/companies")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"filters\": {\n \"matchMode\": \"all\",\n \"mainCnae\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"secondaryCnae\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"companySize\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"states\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"cities\": {\n \"include\": [\n {\n \"state\": \"<string>\",\n \"city\": \"<string>\"\n }\n ],\n \"exclude\": [\n {\n \"state\": \"<string>\",\n \"city\": \"<string>\"\n }\n ]\n },\n \"legalNature\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"registrationStatus\": {\n \"include\": [\n \"<string>\"\n ],\n \"exclude\": [\n \"<string>\"\n ]\n },\n \"capital\": {\n \"include\": {\n \"min\": \"<string>\",\n \"max\": \"<string>\"\n },\n \"exclude\": {\n \"min\": \"<string>\",\n \"max\": \"<string>\"\n }\n },\n \"headquarters\": true\n },\n \"page_size\": 20,\n \"start_cursor\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"object": "list",
"results": [
{
"document": "<string>",
"legalName": "<string>",
"tradeName": "<string>",
"city": "<string>",
"state": "<string>",
"mainCnae": "<string>",
"mainCnaeDescription": "<string>",
"secondaryCnaes": [
"<string>"
],
"companySize": "<string>",
"legalNature": "<string>",
"legalNatureDescription": "<string>",
"capital": "<string>",
"registrationStatus": "<string>",
"headquarters": true,
"periodRef": "<string>"
}
],
"next_cursor": "<string>",
"has_more": true
}Authorizations
OAuth2 Authorization Code flow
Body
application/json
⌘I