> ## Documentation Index > Fetch the complete documentation index at: https://docs.amlok.io/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve lien > Retrieve one lien with provenance. Required scope: `liens:read`. Tenant and field entitlements enforced; unknown or invisible ID returns 404. **Required scope:** `liens:read` Retrieve one lien with provenance. Required scope: `liens:read`. Tenant and field entitlements enforced; unknown or invisible ID returns 404. [Product scope](https://docs.amlok.io/api-reference/products-and-endpoints.md) · [Processing lifecycle](https://docs.amlok.io/api-reference/processing-lifecycle.md) · [Errors](https://docs.amlok.io/api-reference/errors.md) ## OpenAPI ````yaml openapi/amlok-v1.json GET /v1/liens/{id} openapi: 3.1.0 info: title: AMLOK API version: 1.4.2 description: >- API reference for AMLOK 1.4.2, with example requests and responses. Configure your institution-issued environment URL before making requests. x-source-workbook: >- https://docs.google.com/spreadsheets/d/14pU2PLv9JDda8gAa1367hipa2oJQB260fIJthevrp10/edit servers: - url: https://api.example.com description: Set the server URL to your institution-issued AMLOK environment URL. security: - BearerAuth: [] tags: - name: Platform description: Platform operations. - name: Identity description: Identity operations. - name: Banking description: Banking operations. - name: Payments description: Payments operations. - name: Commerce description: Commerce operations. - name: Accounting description: Accounting operations. - name: Inventory description: Inventory operations. - name: Lending description: Lending operations. - name: Liens description: Liens operations. - name: Risk description: Risk operations. - name: Operations description: Operations operations. - name: Webhooks description: Webhooks operations. - name: Reporting description: Reporting operations. paths: /v1/liens/{id}: get: tags: - Liens summary: Retrieve lien description: >- Retrieve one lien with provenance. Required scope: `liens:read`. Tenant and field entitlements enforced; unknown or invisible ID returns 404. operationId: EP108 parameters: - name: X-Request-ID in: header required: false description: >- Optional caller correlation ID; the response includes AMLOK request_id. schema: type: string example: client-request-example - name: id in: path required: true description: Tenant-visible resource identifier. schema: type: string example: lien_example - name: fields in: query required: false description: >- 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. schema: type: string example: id,object,updated_at - name: include in: query required: false description: >- Comma-separated optional expansions: provenance, missing_fields. No unrestricted graph traversal. schema: type: string example: provenance - name: manifest_id in: query required: false description: >- Optional immutable input-manifest ID. Return the exact normalized resource version listed in that manifest, not the current version. Reject IDs absent from the manifest or another subject/workspace. schema: type: string responses: '200': description: Retrieve one lien with provenance. headers: X-Request-ID: description: AMLOK response correlation identifier. schema: type: string example: req_example content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/LienRead' meta: $ref: '#/components/schemas/ResponseMeta' required: - data - meta examples: synthetic: summary: Synthetic retrieve lien value: data: id: lien_example object: lien 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 search_id: lis_example filing_number: REG-1001 original_filing_number: REG-1001 lien_type: ucc jurisdiction: US-DE registry_name: Example Secretary of State status: active raw_status: ACTIVE filed_on: '2024-04-01' lapse_on: '2029-04-01' terminated_on: null debtors: [] secured_parties: [] collateral_description: Equipment described in attached schedule collateral_categories: - equipment is_blanket_lien: null registered_amount: amount: '1234.56' currency: CAD currency_basis: registry_reported document_ids: [] match_disposition: possible_match priority_assessment: null meta: request_id: req_example schema_version: 1.4.2 generated_at: '2026-10-23T14:00:00Z' data_status: partial projected: summary: Metadata-only response with fields=id value: data: id: lien_example object: lien 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 meta: request_id: req_example schema_version: 1.4.2 generated_at: '2026-10-23T14:00:00Z' data_status: partial '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '410': $ref: '#/components/responses/Error410' '429': $ref: '#/components/responses/Error429' '500': $ref: '#/components/responses/Error500' '502': $ref: '#/components/responses/Error502' '503': $ref: '#/components/responses/Error503' security: - BearerAuth: [] x-codeSamples: - lang: Shell label: cURL source: |- curl --request GET --fail-with-body --max-time 30 \ "${AMLOK_API_BASE_URL}/v1/liens/lien_example?fields=id%2Cobject%2Cupdated_at&include=provenance" \ --header "Authorization: Bearer ${AMLOK_API_KEY}" \ --header "Accept: application/json" - lang: Python source: |- 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/liens/lien_example?fields=id%2Cobject%2Cupdated_at&include=provenance", headers=headers, timeout=30, allow_redirects=False, ) response.raise_for_status() print(response.json()) - lang: JavaScript label: Node.js source: >- 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/liens/lien_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()); components: schemas: LienRead: type: object properties: id: type: string description: >- Stable identifier scoped to the client tenant. Never use a provider ID as the public primary key. x-field-id: F0001 x-classification: Confidential x-availability: Required when resource exists object: type: string const: lien subject_id: anyOf: - type: string - type: 'null' description: >- Business or person to which this record relates. Null for tenant-level configuration and unresolved subjects. x-field-id: F0003 x-classification: Confidential x-availability: >- Source, module, country, consent and contracted permissions determine population. created_at: type: string format: date-time description: >- Time AMLOK first stored this resource. Preserve original evidence; do not invent missing values. x-field-id: F0004 x-classification: Confidential x-availability: Required when resource exists updated_at: type: string format: date-time description: >- Time the normalized representation last changed. Preserve original evidence; do not invent missing values. x-field-id: F0005 x-classification: Confidential x-availability: Required when resource exists observed_at: anyOf: - type: string format: date-time - type: 'null' description: >- Time the source was observed by AMLOK. Do not imply this is the economic event time. x-field-id: F0006 x-classification: Confidential x-availability: >- Source, module, country, consent and contracted permissions determine population. effective_at: anyOf: - type: string format: date-time - type: 'null' description: >- Time the source states this version became valid. Preserve original evidence; do not invent missing values. x-field-id: F0007 x-classification: Confidential x-availability: >- Source, module, country, consent and contracted permissions determine population. record_version: type: integer description: >- Monotonically increasing AMLOK version for this resource. Preserve original evidence; do not invent missing values. x-field-id: F0008 x-classification: Confidential x-availability: Required when resource exists deleted_at: anyOf: - type: string format: date-time - type: 'null' description: >- Tombstone timestamp for a source or AMLOK deletion. Null for records not deleted; retain only under the configured policy. x-field-id: F0009 x-classification: Confidential x-availability: >- Source, module, country, consent and contracted permissions determine population. source_refs: type: array items: $ref: '#/components/schemas/SourceRef' description: >- Evidence references contributing to this record. A known empty array is valid for a newly client-created record. x-field-id: F0010 x-classification: Confidential x-availability: Required when resource exists field_provenance: anyOf: - type: array items: $ref: '#/components/schemas/FieldProvenance' - type: 'null' description: >- Field-level source, extraction, transformation and quality details. Preserve original evidence; do not invent missing values. x-field-id: F0011 x-classification: Confidential x-availability: >- Source, module, country, consent and contracted permissions determine population. data_status: $ref: '#/components/schemas/Enum_data_status' description: >- Whether the requested resource is complete for its stated scope. Completeness is relative to declared fields, sources and time interval. x-field-id: F0012 x-classification: Confidential x-availability: Required when resource exists missing_fields: type: array items: $ref: '#/components/schemas/MissingField' description: >- Unavailable field paths and their explicit reasons. Preserve original evidence; do not invent missing values. x-field-id: F0013 x-classification: Confidential x-availability: Required when resource exists schema_version: type: string description: >- Contract version used to serialize this record. Preserve original evidence; do not invent missing values. x-field-id: F0014 x-classification: Confidential x-availability: Required when resource exists client_reference: anyOf: - type: string - type: 'null' description: >- Optional caller-owned correlation identifier. Scoped to tenant; uniqueness only when explicitly contracted. x-field-id: F0015 x-classification: Confidential x-availability: >- Source, module, country, consent and contracted permissions determine population. extensions: anyOf: - type: object additionalProperties: true - type: 'null' description: >- Namespaced extra provider fields without changing the core schema. Access-controlled and documented per provider; no provider tokens. x-field-id: F0016 x-classification: Restricted x-availability: >- Source, module, country, consent and contracted permissions determine population. search_id: anyOf: - type: string - type: 'null' description: >- Search that returned this record. Preserve original evidence; do not invent missing values. x-field-id: F0825 x-classification: Confidential x-availability: >- Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage. filing_number: type: string description: >- Registry-assigned filing or registration number. Preserve original evidence; do not invent missing values. x-field-id: F0826 x-classification: Confidential x-availability: Required when resource exists original_filing_number: anyOf: - type: string - type: 'null' description: >- Initial registration in the filing chain. Preserve original evidence; do not invent missing values. x-field-id: F0827 x-classification: Confidential x-availability: >- Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage. lien_type: $ref: '#/components/schemas/Enum_lien_type' description: >- Legal registry category. Preserve original evidence; do not invent missing values. x-field-id: F0828 x-classification: Confidential x-availability: Required when resource exists jurisdiction: type: string description: >- Filing jurisdiction. Preserve original evidence; do not invent missing values. x-field-id: F0829 x-classification: Confidential x-availability: Required when resource exists registry_name: anyOf: - type: string - type: 'null' description: >- Registry of record. Preserve original evidence; do not invent missing values. x-field-id: F0830 x-classification: Confidential x-availability: >- Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage. status: $ref: '#/components/schemas/Enum_lien_status' description: >- Source-supported registration state. Status is not a legal determination of enforceability or priority. x-field-id: F0831 x-classification: Confidential x-availability: Required when resource exists raw_status: anyOf: - type: string - type: 'null' description: >- Unmodified registry or provider status. Preserve original evidence; do not invent missing values. x-field-id: F0832 x-classification: Confidential x-availability: >- Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage. filed_on: anyOf: - type: string format: date - type: 'null' description: >- Filing or registration date. Preserve original evidence; do not invent missing values. x-field-id: F0833 x-classification: Confidential x-availability: >- Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage. lapse_on: anyOf: - type: string format: date - type: 'null' description: >- Reported lapse date, if known. Preserve original evidence; do not invent missing values. x-field-id: F0834 x-classification: Confidential x-availability: >- Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage. terminated_on: anyOf: - type: string format: date - type: 'null' description: >- Reported termination or discharge date. Preserve original evidence; do not invent missing values. x-field-id: F0835 x-classification: Confidential x-availability: >- Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage. debtors: anyOf: - type: array items: $ref: '#/components/schemas/LienParty' - type: 'null' description: >- Debtors exactly as recorded, including unresolved parties. Preserve original evidence; do not invent missing values. x-field-id: F0836 x-classification: Restricted x-availability: >- Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage. secured_parties: anyOf: - type: array items: $ref: '#/components/schemas/LienParty' - type: 'null' description: >- Secured parties exactly as recorded. Preserve original evidence; do not invent missing values. x-field-id: F0837 x-classification: Confidential x-availability: >- Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage. collateral_description: anyOf: - type: string - type: 'null' description: >- Registry's collateral text when available. Preserve original evidence; do not invent missing values. x-field-id: F0838 x-classification: Confidential x-availability: >- Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage. collateral_categories: anyOf: - type: array items: type: string - type: 'null' description: >- Source or reviewed collateral classification. Preserve original evidence; do not invent missing values. x-field-id: F0839 x-classification: Confidential x-availability: >- Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage. is_blanket_lien: anyOf: - type: boolean - type: 'null' description: >- Whether evidence supports an all-assets description. Null if collateral text is unavailable or ambiguous. x-field-id: F0840 x-classification: Confidential x-availability: >- Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage. registered_amount: type: object properties: amount: anyOf: - type: string pattern: ^-?(?:0|[1-9][0-9]*)(?:\.[0-9]+)?$ description: >- Exact decimal string in major units. Do not use binary floating-point arithmetic. - type: 'null' description: >- Amount explicitly recorded by the registry, where applicable. Amount in major currency units. A UCC filing often has no debt amount; never treat missing amount as zero. x-field-id: F0841 x-classification: Confidential x-availability: >- Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage. currency: anyOf: - type: string - type: 'null' description: >- Currency for registered amount. Uppercase ISO 4217 code when known; null for unsupported/unidentified currency, retain source code. x-field-id: F0842 x-classification: Confidential x-availability: >- Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage. currency_basis: anyOf: - type: string - type: 'null' description: >- Meaning of registered amount and currency as stated by source. Preserve original evidence; do not invent missing values. x-field-id: F0843 x-classification: Confidential x-availability: >- Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage. document_ids: anyOf: - type: array items: type: string - type: 'null' description: >- Images or reports supporting the filing. Preserve original evidence; do not invent missing values. x-field-id: F0844 x-classification: Confidential x-availability: >- Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage. match_disposition: anyOf: - $ref: '#/components/schemas/Enum_match_disposition' - type: 'null' description: >- Debtor identity review result. Preserve original evidence; do not invent missing values. x-field-id: F0845 x-classification: Confidential x-availability: >- Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage. priority_assessment: anyOf: - type: string - type: 'null' description: >- Separately reviewed priority conclusion, if commissioned. Never infer legal priority from filing date alone. x-field-id: F0846 x-classification: Restricted x-availability: >- Registry and provider dependent; no guaranteed balance, collateral detail, priority or certified coverage. required: - id - object - created_at - updated_at - record_version - source_refs - data_status - missing_fields - schema_version title: LienRead description: >- A security registration or other lien record from a stated registry. Population depends on source and tenant entitlement. Read representation: fields selects top-level domain fields. Required metadata is always returned. Selected nested objects retain their complete schema. Without fields, return the full authorized representation. ResponseMeta: type: object properties: request_id: type: string description: AMLOK request correlation ID. schema_version: type: string description: Serialization contract version. generated_at: type: string format: date-time description: Response generation time, not source data freshness. data_status: $ref: '#/components/schemas/Enum_data_status' description: Completeness of this response within its declared scope. coverage: anyOf: - $ref: '#/components/schemas/Coverage' - type: 'null' description: Requested and achieved source/time coverage. required: - request_id - schema_version - generated_at - data_status SourceRef: type: object properties: provider_id: type: string description: >- Inventory or supplemental provider identifier; AMLOK or CLIENT for internal evidence. connection_id: anyOf: - type: string - type: 'null' description: Authorized provider connection. source_record_id: anyOf: - type: string - type: 'null' description: >- Upstream record identifier scoped by provider, connection and record type. source_record_type: anyOf: - type: string - type: 'null' description: Provider object or report type. source_updated_at: anyOf: - type: string format: date-time - type: 'null' description: Source update time; do not replace with retrieval time. retrieved_at: type: string format: date-time description: Time AMLOK retrieved this evidence. document_id: anyOf: - type: string - type: 'null' description: Evidence document when applicable. source_api_version: anyOf: - type: string - type: 'null' description: Version of provider API/schema used. required: - provider_id - retrieved_at FieldProvenance: type: object properties: field_path: type: string description: Relative path in the normalized resource. source_ref_index: type: integer description: Zero-based index into source_refs. source_field_path: anyOf: - type: string - type: 'null' description: Actual field path or document locator. transformation_id: anyOf: - type: string - type: 'null' description: Versioned conversion/mapping rule. evidence_level: $ref: '#/components/schemas/Enum_evidence_level' description: Provenance class for the resulting value. confidence: anyOf: - type: string pattern: ^-?(?:0|[1-9][0-9]*)(?:\.[0-9]+)?$ description: >- Exact decimal string in major units. Do not use binary floating-point arithmetic. - type: 'null' description: Calibrated extraction or matching confidence, if available. source_timezone: anyOf: - type: string - type: 'null' description: Original timezone where needed to interpret local time. required: - field_path - source_ref_index - evidence_level Enum_data_status: type: string enum: - complete - partial - unavailable - pending MissingField: type: object properties: field_path: type: string description: Unavailable relative field path. reason: $ref: '#/components/schemas/Enum_null_reason' description: Specific reason the field has no value. detail: anyOf: - type: string - type: 'null' description: Sanitized explanation useful to the caller. required: - field_path - reason Enum_lien_type: type: string enum: - ucc - ppsa - rdprm - tax - judgment - other - unknown Enum_lien_status: type: string enum: - active - lapsed - terminated - discharged - unknown LienParty: type: object properties: role: type: string description: Recorded debtor, secured party, assignee or other role. name: type: string description: Party name exactly as recorded. entity_id: anyOf: - type: string - type: 'null' description: Resolved AMLOK party only when established. address: anyOf: - $ref: '#/components/schemas/Address' - type: 'null' description: Address in registry evidence. source_party_id: anyOf: - type: string - type: 'null' description: Source identifier if provided. required: - role - name Enum_match_disposition: type: string enum: - unreviewed - false_positive - possible_match - confirmed_match Coverage: type: object properties: requested_from: anyOf: - type: string format: date - type: 'null' description: Inclusive start requested. requested_to: anyOf: - type: string format: date - type: 'null' description: Exclusive end requested. available_from: anyOf: - type: string format: date - type: 'null' description: Earliest actual coverage. available_to: anyOf: - type: string format: date - type: 'null' description: Exclusive end of actual coverage. source_ids: type: array items: type: string description: Sources actually contributing. missing_intervals: type: array items: $ref: '#/components/schemas/Interval' description: Known gaps within requested scope. jurisdictions_completed: anyOf: - type: array items: type: string - type: 'null' description: Completed geographic search scope when applicable. required: - source_ids - missing_intervals ErrorEnvelope: type: object properties: error: $ref: '#/components/schemas/Error' meta: $ref: '#/components/schemas/ResponseMeta' required: - error - meta Enum_evidence_level: type: string enum: - source_record - document_extracted - client_asserted - derived - model_inferred Enum_null_reason: type: string enum: - not_provided - not_supported - not_authorized - not_applicable - pending - redacted - source_error - invalid - insufficient_history Address: type: object properties: line1: anyOf: - type: string - type: 'null' description: Street or delivery address line one. line2: anyOf: - type: string - type: 'null' description: Suite, unit or second address line. city: anyOf: - type: string - type: 'null' description: Locality. region: anyOf: - type: string - type: 'null' description: Subdivision or province code/name; preserve raw when unmapped. postal_code: anyOf: - type: string - type: 'null' description: Postal code as a string with leading zeroes preserved. country: anyOf: - type: string - type: 'null' description: ISO 3166-1 alpha-2 country when established. raw_address: anyOf: - type: string - type: 'null' description: Unparsed source address if structured fields are unavailable. Interval: type: object properties: from: type: string format: date description: Inclusive interval start. to: type: string format: date description: Exclusive interval end. required: - from - to Error: type: object properties: code: type: string description: Stable machine-readable error code. message: type: string description: Safe caller-facing explanation. field: anyOf: - type: string - type: 'null' description: Invalid request field when relevant. retryable: type: boolean description: Whether retry may succeed without changing the request. request_id: type: string description: Correlation identifier for support. required: - code - message - retryable - request_id responses: Error400: description: Request failed. Inspect error.code and error.retryable. headers: X-Request-ID: description: AMLOK response correlation identifier. schema: type: string example: req_example content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: invalid_request: summary: invalid_request value: error: code: invalid_request message: Malformed input, unknown parameter or incompatible filters. retryable: false request_id: req_example meta: request_id: req_example schema_version: 1.4.2 generated_at: '2026-10-23T14:00:00Z' data_status: complete unsupported_parameter: summary: unsupported_parameter value: error: code: unsupported_parameter message: Historical query or filter not implemented on this resource. retryable: false request_id: req_example meta: request_id: req_example schema_version: 1.4.2 generated_at: '2026-10-23T14:00:00Z' data_status: complete validation_error: summary: validation_error value: error: code: validation_error message: >- A field, projection, or request value is invalid. Inspect error.field. retryable: false request_id: req_example meta: request_id: req_example schema_version: 1.4.2 generated_at: '2026-10-23T14:00:00Z' data_status: complete Error401: description: Request failed. Inspect error.code and error.retryable. headers: X-Request-ID: description: AMLOK response correlation identifier. schema: type: string example: req_example content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: unauthenticated: summary: unauthenticated value: error: code: unauthenticated message: Missing, expired or invalid credential. retryable: false request_id: req_example meta: request_id: req_example schema_version: 1.4.2 generated_at: '2026-10-23T14:00:00Z' data_status: complete Error403: description: Request failed. Inspect error.code and error.retryable. headers: X-Request-ID: description: AMLOK response correlation identifier. schema: type: string example: req_example content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: forbidden: summary: forbidden value: error: code: forbidden message: Tenant scope or field/product entitlement missing. retryable: false request_id: req_example meta: request_id: req_example schema_version: 1.4.2 generated_at: '2026-10-23T14:00:00Z' data_status: complete Error404: description: Request failed. Inspect error.code and error.retryable. headers: X-Request-ID: description: AMLOK response correlation identifier. schema: type: string example: req_example content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: not_found: summary: not_found value: error: code: not_found message: Record does not exist or is not visible in this tenant. retryable: false request_id: req_example meta: request_id: req_example schema_version: 1.4.2 generated_at: '2026-10-23T14:00:00Z' data_status: complete Error410: description: Request failed. Inspect error.code and error.retryable. headers: X-Request-ID: description: AMLOK response correlation identifier. schema: type: string example: req_example content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: cursor_expired: summary: cursor_expired value: error: code: cursor_expired message: >- The synchronization cursor has expired. Begin a new synchronization checkpoint and rebuild the collection snapshot. retryable: false request_id: req_example meta: request_id: req_example schema_version: 1.4.2 generated_at: '2026-10-23T14:00:00Z' data_status: complete Error429: description: Request failed. Inspect error.code and error.retryable. headers: X-Request-ID: description: AMLOK response correlation identifier. schema: type: string example: req_example Retry-After: description: >- Delay in seconds or an HTTP-date. The example is illustrative, not a contractual quota. schema: type: string example: '30' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: rate_limited: summary: rate_limited value: error: code: rate_limited message: AMLOK tenant quota or upstream throttle. retryable: true request_id: req_example meta: request_id: req_example schema_version: 1.4.2 generated_at: '2026-10-23T14:00:00Z' data_status: complete Error500: description: Request failed. Inspect error.code and error.retryable. headers: X-Request-ID: description: AMLOK response correlation identifier. schema: type: string example: req_example content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: internal_error: summary: internal_error value: error: code: internal_error message: Unexpected AMLOK processing error. retryable: false request_id: req_example meta: request_id: req_example schema_version: 1.4.2 generated_at: '2026-10-23T14:00:00Z' data_status: complete Error502: description: Request failed. Inspect error.code and error.retryable. headers: X-Request-ID: description: AMLOK response correlation identifier. schema: type: string example: req_example content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: source_error: summary: source_error value: error: code: source_error message: Upstream returned invalid or failed data. retryable: false request_id: req_example meta: request_id: req_example schema_version: 1.4.2 generated_at: '2026-10-23T14:00:00Z' data_status: complete Error503: description: Request failed. Inspect error.code and error.retryable. headers: X-Request-ID: description: AMLOK response correlation identifier. schema: type: string example: req_example content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' examples: source_unavailable: summary: source_unavailable value: error: code: source_unavailable message: Required source temporarily unavailable. retryable: true request_id: req_example meta: request_id: req_example schema_version: 1.4.2 generated_at: '2026-10-23T14:00:00Z' data_status: complete securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: API key description: >- 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.