Create a distribution invitation
curl --request POST \
--url https://api.quiva.ai/accounts/distribution-invite \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"products": [
{
"product_id": "<string>",
"version": "<string>",
"product_name": "<string>",
"type": "<string>",
"commission_cap": 123,
"clear_commission_cap": true
}
],
"space_id": "<string>",
"brokerage_name": "<string>",
"distribution_id": "<string>",
"scope": [
"<string>"
],
"expiry_days": 123,
"abn": "<string>",
"afsl_number": "<string>",
"primary_contact_name": "<string>",
"primary_contact_email": "jsmith@example.com",
"primary_contact_phone": "<string>",
"address": "<string>",
"distribution_agreement_ref": "<string>",
"activity_signal_enabled": true,
"status_map": {},
"publisher_gateway_id": "<string>",
"ingress_path_format": "<string>",
"bind_path_format": "<string>",
"request_path_format": "<string>",
"return_path": "<string>"
}
'import requests
url = "https://api.quiva.ai/accounts/distribution-invite"
payload = {
"products": [
{
"product_id": "<string>",
"version": "<string>",
"product_name": "<string>",
"type": "<string>",
"commission_cap": 123,
"clear_commission_cap": True
}
],
"space_id": "<string>",
"brokerage_name": "<string>",
"distribution_id": "<string>",
"scope": ["<string>"],
"expiry_days": 123,
"abn": "<string>",
"afsl_number": "<string>",
"primary_contact_name": "<string>",
"primary_contact_email": "jsmith@example.com",
"primary_contact_phone": "<string>",
"address": "<string>",
"distribution_agreement_ref": "<string>",
"activity_signal_enabled": True,
"status_map": {},
"publisher_gateway_id": "<string>",
"ingress_path_format": "<string>",
"bind_path_format": "<string>",
"request_path_format": "<string>",
"return_path": "<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({
products: [
{
product_id: '<string>',
version: '<string>',
product_name: '<string>',
type: '<string>',
commission_cap: 123,
clear_commission_cap: true
}
],
space_id: '<string>',
brokerage_name: '<string>',
distribution_id: '<string>',
scope: ['<string>'],
expiry_days: 123,
abn: '<string>',
afsl_number: '<string>',
primary_contact_name: '<string>',
primary_contact_email: 'jsmith@example.com',
primary_contact_phone: '<string>',
address: '<string>',
distribution_agreement_ref: '<string>',
activity_signal_enabled: true,
status_map: {},
publisher_gateway_id: '<string>',
ingress_path_format: '<string>',
bind_path_format: '<string>',
request_path_format: '<string>',
return_path: '<string>'
})
};
fetch('https://api.quiva.ai/accounts/distribution-invite', 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.quiva.ai/accounts/distribution-invite",
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([
'products' => [
[
'product_id' => '<string>',
'version' => '<string>',
'product_name' => '<string>',
'type' => '<string>',
'commission_cap' => 123,
'clear_commission_cap' => true
]
],
'space_id' => '<string>',
'brokerage_name' => '<string>',
'distribution_id' => '<string>',
'scope' => [
'<string>'
],
'expiry_days' => 123,
'abn' => '<string>',
'afsl_number' => '<string>',
'primary_contact_name' => '<string>',
'primary_contact_email' => 'jsmith@example.com',
'primary_contact_phone' => '<string>',
'address' => '<string>',
'distribution_agreement_ref' => '<string>',
'activity_signal_enabled' => true,
'status_map' => [
],
'publisher_gateway_id' => '<string>',
'ingress_path_format' => '<string>',
'bind_path_format' => '<string>',
'request_path_format' => '<string>',
'return_path' => '<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.quiva.ai/accounts/distribution-invite"
payload := strings.NewReader("{\n \"products\": [\n {\n \"product_id\": \"<string>\",\n \"version\": \"<string>\",\n \"product_name\": \"<string>\",\n \"type\": \"<string>\",\n \"commission_cap\": 123,\n \"clear_commission_cap\": true\n }\n ],\n \"space_id\": \"<string>\",\n \"brokerage_name\": \"<string>\",\n \"distribution_id\": \"<string>\",\n \"scope\": [\n \"<string>\"\n ],\n \"expiry_days\": 123,\n \"abn\": \"<string>\",\n \"afsl_number\": \"<string>\",\n \"primary_contact_name\": \"<string>\",\n \"primary_contact_email\": \"jsmith@example.com\",\n \"primary_contact_phone\": \"<string>\",\n \"address\": \"<string>\",\n \"distribution_agreement_ref\": \"<string>\",\n \"activity_signal_enabled\": true,\n \"status_map\": {},\n \"publisher_gateway_id\": \"<string>\",\n \"ingress_path_format\": \"<string>\",\n \"bind_path_format\": \"<string>\",\n \"request_path_format\": \"<string>\",\n \"return_path\": \"<string>\"\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.quiva.ai/accounts/distribution-invite")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"products\": [\n {\n \"product_id\": \"<string>\",\n \"version\": \"<string>\",\n \"product_name\": \"<string>\",\n \"type\": \"<string>\",\n \"commission_cap\": 123,\n \"clear_commission_cap\": true\n }\n ],\n \"space_id\": \"<string>\",\n \"brokerage_name\": \"<string>\",\n \"distribution_id\": \"<string>\",\n \"scope\": [\n \"<string>\"\n ],\n \"expiry_days\": 123,\n \"abn\": \"<string>\",\n \"afsl_number\": \"<string>\",\n \"primary_contact_name\": \"<string>\",\n \"primary_contact_email\": \"jsmith@example.com\",\n \"primary_contact_phone\": \"<string>\",\n \"address\": \"<string>\",\n \"distribution_agreement_ref\": \"<string>\",\n \"activity_signal_enabled\": true,\n \"status_map\": {},\n \"publisher_gateway_id\": \"<string>\",\n \"ingress_path_format\": \"<string>\",\n \"bind_path_format\": \"<string>\",\n \"request_path_format\": \"<string>\",\n \"return_path\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.quiva.ai/accounts/distribution-invite")
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 \"products\": [\n {\n \"product_id\": \"<string>\",\n \"version\": \"<string>\",\n \"product_name\": \"<string>\",\n \"type\": \"<string>\",\n \"commission_cap\": 123,\n \"clear_commission_cap\": true\n }\n ],\n \"space_id\": \"<string>\",\n \"brokerage_name\": \"<string>\",\n \"distribution_id\": \"<string>\",\n \"scope\": [\n \"<string>\"\n ],\n \"expiry_days\": 123,\n \"abn\": \"<string>\",\n \"afsl_number\": \"<string>\",\n \"primary_contact_name\": \"<string>\",\n \"primary_contact_email\": \"jsmith@example.com\",\n \"primary_contact_phone\": \"<string>\",\n \"address\": \"<string>\",\n \"distribution_agreement_ref\": \"<string>\",\n \"activity_signal_enabled\": true,\n \"status_map\": {},\n \"publisher_gateway_id\": \"<string>\",\n \"ingress_path_format\": \"<string>\",\n \"bind_path_format\": \"<string>\",\n \"request_path_format\": \"<string>\",\n \"return_path\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"invite_id": "<string>",
"token": "<string>",
"invite_url": "<string>",
"expires_at": 123,
"distribution_id": "<string>",
"products": [
{
"product_id": "<string>",
"version": "<string>",
"product_name": "<string>",
"type": "<string>",
"commission_cap": 123,
"clear_commission_cap": true
}
],
"brokerage_name": "<string>",
"steps": [
{
"name": "<string>",
"done": true,
"detail": "<string>"
}
],
"outstanding": [
"<string>"
]
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Distribution Invitations
Create a distribution invitation
Mints an invitation from the calling publisher account to a distributor firm. The response carries the one-time token and the public landing link. Root and admin roles only. Refused when the firm already holds an outstanding invitation or a distribution from this publisher.
POST
/
accounts
/
distribution-invite
Create a distribution invitation
curl --request POST \
--url https://api.quiva.ai/accounts/distribution-invite \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"products": [
{
"product_id": "<string>",
"version": "<string>",
"product_name": "<string>",
"type": "<string>",
"commission_cap": 123,
"clear_commission_cap": true
}
],
"space_id": "<string>",
"brokerage_name": "<string>",
"distribution_id": "<string>",
"scope": [
"<string>"
],
"expiry_days": 123,
"abn": "<string>",
"afsl_number": "<string>",
"primary_contact_name": "<string>",
"primary_contact_email": "jsmith@example.com",
"primary_contact_phone": "<string>",
"address": "<string>",
"distribution_agreement_ref": "<string>",
"activity_signal_enabled": true,
"status_map": {},
"publisher_gateway_id": "<string>",
"ingress_path_format": "<string>",
"bind_path_format": "<string>",
"request_path_format": "<string>",
"return_path": "<string>"
}
'import requests
url = "https://api.quiva.ai/accounts/distribution-invite"
payload = {
"products": [
{
"product_id": "<string>",
"version": "<string>",
"product_name": "<string>",
"type": "<string>",
"commission_cap": 123,
"clear_commission_cap": True
}
],
"space_id": "<string>",
"brokerage_name": "<string>",
"distribution_id": "<string>",
"scope": ["<string>"],
"expiry_days": 123,
"abn": "<string>",
"afsl_number": "<string>",
"primary_contact_name": "<string>",
"primary_contact_email": "jsmith@example.com",
"primary_contact_phone": "<string>",
"address": "<string>",
"distribution_agreement_ref": "<string>",
"activity_signal_enabled": True,
"status_map": {},
"publisher_gateway_id": "<string>",
"ingress_path_format": "<string>",
"bind_path_format": "<string>",
"request_path_format": "<string>",
"return_path": "<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({
products: [
{
product_id: '<string>',
version: '<string>',
product_name: '<string>',
type: '<string>',
commission_cap: 123,
clear_commission_cap: true
}
],
space_id: '<string>',
brokerage_name: '<string>',
distribution_id: '<string>',
scope: ['<string>'],
expiry_days: 123,
abn: '<string>',
afsl_number: '<string>',
primary_contact_name: '<string>',
primary_contact_email: 'jsmith@example.com',
primary_contact_phone: '<string>',
address: '<string>',
distribution_agreement_ref: '<string>',
activity_signal_enabled: true,
status_map: {},
publisher_gateway_id: '<string>',
ingress_path_format: '<string>',
bind_path_format: '<string>',
request_path_format: '<string>',
return_path: '<string>'
})
};
fetch('https://api.quiva.ai/accounts/distribution-invite', 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.quiva.ai/accounts/distribution-invite",
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([
'products' => [
[
'product_id' => '<string>',
'version' => '<string>',
'product_name' => '<string>',
'type' => '<string>',
'commission_cap' => 123,
'clear_commission_cap' => true
]
],
'space_id' => '<string>',
'brokerage_name' => '<string>',
'distribution_id' => '<string>',
'scope' => [
'<string>'
],
'expiry_days' => 123,
'abn' => '<string>',
'afsl_number' => '<string>',
'primary_contact_name' => '<string>',
'primary_contact_email' => 'jsmith@example.com',
'primary_contact_phone' => '<string>',
'address' => '<string>',
'distribution_agreement_ref' => '<string>',
'activity_signal_enabled' => true,
'status_map' => [
],
'publisher_gateway_id' => '<string>',
'ingress_path_format' => '<string>',
'bind_path_format' => '<string>',
'request_path_format' => '<string>',
'return_path' => '<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.quiva.ai/accounts/distribution-invite"
payload := strings.NewReader("{\n \"products\": [\n {\n \"product_id\": \"<string>\",\n \"version\": \"<string>\",\n \"product_name\": \"<string>\",\n \"type\": \"<string>\",\n \"commission_cap\": 123,\n \"clear_commission_cap\": true\n }\n ],\n \"space_id\": \"<string>\",\n \"brokerage_name\": \"<string>\",\n \"distribution_id\": \"<string>\",\n \"scope\": [\n \"<string>\"\n ],\n \"expiry_days\": 123,\n \"abn\": \"<string>\",\n \"afsl_number\": \"<string>\",\n \"primary_contact_name\": \"<string>\",\n \"primary_contact_email\": \"jsmith@example.com\",\n \"primary_contact_phone\": \"<string>\",\n \"address\": \"<string>\",\n \"distribution_agreement_ref\": \"<string>\",\n \"activity_signal_enabled\": true,\n \"status_map\": {},\n \"publisher_gateway_id\": \"<string>\",\n \"ingress_path_format\": \"<string>\",\n \"bind_path_format\": \"<string>\",\n \"request_path_format\": \"<string>\",\n \"return_path\": \"<string>\"\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.quiva.ai/accounts/distribution-invite")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"products\": [\n {\n \"product_id\": \"<string>\",\n \"version\": \"<string>\",\n \"product_name\": \"<string>\",\n \"type\": \"<string>\",\n \"commission_cap\": 123,\n \"clear_commission_cap\": true\n }\n ],\n \"space_id\": \"<string>\",\n \"brokerage_name\": \"<string>\",\n \"distribution_id\": \"<string>\",\n \"scope\": [\n \"<string>\"\n ],\n \"expiry_days\": 123,\n \"abn\": \"<string>\",\n \"afsl_number\": \"<string>\",\n \"primary_contact_name\": \"<string>\",\n \"primary_contact_email\": \"jsmith@example.com\",\n \"primary_contact_phone\": \"<string>\",\n \"address\": \"<string>\",\n \"distribution_agreement_ref\": \"<string>\",\n \"activity_signal_enabled\": true,\n \"status_map\": {},\n \"publisher_gateway_id\": \"<string>\",\n \"ingress_path_format\": \"<string>\",\n \"bind_path_format\": \"<string>\",\n \"request_path_format\": \"<string>\",\n \"return_path\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.quiva.ai/accounts/distribution-invite")
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 \"products\": [\n {\n \"product_id\": \"<string>\",\n \"version\": \"<string>\",\n \"product_name\": \"<string>\",\n \"type\": \"<string>\",\n \"commission_cap\": 123,\n \"clear_commission_cap\": true\n }\n ],\n \"space_id\": \"<string>\",\n \"brokerage_name\": \"<string>\",\n \"distribution_id\": \"<string>\",\n \"scope\": [\n \"<string>\"\n ],\n \"expiry_days\": 123,\n \"abn\": \"<string>\",\n \"afsl_number\": \"<string>\",\n \"primary_contact_name\": \"<string>\",\n \"primary_contact_email\": \"jsmith@example.com\",\n \"primary_contact_phone\": \"<string>\",\n \"address\": \"<string>\",\n \"distribution_agreement_ref\": \"<string>\",\n \"activity_signal_enabled\": true,\n \"status_map\": {},\n \"publisher_gateway_id\": \"<string>\",\n \"ingress_path_format\": \"<string>\",\n \"bind_path_format\": \"<string>\",\n \"request_path_format\": \"<string>\",\n \"return_path\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"invite_id": "<string>",
"token": "<string>",
"invite_url": "<string>",
"expires_at": 123,
"distribution_id": "<string>",
"products": [
{
"product_id": "<string>",
"version": "<string>",
"product_name": "<string>",
"type": "<string>",
"commission_cap": 123,
"clear_commission_cap": true
}
],
"brokerage_name": "<string>",
"steps": [
{
"name": "<string>",
"done": true,
"detail": "<string>"
}
],
"outstanding": [
"<string>"
]
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
bearerAuthapiKeyAuth
Body
application/json