Sign Up
curl --request POST \
--url https://api.example.com/api/v1/customer/auth/sign-up \
--header 'Content-Type: application/json' \
--data '
{
"name": "Maria Silva",
"address": {
"city": "Sao Paulo",
"country": "BR",
"label": "Casa",
"lat": -23.55052,
"lng": -46.633308,
"neighborhood": "Bela Vista",
"number": "1000",
"state": "SP",
"street": "Av. Paulista",
"zipCode": "01310-100",
"complement": "Apto 42"
},
"birthDate": "1990-05-15",
"document": "36641876870",
"password": "P@ssw0rd!",
"phoneDdi": "55",
"phoneIso": "BR",
"phoneNumber": "99999999999",
"email": "maria@example.com"
}
'import requests
url = "https://api.example.com/api/v1/customer/auth/sign-up"
payload = {
"name": "Maria Silva",
"address": {
"city": "Sao Paulo",
"country": "BR",
"label": "Casa",
"lat": -23.55052,
"lng": -46.633308,
"neighborhood": "Bela Vista",
"number": "1000",
"state": "SP",
"street": "Av. Paulista",
"zipCode": "01310-100",
"complement": "Apto 42"
},
"birthDate": "1990-05-15",
"document": "36641876870",
"password": "P@ssw0rd!",
"phoneDdi": "55",
"phoneIso": "BR",
"phoneNumber": "99999999999",
"email": "maria@example.com"
}
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: 'Maria Silva',
address: {
city: 'Sao Paulo',
country: 'BR',
label: 'Casa',
lat: -23.55052,
lng: -46.633308,
neighborhood: 'Bela Vista',
number: '1000',
state: 'SP',
street: 'Av. Paulista',
zipCode: '01310-100',
complement: 'Apto 42'
},
birthDate: '1990-05-15',
document: '36641876870',
password: 'P@ssw0rd!',
phoneDdi: '55',
phoneIso: 'BR',
phoneNumber: '99999999999',
email: 'maria@example.com'
})
};
fetch('https://api.example.com/api/v1/customer/auth/sign-up', 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.example.com/api/v1/customer/auth/sign-up",
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' => 'Maria Silva',
'address' => [
'city' => 'Sao Paulo',
'country' => 'BR',
'label' => 'Casa',
'lat' => -23.55052,
'lng' => -46.633308,
'neighborhood' => 'Bela Vista',
'number' => '1000',
'state' => 'SP',
'street' => 'Av. Paulista',
'zipCode' => '01310-100',
'complement' => 'Apto 42'
],
'birthDate' => '1990-05-15',
'document' => '36641876870',
'password' => 'P@ssw0rd!',
'phoneDdi' => '55',
'phoneIso' => 'BR',
'phoneNumber' => '99999999999',
'email' => 'maria@example.com'
]),
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.example.com/api/v1/customer/auth/sign-up"
payload := strings.NewReader("{\n \"name\": \"Maria Silva\",\n \"address\": {\n \"city\": \"Sao Paulo\",\n \"country\": \"BR\",\n \"label\": \"Casa\",\n \"lat\": -23.55052,\n \"lng\": -46.633308,\n \"neighborhood\": \"Bela Vista\",\n \"number\": \"1000\",\n \"state\": \"SP\",\n \"street\": \"Av. Paulista\",\n \"zipCode\": \"01310-100\",\n \"complement\": \"Apto 42\"\n },\n \"birthDate\": \"1990-05-15\",\n \"document\": \"36641876870\",\n \"password\": \"P@ssw0rd!\",\n \"phoneDdi\": \"55\",\n \"phoneIso\": \"BR\",\n \"phoneNumber\": \"99999999999\",\n \"email\": \"maria@example.com\"\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.example.com/api/v1/customer/auth/sign-up")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Maria Silva\",\n \"address\": {\n \"city\": \"Sao Paulo\",\n \"country\": \"BR\",\n \"label\": \"Casa\",\n \"lat\": -23.55052,\n \"lng\": -46.633308,\n \"neighborhood\": \"Bela Vista\",\n \"number\": \"1000\",\n \"state\": \"SP\",\n \"street\": \"Av. Paulista\",\n \"zipCode\": \"01310-100\",\n \"complement\": \"Apto 42\"\n },\n \"birthDate\": \"1990-05-15\",\n \"document\": \"36641876870\",\n \"password\": \"P@ssw0rd!\",\n \"phoneDdi\": \"55\",\n \"phoneIso\": \"BR\",\n \"phoneNumber\": \"99999999999\",\n \"email\": \"maria@example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/customer/auth/sign-up")
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\": \"Maria Silva\",\n \"address\": {\n \"city\": \"Sao Paulo\",\n \"country\": \"BR\",\n \"label\": \"Casa\",\n \"lat\": -23.55052,\n \"lng\": -46.633308,\n \"neighborhood\": \"Bela Vista\",\n \"number\": \"1000\",\n \"state\": \"SP\",\n \"street\": \"Av. Paulista\",\n \"zipCode\": \"01310-100\",\n \"complement\": \"Apto 42\"\n },\n \"birthDate\": \"1990-05-15\",\n \"document\": \"36641876870\",\n \"password\": \"P@ssw0rd!\",\n \"phoneDdi\": \"55\",\n \"phoneIso\": \"BR\",\n \"phoneNumber\": \"99999999999\",\n \"email\": \"maria@example.com\"\n}"
response = http.request(request)
puts response.read_body{
"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...",
"refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp..."
}{
"errors": [
{
"message": "required",
"path": "name"
}
],
"message": "Bad Request Error",
"statusCode": 400
}{
"message": "Internal Server Error",
"statusCode": 500
}Auth
Sign Up
Registers a new user.
POST
/
api
/
v1
/
customer
/
auth
/
sign-up
Sign Up
curl --request POST \
--url https://api.example.com/api/v1/customer/auth/sign-up \
--header 'Content-Type: application/json' \
--data '
{
"name": "Maria Silva",
"address": {
"city": "Sao Paulo",
"country": "BR",
"label": "Casa",
"lat": -23.55052,
"lng": -46.633308,
"neighborhood": "Bela Vista",
"number": "1000",
"state": "SP",
"street": "Av. Paulista",
"zipCode": "01310-100",
"complement": "Apto 42"
},
"birthDate": "1990-05-15",
"document": "36641876870",
"password": "P@ssw0rd!",
"phoneDdi": "55",
"phoneIso": "BR",
"phoneNumber": "99999999999",
"email": "maria@example.com"
}
'import requests
url = "https://api.example.com/api/v1/customer/auth/sign-up"
payload = {
"name": "Maria Silva",
"address": {
"city": "Sao Paulo",
"country": "BR",
"label": "Casa",
"lat": -23.55052,
"lng": -46.633308,
"neighborhood": "Bela Vista",
"number": "1000",
"state": "SP",
"street": "Av. Paulista",
"zipCode": "01310-100",
"complement": "Apto 42"
},
"birthDate": "1990-05-15",
"document": "36641876870",
"password": "P@ssw0rd!",
"phoneDdi": "55",
"phoneIso": "BR",
"phoneNumber": "99999999999",
"email": "maria@example.com"
}
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: 'Maria Silva',
address: {
city: 'Sao Paulo',
country: 'BR',
label: 'Casa',
lat: -23.55052,
lng: -46.633308,
neighborhood: 'Bela Vista',
number: '1000',
state: 'SP',
street: 'Av. Paulista',
zipCode: '01310-100',
complement: 'Apto 42'
},
birthDate: '1990-05-15',
document: '36641876870',
password: 'P@ssw0rd!',
phoneDdi: '55',
phoneIso: 'BR',
phoneNumber: '99999999999',
email: 'maria@example.com'
})
};
fetch('https://api.example.com/api/v1/customer/auth/sign-up', 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.example.com/api/v1/customer/auth/sign-up",
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' => 'Maria Silva',
'address' => [
'city' => 'Sao Paulo',
'country' => 'BR',
'label' => 'Casa',
'lat' => -23.55052,
'lng' => -46.633308,
'neighborhood' => 'Bela Vista',
'number' => '1000',
'state' => 'SP',
'street' => 'Av. Paulista',
'zipCode' => '01310-100',
'complement' => 'Apto 42'
],
'birthDate' => '1990-05-15',
'document' => '36641876870',
'password' => 'P@ssw0rd!',
'phoneDdi' => '55',
'phoneIso' => 'BR',
'phoneNumber' => '99999999999',
'email' => 'maria@example.com'
]),
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.example.com/api/v1/customer/auth/sign-up"
payload := strings.NewReader("{\n \"name\": \"Maria Silva\",\n \"address\": {\n \"city\": \"Sao Paulo\",\n \"country\": \"BR\",\n \"label\": \"Casa\",\n \"lat\": -23.55052,\n \"lng\": -46.633308,\n \"neighborhood\": \"Bela Vista\",\n \"number\": \"1000\",\n \"state\": \"SP\",\n \"street\": \"Av. Paulista\",\n \"zipCode\": \"01310-100\",\n \"complement\": \"Apto 42\"\n },\n \"birthDate\": \"1990-05-15\",\n \"document\": \"36641876870\",\n \"password\": \"P@ssw0rd!\",\n \"phoneDdi\": \"55\",\n \"phoneIso\": \"BR\",\n \"phoneNumber\": \"99999999999\",\n \"email\": \"maria@example.com\"\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.example.com/api/v1/customer/auth/sign-up")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Maria Silva\",\n \"address\": {\n \"city\": \"Sao Paulo\",\n \"country\": \"BR\",\n \"label\": \"Casa\",\n \"lat\": -23.55052,\n \"lng\": -46.633308,\n \"neighborhood\": \"Bela Vista\",\n \"number\": \"1000\",\n \"state\": \"SP\",\n \"street\": \"Av. Paulista\",\n \"zipCode\": \"01310-100\",\n \"complement\": \"Apto 42\"\n },\n \"birthDate\": \"1990-05-15\",\n \"document\": \"36641876870\",\n \"password\": \"P@ssw0rd!\",\n \"phoneDdi\": \"55\",\n \"phoneIso\": \"BR\",\n \"phoneNumber\": \"99999999999\",\n \"email\": \"maria@example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/customer/auth/sign-up")
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\": \"Maria Silva\",\n \"address\": {\n \"city\": \"Sao Paulo\",\n \"country\": \"BR\",\n \"label\": \"Casa\",\n \"lat\": -23.55052,\n \"lng\": -46.633308,\n \"neighborhood\": \"Bela Vista\",\n \"number\": \"1000\",\n \"state\": \"SP\",\n \"street\": \"Av. Paulista\",\n \"zipCode\": \"01310-100\",\n \"complement\": \"Apto 42\"\n },\n \"birthDate\": \"1990-05-15\",\n \"document\": \"36641876870\",\n \"password\": \"P@ssw0rd!\",\n \"phoneDdi\": \"55\",\n \"phoneIso\": \"BR\",\n \"phoneNumber\": \"99999999999\",\n \"email\": \"maria@example.com\"\n}"
response = http.request(request)
puts response.read_body{
"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...",
"refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp..."
}{
"errors": [
{
"message": "required",
"path": "name"
}
],
"message": "Bad Request Error",
"statusCode": 400
}{
"message": "Internal Server Error",
"statusCode": 500
}Query Parameters
Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.
Body
application/json
Sign-up payload
Full name
Example:
"Maria Silva"
Show child attributes
Show child attributes
Date of birth
Example:
"1990-05-15"
Customer document
Example:
"36641876870"
Password
Minimum string length:
8Example:
"P@ssw0rd!"
International dialing code
Example:
"55"
Phone ISO country code
Example:
"BR"
Phone number without country code
Example:
"99999999999"
Email address
Example:
"maria@example.com"