Create a client onboarding
curl --request POST \
--url https://anzapi.onboardme.app/api/v1/onboardings/create \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"userKey": "11111111-2222-3333-4444-555555555555",
"sendToRecipient": true,
"recipient": {
"name": "Alex",
"surname": "Nguyen",
"email": "[email protected]",
"mobile": "+61 412 555 014",
"sendSms": false
},
"clients": [
{
"entityKey": "2c4f6a88-1b3d-5e7f-90ab-cdef12345678",
"clientCode": "RS-10492",
"requireTaxDetails": true,
"requireDocuments": true,
"documents": [
"Certificate of incorporation"
],
"identityVerification": false
},
{
"entityType": "Individual",
"name": "Jordan",
"surname": "Lee",
"identityVerification": true,
"verificationMethod": "Standard"
}
]
}
'import requests
url = "https://anzapi.onboardme.app/api/v1/onboardings/create"
payload = {
"userKey": "11111111-2222-3333-4444-555555555555",
"sendToRecipient": True,
"recipient": {
"name": "Alex",
"surname": "Nguyen",
"email": "[email protected]",
"mobile": "+61 412 555 014",
"sendSms": False
},
"clients": [
{
"entityKey": "2c4f6a88-1b3d-5e7f-90ab-cdef12345678",
"clientCode": "RS-10492",
"requireTaxDetails": True,
"requireDocuments": True,
"documents": ["Certificate of incorporation"],
"identityVerification": False
},
{
"entityType": "Individual",
"name": "Jordan",
"surname": "Lee",
"identityVerification": True,
"verificationMethod": "Standard"
}
]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
userKey: '11111111-2222-3333-4444-555555555555',
sendToRecipient: true,
recipient: {
name: 'Alex',
surname: 'Nguyen',
email: '[email protected]',
mobile: '+61 412 555 014',
sendSms: false
},
clients: [
{
entityKey: '2c4f6a88-1b3d-5e7f-90ab-cdef12345678',
clientCode: 'RS-10492',
requireTaxDetails: true,
requireDocuments: true,
documents: ['Certificate of incorporation'],
identityVerification: false
},
{
entityType: 'Individual',
name: 'Jordan',
surname: 'Lee',
identityVerification: true,
verificationMethod: 'Standard'
}
]
})
};
fetch('https://anzapi.onboardme.app/api/v1/onboardings/create', 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://anzapi.onboardme.app/api/v1/onboardings/create",
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([
'userKey' => '11111111-2222-3333-4444-555555555555',
'sendToRecipient' => true,
'recipient' => [
'name' => 'Alex',
'surname' => 'Nguyen',
'email' => '[email protected]',
'mobile' => '+61 412 555 014',
'sendSms' => false
],
'clients' => [
[
'entityKey' => '2c4f6a88-1b3d-5e7f-90ab-cdef12345678',
'clientCode' => 'RS-10492',
'requireTaxDetails' => true,
'requireDocuments' => true,
'documents' => [
'Certificate of incorporation'
],
'identityVerification' => false
],
[
'entityType' => 'Individual',
'name' => 'Jordan',
'surname' => 'Lee',
'identityVerification' => true,
'verificationMethod' => 'Standard'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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://anzapi.onboardme.app/api/v1/onboardings/create"
payload := strings.NewReader("{\n \"userKey\": \"11111111-2222-3333-4444-555555555555\",\n \"sendToRecipient\": true,\n \"recipient\": {\n \"name\": \"Alex\",\n \"surname\": \"Nguyen\",\n \"email\": \"[email protected]\",\n \"mobile\": \"+61 412 555 014\",\n \"sendSms\": false\n },\n \"clients\": [\n {\n \"entityKey\": \"2c4f6a88-1b3d-5e7f-90ab-cdef12345678\",\n \"clientCode\": \"RS-10492\",\n \"requireTaxDetails\": true,\n \"requireDocuments\": true,\n \"documents\": [\n \"Certificate of incorporation\"\n ],\n \"identityVerification\": false\n },\n {\n \"entityType\": \"Individual\",\n \"name\": \"Jordan\",\n \"surname\": \"Lee\",\n \"identityVerification\": true,\n \"verificationMethod\": \"Standard\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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://anzapi.onboardme.app/api/v1/onboardings/create")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"userKey\": \"11111111-2222-3333-4444-555555555555\",\n \"sendToRecipient\": true,\n \"recipient\": {\n \"name\": \"Alex\",\n \"surname\": \"Nguyen\",\n \"email\": \"[email protected]\",\n \"mobile\": \"+61 412 555 014\",\n \"sendSms\": false\n },\n \"clients\": [\n {\n \"entityKey\": \"2c4f6a88-1b3d-5e7f-90ab-cdef12345678\",\n \"clientCode\": \"RS-10492\",\n \"requireTaxDetails\": true,\n \"requireDocuments\": true,\n \"documents\": [\n \"Certificate of incorporation\"\n ],\n \"identityVerification\": false\n },\n {\n \"entityType\": \"Individual\",\n \"name\": \"Jordan\",\n \"surname\": \"Lee\",\n \"identityVerification\": true,\n \"verificationMethod\": \"Standard\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://anzapi.onboardme.app/api/v1/onboardings/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userKey\": \"11111111-2222-3333-4444-555555555555\",\n \"sendToRecipient\": true,\n \"recipient\": {\n \"name\": \"Alex\",\n \"surname\": \"Nguyen\",\n \"email\": \"[email protected]\",\n \"mobile\": \"+61 412 555 014\",\n \"sendSms\": false\n },\n \"clients\": [\n {\n \"entityKey\": \"2c4f6a88-1b3d-5e7f-90ab-cdef12345678\",\n \"clientCode\": \"RS-10492\",\n \"requireTaxDetails\": true,\n \"requireDocuments\": true,\n \"documents\": [\n \"Certificate of incorporation\"\n ],\n \"identityVerification\": false\n },\n {\n \"entityType\": \"Individual\",\n \"name\": \"Jordan\",\n \"surname\": \"Lee\",\n \"identityVerification\": true,\n \"verificationMethod\": \"Standard\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"onboardingKey": "aabbccdd-1122-3344-5566-77889900aabb",
"sentToRecipient": true,
"recipientKey": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
"recipientAccessUrl": "https://app.example/clients/welcome?key=aabbccdd-1122-3344-5566-77889900aabb&recipientKey=f1e2d3c4-b5a6-7890-abcd-ef1234567890",
"clients": [
{
"entityKey": "2c4f6a88-1b3d-5e7f-90ab-cdef12345678",
"clientCode": "RS-10492",
"entityOnboardingId": 501
},
{
"entityKey": null,
"clientCode": null,
"entityOnboardingId": 502
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Onboardings
Create a client onboarding
Create a client onboarding job.
POST
/
api
/
v1
/
onboardings
/
create
Create a client onboarding
curl --request POST \
--url https://anzapi.onboardme.app/api/v1/onboardings/create \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"userKey": "11111111-2222-3333-4444-555555555555",
"sendToRecipient": true,
"recipient": {
"name": "Alex",
"surname": "Nguyen",
"email": "[email protected]",
"mobile": "+61 412 555 014",
"sendSms": false
},
"clients": [
{
"entityKey": "2c4f6a88-1b3d-5e7f-90ab-cdef12345678",
"clientCode": "RS-10492",
"requireTaxDetails": true,
"requireDocuments": true,
"documents": [
"Certificate of incorporation"
],
"identityVerification": false
},
{
"entityType": "Individual",
"name": "Jordan",
"surname": "Lee",
"identityVerification": true,
"verificationMethod": "Standard"
}
]
}
'import requests
url = "https://anzapi.onboardme.app/api/v1/onboardings/create"
payload = {
"userKey": "11111111-2222-3333-4444-555555555555",
"sendToRecipient": True,
"recipient": {
"name": "Alex",
"surname": "Nguyen",
"email": "[email protected]",
"mobile": "+61 412 555 014",
"sendSms": False
},
"clients": [
{
"entityKey": "2c4f6a88-1b3d-5e7f-90ab-cdef12345678",
"clientCode": "RS-10492",
"requireTaxDetails": True,
"requireDocuments": True,
"documents": ["Certificate of incorporation"],
"identityVerification": False
},
{
"entityType": "Individual",
"name": "Jordan",
"surname": "Lee",
"identityVerification": True,
"verificationMethod": "Standard"
}
]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
userKey: '11111111-2222-3333-4444-555555555555',
sendToRecipient: true,
recipient: {
name: 'Alex',
surname: 'Nguyen',
email: '[email protected]',
mobile: '+61 412 555 014',
sendSms: false
},
clients: [
{
entityKey: '2c4f6a88-1b3d-5e7f-90ab-cdef12345678',
clientCode: 'RS-10492',
requireTaxDetails: true,
requireDocuments: true,
documents: ['Certificate of incorporation'],
identityVerification: false
},
{
entityType: 'Individual',
name: 'Jordan',
surname: 'Lee',
identityVerification: true,
verificationMethod: 'Standard'
}
]
})
};
fetch('https://anzapi.onboardme.app/api/v1/onboardings/create', 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://anzapi.onboardme.app/api/v1/onboardings/create",
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([
'userKey' => '11111111-2222-3333-4444-555555555555',
'sendToRecipient' => true,
'recipient' => [
'name' => 'Alex',
'surname' => 'Nguyen',
'email' => '[email protected]',
'mobile' => '+61 412 555 014',
'sendSms' => false
],
'clients' => [
[
'entityKey' => '2c4f6a88-1b3d-5e7f-90ab-cdef12345678',
'clientCode' => 'RS-10492',
'requireTaxDetails' => true,
'requireDocuments' => true,
'documents' => [
'Certificate of incorporation'
],
'identityVerification' => false
],
[
'entityType' => 'Individual',
'name' => 'Jordan',
'surname' => 'Lee',
'identityVerification' => true,
'verificationMethod' => 'Standard'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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://anzapi.onboardme.app/api/v1/onboardings/create"
payload := strings.NewReader("{\n \"userKey\": \"11111111-2222-3333-4444-555555555555\",\n \"sendToRecipient\": true,\n \"recipient\": {\n \"name\": \"Alex\",\n \"surname\": \"Nguyen\",\n \"email\": \"[email protected]\",\n \"mobile\": \"+61 412 555 014\",\n \"sendSms\": false\n },\n \"clients\": [\n {\n \"entityKey\": \"2c4f6a88-1b3d-5e7f-90ab-cdef12345678\",\n \"clientCode\": \"RS-10492\",\n \"requireTaxDetails\": true,\n \"requireDocuments\": true,\n \"documents\": [\n \"Certificate of incorporation\"\n ],\n \"identityVerification\": false\n },\n {\n \"entityType\": \"Individual\",\n \"name\": \"Jordan\",\n \"surname\": \"Lee\",\n \"identityVerification\": true,\n \"verificationMethod\": \"Standard\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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://anzapi.onboardme.app/api/v1/onboardings/create")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"userKey\": \"11111111-2222-3333-4444-555555555555\",\n \"sendToRecipient\": true,\n \"recipient\": {\n \"name\": \"Alex\",\n \"surname\": \"Nguyen\",\n \"email\": \"[email protected]\",\n \"mobile\": \"+61 412 555 014\",\n \"sendSms\": false\n },\n \"clients\": [\n {\n \"entityKey\": \"2c4f6a88-1b3d-5e7f-90ab-cdef12345678\",\n \"clientCode\": \"RS-10492\",\n \"requireTaxDetails\": true,\n \"requireDocuments\": true,\n \"documents\": [\n \"Certificate of incorporation\"\n ],\n \"identityVerification\": false\n },\n {\n \"entityType\": \"Individual\",\n \"name\": \"Jordan\",\n \"surname\": \"Lee\",\n \"identityVerification\": true,\n \"verificationMethod\": \"Standard\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://anzapi.onboardme.app/api/v1/onboardings/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userKey\": \"11111111-2222-3333-4444-555555555555\",\n \"sendToRecipient\": true,\n \"recipient\": {\n \"name\": \"Alex\",\n \"surname\": \"Nguyen\",\n \"email\": \"[email protected]\",\n \"mobile\": \"+61 412 555 014\",\n \"sendSms\": false\n },\n \"clients\": [\n {\n \"entityKey\": \"2c4f6a88-1b3d-5e7f-90ab-cdef12345678\",\n \"clientCode\": \"RS-10492\",\n \"requireTaxDetails\": true,\n \"requireDocuments\": true,\n \"documents\": [\n \"Certificate of incorporation\"\n ],\n \"identityVerification\": false\n },\n {\n \"entityType\": \"Individual\",\n \"name\": \"Jordan\",\n \"surname\": \"Lee\",\n \"identityVerification\": true,\n \"verificationMethod\": \"Standard\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"onboardingKey": "aabbccdd-1122-3344-5566-77889900aabb",
"sentToRecipient": true,
"recipientKey": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
"recipientAccessUrl": "https://app.example/clients/welcome?key=aabbccdd-1122-3344-5566-77889900aabb&recipientKey=f1e2d3c4-b5a6-7890-abcd-ef1234567890",
"clients": [
{
"entityKey": "2c4f6a88-1b3d-5e7f-90ab-cdef12345678",
"clientCode": "RS-10492",
"entityOnboardingId": 501
},
{
"entityKey": null,
"clientCode": null,
"entityOnboardingId": 502
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Authorizations
Swagger / Postman only: Client ID as username, Client secret as password. In Postman, set this once on the collection (Authorization → Basic Auth) so all requests inherit. For production server-to-server code, prefer X-OM-Auth-ID and X-OM-Auth-Key headers.
Body
application/jsontext/jsonapplication/*+json