Quote insurance
curl --request POST \
--url https://api.example.com/v1/insurance_quotes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"insured_value": {
"amount": 123,
"currency": "usd"
},
"shipment": "<string>",
"coverage_types": [],
"connections": [
"<string>"
]
}
'import requests
url = "https://api.example.com/v1/insurance_quotes"
payload = {
"insured_value": {
"amount": 123,
"currency": "usd"
},
"shipment": "<string>",
"coverage_types": [],
"connections": ["<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({
insured_value: {amount: 123, currency: 'usd'},
shipment: '<string>',
coverage_types: [],
connections: ['<string>']
})
};
fetch('https://api.example.com/v1/insurance_quotes', 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/insurance_quotes",
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([
'insured_value' => [
'amount' => 123,
'currency' => 'usd'
],
'shipment' => '<string>',
'coverage_types' => [
],
'connections' => [
'<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/insurance_quotes"
payload := strings.NewReader("{\n \"insured_value\": {\n \"amount\": 123,\n \"currency\": \"usd\"\n },\n \"shipment\": \"<string>\",\n \"coverage_types\": [],\n \"connections\": [\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/insurance_quotes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"insured_value\": {\n \"amount\": 123,\n \"currency\": \"usd\"\n },\n \"shipment\": \"<string>\",\n \"coverage_types\": [],\n \"connections\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/insurance_quotes")
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 \"insured_value\": {\n \"amount\": 123,\n \"currency\": \"usd\"\n },\n \"shipment\": \"<string>\",\n \"coverage_types\": [],\n \"connections\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"object": "list",
"data": [
{
"id": "<string>",
"object": "insurance_quote",
"premium": {
"amount": 123,
"currency": "usd"
},
"insured_value": {
"amount": 123,
"currency": "usd"
},
"connection": "<string>",
"provider": "<string>",
"deductible": {
"amount": 123,
"currency": "usd"
},
"coverage_types": [
"<string>"
],
"exclusions": [
"<string>"
],
"terms_url": "<string>",
"expires_at": 123
}
],
"errors": [
{
"connection": "<string>",
"code": "<string>",
"message": "<string>",
"carrier": "<string>",
"type": "<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
Quote insurance
POST
/
v1
/
insurance_quotes
Quote insurance
curl --request POST \
--url https://api.example.com/v1/insurance_quotes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"insured_value": {
"amount": 123,
"currency": "usd"
},
"shipment": "<string>",
"coverage_types": [],
"connections": [
"<string>"
]
}
'import requests
url = "https://api.example.com/v1/insurance_quotes"
payload = {
"insured_value": {
"amount": 123,
"currency": "usd"
},
"shipment": "<string>",
"coverage_types": [],
"connections": ["<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({
insured_value: {amount: 123, currency: 'usd'},
shipment: '<string>',
coverage_types: [],
connections: ['<string>']
})
};
fetch('https://api.example.com/v1/insurance_quotes', 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/insurance_quotes",
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([
'insured_value' => [
'amount' => 123,
'currency' => 'usd'
],
'shipment' => '<string>',
'coverage_types' => [
],
'connections' => [
'<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/insurance_quotes"
payload := strings.NewReader("{\n \"insured_value\": {\n \"amount\": 123,\n \"currency\": \"usd\"\n },\n \"shipment\": \"<string>\",\n \"coverage_types\": [],\n \"connections\": [\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/insurance_quotes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"insured_value\": {\n \"amount\": 123,\n \"currency\": \"usd\"\n },\n \"shipment\": \"<string>\",\n \"coverage_types\": [],\n \"connections\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/insurance_quotes")
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 \"insured_value\": {\n \"amount\": 123,\n \"currency\": \"usd\"\n },\n \"shipment\": \"<string>\",\n \"coverage_types\": [],\n \"connections\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"object": "list",
"data": [
{
"id": "<string>",
"object": "insurance_quote",
"premium": {
"amount": 123,
"currency": "usd"
},
"insured_value": {
"amount": 123,
"currency": "usd"
},
"connection": "<string>",
"provider": "<string>",
"deductible": {
"amount": 123,
"currency": "usd"
},
"coverage_types": [
"<string>"
],
"exclusions": [
"<string>"
],
"terms_url": "<string>",
"expires_at": 123
}
],
"errors": [
{
"connection": "<string>",
"code": "<string>",
"message": "<string>",
"carrier": "<string>",
"type": "<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