Start an OAuth/OIDC connect flow
curl --request POST \
--url https://api.example.com/v1/connect_sessions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"carrier": "<string>",
"app": "<string>",
"return_url": "<string>",
"display_name": "<string>",
"config": {},
"scopes": [
"<string>"
],
"connection": "<string>",
"login_hint": "<string>",
"user_metadata": {}
}
'import requests
url = "https://api.example.com/v1/connect_sessions"
payload = {
"carrier": "<string>",
"app": "<string>",
"return_url": "<string>",
"display_name": "<string>",
"config": {},
"scopes": ["<string>"],
"connection": "<string>",
"login_hint": "<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({
carrier: '<string>',
app: '<string>',
return_url: '<string>',
display_name: '<string>',
config: {},
scopes: ['<string>'],
connection: '<string>',
login_hint: '<string>',
user_metadata: {}
})
};
fetch('https://api.example.com/v1/connect_sessions', 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/connect_sessions",
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([
'carrier' => '<string>',
'app' => '<string>',
'return_url' => '<string>',
'display_name' => '<string>',
'config' => [
],
'scopes' => [
'<string>'
],
'connection' => '<string>',
'login_hint' => '<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/connect_sessions"
payload := strings.NewReader("{\n \"carrier\": \"<string>\",\n \"app\": \"<string>\",\n \"return_url\": \"<string>\",\n \"display_name\": \"<string>\",\n \"config\": {},\n \"scopes\": [\n \"<string>\"\n ],\n \"connection\": \"<string>\",\n \"login_hint\": \"<string>\",\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/connect_sessions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"carrier\": \"<string>\",\n \"app\": \"<string>\",\n \"return_url\": \"<string>\",\n \"display_name\": \"<string>\",\n \"config\": {},\n \"scopes\": [\n \"<string>\"\n ],\n \"connection\": \"<string>\",\n \"login_hint\": \"<string>\",\n \"user_metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/connect_sessions")
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 \"carrier\": \"<string>\",\n \"app\": \"<string>\",\n \"return_url\": \"<string>\",\n \"display_name\": \"<string>\",\n \"config\": {},\n \"scopes\": [\n \"<string>\"\n ],\n \"connection\": \"<string>\",\n \"login_hint\": \"<string>\",\n \"user_metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"object": "connect_session",
"status": "open",
"carrier": "<string>",
"url": "<string>",
"expires_at": 123,
"livemode": true,
"created": 123,
"mode": "redirect",
"app": "<string>",
"user_code": "<string>",
"return_url": "<string>",
"connection": "<string>",
"error": {
"code": "access_denied",
"message": "<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>"
}
]
}
}Connections
Start an OAuth/OIDC connect flow
POST
/
v1
/
connect_sessions
Start an OAuth/OIDC connect flow
curl --request POST \
--url https://api.example.com/v1/connect_sessions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"carrier": "<string>",
"app": "<string>",
"return_url": "<string>",
"display_name": "<string>",
"config": {},
"scopes": [
"<string>"
],
"connection": "<string>",
"login_hint": "<string>",
"user_metadata": {}
}
'import requests
url = "https://api.example.com/v1/connect_sessions"
payload = {
"carrier": "<string>",
"app": "<string>",
"return_url": "<string>",
"display_name": "<string>",
"config": {},
"scopes": ["<string>"],
"connection": "<string>",
"login_hint": "<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({
carrier: '<string>',
app: '<string>',
return_url: '<string>',
display_name: '<string>',
config: {},
scopes: ['<string>'],
connection: '<string>',
login_hint: '<string>',
user_metadata: {}
})
};
fetch('https://api.example.com/v1/connect_sessions', 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/connect_sessions",
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([
'carrier' => '<string>',
'app' => '<string>',
'return_url' => '<string>',
'display_name' => '<string>',
'config' => [
],
'scopes' => [
'<string>'
],
'connection' => '<string>',
'login_hint' => '<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/connect_sessions"
payload := strings.NewReader("{\n \"carrier\": \"<string>\",\n \"app\": \"<string>\",\n \"return_url\": \"<string>\",\n \"display_name\": \"<string>\",\n \"config\": {},\n \"scopes\": [\n \"<string>\"\n ],\n \"connection\": \"<string>\",\n \"login_hint\": \"<string>\",\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/connect_sessions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"carrier\": \"<string>\",\n \"app\": \"<string>\",\n \"return_url\": \"<string>\",\n \"display_name\": \"<string>\",\n \"config\": {},\n \"scopes\": [\n \"<string>\"\n ],\n \"connection\": \"<string>\",\n \"login_hint\": \"<string>\",\n \"user_metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/connect_sessions")
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 \"carrier\": \"<string>\",\n \"app\": \"<string>\",\n \"return_url\": \"<string>\",\n \"display_name\": \"<string>\",\n \"config\": {},\n \"scopes\": [\n \"<string>\"\n ],\n \"connection\": \"<string>\",\n \"login_hint\": \"<string>\",\n \"user_metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"object": "connect_session",
"status": "open",
"carrier": "<string>",
"url": "<string>",
"expires_at": 123,
"livemode": true,
"created": 123,
"mode": "redirect",
"app": "<string>",
"user_code": "<string>",
"return_url": "<string>",
"connection": "<string>",
"error": {
"code": "access_denied",
"message": "<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
Available options:
redirect, device Client-writable. Up to 50 string key/value pairs. Never sent to carriers.
Show child attributes
Show child attributes
Response
OK
Available options:
connect_session Available options:
open, completed, failed, expired Unix timestamp (seconds)
Unix timestamp (seconds)
Available options:
redirect, device Show child attributes
Show child attributes