Create invitation link
curl --request POST \
--url https://api.natural.com/customers/invitation-links \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"attributes": {
"proposedAgents": [
{
"agentId": "agt_019cd1798d637a4da75dce386343931d",
"permissions": [
"payments.read",
"payments.create"
],
"limits": {
"perTransaction": 100000
}
}
],
"name": "Q3 carrier onboarding",
"tags": {
"campaign": "q3_carrier_onboarding"
}
}
}
}
'import requests
url = "https://api.natural.com/customers/invitation-links"
payload = { "data": { "attributes": {
"proposedAgents": [
{
"agentId": "agt_019cd1798d637a4da75dce386343931d",
"permissions": ["payments.read", "payments.create"],
"limits": { "perTransaction": 100000 }
}
],
"name": "Q3 carrier onboarding",
"tags": { "campaign": "q3_carrier_onboarding" }
} } }
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({
data: {
attributes: {
proposedAgents: [
{
agentId: 'agt_019cd1798d637a4da75dce386343931d',
permissions: ['payments.read', 'payments.create'],
limits: {perTransaction: 100000}
}
],
name: 'Q3 carrier onboarding',
tags: {campaign: 'q3_carrier_onboarding'}
}
}
})
};
fetch('https://api.natural.com/customers/invitation-links', 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.natural.com/customers/invitation-links",
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([
'data' => [
'attributes' => [
'proposedAgents' => [
[
'agentId' => 'agt_019cd1798d637a4da75dce386343931d',
'permissions' => [
'payments.read',
'payments.create'
],
'limits' => [
'perTransaction' => 100000
]
]
],
'name' => 'Q3 carrier onboarding',
'tags' => [
'campaign' => 'q3_carrier_onboarding'
]
]
]
]),
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.natural.com/customers/invitation-links"
payload := strings.NewReader("{\n \"data\": {\n \"attributes\": {\n \"proposedAgents\": [\n {\n \"agentId\": \"agt_019cd1798d637a4da75dce386343931d\",\n \"permissions\": [\n \"payments.read\",\n \"payments.create\"\n ],\n \"limits\": {\n \"perTransaction\": 100000\n }\n }\n ],\n \"name\": \"Q3 carrier onboarding\",\n \"tags\": {\n \"campaign\": \"q3_carrier_onboarding\"\n }\n }\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.natural.com/customers/invitation-links")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"attributes\": {\n \"proposedAgents\": [\n {\n \"agentId\": \"agt_019cd1798d637a4da75dce386343931d\",\n \"permissions\": [\n \"payments.read\",\n \"payments.create\"\n ],\n \"limits\": {\n \"perTransaction\": 100000\n }\n }\n ],\n \"name\": \"Q3 carrier onboarding\",\n \"tags\": {\n \"campaign\": \"q3_carrier_onboarding\"\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.natural.com/customers/invitation-links")
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 \"data\": {\n \"attributes\": {\n \"proposedAgents\": [\n {\n \"agentId\": \"agt_019cd1798d637a4da75dce386343931d\",\n \"permissions\": [\n \"payments.read\",\n \"payments.create\"\n ],\n \"limits\": {\n \"perTransaction\": 100000\n }\n }\n ],\n \"name\": \"Q3 carrier onboarding\",\n \"tags\": {\n \"campaign\": \"q3_carrier_onboarding\"\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"type": "invitationLink",
"id": "ivl_019cd1798d9a054033f6006d22544b56",
"attributes": {
"proposedAgents": [
{
"agentId": "agt_019cd1798d637a4da75dce386343931d",
"permissions": [
"payments.read",
"payments.create"
],
"limits": {
"perTransaction": 100000
}
}
],
"status": "active",
"createdAt": "2026-01-04T15:30:00.000Z",
"name": "Q3 carrier onboarding",
"expiresAt": null,
"tags": {
"campaign": "q3_carrier_onboarding"
},
"token": "hV3nwqumSGr7fcAJZQyLtN",
"url": "https://www.natural.com/connect/hV3nwqumSGr7fcAJZQyLtN"
},
"relationships": {
"developerParty": {
"data": {
"type": "party",
"id": "pty_019cd1798d617f65a79cb965dda9eac3"
}
}
}
}
}Invitation Links
Create invitation link
Create a shareable link offering your agents, with the permissions and limits you set, to any customer who opens it. Returns the Invitation Link object.
POST
/
customers
/
invitation-links
Create invitation link
curl --request POST \
--url https://api.natural.com/customers/invitation-links \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"attributes": {
"proposedAgents": [
{
"agentId": "agt_019cd1798d637a4da75dce386343931d",
"permissions": [
"payments.read",
"payments.create"
],
"limits": {
"perTransaction": 100000
}
}
],
"name": "Q3 carrier onboarding",
"tags": {
"campaign": "q3_carrier_onboarding"
}
}
}
}
'import requests
url = "https://api.natural.com/customers/invitation-links"
payload = { "data": { "attributes": {
"proposedAgents": [
{
"agentId": "agt_019cd1798d637a4da75dce386343931d",
"permissions": ["payments.read", "payments.create"],
"limits": { "perTransaction": 100000 }
}
],
"name": "Q3 carrier onboarding",
"tags": { "campaign": "q3_carrier_onboarding" }
} } }
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({
data: {
attributes: {
proposedAgents: [
{
agentId: 'agt_019cd1798d637a4da75dce386343931d',
permissions: ['payments.read', 'payments.create'],
limits: {perTransaction: 100000}
}
],
name: 'Q3 carrier onboarding',
tags: {campaign: 'q3_carrier_onboarding'}
}
}
})
};
fetch('https://api.natural.com/customers/invitation-links', 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.natural.com/customers/invitation-links",
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([
'data' => [
'attributes' => [
'proposedAgents' => [
[
'agentId' => 'agt_019cd1798d637a4da75dce386343931d',
'permissions' => [
'payments.read',
'payments.create'
],
'limits' => [
'perTransaction' => 100000
]
]
],
'name' => 'Q3 carrier onboarding',
'tags' => [
'campaign' => 'q3_carrier_onboarding'
]
]
]
]),
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.natural.com/customers/invitation-links"
payload := strings.NewReader("{\n \"data\": {\n \"attributes\": {\n \"proposedAgents\": [\n {\n \"agentId\": \"agt_019cd1798d637a4da75dce386343931d\",\n \"permissions\": [\n \"payments.read\",\n \"payments.create\"\n ],\n \"limits\": {\n \"perTransaction\": 100000\n }\n }\n ],\n \"name\": \"Q3 carrier onboarding\",\n \"tags\": {\n \"campaign\": \"q3_carrier_onboarding\"\n }\n }\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.natural.com/customers/invitation-links")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"attributes\": {\n \"proposedAgents\": [\n {\n \"agentId\": \"agt_019cd1798d637a4da75dce386343931d\",\n \"permissions\": [\n \"payments.read\",\n \"payments.create\"\n ],\n \"limits\": {\n \"perTransaction\": 100000\n }\n }\n ],\n \"name\": \"Q3 carrier onboarding\",\n \"tags\": {\n \"campaign\": \"q3_carrier_onboarding\"\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.natural.com/customers/invitation-links")
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 \"data\": {\n \"attributes\": {\n \"proposedAgents\": [\n {\n \"agentId\": \"agt_019cd1798d637a4da75dce386343931d\",\n \"permissions\": [\n \"payments.read\",\n \"payments.create\"\n ],\n \"limits\": {\n \"perTransaction\": 100000\n }\n }\n ],\n \"name\": \"Q3 carrier onboarding\",\n \"tags\": {\n \"campaign\": \"q3_carrier_onboarding\"\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"type": "invitationLink",
"id": "ivl_019cd1798d9a054033f6006d22544b56",
"attributes": {
"proposedAgents": [
{
"agentId": "agt_019cd1798d637a4da75dce386343931d",
"permissions": [
"payments.read",
"payments.create"
],
"limits": {
"perTransaction": 100000
}
}
],
"status": "active",
"createdAt": "2026-01-04T15:30:00.000Z",
"name": "Q3 carrier onboarding",
"expiresAt": null,
"tags": {
"campaign": "q3_carrier_onboarding"
},
"token": "hV3nwqumSGr7fcAJZQyLtN",
"url": "https://www.natural.com/connect/hV3nwqumSGr7fcAJZQyLtN"
},
"relationships": {
"developerParty": {
"data": {
"type": "party",
"id": "pty_019cd1798d617f65a79cb965dda9eac3"
}
}
}
}
}Authorizations
Headers
Was this page helpful?