Get onboarding by key
curl --request GET \
--url https://anzapi.onboardme.app/api/v1/onboardings/{key} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://anzapi.onboardme.app/api/v1/onboardings/{key}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://anzapi.onboardme.app/api/v1/onboardings/{key}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://anzapi.onboardme.app/api/v1/onboardings/{key}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://anzapi.onboardme.app/api/v1/onboardings/{key}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://anzapi.onboardme.app/api/v1/onboardings/{key}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"onboardingKey": "aabbccdd-1122-3344-5566-77889900aabb",
"onboardingID": 8934,
"statusID": 2,
"statusName": "In progress",
"createdOn": "2025-04-07T10:00:00Z",
"sentOn": "2025-04-08T07:45:00Z",
"updatedOn": "2025-04-10T06:30:00Z",
"engagementKey": "8f9e2b1c-3d4a-5e6f-7890-abcdef012345",
"formKey": "99999999-8888-7777-6666-555555555555",
"entities": [
{
"entityKey": "2c4f6a88-1b3d-5e7f-90ab-cdef12345678",
"entityOnboardingID": 501,
"entityTypeName": "Company",
"completed": false,
"requireDocs": true,
"mustVerify": true,
"name": "Riverstone Holdings Ltd",
"email": "[email protected]",
"requiredDocs": [],
"verification": {
"requestedMethod": "ComplyCube",
"isVerified": true,
"verifiedDate": "2025-04-09T12:00:00Z",
"verificationMethod": "ComplyCube",
"verificationStatus": "complete",
"documentCheckId": "chk_doc_abc123",
"identityCheckId": "chk_id_xyz789",
"amlCheckId": "chk_aml_def456"
}
}
],
"recipients": []
}{
"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
Get onboarding by key
Get one onboarding job.
GET
/
api
/
v1
/
onboardings
/
{key}
Get onboarding by key
curl --request GET \
--url https://anzapi.onboardme.app/api/v1/onboardings/{key} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://anzapi.onboardme.app/api/v1/onboardings/{key}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://anzapi.onboardme.app/api/v1/onboardings/{key}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://anzapi.onboardme.app/api/v1/onboardings/{key}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://anzapi.onboardme.app/api/v1/onboardings/{key}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://anzapi.onboardme.app/api/v1/onboardings/{key}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"onboardingKey": "aabbccdd-1122-3344-5566-77889900aabb",
"onboardingID": 8934,
"statusID": 2,
"statusName": "In progress",
"createdOn": "2025-04-07T10:00:00Z",
"sentOn": "2025-04-08T07:45:00Z",
"updatedOn": "2025-04-10T06:30:00Z",
"engagementKey": "8f9e2b1c-3d4a-5e6f-7890-abcdef012345",
"formKey": "99999999-8888-7777-6666-555555555555",
"entities": [
{
"entityKey": "2c4f6a88-1b3d-5e7f-90ab-cdef12345678",
"entityOnboardingID": 501,
"entityTypeName": "Company",
"completed": false,
"requireDocs": true,
"mustVerify": true,
"name": "Riverstone Holdings Ltd",
"email": "[email protected]",
"requiredDocs": [],
"verification": {
"requestedMethod": "ComplyCube",
"isVerified": true,
"verifiedDate": "2025-04-09T12:00:00Z",
"verificationMethod": "ComplyCube",
"verificationStatus": "complete",
"documentCheckId": "chk_doc_abc123",
"identityCheckId": "chk_id_xyz789",
"amlCheckId": "chk_aml_def456"
}
}
],
"recipients": []
}{
"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.
Path Parameters
Onboarding job key (identifier).
Response
OK
Show child attributes
Show child attributes
Show child attributes
Show child attributes