Create a child account
curl --request POST \
--url https://api.example.com/v1/accounts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"profile": {},
"settings": {},
"modules": [
"<string>"
],
"user_metadata": {}
}
'import requests
url = "https://api.example.com/v1/accounts"
payload = {
"profile": {},
"settings": {},
"modules": ["<string>"],
"user_metadata": {}
}
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({profile: {}, settings: {}, modules: ['<string>'], user_metadata: {}})
};
fetch('https://api.example.com/v1/accounts', 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/v1/accounts",
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([
'profile' => [
],
'settings' => [
],
'modules' => [
'<string>'
],
'user_metadata' => [
]
]),
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://api.example.com/v1/accounts"
payload := strings.NewReader("{\n \"profile\": {},\n \"settings\": {},\n \"modules\": [\n \"<string>\"\n ],\n \"user_metadata\": {}\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("https://api.example.com/v1/accounts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"profile\": {},\n \"settings\": {},\n \"modules\": [\n \"<string>\"\n ],\n \"user_metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"profile\": {},\n \"settings\": {},\n \"modules\": [\n \"<string>\"\n ],\n \"user_metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "acct_1Q2w3E4r",
"object": "account",
"livemode": true,
"created": 123,
"type": "merchant",
"status": "onboarding",
"updated": 123,
"carrier": {
"id": "<string>",
"kinds": [
"<string>"
],
"codes": {},
"status": "onboarding",
"visibility": "network",
"service_area": [
"<string>"
],
"segments": {
"first_mile": {
"lanes": [
{
"from_zone": "<string>",
"to_zone": "<string>",
"modes": [
"<string>"
]
}
],
"zones": [
"<string>"
],
"handoff_points": [
"<string>"
],
"customs": {
"export": true,
"import": true
}
},
"middle_mile": {
"lanes": [
{
"from_zone": "<string>",
"to_zone": "<string>",
"modes": [
"<string>"
]
}
],
"zones": [
"<string>"
],
"handoff_points": [
"<string>"
],
"customs": {
"export": true,
"import": true
}
},
"last_mile": {
"lanes": [
{
"from_zone": "<string>",
"to_zone": "<string>",
"modes": [
"<string>"
]
}
],
"zones": [
"<string>"
],
"handoff_points": [
"<string>"
],
"customs": {
"export": true,
"import": true
}
},
"end_to_end": {
"lanes": [
{
"from_zone": "<string>",
"to_zone": "<string>",
"modes": [
"<string>"
]
}
],
"zones": [
"<string>"
],
"handoff_points": [
"<string>"
],
"customs": {
"export": true,
"import": true
}
}
}
},
"parent": "<string>",
"profile": {
"legal_name": "<string>",
"display_name": "<string>",
"contact": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"website": "<string>",
"industry": "<string>"
},
"settings": {
"timezone": "<string>",
"currency": "<string>",
"units": {
"weight": "<string>",
"dimensions": "<string>"
},
"label_format": {
"format": "pdf",
"size": "<string>",
"dpi": "203",
"inline": true
},
"default_ship_from": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"api_version": "<string>"
},
"modules": [
"<string>"
],
"requirements": {
"currently_due": [
"<string>"
],
"pending_verification": [
"<string>"
]
},
"user_metadata": {},
"carrier_metadata": {},
"system_metadata": {
"source": "api",
"created_by": {
"type": "api_key",
"id": "<string>"
},
"request_id": "<string>",
"idempotency_key": "<string>",
"batch": "<string>",
"generated": true,
"test_scenario": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}Accounts
Create a child account
POST
/
v1
/
accounts
Create a child account
curl --request POST \
--url https://api.example.com/v1/accounts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"profile": {},
"settings": {},
"modules": [
"<string>"
],
"user_metadata": {}
}
'import requests
url = "https://api.example.com/v1/accounts"
payload = {
"profile": {},
"settings": {},
"modules": ["<string>"],
"user_metadata": {}
}
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({profile: {}, settings: {}, modules: ['<string>'], user_metadata: {}})
};
fetch('https://api.example.com/v1/accounts', 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/v1/accounts",
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([
'profile' => [
],
'settings' => [
],
'modules' => [
'<string>'
],
'user_metadata' => [
]
]),
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://api.example.com/v1/accounts"
payload := strings.NewReader("{\n \"profile\": {},\n \"settings\": {},\n \"modules\": [\n \"<string>\"\n ],\n \"user_metadata\": {}\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("https://api.example.com/v1/accounts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"profile\": {},\n \"settings\": {},\n \"modules\": [\n \"<string>\"\n ],\n \"user_metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"profile\": {},\n \"settings\": {},\n \"modules\": [\n \"<string>\"\n ],\n \"user_metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "acct_1Q2w3E4r",
"object": "account",
"livemode": true,
"created": 123,
"type": "merchant",
"status": "onboarding",
"updated": 123,
"carrier": {
"id": "<string>",
"kinds": [
"<string>"
],
"codes": {},
"status": "onboarding",
"visibility": "network",
"service_area": [
"<string>"
],
"segments": {
"first_mile": {
"lanes": [
{
"from_zone": "<string>",
"to_zone": "<string>",
"modes": [
"<string>"
]
}
],
"zones": [
"<string>"
],
"handoff_points": [
"<string>"
],
"customs": {
"export": true,
"import": true
}
},
"middle_mile": {
"lanes": [
{
"from_zone": "<string>",
"to_zone": "<string>",
"modes": [
"<string>"
]
}
],
"zones": [
"<string>"
],
"handoff_points": [
"<string>"
],
"customs": {
"export": true,
"import": true
}
},
"last_mile": {
"lanes": [
{
"from_zone": "<string>",
"to_zone": "<string>",
"modes": [
"<string>"
]
}
],
"zones": [
"<string>"
],
"handoff_points": [
"<string>"
],
"customs": {
"export": true,
"import": true
}
},
"end_to_end": {
"lanes": [
{
"from_zone": "<string>",
"to_zone": "<string>",
"modes": [
"<string>"
]
}
],
"zones": [
"<string>"
],
"handoff_points": [
"<string>"
],
"customs": {
"export": true,
"import": true
}
}
}
},
"parent": "<string>",
"profile": {
"legal_name": "<string>",
"display_name": "<string>",
"contact": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"website": "<string>",
"industry": "<string>"
},
"settings": {
"timezone": "<string>",
"currency": "<string>",
"units": {
"weight": "<string>",
"dimensions": "<string>"
},
"label_format": {
"format": "pdf",
"size": "<string>",
"dpi": "203",
"inline": true
},
"default_ship_from": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"type": "eori",
"value": "<string>",
"country": "<string>"
}
],
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"status": "verified",
"suggested": "<unknown>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>",
"type": "locker"
}
},
"api_version": "<string>"
},
"modules": [
"<string>"
],
"requirements": {
"currently_due": [
"<string>"
],
"pending_verification": [
"<string>"
]
},
"user_metadata": {},
"carrier_metadata": {},
"system_metadata": {
"source": "api",
"created_by": {
"type": "api_key",
"id": "<string>"
},
"request_id": "<string>",
"idempotency_key": "<string>",
"batch": "<string>",
"generated": true,
"test_scenario": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"carrier": {
"id": "<string>",
"connection": "<string>",
"code": "<string>",
"message": "<string>"
},
"shipment": "<string>",
"details": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>"
}
]
}
}Authorizations
apiKeyoauth2
sk_test_ / sk_live_ / rk_test_ / rk_live_ keys
Headers
Act on behalf of a connected account (acct_...)
Maximum string length:
255Body
application/json
Response
OK
Prefixed acct_
Example:
"acct_1Q2w3E4r"
Available options:
account Unix timestamp (seconds)
Available options:
merchant, carrier, partner, platform, internal Available options:
onboarding, active, restricted, suspended, closed Unix timestamp (seconds)
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Client-writable. Up to 50 string key/value pairs. Never sent to carriers.
Show child attributes
Show child attributes
Read-only. Carrier-returned data not modelled by the spec (routing codes, internal IDs). Untrusted and unversioned; keys may change with the carrier's API.
Read-only. Implementer provenance. Implementer-specific keys are prefixed x_.
Show child attributes
Show child attributes