Save organization billing details
curl --request PUT \
--url https://billing.basaltic.sh/v1/profile \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"company_name": "<string>",
"country": "BR",
"tax_id": "<string>",
"foreign_tax_id": "<string>",
"no_tax_id_reason": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"street_name": "<string>",
"street_number": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"municipality_code": "3550308",
"state": "<string>",
"postal_code": "<string>"
}
'import requests
url = "https://billing.basaltic.sh/v1/profile"
payload = {
"company_name": "<string>",
"country": "BR",
"tax_id": "<string>",
"foreign_tax_id": "<string>",
"no_tax_id_reason": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"street_name": "<string>",
"street_number": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"municipality_code": "3550308",
"state": "<string>",
"postal_code": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
company_name: '<string>',
country: 'BR',
tax_id: '<string>',
foreign_tax_id: '<string>',
no_tax_id_reason: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
street_name: '<string>',
street_number: '<string>',
complement: '<string>',
neighborhood: '<string>',
city: '<string>',
municipality_code: '3550308',
state: '<string>',
postal_code: '<string>'
})
};
fetch('https://billing.basaltic.sh/v1/profile', 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://billing.basaltic.sh/v1/profile",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'company_name' => '<string>',
'country' => 'BR',
'tax_id' => '<string>',
'foreign_tax_id' => '<string>',
'no_tax_id_reason' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'street_name' => '<string>',
'street_number' => '<string>',
'complement' => '<string>',
'neighborhood' => '<string>',
'city' => '<string>',
'municipality_code' => '3550308',
'state' => '<string>',
'postal_code' => '<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 := "https://billing.basaltic.sh/v1/profile"
payload := strings.NewReader("{\n \"company_name\": \"<string>\",\n \"country\": \"BR\",\n \"tax_id\": \"<string>\",\n \"foreign_tax_id\": \"<string>\",\n \"no_tax_id_reason\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"street_name\": \"<string>\",\n \"street_number\": \"<string>\",\n \"complement\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"municipality_code\": \"3550308\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://billing.basaltic.sh/v1/profile")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"company_name\": \"<string>\",\n \"country\": \"BR\",\n \"tax_id\": \"<string>\",\n \"foreign_tax_id\": \"<string>\",\n \"no_tax_id_reason\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"street_name\": \"<string>\",\n \"street_number\": \"<string>\",\n \"complement\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"municipality_code\": \"3550308\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://billing.basaltic.sh/v1/profile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"company_name\": \"<string>\",\n \"country\": \"BR\",\n \"tax_id\": \"<string>\",\n \"foreign_tax_id\": \"<string>\",\n \"no_tax_id_reason\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"street_name\": \"<string>\",\n \"street_number\": \"<string>\",\n \"complement\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"municipality_code\": \"3550308\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"customer_type": "",
"company_name": "<string>",
"country": "BR",
"tax_id": "<string>",
"foreign_tax_id": "<string>",
"no_tax_id_reason": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"street_name": "<string>",
"street_number": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"municipality_code": "3550308",
"state": "<string>",
"postal_code": "<string>",
"ready": true,
"missing_fields": [
"<string>"
]
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "ACCESS_DENIED",
"message": "You don't have permission to perform this action",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}Profile
Save organization billing details
Replaces billing details for future fiscal documents. Existing prepared or issued documents retain their recipient snapshot. A complete profile finishes the billing-details onboarding step and allows waiting fiscal workflows to proceed.
PUT
/
v1
/
profile
Save organization billing details
curl --request PUT \
--url https://billing.basaltic.sh/v1/profile \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"company_name": "<string>",
"country": "BR",
"tax_id": "<string>",
"foreign_tax_id": "<string>",
"no_tax_id_reason": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"street_name": "<string>",
"street_number": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"municipality_code": "3550308",
"state": "<string>",
"postal_code": "<string>"
}
'import requests
url = "https://billing.basaltic.sh/v1/profile"
payload = {
"company_name": "<string>",
"country": "BR",
"tax_id": "<string>",
"foreign_tax_id": "<string>",
"no_tax_id_reason": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"street_name": "<string>",
"street_number": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"municipality_code": "3550308",
"state": "<string>",
"postal_code": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
company_name: '<string>',
country: 'BR',
tax_id: '<string>',
foreign_tax_id: '<string>',
no_tax_id_reason: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
street_name: '<string>',
street_number: '<string>',
complement: '<string>',
neighborhood: '<string>',
city: '<string>',
municipality_code: '3550308',
state: '<string>',
postal_code: '<string>'
})
};
fetch('https://billing.basaltic.sh/v1/profile', 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://billing.basaltic.sh/v1/profile",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'company_name' => '<string>',
'country' => 'BR',
'tax_id' => '<string>',
'foreign_tax_id' => '<string>',
'no_tax_id_reason' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'street_name' => '<string>',
'street_number' => '<string>',
'complement' => '<string>',
'neighborhood' => '<string>',
'city' => '<string>',
'municipality_code' => '3550308',
'state' => '<string>',
'postal_code' => '<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 := "https://billing.basaltic.sh/v1/profile"
payload := strings.NewReader("{\n \"company_name\": \"<string>\",\n \"country\": \"BR\",\n \"tax_id\": \"<string>\",\n \"foreign_tax_id\": \"<string>\",\n \"no_tax_id_reason\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"street_name\": \"<string>\",\n \"street_number\": \"<string>\",\n \"complement\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"municipality_code\": \"3550308\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://billing.basaltic.sh/v1/profile")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"company_name\": \"<string>\",\n \"country\": \"BR\",\n \"tax_id\": \"<string>\",\n \"foreign_tax_id\": \"<string>\",\n \"no_tax_id_reason\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"street_name\": \"<string>\",\n \"street_number\": \"<string>\",\n \"complement\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"municipality_code\": \"3550308\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://billing.basaltic.sh/v1/profile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"company_name\": \"<string>\",\n \"country\": \"BR\",\n \"tax_id\": \"<string>\",\n \"foreign_tax_id\": \"<string>\",\n \"no_tax_id_reason\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"street_name\": \"<string>\",\n \"street_number\": \"<string>\",\n \"complement\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"municipality_code\": \"3550308\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"customer_type": "",
"company_name": "<string>",
"country": "BR",
"tax_id": "<string>",
"foreign_tax_id": "<string>",
"no_tax_id_reason": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"street_name": "<string>",
"street_number": "<string>",
"complement": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"municipality_code": "3550308",
"state": "<string>",
"postal_code": "<string>",
"ready": true,
"missing_fields": [
"<string>"
]
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "ACCESS_DENIED",
"message": "You don't have permission to perform this action",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}Requires the IAM action
billing:UpdateBillingProfile. See BILLING permissions for the full list, what each one covers, and an example policy.Authorizations
An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>.
This is the recommended way to authenticate.
Get one by exchanging a service account's access key pair at
POST /v1/oauth/token with grant_type=client_credentials. It is the
standard client-credentials grant, so any OAuth-aware library will
obtain and refresh it for you.
curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \ https://iam.basaltic.sh/v1/oauth/token
Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.
Body
application/json
Organization billing recipient. Incomplete drafts are saved; ready becomes true only after all country-specific fields are valid. New onboarding completes after this step.
Available options:
individual, company Full legal name of the individual or company.
Maximum string length:
75ISO 3166-1 alpha-2 country code.
Required string length:
2Example:
"BR"
CPF for a Brazilian individual or CNPJ for a Brazilian company. Check digits are validated.
Foreign identifier; not validated as a Brazilian document.
Maximum string length:
50Required for a foreign recipient without a tax identifier.
Maximum string length:
100Billing email for fiscal invoice delivery. The onboarding form prefills this from the signed-in user's email.
Maximum string length:
75Maximum string length:
50Maximum string length:
50Maximum string length:
10Maximum string length:
30Maximum string length:
30Maximum string length:
100Seven-digit IBGE municipality code, required for a Brazilian recipient.
Example:
"3550308"
Two-letter UF for Brazil; free-form state/province abroad.
Maximum string length:
100Eight-digit CEP for Brazil; optional international postal code abroad.
Maximum string length:
20Response
Saved details, readiness and missing fields.
Organization billing recipient. Incomplete drafts are saved; ready becomes true only after all country-specific fields are valid. New onboarding completes after this step.
Available options:
individual, company Full legal name of the individual or company.
Maximum string length:
75ISO 3166-1 alpha-2 country code.
Required string length:
2Example:
"BR"
CPF for a Brazilian individual or CNPJ for a Brazilian company. Check digits are validated.
Foreign identifier; not validated as a Brazilian document.
Maximum string length:
50Required for a foreign recipient without a tax identifier.
Maximum string length:
100Billing email for fiscal invoice delivery. The onboarding form prefills this from the signed-in user's email.
Maximum string length:
75Maximum string length:
50Maximum string length:
50Maximum string length:
10Maximum string length:
30Maximum string length:
30Maximum string length:
100Seven-digit IBGE municipality code, required for a Brazilian recipient.
Example:
"3550308"
Two-letter UF for Brazil; free-form state/province abroad.
Maximum string length:
100Eight-digit CEP for Brazil; optional international postal code abroad.
Maximum string length:
20