Collection invites
Bulk-invite Beneficiaries
The invite-first flow, pluralized (1..500 rows): each row becomes an identity-only stub (identity_pending) and every persisted stub receives a full_onboarding collection link. Row failures (duplicate email, wrong-type identity field) are reported per row in failed and never abort the rest of the file.
POST
/
v1
/
beneficiaries
/
bulk-invites
Bulk-invite Beneficiaries from CSV rows
curl --request POST \
--url https://api.example.com/v1/beneficiaries/bulk-invites \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"rows": [
{
"email": "jsmith@example.com",
"first_name": "<string>",
"last_name": "<string>",
"business_name": "<string>",
"nickname": "<string>"
}
],
"message": "<string>"
}
'import requests
url = "https://api.example.com/v1/beneficiaries/bulk-invites"
payload = {
"rows": [
{
"email": "jsmith@example.com",
"first_name": "<string>",
"last_name": "<string>",
"business_name": "<string>",
"nickname": "<string>"
}
],
"message": "<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({
rows: [
{
email: 'jsmith@example.com',
first_name: '<string>',
last_name: '<string>',
business_name: '<string>',
nickname: '<string>'
}
],
message: '<string>'
})
};
fetch('https://api.example.com/v1/beneficiaries/bulk-invites', 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/beneficiaries/bulk-invites",
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([
'rows' => [
[
'email' => 'jsmith@example.com',
'first_name' => '<string>',
'last_name' => '<string>',
'business_name' => '<string>',
'nickname' => '<string>'
]
],
'message' => '<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/beneficiaries/bulk-invites"
payload := strings.NewReader("{\n \"rows\": [\n {\n \"email\": \"jsmith@example.com\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"business_name\": \"<string>\",\n \"nickname\": \"<string>\"\n }\n ],\n \"message\": \"<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.example.com/v1/beneficiaries/bulk-invites")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"rows\": [\n {\n \"email\": \"jsmith@example.com\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"business_name\": \"<string>\",\n \"nickname\": \"<string>\"\n }\n ],\n \"message\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/beneficiaries/bulk-invites")
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 \"rows\": [\n {\n \"email\": \"jsmith@example.com\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"business_name\": \"<string>\",\n \"nickname\": \"<string>\"\n }\n ],\n \"message\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"invited": [
{
"index": 123,
"id": "<string>",
"email": "jsmith@example.com"
}
],
"failed": [
{
"index": 123,
"email": "jsmith@example.com",
"error": "<string>"
}
]
}Authorizations
Cleff API key issued to a Business that self-registers via POST /v1/registration
Body
application/json
⌘I
Bulk-invite Beneficiaries from CSV rows
curl --request POST \
--url https://api.example.com/v1/beneficiaries/bulk-invites \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"rows": [
{
"email": "jsmith@example.com",
"first_name": "<string>",
"last_name": "<string>",
"business_name": "<string>",
"nickname": "<string>"
}
],
"message": "<string>"
}
'import requests
url = "https://api.example.com/v1/beneficiaries/bulk-invites"
payload = {
"rows": [
{
"email": "jsmith@example.com",
"first_name": "<string>",
"last_name": "<string>",
"business_name": "<string>",
"nickname": "<string>"
}
],
"message": "<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({
rows: [
{
email: 'jsmith@example.com',
first_name: '<string>',
last_name: '<string>',
business_name: '<string>',
nickname: '<string>'
}
],
message: '<string>'
})
};
fetch('https://api.example.com/v1/beneficiaries/bulk-invites', 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/beneficiaries/bulk-invites",
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([
'rows' => [
[
'email' => 'jsmith@example.com',
'first_name' => '<string>',
'last_name' => '<string>',
'business_name' => '<string>',
'nickname' => '<string>'
]
],
'message' => '<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/beneficiaries/bulk-invites"
payload := strings.NewReader("{\n \"rows\": [\n {\n \"email\": \"jsmith@example.com\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"business_name\": \"<string>\",\n \"nickname\": \"<string>\"\n }\n ],\n \"message\": \"<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.example.com/v1/beneficiaries/bulk-invites")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"rows\": [\n {\n \"email\": \"jsmith@example.com\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"business_name\": \"<string>\",\n \"nickname\": \"<string>\"\n }\n ],\n \"message\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/beneficiaries/bulk-invites")
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 \"rows\": [\n {\n \"email\": \"jsmith@example.com\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"business_name\": \"<string>\",\n \"nickname\": \"<string>\"\n }\n ],\n \"message\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"invited": [
{
"index": 123,
"id": "<string>",
"email": "jsmith@example.com"
}
],
"failed": [
{
"index": 123,
"email": "jsmith@example.com",
"error": "<string>"
}
]
}