Create a customer
curl --request POST \
--url https://api.registry.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/customer \
--header 'Content-Type: application/json' \
--data '
{
"name": "Ana Souza",
"email": "ana.souza@example.com",
"phoneNumber": "+5511999999999",
"document": "52998224725",
"address": {
"city": "São Paulo",
"neighborhood": "Centro",
"number": "123",
"state": "SP",
"street": "Rua das Flores",
"postalCode": "01000-000",
"complement": "Apto 45"
},
"trandingName": "Souza Studio",
"customFields": {
"cost-center": "CC-1020"
}
}
'import requests
url = "https://api.registry.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/customer"
payload = {
"name": "Ana Souza",
"email": "ana.souza@example.com",
"phoneNumber": "+5511999999999",
"document": "52998224725",
"address": {
"city": "São Paulo",
"neighborhood": "Centro",
"number": "123",
"state": "SP",
"street": "Rua das Flores",
"postalCode": "01000-000",
"complement": "Apto 45"
},
"trandingName": "Souza Studio",
"customFields": { "cost-center": "CC-1020" }
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Ana Souza',
email: 'ana.souza@example.com',
phoneNumber: '+5511999999999',
document: '52998224725',
address: {
city: 'São Paulo',
neighborhood: 'Centro',
number: '123',
state: 'SP',
street: 'Rua das Flores',
postalCode: '01000-000',
complement: 'Apto 45'
},
trandingName: 'Souza Studio',
customFields: {'cost-center': 'CC-1020'}
})
};
fetch('https://api.registry.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/customer', 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.registry.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/customer",
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' => 'Ana Souza',
'email' => 'ana.souza@example.com',
'phoneNumber' => '+5511999999999',
'document' => '52998224725',
'address' => [
'city' => 'São Paulo',
'neighborhood' => 'Centro',
'number' => '123',
'state' => 'SP',
'street' => 'Rua das Flores',
'postalCode' => '01000-000',
'complement' => 'Apto 45'
],
'trandingName' => 'Souza Studio',
'customFields' => [
'cost-center' => 'CC-1020'
]
]),
CURLOPT_HTTPHEADER => [
"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://api.registry.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/customer"
payload := strings.NewReader("{\n \"name\": \"Ana Souza\",\n \"email\": \"ana.souza@example.com\",\n \"phoneNumber\": \"+5511999999999\",\n \"document\": \"52998224725\",\n \"address\": {\n \"city\": \"São Paulo\",\n \"neighborhood\": \"Centro\",\n \"number\": \"123\",\n \"state\": \"SP\",\n \"street\": \"Rua das Flores\",\n \"postalCode\": \"01000-000\",\n \"complement\": \"Apto 45\"\n },\n \"trandingName\": \"Souza Studio\",\n \"customFields\": {\n \"cost-center\": \"CC-1020\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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("https://api.registry.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/customer")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Ana Souza\",\n \"email\": \"ana.souza@example.com\",\n \"phoneNumber\": \"+5511999999999\",\n \"document\": \"52998224725\",\n \"address\": {\n \"city\": \"São Paulo\",\n \"neighborhood\": \"Centro\",\n \"number\": \"123\",\n \"state\": \"SP\",\n \"street\": \"Rua das Flores\",\n \"postalCode\": \"01000-000\",\n \"complement\": \"Apto 45\"\n },\n \"trandingName\": \"Souza Studio\",\n \"customFields\": {\n \"cost-center\": \"CC-1020\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.registry.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/customer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Ana Souza\",\n \"email\": \"ana.souza@example.com\",\n \"phoneNumber\": \"+5511999999999\",\n \"document\": \"52998224725\",\n \"address\": {\n \"city\": \"São Paulo\",\n \"neighborhood\": \"Centro\",\n \"number\": \"123\",\n \"state\": \"SP\",\n \"street\": \"Rua das Flores\",\n \"postalCode\": \"01000-000\",\n \"complement\": \"Apto 45\"\n },\n \"trandingName\": \"Souza Studio\",\n \"customFields\": {\n \"cost-center\": \"CC-1020\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "7f3b1c52-9e4a-4d1b-8a67-2c5d9f0e4b13",
"hash": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f",
"address": {
"street": "Rua das Flores",
"number": "123",
"complement": "Apto 45",
"neighborhood": "Centro",
"city": "São Paulo",
"state": "SP",
"postalCode": "01000-000"
},
"name": "Ana Souza",
"document": "52998224725",
"documentType": "CPF",
"trandingName": "Souza Studio",
"email": "ana.souza@example.com",
"phoneNumber": "+5511999999999",
"customFields": {
"cost-center": "CC-1020"
}
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "FORBIDDEN_CUSTOMER",
"origin": "REGISTRY",
"message": "You do not have permission to perform this action on this resource (customer)"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "CUSTOMER_CONFLICT",
"origin": "REGISTRY",
"message": "Customer already exists"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BAD_REQUEST",
"origin": "REGISTRY",
"message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
"fields": [
{
"field": "name",
"message": "Invalid input: expected string, received undefined",
"code": "NAME_REQUIRED"
}
]
}Create a customer
Creates a customer of the organization — a person or a company you bill — and answers it.
POST
/
realms
/
{realmId}
/
organizations
/
{organizationId}
/
customer
Create a customer
curl --request POST \
--url https://api.registry.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/customer \
--header 'Content-Type: application/json' \
--data '
{
"name": "Ana Souza",
"email": "ana.souza@example.com",
"phoneNumber": "+5511999999999",
"document": "52998224725",
"address": {
"city": "São Paulo",
"neighborhood": "Centro",
"number": "123",
"state": "SP",
"street": "Rua das Flores",
"postalCode": "01000-000",
"complement": "Apto 45"
},
"trandingName": "Souza Studio",
"customFields": {
"cost-center": "CC-1020"
}
}
'import requests
url = "https://api.registry.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/customer"
payload = {
"name": "Ana Souza",
"email": "ana.souza@example.com",
"phoneNumber": "+5511999999999",
"document": "52998224725",
"address": {
"city": "São Paulo",
"neighborhood": "Centro",
"number": "123",
"state": "SP",
"street": "Rua das Flores",
"postalCode": "01000-000",
"complement": "Apto 45"
},
"trandingName": "Souza Studio",
"customFields": { "cost-center": "CC-1020" }
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Ana Souza',
email: 'ana.souza@example.com',
phoneNumber: '+5511999999999',
document: '52998224725',
address: {
city: 'São Paulo',
neighborhood: 'Centro',
number: '123',
state: 'SP',
street: 'Rua das Flores',
postalCode: '01000-000',
complement: 'Apto 45'
},
trandingName: 'Souza Studio',
customFields: {'cost-center': 'CC-1020'}
})
};
fetch('https://api.registry.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/customer', 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.registry.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/customer",
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' => 'Ana Souza',
'email' => 'ana.souza@example.com',
'phoneNumber' => '+5511999999999',
'document' => '52998224725',
'address' => [
'city' => 'São Paulo',
'neighborhood' => 'Centro',
'number' => '123',
'state' => 'SP',
'street' => 'Rua das Flores',
'postalCode' => '01000-000',
'complement' => 'Apto 45'
],
'trandingName' => 'Souza Studio',
'customFields' => [
'cost-center' => 'CC-1020'
]
]),
CURLOPT_HTTPHEADER => [
"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://api.registry.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/customer"
payload := strings.NewReader("{\n \"name\": \"Ana Souza\",\n \"email\": \"ana.souza@example.com\",\n \"phoneNumber\": \"+5511999999999\",\n \"document\": \"52998224725\",\n \"address\": {\n \"city\": \"São Paulo\",\n \"neighborhood\": \"Centro\",\n \"number\": \"123\",\n \"state\": \"SP\",\n \"street\": \"Rua das Flores\",\n \"postalCode\": \"01000-000\",\n \"complement\": \"Apto 45\"\n },\n \"trandingName\": \"Souza Studio\",\n \"customFields\": {\n \"cost-center\": \"CC-1020\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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("https://api.registry.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/customer")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Ana Souza\",\n \"email\": \"ana.souza@example.com\",\n \"phoneNumber\": \"+5511999999999\",\n \"document\": \"52998224725\",\n \"address\": {\n \"city\": \"São Paulo\",\n \"neighborhood\": \"Centro\",\n \"number\": \"123\",\n \"state\": \"SP\",\n \"street\": \"Rua das Flores\",\n \"postalCode\": \"01000-000\",\n \"complement\": \"Apto 45\"\n },\n \"trandingName\": \"Souza Studio\",\n \"customFields\": {\n \"cost-center\": \"CC-1020\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.registry.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/customer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Ana Souza\",\n \"email\": \"ana.souza@example.com\",\n \"phoneNumber\": \"+5511999999999\",\n \"document\": \"52998224725\",\n \"address\": {\n \"city\": \"São Paulo\",\n \"neighborhood\": \"Centro\",\n \"number\": \"123\",\n \"state\": \"SP\",\n \"street\": \"Rua das Flores\",\n \"postalCode\": \"01000-000\",\n \"complement\": \"Apto 45\"\n },\n \"trandingName\": \"Souza Studio\",\n \"customFields\": {\n \"cost-center\": \"CC-1020\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "7f3b1c52-9e4a-4d1b-8a67-2c5d9f0e4b13",
"hash": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f",
"address": {
"street": "Rua das Flores",
"number": "123",
"complement": "Apto 45",
"neighborhood": "Centro",
"city": "São Paulo",
"state": "SP",
"postalCode": "01000-000"
},
"name": "Ana Souza",
"document": "52998224725",
"documentType": "CPF",
"trandingName": "Souza Studio",
"email": "ana.souza@example.com",
"phoneNumber": "+5511999999999",
"customFields": {
"cost-center": "CC-1020"
}
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "FORBIDDEN_CUSTOMER",
"origin": "REGISTRY",
"message": "You do not have permission to perform this action on this resource (customer)"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "CUSTOMER_CONFLICT",
"origin": "REGISTRY",
"message": "Customer already exists"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BAD_REQUEST",
"origin": "REGISTRY",
"message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
"fields": [
{
"field": "name",
"message": "Invalid input: expected string, received undefined",
"code": "NAME_REQUIRED"
}
]
}Every new customer is
ACTIVE. Its document (CPF or CNPJ) can belong to one customer only in the organization.
customFields are checked against the organization’s active custom fields for customers: every key must be the slug of one of them and every value must fit its type. A custom field marked as required must have a value, even when you send no customFields at all.Path Parameters
ID of your realm.
Format: UUID
ID of the organization the customer belongs to.
Format: UUID
Body
application/json
Name of the customer: a person's full name or a company's name.
Required string length:
1 - 100Example:
"Ana Souza"
E-mail address of the customer.
Pattern:
^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$Example:
"ana.souza@example.com"
Brazilian phone number in international format: +55, the area code and the number (10 or 11 digits).
Pattern:
^\+55[0-9]{10,11}$Example:
"+5511999999999"
CPF (11 digits) or CNPJ (14 characters: the first 12 may be letters, the last 2 are digits) of the customer, with no dots, dashes or slashes. The check digits are verified and letters are stored in uppercase. A document can belong to one customer only in the organization.
Minimum string length:
1Pattern:
^[A-Za-z0-9]+$Example:
"52998224725"
Postal address of the customer.
Show child attributes
Show child attributes
Trade name of a company customer.
Example:
"Souza Studio"
Values of the organization's custom fields for this customer, keyed by each field's slug. Every key must be the slug of an active custom field defined for customers, and every value must fit that field's type; a field marked as required must have a value.
Example: {"cost-center":"CC-1020"}
Show child attributes
Show child attributes
Example:
{ "cost-center": "CC-1020" }
Response
Successful response
The customer a create or an update answers with.
ID of the customer.
Example:
"7f3b1c52-9e4a-4d1b-8a67-2c5d9f0e4b13"
Token that identifies the customer in the link of their portal page.
Example:
"c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f"
Postal address of the customer.
Show child attributes
Show child attributes
Example:
{
"street": "Rua das Flores",
"number": "123",
"complement": "Apto 45",
"neighborhood": "Centro",
"city": "São Paulo",
"state": "SP",
"postalCode": "01000-000"
}
Name of the customer: a person's full name or a company's name.
Example:
"Ana Souza"
Tax ID of the customer, without formatting: a CPF (11 digits) or a CNPJ (14 characters — the first 12 may be uppercase letters, the last 2 are digits).
Example:
"52998224725"
Kind of document: CPF for 11 characters, CNPJ otherwise.
Example:
"CPF"
Trade name of a company customer.
Example:
"Souza Studio"
E-mail address of the customer.
Example:
"ana.souza@example.com"
Phone number of the customer, in international format: + followed by digits.
Example:
"+5511999999999"
Values of the organization's custom fields for this customer, keyed by the field's slug. Absent, or null, when the customer has none.
Example: {"cost-center":"CC-1020"}
Show child attributes
Show child attributes
Example:
{ "cost-center": "CC-1020" }