cURL

curl --request GET --fail-with-body --max-time 30 \
  "${AMLOK_API_BASE_URL}/v1/configuration" \
  --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/configuration",
    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/configuration", {
  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": "config_example",
    "object": "environment_configuration",
    "workspace_id": "wsp_example",
    "environment": "sandbox",
    "revision": "cfg_example",
    "effective_at": "2026-10-23T14:00:00Z",
    "workflow_versions": [
      {
        "id": "underwrite-v1",
        "workflow_type": "underwrite",
        "products": [
          "insights"
        ],
        "verification_types": []
      },
      {
        "id": "kyc-ca-v1",
        "workflow_type": "verify",
        "products": [
          "insights",
          "signal"
        ],
        "verification_types": [
          "kyc"
        ]
      },
      {
        "id": "kyb-ca-v1",
        "workflow_type": "verify",
        "products": [
          "insights",
          "signal"
        ],
        "verification_types": [
          "kyb"
        ]
      }
    ],
    "rulesets": [
      {
        "id": "monitoring-v1",
        "attribute_keys": [
          "cash_flow.net_monthly"
        ],
        "resource_types": [
          "bank_transaction"
        ]
      }
    ],
    "cadences": [
      {
        "id": "daily",
        "description": "Daily AMLOK evaluation subject to actual provider freshness and permission."
      }
    ],
    "limits": {
      "requests_per_minute": 120,
      "burst_requests": 20,
      "concurrent_jobs": 5,
      "upload_bytes": 10485760,
      "document_pages": 100,
      "mime_types": [
        "application/pdf"
      ]
    },
    "webhooks": {
      "event_retention_seconds": 2592000,
      "delivery_timeout_seconds": 10,
      "rotation_overlap_seconds": 86400,
      "retained_from": "2026-09-23T14:00:00Z"
    },
    "idempotency_replay_seconds": 86400
  },
  "meta": {
    "request_id": "req_example",
    "schema_version": "1.4.2",
    "generated_at": "2026-10-23T14:00:00Z",
    "data_status": "complete"
  }
}

Platform

Retrieve environment configuration

Read accepted identifiers and actual operational limits for the key-bound workspace and environment. Numbers in saved examples are synthetic, not production defaults or SLA promises. Use workflow_versions[].id as workflow_version, rulesets[].id as ruleset_version and cadences[].id as cadence. Resource and attribute selection must be allowed by that ruleset. GET /v1/providers supplies enabled product IDs and resource mappings. Rates and workload limits remain in read-only billing rate cards and workload reports. Cache by revision and refresh on configuration-related 422 errors or before adopting a new workflow. Changes to configured limits or identifiers are communicated through the account manager before taking effect under the agreement; in-flight work retains its accepted workflow revision.

GET

configuration

cURL

curl --request GET --fail-with-body --max-time 30 \
  "${AMLOK_API_BASE_URL}/v1/configuration" \
  --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/configuration",
    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/configuration", {
  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": "config_example",
    "object": "environment_configuration",
    "workspace_id": "wsp_example",
    "environment": "sandbox",
    "revision": "cfg_example",
    "effective_at": "2026-10-23T14:00:00Z",
    "workflow_versions": [
      {
        "id": "underwrite-v1",
        "workflow_type": "underwrite",
        "products": [
          "insights"
        ],
        "verification_types": []
      },
      {
        "id": "kyc-ca-v1",
        "workflow_type": "verify",
        "products": [
          "insights",
          "signal"
        ],
        "verification_types": [
          "kyc"
        ]
      },
      {
        "id": "kyb-ca-v1",
        "workflow_type": "verify",
        "products": [
          "insights",
          "signal"
        ],
        "verification_types": [
          "kyb"
        ]
      }
    ],
    "rulesets": [
      {
        "id": "monitoring-v1",
        "attribute_keys": [
          "cash_flow.net_monthly"
        ],
        "resource_types": [
          "bank_transaction"
        ]
      }
    ],
    "cadences": [
      {
        "id": "daily",
        "description": "Daily AMLOK evaluation subject to actual provider freshness and permission."
      }
    ],
    "limits": {
      "requests_per_minute": 120,
      "burst_requests": 20,
      "concurrent_jobs": 5,
      "upload_bytes": 10485760,
      "document_pages": 100,
      "mime_types": [
        "application/pdf"
      ]
    },
    "webhooks": {
      "event_retention_seconds": 2592000,
      "delivery_timeout_seconds": 10,
      "rotation_overlap_seconds": 86400,
      "retained_from": "2026-09-23T14:00:00Z"
    },
    "idempotency_replay_seconds": 86400
  },
  "meta": {
    "request_id": "req_example",
    "schema_version": "1.4.2",
    "generated_at": "2026-10-23T14:00:00Z",
    "data_status": "complete"
  }
}

Required scope: platform:read Read accepted identifiers and actual operational limits for the key-bound workspace and environment. Numbers in saved examples are synthetic, not production defaults or SLA promises. Use workflow_versions[].id as workflow_version, rulesets[].id as ruleset_version and cadences[].id as cadence. Resource and attribute selection must be allowed by that ruleset. GET /v1/providers supplies enabled product IDs and resource mappings. Rates and workload limits remain in read-only billing rate cards and workload reports. Cache by revision and refresh on configuration-related 422 errors or before adopting a new workflow. Changes to configured limits or identifiers are communicated through the account manager before taking effect under the agreement; in-flight work retains its accepted workflow revision. 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.

Response

Authorized response.

data

object

required

Show child attributes

Get started

Endpoints

Essentials

Retrieve environment configuration

Authorizations

Response