Replace onboarding clients
curl --request PUT \
--url https://anzapi.onboardme.app/api/v1/onboardings/{key}/clients \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"userKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clients": [
{
"id": 123,
"remove": true,
"entityKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientCode": "<string>",
"entityTypeId": 123,
"entityType": "<string>",
"name": "<string>",
"surname": "<string>",
"email": "<string>",
"mobile": "<string>",
"requireTaxDetails": true,
"identityVerification": true,
"verificationMethod": "<string>",
"requireDocuments": true,
"documents": [
"<string>"
],
"requestAccountingFileAccess": true,
"accountingFileInviteName": "<string>"
}
],
"recipientKeys": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
'import requests
url = "https://anzapi.onboardme.app/api/v1/onboardings/{key}/clients"
payload = {
"userKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clients": [
{
"id": 123,
"remove": True,
"entityKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientCode": "<string>",
"entityTypeId": 123,
"entityType": "<string>",
"name": "<string>",
"surname": "<string>",
"email": "<string>",
"mobile": "<string>",
"requireTaxDetails": True,
"identityVerification": True,
"verificationMethod": "<string>",
"requireDocuments": True,
"documents": ["<string>"],
"requestAccountingFileAccess": True,
"accountingFileInviteName": "<string>"
}
],
"recipientKeys": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
userKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
clients: [
{
id: 123,
remove: true,
entityKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
clientCode: '<string>',
entityTypeId: 123,
entityType: '<string>',
name: '<string>',
surname: '<string>',
email: '<string>',
mobile: '<string>',
requireTaxDetails: true,
identityVerification: true,
verificationMethod: '<string>',
requireDocuments: true,
documents: ['<string>'],
requestAccountingFileAccess: true,
accountingFileInviteName: '<string>'
}
],
recipientKeys: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
})
};
fetch('https://anzapi.onboardme.app/api/v1/onboardings/{key}/clients', 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/{key}/clients",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'userKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'clients' => [
[
'id' => 123,
'remove' => true,
'entityKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'clientCode' => '<string>',
'entityTypeId' => 123,
'entityType' => '<string>',
'name' => '<string>',
'surname' => '<string>',
'email' => '<string>',
'mobile' => '<string>',
'requireTaxDetails' => true,
'identityVerification' => true,
'verificationMethod' => '<string>',
'requireDocuments' => true,
'documents' => [
'<string>'
],
'requestAccountingFileAccess' => true,
'accountingFileInviteName' => '<string>'
]
],
'recipientKeys' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
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/{key}/clients"
payload := strings.NewReader("{\n \"userKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"clients\": [\n {\n \"id\": 123,\n \"remove\": true,\n \"entityKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"clientCode\": \"<string>\",\n \"entityTypeId\": 123,\n \"entityType\": \"<string>\",\n \"name\": \"<string>\",\n \"surname\": \"<string>\",\n \"email\": \"<string>\",\n \"mobile\": \"<string>\",\n \"requireTaxDetails\": true,\n \"identityVerification\": true,\n \"verificationMethod\": \"<string>\",\n \"requireDocuments\": true,\n \"documents\": [\n \"<string>\"\n ],\n \"requestAccountingFileAccess\": true,\n \"accountingFileInviteName\": \"<string>\"\n }\n ],\n \"recipientKeys\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://anzapi.onboardme.app/api/v1/onboardings/{key}/clients")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"userKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"clients\": [\n {\n \"id\": 123,\n \"remove\": true,\n \"entityKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"clientCode\": \"<string>\",\n \"entityTypeId\": 123,\n \"entityType\": \"<string>\",\n \"name\": \"<string>\",\n \"surname\": \"<string>\",\n \"email\": \"<string>\",\n \"mobile\": \"<string>\",\n \"requireTaxDetails\": true,\n \"identityVerification\": true,\n \"verificationMethod\": \"<string>\",\n \"requireDocuments\": true,\n \"documents\": [\n \"<string>\"\n ],\n \"requestAccountingFileAccess\": true,\n \"accountingFileInviteName\": \"<string>\"\n }\n ],\n \"recipientKeys\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://anzapi.onboardme.app/api/v1/onboardings/{key}/clients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"clients\": [\n {\n \"id\": 123,\n \"remove\": true,\n \"entityKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"clientCode\": \"<string>\",\n \"entityTypeId\": 123,\n \"entityType\": \"<string>\",\n \"name\": \"<string>\",\n \"surname\": \"<string>\",\n \"email\": \"<string>\",\n \"mobile\": \"<string>\",\n \"requireTaxDetails\": true,\n \"identityVerification\": true,\n \"verificationMethod\": \"<string>\",\n \"requireDocuments\": true,\n \"documents\": [\n \"<string>\"\n ],\n \"requestAccountingFileAccess\": true,\n \"accountingFileInviteName\": \"<string>\"\n }\n ],\n \"recipientKeys\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}"
response = http.request(request)
puts response.read_bodyOnboarding management
Replace onboarding clients
Replace the full list of clients on an onboarding. Clients you leave out are removed.
PUT
/
api
/
v1
/
onboardings
/
{key}
/
clients
Replace onboarding clients
curl --request PUT \
--url https://anzapi.onboardme.app/api/v1/onboardings/{key}/clients \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"userKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clients": [
{
"id": 123,
"remove": true,
"entityKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientCode": "<string>",
"entityTypeId": 123,
"entityType": "<string>",
"name": "<string>",
"surname": "<string>",
"email": "<string>",
"mobile": "<string>",
"requireTaxDetails": true,
"identityVerification": true,
"verificationMethod": "<string>",
"requireDocuments": true,
"documents": [
"<string>"
],
"requestAccountingFileAccess": true,
"accountingFileInviteName": "<string>"
}
],
"recipientKeys": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
'import requests
url = "https://anzapi.onboardme.app/api/v1/onboardings/{key}/clients"
payload = {
"userKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clients": [
{
"id": 123,
"remove": True,
"entityKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientCode": "<string>",
"entityTypeId": 123,
"entityType": "<string>",
"name": "<string>",
"surname": "<string>",
"email": "<string>",
"mobile": "<string>",
"requireTaxDetails": True,
"identityVerification": True,
"verificationMethod": "<string>",
"requireDocuments": True,
"documents": ["<string>"],
"requestAccountingFileAccess": True,
"accountingFileInviteName": "<string>"
}
],
"recipientKeys": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
userKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
clients: [
{
id: 123,
remove: true,
entityKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
clientCode: '<string>',
entityTypeId: 123,
entityType: '<string>',
name: '<string>',
surname: '<string>',
email: '<string>',
mobile: '<string>',
requireTaxDetails: true,
identityVerification: true,
verificationMethod: '<string>',
requireDocuments: true,
documents: ['<string>'],
requestAccountingFileAccess: true,
accountingFileInviteName: '<string>'
}
],
recipientKeys: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
})
};
fetch('https://anzapi.onboardme.app/api/v1/onboardings/{key}/clients', 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/{key}/clients",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'userKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'clients' => [
[
'id' => 123,
'remove' => true,
'entityKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'clientCode' => '<string>',
'entityTypeId' => 123,
'entityType' => '<string>',
'name' => '<string>',
'surname' => '<string>',
'email' => '<string>',
'mobile' => '<string>',
'requireTaxDetails' => true,
'identityVerification' => true,
'verificationMethod' => '<string>',
'requireDocuments' => true,
'documents' => [
'<string>'
],
'requestAccountingFileAccess' => true,
'accountingFileInviteName' => '<string>'
]
],
'recipientKeys' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
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/{key}/clients"
payload := strings.NewReader("{\n \"userKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"clients\": [\n {\n \"id\": 123,\n \"remove\": true,\n \"entityKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"clientCode\": \"<string>\",\n \"entityTypeId\": 123,\n \"entityType\": \"<string>\",\n \"name\": \"<string>\",\n \"surname\": \"<string>\",\n \"email\": \"<string>\",\n \"mobile\": \"<string>\",\n \"requireTaxDetails\": true,\n \"identityVerification\": true,\n \"verificationMethod\": \"<string>\",\n \"requireDocuments\": true,\n \"documents\": [\n \"<string>\"\n ],\n \"requestAccountingFileAccess\": true,\n \"accountingFileInviteName\": \"<string>\"\n }\n ],\n \"recipientKeys\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://anzapi.onboardme.app/api/v1/onboardings/{key}/clients")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"userKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"clients\": [\n {\n \"id\": 123,\n \"remove\": true,\n \"entityKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"clientCode\": \"<string>\",\n \"entityTypeId\": 123,\n \"entityType\": \"<string>\",\n \"name\": \"<string>\",\n \"surname\": \"<string>\",\n \"email\": \"<string>\",\n \"mobile\": \"<string>\",\n \"requireTaxDetails\": true,\n \"identityVerification\": true,\n \"verificationMethod\": \"<string>\",\n \"requireDocuments\": true,\n \"documents\": [\n \"<string>\"\n ],\n \"requestAccountingFileAccess\": true,\n \"accountingFileInviteName\": \"<string>\"\n }\n ],\n \"recipientKeys\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://anzapi.onboardme.app/api/v1/onboardings/{key}/clients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"clients\": [\n {\n \"id\": 123,\n \"remove\": true,\n \"entityKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"clientCode\": \"<string>\",\n \"entityTypeId\": 123,\n \"entityType\": \"<string>\",\n \"name\": \"<string>\",\n \"surname\": \"<string>\",\n \"email\": \"<string>\",\n \"mobile\": \"<string>\",\n \"requireTaxDetails\": true,\n \"identityVerification\": true,\n \"verificationMethod\": \"<string>\",\n \"requireDocuments\": true,\n \"documents\": [\n \"<string>\"\n ],\n \"requestAccountingFileAccess\": true,\n \"accountingFileInviteName\": \"<string>\"\n }\n ],\n \"recipientKeys\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
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.
Path Parameters
Body
application/jsontext/jsonapplication/*+json
Response
200
OK