Validate an address
curl --request POST \
--url https://api.example.com/v1/address_validations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"suggested": "<unknown>",
"messages": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"contact": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"value": "<string>",
"country": "<string>"
}
],
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>"
}
},
"connection": "<string>",
"features": [
"<string>"
]
}
'import requests
url = "https://api.example.com/v1/address_validations"
payload = {
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": True,
"validation": {
"suggested": "<unknown>",
"messages": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"contact": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"value": "<string>",
"country": "<string>"
}
],
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>"
}
},
"connection": "<string>",
"features": ["<string>"]
}
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({
address: {
line1: '<string>',
country: '<string>',
street_number: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
postal_code: '<string>',
residential: true,
validation: {
suggested: '<unknown>',
messages: [
{code: '<string>', message: '<string>', param: '<string>', carrier: '<string>'}
]
}
},
contact: {
name: '<string>',
company: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
tax_ids: [{value: '<string>', country: '<string>'}],
instructions: '<string>',
access_point: {carrier: '<string>', id: '<string>'}
},
connection: '<string>',
features: ['<string>']
})
};
fetch('https://api.example.com/v1/address_validations', 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/address_validations",
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([
'address' => [
'line1' => '<string>',
'country' => '<string>',
'street_number' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal_code' => '<string>',
'residential' => true,
'validation' => [
'suggested' => '<unknown>',
'messages' => [
[
'code' => '<string>',
'message' => '<string>',
'param' => '<string>',
'carrier' => '<string>'
]
]
]
],
'contact' => [
'name' => '<string>',
'company' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'tax_ids' => [
[
'value' => '<string>',
'country' => '<string>'
]
],
'instructions' => '<string>',
'access_point' => [
'carrier' => '<string>',
'id' => '<string>'
]
],
'connection' => '<string>',
'features' => [
'<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://api.example.com/v1/address_validations"
payload := strings.NewReader("{\n \"address\": {\n \"line1\": \"<string>\",\n \"country\": \"<string>\",\n \"street_number\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"residential\": true,\n \"validation\": {\n \"suggested\": \"<unknown>\",\n \"messages\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"param\": \"<string>\",\n \"carrier\": \"<string>\"\n }\n ]\n }\n },\n \"contact\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"tax_ids\": [\n {\n \"value\": \"<string>\",\n \"country\": \"<string>\"\n }\n ],\n \"instructions\": \"<string>\",\n \"access_point\": {\n \"carrier\": \"<string>\",\n \"id\": \"<string>\"\n }\n },\n \"connection\": \"<string>\",\n \"features\": [\n \"<string>\"\n ]\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/address_validations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"address\": {\n \"line1\": \"<string>\",\n \"country\": \"<string>\",\n \"street_number\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"residential\": true,\n \"validation\": {\n \"suggested\": \"<unknown>\",\n \"messages\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"param\": \"<string>\",\n \"carrier\": \"<string>\"\n }\n ]\n }\n },\n \"contact\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"tax_ids\": [\n {\n \"value\": \"<string>\",\n \"country\": \"<string>\"\n }\n ],\n \"instructions\": \"<string>\",\n \"access_point\": {\n \"carrier\": \"<string>\",\n \"id\": \"<string>\"\n }\n },\n \"connection\": \"<string>\",\n \"features\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/address_validations")
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 \"address\": {\n \"line1\": \"<string>\",\n \"country\": \"<string>\",\n \"street_number\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"residential\": true,\n \"validation\": {\n \"suggested\": \"<unknown>\",\n \"messages\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"param\": \"<string>\",\n \"carrier\": \"<string>\"\n }\n ]\n }\n },\n \"contact\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"tax_ids\": [\n {\n \"value\": \"<string>\",\n \"country\": \"<string>\"\n }\n ],\n \"instructions\": \"<string>\",\n \"access_point\": {\n \"carrier\": \"<string>\",\n \"id\": \"<string>\"\n }\n },\n \"connection\": \"<string>\",\n \"features\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"object": "address_validation",
"status": "verified",
"deliverability": "deliverable",
"input": {
"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>"
}
]
}
},
"suggested": {
"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>"
}
]
}
},
"alternatives": [
{
"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>"
}
]
}
}
],
"components": {},
"residential": true,
"geocode": {
"latitude": 123,
"longitude": 123,
"accuracy": "rooftop"
},
"changes": [
"<string>"
],
"connection": "<string>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
],
"carrier_metadata": {}
}{
"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>"
}
]
}
}Integrations
Validate an address
POST
/
v1
/
address_validations
Validate an address
curl --request POST \
--url https://api.example.com/v1/address_validations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": true,
"validation": {
"suggested": "<unknown>",
"messages": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"contact": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"value": "<string>",
"country": "<string>"
}
],
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>"
}
},
"connection": "<string>",
"features": [
"<string>"
]
}
'import requests
url = "https://api.example.com/v1/address_validations"
payload = {
"address": {
"line1": "<string>",
"country": "<string>",
"street_number": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"residential": True,
"validation": {
"suggested": "<unknown>",
"messages": [
{
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
]
}
},
"contact": {
"name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"tax_ids": [
{
"value": "<string>",
"country": "<string>"
}
],
"instructions": "<string>",
"access_point": {
"carrier": "<string>",
"id": "<string>"
}
},
"connection": "<string>",
"features": ["<string>"]
}
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({
address: {
line1: '<string>',
country: '<string>',
street_number: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
postal_code: '<string>',
residential: true,
validation: {
suggested: '<unknown>',
messages: [
{code: '<string>', message: '<string>', param: '<string>', carrier: '<string>'}
]
}
},
contact: {
name: '<string>',
company: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
tax_ids: [{value: '<string>', country: '<string>'}],
instructions: '<string>',
access_point: {carrier: '<string>', id: '<string>'}
},
connection: '<string>',
features: ['<string>']
})
};
fetch('https://api.example.com/v1/address_validations', 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/address_validations",
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([
'address' => [
'line1' => '<string>',
'country' => '<string>',
'street_number' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal_code' => '<string>',
'residential' => true,
'validation' => [
'suggested' => '<unknown>',
'messages' => [
[
'code' => '<string>',
'message' => '<string>',
'param' => '<string>',
'carrier' => '<string>'
]
]
]
],
'contact' => [
'name' => '<string>',
'company' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'tax_ids' => [
[
'value' => '<string>',
'country' => '<string>'
]
],
'instructions' => '<string>',
'access_point' => [
'carrier' => '<string>',
'id' => '<string>'
]
],
'connection' => '<string>',
'features' => [
'<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://api.example.com/v1/address_validations"
payload := strings.NewReader("{\n \"address\": {\n \"line1\": \"<string>\",\n \"country\": \"<string>\",\n \"street_number\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"residential\": true,\n \"validation\": {\n \"suggested\": \"<unknown>\",\n \"messages\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"param\": \"<string>\",\n \"carrier\": \"<string>\"\n }\n ]\n }\n },\n \"contact\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"tax_ids\": [\n {\n \"value\": \"<string>\",\n \"country\": \"<string>\"\n }\n ],\n \"instructions\": \"<string>\",\n \"access_point\": {\n \"carrier\": \"<string>\",\n \"id\": \"<string>\"\n }\n },\n \"connection\": \"<string>\",\n \"features\": [\n \"<string>\"\n ]\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/address_validations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"address\": {\n \"line1\": \"<string>\",\n \"country\": \"<string>\",\n \"street_number\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"residential\": true,\n \"validation\": {\n \"suggested\": \"<unknown>\",\n \"messages\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"param\": \"<string>\",\n \"carrier\": \"<string>\"\n }\n ]\n }\n },\n \"contact\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"tax_ids\": [\n {\n \"value\": \"<string>\",\n \"country\": \"<string>\"\n }\n ],\n \"instructions\": \"<string>\",\n \"access_point\": {\n \"carrier\": \"<string>\",\n \"id\": \"<string>\"\n }\n },\n \"connection\": \"<string>\",\n \"features\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/address_validations")
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 \"address\": {\n \"line1\": \"<string>\",\n \"country\": \"<string>\",\n \"street_number\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"residential\": true,\n \"validation\": {\n \"suggested\": \"<unknown>\",\n \"messages\": [\n {\n \"code\": \"<string>\",\n \"message\": \"<string>\",\n \"param\": \"<string>\",\n \"carrier\": \"<string>\"\n }\n ]\n }\n },\n \"contact\": {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"tax_ids\": [\n {\n \"value\": \"<string>\",\n \"country\": \"<string>\"\n }\n ],\n \"instructions\": \"<string>\",\n \"access_point\": {\n \"carrier\": \"<string>\",\n \"id\": \"<string>\"\n }\n },\n \"connection\": \"<string>\",\n \"features\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"object": "address_validation",
"status": "verified",
"deliverability": "deliverable",
"input": {
"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>"
}
]
}
},
"suggested": {
"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>"
}
]
}
},
"alternatives": [
{
"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>"
}
]
}
}
],
"components": {},
"residential": true,
"geocode": {
"latitude": 123,
"longitude": 123,
"accuracy": "rooftop"
},
"changes": [
"<string>"
],
"connection": "<string>",
"messages": [
{
"level": "info",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"carrier": "<string>"
}
],
"carrier_metadata": {}
}{
"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_...)
Body
application/json
Response
OK
Available options:
address_validation Available options:
verified, corrected, ambiguous, unverified, invalid Available options:
deliverable, deliverable_missing_unit, undeliverable, unknown Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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.