curl --request POST \
--url https://api.spedy.com.br/v1/companies \
--header 'Content-Type: application/json-patch+json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"name": "<string>",
"legalName": "<string>",
"federalTaxNumber": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"code": "<string>",
"name": "<string>"
},
"country": {
"name": "<string>",
"code": 123
},
"cityName": "<string>"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stateTaxNumber": "<string>",
"cityTaxNumber": "<string>",
"email": "<string>",
"phone": "<string>",
"mobilePhone": "<string>",
"economicActivities": [
{
"code": "<string>"
}
]
}
'import requests
url = "https://api.spedy.com.br/v1/companies"
payload = {
"name": "<string>",
"legalName": "<string>",
"federalTaxNumber": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"code": "<string>",
"name": "<string>"
},
"country": {
"name": "<string>",
"code": 123
},
"cityName": "<string>"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stateTaxNumber": "<string>",
"cityTaxNumber": "<string>",
"email": "<string>",
"phone": "<string>",
"mobilePhone": "<string>",
"economicActivities": [{ "code": "<string>" }]
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json-patch+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
name: '<string>',
legalName: '<string>',
federalTaxNumber: '<string>',
address: {
street: '<string>',
district: '<string>',
postalCode: '<string>',
number: '<string>',
additionalInformation: '<string>',
city: {code: '<string>', name: '<string>'},
country: {name: '<string>', code: 123},
cityName: '<string>'
},
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
stateTaxNumber: '<string>',
cityTaxNumber: '<string>',
email: '<string>',
phone: '<string>',
mobilePhone: '<string>',
economicActivities: [{code: '<string>'}]
})
};
fetch('https://api.spedy.com.br/v1/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_URL => "https://api.spedy.com.br/v1/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([
'name' => '<string>',
'legalName' => '<string>',
'federalTaxNumber' => '<string>',
'address' => [
'street' => '<string>',
'district' => '<string>',
'postalCode' => '<string>',
'number' => '<string>',
'additionalInformation' => '<string>',
'city' => [
'code' => '<string>',
'name' => '<string>'
],
'country' => [
'name' => '<string>',
'code' => 123
],
'cityName' => '<string>'
],
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'stateTaxNumber' => '<string>',
'cityTaxNumber' => '<string>',
'email' => '<string>',
'phone' => '<string>',
'mobilePhone' => '<string>',
'economicActivities' => [
[
'code' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+json",
"X-Api-Key: <api-key>"
],
]);
$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.spedy.com.br/v1/companies"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"legalName\": \"<string>\",\n \"federalTaxNumber\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"code\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"country\": {\n \"name\": \"<string>\",\n \"code\": 123\n },\n \"cityName\": \"<string>\"\n },\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"stateTaxNumber\": \"<string>\",\n \"cityTaxNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"mobilePhone\": \"<string>\",\n \"economicActivities\": [\n {\n \"code\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json-patch+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.spedy.com.br/v1/companies")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"name\": \"<string>\",\n \"legalName\": \"<string>\",\n \"federalTaxNumber\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"code\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"country\": {\n \"name\": \"<string>\",\n \"code\": 123\n },\n \"cityName\": \"<string>\"\n },\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"stateTaxNumber\": \"<string>\",\n \"cityTaxNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"mobilePhone\": \"<string>\",\n \"economicActivities\": [\n {\n \"code\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spedy.com.br/v1/companies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"name\": \"<string>\",\n \"legalName\": \"<string>\",\n \"federalTaxNumber\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"code\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"country\": {\n \"name\": \"<string>\",\n \"code\": 123\n },\n \"cityName\": \"<string>\"\n },\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"stateTaxNumber\": \"<string>\",\n \"cityTaxNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"mobilePhone\": \"<string>\",\n \"economicActivities\": [\n {\n \"code\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"legalName": "<string>",
"federalTaxNumber": "<string>",
"stateTaxNumber": "<string>",
"cityTaxNumber": "<string>",
"email": "<string>",
"phone": "<string>",
"mobilePhone": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"code": "<string>",
"name": "<string>",
"state": "ro"
},
"country": {
"name": "<string>",
"code": 123
},
"cityName": "<string>"
},
"taxRegime": "simplesNacional",
"specialTaxRegime": "municipalMicroenterprise",
"simplesNacionalTaxRegime": "federalAndMunicipalBySimplesNacional",
"apiCredentials": {
"apiKey": "<string>"
},
"economicActivities": [
{
"code": "<string>",
"type": "main"
}
]
}Criar Empresa
Cadastra uma empresa emissora (CNPJ, razão social, endereço). Requer a chave da empresa titular — a única autorizada a gerenciar empresas. A resposta traz a X-Api-Key da nova empresa.
curl --request POST \
--url https://api.spedy.com.br/v1/companies \
--header 'Content-Type: application/json-patch+json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"name": "<string>",
"legalName": "<string>",
"federalTaxNumber": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"code": "<string>",
"name": "<string>"
},
"country": {
"name": "<string>",
"code": 123
},
"cityName": "<string>"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stateTaxNumber": "<string>",
"cityTaxNumber": "<string>",
"email": "<string>",
"phone": "<string>",
"mobilePhone": "<string>",
"economicActivities": [
{
"code": "<string>"
}
]
}
'import requests
url = "https://api.spedy.com.br/v1/companies"
payload = {
"name": "<string>",
"legalName": "<string>",
"federalTaxNumber": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"code": "<string>",
"name": "<string>"
},
"country": {
"name": "<string>",
"code": 123
},
"cityName": "<string>"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stateTaxNumber": "<string>",
"cityTaxNumber": "<string>",
"email": "<string>",
"phone": "<string>",
"mobilePhone": "<string>",
"economicActivities": [{ "code": "<string>" }]
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json-patch+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
name: '<string>',
legalName: '<string>',
federalTaxNumber: '<string>',
address: {
street: '<string>',
district: '<string>',
postalCode: '<string>',
number: '<string>',
additionalInformation: '<string>',
city: {code: '<string>', name: '<string>'},
country: {name: '<string>', code: 123},
cityName: '<string>'
},
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
stateTaxNumber: '<string>',
cityTaxNumber: '<string>',
email: '<string>',
phone: '<string>',
mobilePhone: '<string>',
economicActivities: [{code: '<string>'}]
})
};
fetch('https://api.spedy.com.br/v1/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_URL => "https://api.spedy.com.br/v1/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([
'name' => '<string>',
'legalName' => '<string>',
'federalTaxNumber' => '<string>',
'address' => [
'street' => '<string>',
'district' => '<string>',
'postalCode' => '<string>',
'number' => '<string>',
'additionalInformation' => '<string>',
'city' => [
'code' => '<string>',
'name' => '<string>'
],
'country' => [
'name' => '<string>',
'code' => 123
],
'cityName' => '<string>'
],
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'stateTaxNumber' => '<string>',
'cityTaxNumber' => '<string>',
'email' => '<string>',
'phone' => '<string>',
'mobilePhone' => '<string>',
'economicActivities' => [
[
'code' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+json",
"X-Api-Key: <api-key>"
],
]);
$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.spedy.com.br/v1/companies"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"legalName\": \"<string>\",\n \"federalTaxNumber\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"code\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"country\": {\n \"name\": \"<string>\",\n \"code\": 123\n },\n \"cityName\": \"<string>\"\n },\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"stateTaxNumber\": \"<string>\",\n \"cityTaxNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"mobilePhone\": \"<string>\",\n \"economicActivities\": [\n {\n \"code\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json-patch+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.spedy.com.br/v1/companies")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"name\": \"<string>\",\n \"legalName\": \"<string>\",\n \"federalTaxNumber\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"code\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"country\": {\n \"name\": \"<string>\",\n \"code\": 123\n },\n \"cityName\": \"<string>\"\n },\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"stateTaxNumber\": \"<string>\",\n \"cityTaxNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"mobilePhone\": \"<string>\",\n \"economicActivities\": [\n {\n \"code\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spedy.com.br/v1/companies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"name\": \"<string>\",\n \"legalName\": \"<string>\",\n \"federalTaxNumber\": \"<string>\",\n \"address\": {\n \"street\": \"<string>\",\n \"district\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"number\": \"<string>\",\n \"additionalInformation\": \"<string>\",\n \"city\": {\n \"code\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"country\": {\n \"name\": \"<string>\",\n \"code\": 123\n },\n \"cityName\": \"<string>\"\n },\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"stateTaxNumber\": \"<string>\",\n \"cityTaxNumber\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"mobilePhone\": \"<string>\",\n \"economicActivities\": [\n {\n \"code\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"legalName": "<string>",
"federalTaxNumber": "<string>",
"stateTaxNumber": "<string>",
"cityTaxNumber": "<string>",
"email": "<string>",
"phone": "<string>",
"mobilePhone": "<string>",
"address": {
"street": "<string>",
"district": "<string>",
"postalCode": "<string>",
"number": "<string>",
"additionalInformation": "<string>",
"city": {
"code": "<string>",
"name": "<string>",
"state": "ro"
},
"country": {
"name": "<string>",
"code": 123
},
"cityName": "<string>"
},
"taxRegime": "simplesNacional",
"specialTaxRegime": "municipalMicroenterprise",
"simplesNacionalTaxRegime": "federalAndMunicipalBySimplesNacional",
"apiCredentials": {
"apiKey": "<string>"
},
"economicActivities": [
{
"code": "<string>",
"type": "main"
}
]
}Authorizations
Authorization By X-Api-Key inside request's header
Body
Nome fantasia
80Razão Social
80CNPJ
1Endereço
Show child attributes
Show child attributes
Inscrição Estadual
Inscrição Municipal
80Telefone
Celular
CRT
Valores possíveis:
- simplesNacional: Simples Nacional
- simplesNacionalExcessoSublimite: Simples Nacional — Excesso de sublimite de receita bruta
- regimeNormal: Regime Normal (Lucro Presumido ou Lucro Real)
- simplesNacionalMEI: Simples Nacional — MEI
simplesNacional, simplesNacionalExcessoSublimite, regimeNormal, simplesNacionalMEI Regime Especial
Valores possíveis:
- municipalMicroenterprise: 1 – Microempresa Municipal
- estimate: 2 – Estimativa
- societyOfProfessionals: 3 – Sociedade de Profissionais
- cooperative: 4 – Cooperativa
- individualMicroenterprise: 5 – Microempresário Individual (MEI)
- microenterpriseAndSmallBusiness: 6 – Microempresário e Empresa de Pequeno Porte (ME EPP)
- noSpecialRegime: 7 - Sem Regime Especial
- others: 8 - Outros
municipalMicroenterprise, estimate, societyOfProfessionals, cooperative, individualMicroenterprise, microenterpriseAndSmallBusiness, noSpecialRegime, others Regime de Apuração dos Tributos do Simples Nacional
Valores possíveis:
- federalAndMunicipalBySimplesNacional: Regime de apuração dos tributos federais e municipal pelo Simples Nacional
- federalBySimplesAndIssqnByNfse: Regime de apuração dos tributos federais pelo Simples Nacional e o ISSQN pela NFS-e conforme legislação municipal
- federalAndMunicipalByNfse: Regime de apuração dos tributos federais e municipal pela NFS-e conforme legislações federal e municipal
federalAndMunicipalBySimplesNacional, federalBySimplesAndIssqnByNfse, federalAndMunicipalByNfse Atividades econômicas (CNAE)
Show child attributes
Show child attributes
Response
Success
Nome fantasia
Razão Social
CNPJ
Inscrição Estadual
Inscrição Municipal
Telefone
Celular
Endereço
Show child attributes
Show child attributes
CRT
Valores possíveis:
- simplesNacional: Simples Nacional
- simplesNacionalExcessoSublimite: Simples Nacional — Excesso de sublimite de receita bruta
- regimeNormal: Regime Normal (Lucro Presumido ou Lucro Real)
- simplesNacionalMEI: Simples Nacional — MEI
simplesNacional, simplesNacionalExcessoSublimite, regimeNormal, simplesNacionalMEI Regime Especial
Valores possíveis:
- municipalMicroenterprise: 1 – Microempresa Municipal
- estimate: 2 – Estimativa
- societyOfProfessionals: 3 – Sociedade de Profissionais
- cooperative: 4 – Cooperativa
- individualMicroenterprise: 5 – Microempresário Individual (MEI)
- microenterpriseAndSmallBusiness: 6 – Microempresário e Empresa de Pequeno Porte (ME EPP)
- noSpecialRegime: 7 - Sem Regime Especial
- others: 8 - Outros
municipalMicroenterprise, estimate, societyOfProfessionals, cooperative, individualMicroenterprise, microenterpriseAndSmallBusiness, noSpecialRegime, others Regime de Apuração dos Tributos do Simples Nacional
Valores possíveis:
- federalAndMunicipalBySimplesNacional: Regime de apuração dos tributos federais e municipal pelo Simples Nacional
- federalBySimplesAndIssqnByNfse: Regime de apuração dos tributos federais pelo Simples Nacional e o ISSQN pela NFS-e conforme legislação municipal
- federalAndMunicipalByNfse: Regime de apuração dos tributos federais e municipal pela NFS-e conforme legislações federal e municipal
federalAndMunicipalBySimplesNacional, federalBySimplesAndIssqnByNfse, federalAndMunicipalByNfse Credenciais da API
Show child attributes
Show child attributes
Atividades econômicas (CNAE)
Show child attributes
Show child attributes