> ## 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. # List lien searches > List authorized lien search records. Required scope: `liens:read`. US UCC and Canadian provincial PPSA/RDPRM are separate products. Contract, jurisdiction, search type and redistribution rights must be established. **Required scope:** `liens:read` List authorized lien search records. Required scope: `liens:read`. US UCC and Canadian provincial PPSA/RDPRM are separate products. Contract, jurisdiction, search type and redistribution rights must be established. [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/lien-searches 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/lien-searches: get: tags: - Liens summary: List lien searches description: >- List authorized lien search records. Required scope: `liens:read`. US UCC and Canadian provincial PPSA/RDPRM are separate products. Contract, jurisdiction, search type and redistribution rights must be established. operationId: EP105 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: limit in: query required: false description: Page size. Default 100, maximum 200. schema: type: integer minimum: 1 maximum: 200 default: 100 example: 100 - name: cursor in: query required: false description: Opaque AMLOK cursor. Preserve the original filters. schema: type: string example: cur_example - name: subject_id in: query required: false description: Filter to one authorized business or person where applicable. schema: type: string example: biz_example - name: updated_from in: query required: false description: Inclusive normalized update time. schema: type: string format: date-time - name: updated_to in: query required: false description: Exclusive normalized update time. schema: type: string format: date-time - name: status in: query required: false description: Filter by this resource status. schema: $ref: '#/components/schemas/Enum_search_status' - 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: snapshot_id in: query required: false description: >- Optional synchronization-checkpoint ID. Freezes this collection at the checkpoint boundary; cursor binds the snapshot. Unsupported or expired snapshots return 410. schema: type: string responses: '200': description: List authorized lien search records. headers: X-Request-ID: description: AMLOK response correlation identifier. schema: type: string example: req_example content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/LienSearchRead' page: $ref: '#/components/schemas/Page' meta: $ref: '#/components/schemas/ResponseMeta' required: - data - page - meta examples: synthetic: summary: Synthetic list lien searches value: data: - id: lis_example object: lien_search subject_id: biz_example created_at: '2026-10-22T13:00:00Z' updated_at: '2026-10-22T14:00:00Z' record_version: 1 source_refs: [] data_status: partial missing_fields: - field_path: jurisdictions_completed reason: source_error detail: US-NY search failed. schema_version: 1.4.2 debtor_name: Example Manufacturing Inc. debtor_type: business search_type: name jurisdictions_requested: - US-DE - US-NY jurisdictions_completed: - US-DE status: partial result_count: 0 lien_ids: [] stop_reason: null processing_context: product: insights workflow_run_id: wfr_example 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 projected: summary: Metadata-only response with fields=id value: data: - id: lis_example object: lien_search created_at: '2026-10-22T13:00:00Z' updated_at: '2026-10-22T14:00:00Z' record_version: 1 source_refs: [] data_status: partial missing_fields: - field_path: jurisdictions_completed reason: source_error detail: US-NY search failed. schema_version: 1.4.2 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 '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/lien-searches?limit=100&cursor=cur_example&subject_id=biz_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/lien-searches?limit=100&cursor=cur_example&subject_id=biz_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/lien-searches?limit=100&cursor=cur_example&subject_id=biz_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: Enum_search_status: type: string enum: - queued - running - completed - partial - failed - cancelled LienSearchRead: 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_search 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. debtor_name: type: string description: >- Exact debtor name submitted for search. Preserve original evidence; do not invent missing values. x-field-id: F0810 x-classification: Restricted x-availability: Required when resource exists debtor_entity_id: anyOf: - type: string - type: 'null' description: >- Resolved AMLOK debtor entity. Preserve original evidence; do not invent missing values. x-field-id: F0811 x-classification: Confidential x-availability: >- US UCC and Canadian provincial PPSA/RDPRM are separate products. Contract, jurisdiction, search type and redistribution rights must be established. debtor_type: $ref: '#/components/schemas/Enum_party_type' description: >- Person or business search subject. Preserve original evidence; do not invent missing values. x-field-id: F0812 x-classification: Confidential x-availability: Required when resource exists search_type: type: string description: >- Name, registration number, VIN or serial search when supported. Preserve original evidence; do not invent missing values. x-field-id: F0813 x-classification: Confidential x-availability: Required when resource exists identifier: anyOf: - type: string - type: 'null' description: >- Search identifier if the chosen mode requires it. Preserve original evidence; do not invent missing values. x-field-id: F0814 x-classification: Restricted x-availability: >- US UCC and Canadian provincial PPSA/RDPRM are separate products. Contract, jurisdiction, search type and redistribution rights must be established. jurisdictions_requested: type: array items: type: string description: >- Jurisdictions explicitly requested. Preserve original evidence; do not invent missing values. x-field-id: F0815 x-classification: Confidential x-availability: Required when resource exists jurisdictions_completed: type: array items: type: string description: >- Jurisdictions actually completed. Preserve original evidence; do not invent missing values. x-field-id: F0816 x-classification: Confidential x-availability: Required when resource exists status: $ref: '#/components/schemas/Enum_search_status' description: >- Search execution state. Preserve original evidence; do not invent missing values. x-field-id: F0817 x-classification: Confidential x-availability: Required when resource exists searched_at: anyOf: - type: string format: date-time - type: 'null' description: >- Provider search execution time. Preserve original evidence; do not invent missing values. x-field-id: F0818 x-classification: Confidential x-availability: >- US UCC and Canadian provincial PPSA/RDPRM are separate products. Contract, jurisdiction, search type and redistribution rights must be established. effective_through: anyOf: - type: string format: date-time - type: 'null' description: >- Registry's stated effective coverage time. Unknown does not mean current to the request time. x-field-id: F0819 x-classification: Confidential x-availability: >- US UCC and Canadian provincial PPSA/RDPRM are separate products. Contract, jurisdiction, search type and redistribution rights must be established. is_certified: anyOf: - type: boolean - type: 'null' description: >- Whether an official certified search was returned. API search output is not automatically certified. x-field-id: F0820 x-classification: Confidential x-availability: >- US UCC and Canadian provincial PPSA/RDPRM are separate products. Contract, jurisdiction, search type and redistribution rights must be established. search_logic: anyOf: - type: string - type: 'null' description: >- Provider or registry matching method. Preserve original evidence; do not invent missing values. x-field-id: F0821 x-classification: Confidential x-availability: >- US UCC and Canadian provincial PPSA/RDPRM are separate products. Contract, jurisdiction, search type and redistribution rights must be established. result_count: anyOf: - type: integer - type: 'null' description: >- Number of returned filings within completed scope. Preserve original evidence; do not invent missing values. x-field-id: F0822 x-classification: Confidential x-availability: >- US UCC and Canadian provincial PPSA/RDPRM are separate products. Contract, jurisdiction, search type and redistribution rights must be established. lien_ids: anyOf: - type: array items: type: string - type: 'null' description: >- Normalized filing results. Preserve original evidence; do not invent missing values. x-field-id: F0823 x-classification: Confidential x-availability: >- US UCC and Canadian provincial PPSA/RDPRM are separate products. Contract, jurisdiction, search type and redistribution rights must be established. report_document_id: anyOf: - type: string - type: 'null' description: >- Original report or certificate. Preserve original evidence; do not invent missing values. x-field-id: F0824 x-classification: Restricted x-availability: >- US UCC and Canadian provincial PPSA/RDPRM are separate products. Contract, jurisdiction, search type and redistribution rights must be established. stop_reason: anyOf: - type: string enum: - account_cancellation - parent_cancelled - consent_revoked - type: 'null' processing_context: $ref: '#/components/schemas/ProcessingContext' required: - id - object - created_at - updated_at - record_version - source_refs - data_status - missing_fields - schema_version title: LienSearchRead description: >- A search request with explicit debtor, jurisdiction and coverage. 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. Page: type: object properties: next_cursor: anyOf: - type: string - type: 'null' description: Opaque cursor for subsequent page; null after final page. has_more: type: boolean description: Whether more authorized records remain. limit: type: integer description: Applied result limit, from 1 to 200 in this contract. minimum: 1 maximum: 200 required: - has_more - limit 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_party_type: type: string enum: - business - person ProcessingContext: oneOf: - type: object properties: product: const: insights type: string workflow_run_id: type: string minLength: 1 subject_association_id: type: string minLength: 1 required: - product - workflow_run_id additionalProperties: false - type: object properties: product: const: signal type: string monitoring_period_id: type: string minLength: 1 subject_association_id: type: string minLength: 1 required: - product - monitoring_period_id additionalProperties: false discriminator: propertyName: product description: >- Parent must belong to this workspace. Same-subject stages need no association. Only person KYC may target a different subject: supply an active subject_association_id linking that person to the parent business. Insights requires an unfinished authorized root run; Signal requires an active paid period. Stage scope, consent, association and workload are checked on every attempt. The parent business remains the billing and workload subject. No standalone service or extra charge. 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 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.