cURL

curl --request POST --fail-with-body --max-time 30 \
  "${AMLOK_API_BASE_URL}/v1/consents" \
  --header "Authorization: Bearer ${AMLOK_API_KEY}" \
  --header "Accept: application/json" \
  --header 'Idempotency-Key: idem_example_1001' \
  --header 'Content-Type: application/json' \
  --data '{
  "subject_id": "biz_example",
  "subject_type": "business",
  "purposes": [
    "credit_assessment"
  ],
  "scopes": [
    "banking:read"
  ],
  "policy_version": "consent-v1",
  "evidence_document_id": "doc_consent"
}'

import os
import requests

base_url = os.environ["AMLOK_API_BASE_URL"].rstrip("/")
headers = {'Accept': 'application/json',
 'Idempotency-Key': 'idem_example_1001',
 'Content-Type': 'application/json'}
headers["Authorization"] = "Bearer " + os.environ["AMLOK_API_KEY"]

response = requests.request(
    "POST", base_url + "/v1/consents",
    headers=headers, timeout=30, allow_redirects=False,
    json={'subject_id': 'biz_example',
 'subject_type': 'business',
 'purposes': ['credit_assessment'],
 'scopes': ['banking:read'],
 'policy_version': 'consent-v1',
 'evidence_document_id': 'doc_consent'},
)
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",
  "Idempotency-Key": "idem_example_1001",
  "Content-Type": "application/json"
};
headers.Authorization = `Bearer ${apiKey}`;
const response = await fetch(baseUrl.replace(/\/$/, "") + "/v1/consents", {
  method: "POST", headers,
  redirect: "error", signal: AbortSignal.timeout(30000),
  body: JSON.stringify({
  "subject_id": "biz_example",
  "subject_type": "business",
  "purposes": [
    "credit_assessment"
  ],
  "scopes": [
    "banking:read"
  ],
  "policy_version": "consent-v1",
  "evidence_document_id": "doc_consent"
}),
});
if (!response.ok) throw new Error(`AMLOK returned HTTP ${response.status}`);
console.log(await response.json());

{
  "data": {
    "id": "con_example",
    "object": "consent",
    "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",
    "subject_type": "business",
    "status": "granted",
    "purposes": [
      "credit_assessment"
    ],
    "scopes": [
      "banking:read"
    ],
    "granted_at": null,
    "expires_at": null,
    "revoked_at": null,
    "policy_version": "consent-v1",
    "evidence_document_id": "doc_consent",
    "authorized_by": "per_authorizer"
  },
  "meta": {
    "request_id": "req_example",
    "schema_version": "1.4.2",
    "generated_at": "2026-10-23T14:00:00Z",
    "data_status": "partial"
  }
}

Platform

Create consent

Record authorization and evidence.

Required scope: consent:write. Caller must have authority; recording consent does not manufacture user authorization. Once account cancellation is submitted, processing and usage deductions stop immediately. Reject new operational commands with 409 invalid_state; pending work is cancelled without another debit. Read-only reporting remains available until workspace deletion. Accepted commands have a durable request receipt. Full response replay lasts 24 hours; afterward the same key and target return 409 idempotency_result_expired without re-execution. Different payloads return 409 idempotency_conflict. Use GET /v1/request-receipts/lookup to find the original resource. The fingerprint includes the resolved target path and intended payload; a key used on another target is rejected rather than replayed onto it. Pre-execution validation or insufficient-credit rejection creates no accepted receipt.

POST

consents

cURL

curl --request POST --fail-with-body --max-time 30 \
  "${AMLOK_API_BASE_URL}/v1/consents" \
  --header "Authorization: Bearer ${AMLOK_API_KEY}" \
  --header "Accept: application/json" \
  --header 'Idempotency-Key: idem_example_1001' \
  --header 'Content-Type: application/json' \
  --data '{
  "subject_id": "biz_example",
  "subject_type": "business",
  "purposes": [
    "credit_assessment"
  ],
  "scopes": [
    "banking:read"
  ],
  "policy_version": "consent-v1",
  "evidence_document_id": "doc_consent"
}'

import os
import requests

base_url = os.environ["AMLOK_API_BASE_URL"].rstrip("/")
headers = {'Accept': 'application/json',
 'Idempotency-Key': 'idem_example_1001',
 'Content-Type': 'application/json'}
headers["Authorization"] = "Bearer " + os.environ["AMLOK_API_KEY"]

response = requests.request(
    "POST", base_url + "/v1/consents",
    headers=headers, timeout=30, allow_redirects=False,
    json={'subject_id': 'biz_example',
 'subject_type': 'business',
 'purposes': ['credit_assessment'],
 'scopes': ['banking:read'],
 'policy_version': 'consent-v1',
 'evidence_document_id': 'doc_consent'},
)
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",
  "Idempotency-Key": "idem_example_1001",
  "Content-Type": "application/json"
};
headers.Authorization = `Bearer ${apiKey}`;
const response = await fetch(baseUrl.replace(/\/$/, "") + "/v1/consents", {
  method: "POST", headers,
  redirect: "error", signal: AbortSignal.timeout(30000),
  body: JSON.stringify({
  "subject_id": "biz_example",
  "subject_type": "business",
  "purposes": [
    "credit_assessment"
  ],
  "scopes": [
    "banking:read"
  ],
  "policy_version": "consent-v1",
  "evidence_document_id": "doc_consent"
}),
});
if (!response.ok) throw new Error(`AMLOK returned HTTP ${response.status}`);
console.log(await response.json());

{
  "data": {
    "id": "con_example",
    "object": "consent",
    "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",
    "subject_type": "business",
    "status": "granted",
    "purposes": [
      "credit_assessment"
    ],
    "scopes": [
      "banking:read"
    ],
    "granted_at": null,
    "expires_at": null,
    "revoked_at": null,
    "policy_version": "consent-v1",
    "evidence_document_id": "doc_consent",
    "authorized_by": "per_authorizer"
  },
  "meta": {
    "request_id": "req_example",
    "schema_version": "1.4.2",
    "generated_at": "2026-10-23T14:00:00Z",
    "data_status": "partial"
  }
}

Required scope: consent:write Record authorization and evidence. Required scope: consent:write. Caller must have authority; recording consent does not manufacture user authorization. Once account cancellation is submitted, processing and usage deductions stop immediately. Reject new operational commands with 409 invalid_state; pending work is cancelled without another debit. Read-only reporting remains available until workspace deletion. Accepted commands have a durable request receipt. Full response replay lasts 24 hours; afterward the same key and target return 409 idempotency_result_expired without re-execution. Different payloads return 409 idempotency_conflict. Use GET /v1/request-receipts/lookup to find the original resource. The fingerprint includes the resolved target path and intended payload; a key used on another target is rejected rather than replayed onto it. Pre-execution validation or insufficient-credit rejection creates no accepted receipt. Product scope · Processing lifecycle · Errors

Authorizations

Authorization

string

header

required

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

X-Request-ID

string

Optional caller correlation ID; the response includes AMLOK request_id.

Idempotency-Key

string

required

Reuse for retries of the same intended command and identical payload. Retention: 24 hours.

Body

application/json

subject_id

string

required

Subject granting or represented by authorization.

Minimum string length: 1

subject_type

enum<string>

required

Business or person.

Available options:

business,

person

purposes

string[]

required

Permitted documented purposes.

Minimum array length: 1

scopes

string[]

required

Data/action permissions.

Minimum array length: 1

policy_version

string

required

Text or authority version captured.

Minimum string length: 1

evidence_document_id

string

required

Evidence of real authorization.

Minimum string length: 1

Response

Record authorization and evidence.

data

consent · object

required

Authorization and permitted use linked to a subject and client. Population depends on source and tenant entitlement.

Show child attributes

Get started

Endpoints

Essentials

Create consent

Authorizations

Headers

Body

Response