cURL
curl --request GET --fail-with-body --max-time 30 \
"${AMLOK_API_BASE_URL}/v1/relationships?limit=100&cursor=cur_example&subject_id=biz_example&connection_id=cnn_example&fields=id%2Cobject%2Cupdated_at&include=provenance" \
--header "Authorization: Bearer ${AMLOK_API_KEY}" \
--header "Accept: application/json"import os
import requests
base_url = os.environ["AMLOK_API_BASE_URL"].rstrip("/")
headers = {'Accept': 'application/json'}
headers["Authorization"] = "Bearer " + os.environ["AMLOK_API_KEY"]
response = requests.request(
"GET", base_url + "/v1/relationships?limit=100&cursor=cur_example&subject_id=biz_example&connection_id=cnn_example&fields=id%2Cobject%2Cupdated_at&include=provenance",
headers=headers, timeout=30, allow_redirects=False,
)
response.raise_for_status()
print(response.json())
const baseUrl = process.env.AMLOK_API_BASE_URL;
const apiKey = process.env.AMLOK_API_KEY;
if (!baseUrl || !apiKey) throw new Error("Configure AMLOK_API_BASE_URL and AMLOK_API_KEY");
const headers = {
"Accept": "application/json"
};
headers.Authorization = `Bearer ${apiKey}`;
const response = await fetch(baseUrl.replace(/\/$/, "") + "/v1/relationships?limit=100&cursor=cur_example&subject_id=biz_example&connection_id=cnn_example&fields=id%2Cobject%2Cupdated_at&include=provenance", {
method: "GET", headers,
redirect: "error", signal: AbortSignal.timeout(30000),
});
if (!response.ok) throw new Error(`AMLOK returned HTTP ${response.status}`);
console.log(await response.json());{
"data": [
{
"id": "relationship_example",
"object": "relationship",
"subject_id": "biz_example",
"created_at": "2026-10-23T14:00:00Z",
"updated_at": "2026-10-23T14:00:00Z",
"record_version": 1,
"source_refs": [],
"data_status": "partial",
"missing_fields": [],
"schema_version": "1.4.2",
"client_reference": "app-1029",
"from_entity_id": "per_owner",
"to_entity_id": "biz_borrower",
"relationship_type": "beneficial_owner",
"ownership_ratio": "0.25",
"ownership_band_min": "0.25",
"ownership_band_max": "0.50",
"voting_ratio": "0.30",
"is_ultimate_owner": true,
"control_description": "Appointment rights",
"valid_from": "2020-01-01",
"valid_to": null,
"evidence_document_ids": [],
"confidence": null,
"review_status": "not_reviewed"
}
],
"page": {
"next_cursor": null,
"has_more": false,
"limit": 100
},
"meta": {
"request_id": "req_example",
"schema_version": "1.4.2",
"generated_at": "2026-10-23T14:00:00Z",
"data_status": "partial"
}
}Identity
List relationships
List authorized relationship records.
Required scope: identity:read. Source, module, country, consent and contracted permissions determine population.
GET
/
v1
/
relationships
cURL
curl --request GET --fail-with-body --max-time 30 \
"${AMLOK_API_BASE_URL}/v1/relationships?limit=100&cursor=cur_example&subject_id=biz_example&connection_id=cnn_example&fields=id%2Cobject%2Cupdated_at&include=provenance" \
--header "Authorization: Bearer ${AMLOK_API_KEY}" \
--header "Accept: application/json"import os
import requests
base_url = os.environ["AMLOK_API_BASE_URL"].rstrip("/")
headers = {'Accept': 'application/json'}
headers["Authorization"] = "Bearer " + os.environ["AMLOK_API_KEY"]
response = requests.request(
"GET", base_url + "/v1/relationships?limit=100&cursor=cur_example&subject_id=biz_example&connection_id=cnn_example&fields=id%2Cobject%2Cupdated_at&include=provenance",
headers=headers, timeout=30, allow_redirects=False,
)
response.raise_for_status()
print(response.json())
const baseUrl = process.env.AMLOK_API_BASE_URL;
const apiKey = process.env.AMLOK_API_KEY;
if (!baseUrl || !apiKey) throw new Error("Configure AMLOK_API_BASE_URL and AMLOK_API_KEY");
const headers = {
"Accept": "application/json"
};
headers.Authorization = `Bearer ${apiKey}`;
const response = await fetch(baseUrl.replace(/\/$/, "") + "/v1/relationships?limit=100&cursor=cur_example&subject_id=biz_example&connection_id=cnn_example&fields=id%2Cobject%2Cupdated_at&include=provenance", {
method: "GET", headers,
redirect: "error", signal: AbortSignal.timeout(30000),
});
if (!response.ok) throw new Error(`AMLOK returned HTTP ${response.status}`);
console.log(await response.json());{
"data": [
{
"id": "relationship_example",
"object": "relationship",
"subject_id": "biz_example",
"created_at": "2026-10-23T14:00:00Z",
"updated_at": "2026-10-23T14:00:00Z",
"record_version": 1,
"source_refs": [],
"data_status": "partial",
"missing_fields": [],
"schema_version": "1.4.2",
"client_reference": "app-1029",
"from_entity_id": "per_owner",
"to_entity_id": "biz_borrower",
"relationship_type": "beneficial_owner",
"ownership_ratio": "0.25",
"ownership_band_min": "0.25",
"ownership_band_max": "0.50",
"voting_ratio": "0.30",
"is_ultimate_owner": true,
"control_description": "Appointment rights",
"valid_from": "2020-01-01",
"valid_to": null,
"evidence_document_ids": [],
"confidence": null,
"review_status": "not_reviewed"
}
],
"page": {
"next_cursor": null,
"has_more": false,
"limit": 100
},
"meta": {
"request_id": "req_example",
"schema_version": "1.4.2",
"generated_at": "2026-10-23T14:00:00Z",
"data_status": "partial"
}
}Required scope:
identity:read
List authorized relationship records.
Required scope: identity:read. Source, module, country, consent and contracted permissions determine population.
Product scope · Processing lifecycle · ErrorsAuthorizations
Server-to-server API key bound to exactly one workspace, institution tenant and environment. No caller-supplied workspace override is accepted. Do not use in public browser code.
Headers
Optional caller correlation ID; the response includes AMLOK request_id.
Query Parameters
Page size. Default 100, maximum 200.
Required range:
1 <= x <= 200Opaque AMLOK cursor. Preserve the original filters.
Filter to one authorized business or person where applicable.
Inclusive normalized update time.
Exclusive normalized update time.
Filter one authorized source connection.
Comma-separated top-level field names. Required identity and metadata always remain. Selected objects are complete; nested paths and wildcards are unsupported. Unknown fields return 400 validation_error.
Comma-separated optional expansions: provenance, missing_fields. No unrestricted graph traversal.
Optional synchronization-checkpoint ID. Freezes this collection at the checkpoint boundary; cursor binds the snapshot. Unsupported or expired snapshots return 410.