> ## 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. # Get consent > Get consent. Get consent. All IDs and cursors must belong to the authorized workspace and environment. Required scope: connections:read. Examples use synthetic IDs. Replace them with values returned by your environment. ## OpenAPI ````yaml openapi/amlok.json GET /v1/consents/{id} openapi: 3.1.0 info: title: AMLOK API version: 1.0.0 description: >- AMLOK API: borrower connections, Insights origination, immutable risk packages and Signal monitoring. Use your institution-issued API origin. servers: [] security: - BearerAuth: [] tags: - name: Sandbox description: Reproducible developer scenarios with synthetic data and money. paths: /v1/consents/{id}: get: tags: - Connections summary: Get consent description: >- Get consent. All IDs and cursors must belong to the authorized workspace and environment. Required scope: connections:read. operationId: getConsent parameters: - name: id in: path required: true schema: type: string minLength: 1 description: id responses: '200': description: Successful response. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/Consent' meta: $ref: '#/components/schemas/Meta' required: - data - meta additionalProperties: false example: data: id: consent_synthetic borrower_id: bor_synthetic status: active purposes: - credit_assessment - continuous_monitoring captured_at: '2026-11-06T12:00:00Z' expires_at: null revoked_at: null record_version: 1 meta: request_id: req_synthetic schema_version: 1.0.0 environment: sandbox headers: X-Request-ID: schema: type: string minLength: 1 description: Same request ID as meta.request_id or error.request_id. '400': description: >- Inspect structured error; retry only when retryable. 429 and 503 can include Retry-After. content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/Error' required: - error additionalProperties: false example: error: code: validation_error message: Validation error. retryable: false request_id: req_synthetic field: null headers: X-Request-ID: schema: type: string minLength: 1 description: Same request ID as meta.request_id or error.request_id. '401': description: >- Inspect structured error; retry only when retryable. 429 and 503 can include Retry-After. content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/Error' required: - error additionalProperties: false example: error: code: unauthenticated message: Unauthenticated. retryable: false request_id: req_synthetic field: null headers: X-Request-ID: schema: type: string minLength: 1 description: Same request ID as meta.request_id or error.request_id. '403': description: >- Inspect structured error; retry only when retryable. 429 and 503 can include Retry-After. content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/Error' required: - error additionalProperties: false example: error: code: forbidden message: Forbidden. retryable: false request_id: req_synthetic field: null headers: X-Request-ID: schema: type: string minLength: 1 description: Same request ID as meta.request_id or error.request_id. '404': description: >- Inspect structured error; retry only when retryable. 429 and 503 can include Retry-After. content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/Error' required: - error additionalProperties: false example: error: code: not_found message: Not found. retryable: false request_id: req_synthetic field: null headers: X-Request-ID: schema: type: string minLength: 1 description: Same request ID as meta.request_id or error.request_id. '409': description: >- Inspect structured error; retry only when retryable. 429 and 503 can include Retry-After. content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/Error' required: - error additionalProperties: false example: error: code: invalid_state message: Invalid state. retryable: false request_id: req_synthetic field: null headers: X-Request-ID: schema: type: string minLength: 1 description: Same request ID as meta.request_id or error.request_id. '410': description: >- Inspect structured error; retry only when retryable. 429 and 503 can include Retry-After. content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/Error' required: - error additionalProperties: false example: error: code: cursor_expired message: Cursor expired. retryable: false request_id: req_synthetic field: null headers: X-Request-ID: schema: type: string minLength: 1 description: Same request ID as meta.request_id or error.request_id. '429': description: >- Rate budget, shared in-flight limit or ready-queue limit exceeded before admission. Retry-After is mandatory in whole seconds. Preserve command identity. No accepted receipt or charge is created. content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/Error' required: - error additionalProperties: false example: error: code: rate_limited message: Rate limited. retryable: true request_id: req_synthetic field: null headers: Retry-After: description: Minimum delay in seconds before retry. schema: type: integer minimum: 0 X-Request-ID: schema: type: string minLength: 1 description: Same request ID as meta.request_id or error.request_id. '503': description: >- Inspect structured error; retry only when retryable. 429 and 503 can include Retry-After. content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/Error' required: - error additionalProperties: false example: error: code: temporarily_unavailable message: Temporarily unavailable. retryable: true request_id: req_synthetic field: null headers: Retry-After: description: Minimum delay in seconds before retry. schema: type: integer minimum: 0 X-Request-ID: schema: type: string minLength: 1 description: Same request ID as meta.request_id or error.request_id. security: - BearerAuth: [] x-codeSamples: - lang: Shell label: cURL source: |- curl --request GET --fail-with-body --max-time 30 \ "${AMLOK_API_BASE_URL}/v1/consents/record_synthetic" \ --header "Authorization: Bearer ${AMLOK_API_KEY}" \ --header 'Accept: application/json' - lang: Python source: > import os import requests headers = {'Accept': 'application/json'} headers["Authorization"] = "Bearer " + os.environ["AMLOK_API_KEY"] response = requests.request('GET', os.environ["AMLOK_API_BASE_URL"] + '/v1/consents/record_synthetic', headers=headers, timeout=30, allow_redirects=False) response.raise_for_status() print(response.json()) - lang: JavaScript source: > const headers = {"Accept": "application/json"}; headers.Authorization = `Bearer ${process.env.AMLOK_API_KEY}`; const response = await fetch(process.env.AMLOK_API_BASE_URL + "/v1/consents/record_synthetic", { method: "GET", headers, redirect: "error", signal: AbortSignal.timeout(30000) }); if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`); console.log(await response.json()); components: schemas: Consent: type: object properties: id: type: string minLength: 1 description: >- Opaque identifier, authorized within the API key workspace and environment. borrower_id: type: string minLength: 1 description: >- Opaque identifier, authorized within the API key workspace and environment. status: type: string enum: - active - revoked - expired description: >- Current lifecycle state. See the product lifecycle and recovery guides. purposes: type: array items: type: string enum: - credit_assessment - continuous_monitoring minItems: 1 uniqueItems: true description: >- Purposes for Consent. Constraints, requiredness and allowed values are defined by this schema. captured_at: type: string minLength: 1 format: date-time description: >- Captured at for Consent. Constraints, requiredness and allowed values are defined by this schema. expires_at: anyOf: - type: string minLength: 1 format: date-time - type: 'null' description: UTC expiration; do not use this resource after this instant. revoked_at: anyOf: - type: string minLength: 1 format: date-time - type: 'null' description: >- Revoked at for Consent. Constraints, requiredness and allowed values are defined by this schema. record_version: type: integer minimum: 1 description: >- Monotonically increasing version of this resource. Compare with event.resource_version; snapshot reads preserve their historical version. required: - id - borrower_id - status - purposes - captured_at - expires_at - revoked_at - record_version additionalProperties: false Meta: type: object properties: request_id: type: string minLength: 1 description: >- Opaque identifier, authorized within the API key workspace and environment. schema_version: type: string minLength: 1 description: >- Schema version for Meta. Constraints, requiredness and allowed values are defined by this schema. environment: type: string enum: - sandbox - live description: >- Environment for Meta. Constraints, requiredness and allowed values are defined by this schema. required: - request_id - schema_version - environment additionalProperties: false Error: type: object properties: code: type: string enum: - validation_error - unauthenticated - forbidden - not_found - invalid_state - idempotency_conflict - insufficient_credits - precondition_failed - cursor_expired - rate_limited - temporarily_unavailable - deal_snapshot_conflict - payload_too_large - unsupported_media_type - document_rejected - processing_failed - session_expired - consent_purpose_missing - sandbox_only - scenario_not_available - idempotency_result_expired - capacity_exceeded - queue_full - queue_wait_exceeded - processing_deadline_exceeded - response_too_large - export_too_large - export_expired - invalid_export_part description: >- Stable machine-readable code. validation_error: Correct the named field, schema or incompatible input. Do not retry unchanged. unauthenticated: Use an unexpired, unrevoked API key for this workspace environment. forbidden: Check current membership, scopes, product access, Live activation and source consent. not_found: Check the ID and workspace/environment; foreign records are not exposed. invalid_state: Fetch current state and choose an allowed lifecycle action. idempotency_conflict: Reuse the original payload for that key, or use a fresh key for a genuinely new command. insufficient_credits: Top up through the Console. For an accepted resource, inspect waiting_for_credits before submitting more work. precondition_failed: Fetch the current ETag, review the change and submit If-Match again. cursor_expired: Start a new snapshot and reconcile; retain deduplication state. Expired event replays cannot be queued. rate_limited: Respect Retry-After and use bounded jittered backoff with the same command identity. temporarily_unavailable: Respect retryable and Retry-After; recover an uncertain accepted command before repeating it. deal_snapshot_conflict: Read the current deal snapshot and review previous_snapshot_id before appending. payload_too_large: Reduce JSON or upload size to the operational profile limit; do not split a single document arbitrarily. unsupported_media_type: Send the supported Content-Type and matching detected file content. document_rejected: Inspect the rejected document and replace unsafe, corrupt or unsupported content. processing_failed: Inspect the terminal origination, monitor, run or export failure and retain request_id for support. session_expired: Create a new short-lived embedding session; do not reuse its launch URL. consent_purpose_missing: Obtain the required borrower purpose through the approved Hub configuration. sandbox_only: Remove simulation controls from Live; use the Sandbox environment to test scenarios. scenario_not_available: Choose a scenario returned by the Sandbox catalog and meet its preconditions. idempotency_result_expired: Look up the durable request receipt and resource; an expired cached response does not authorize duplicate work. capacity_exceeded: Lower concurrency or resource fan-out and respect Retry-After. queue_full: Apply bounded backoff; do not replace the idempotency key while retrying submission. queue_wait_exceeded: Inspect the accepted resource failure; review capacity before an intentional new command. processing_deadline_exceeded: Inspect partial evidence and the terminal failure; do not interpret a deadline as a completed result. response_too_large: Use Error.recovery to choose a summary, section, smaller page or supported export. export_too_large: Reduce the export scope or choose a supported partitioned format. export_expired: Create a new export; expired downloads are not renewed indefinitely. invalid_export_part: Read the export manifest and request an existing part number. message: type: string minLength: 1 description: >- Message for Error. Constraints, requiredness and allowed values are defined by this schema. retryable: type: boolean description: >- Retryable for Error. Constraints, requiredness and allowed values are defined by this schema. request_id: type: string minLength: 1 description: >- Opaque identifier, authorized within the API key workspace and environment. field: anyOf: - type: string minLength: 1 - type: 'null' description: >- Field for Error. Constraints, requiredness and allowed values are defined by this schema. capacity: $ref: '#/components/schemas/CapacityErrorDetail' recovery: $ref: '#/components/schemas/LargeResponseRecovery' required: - code - message - retryable - request_id - field additionalProperties: false allOf: - if: properties: code: const: response_too_large then: required: - recovery properties: retryable: const: false - if: properties: code: enum: - capacity_exceeded - queue_full then: required: - capacity properties: retryable: const: true CapacityErrorDetail: type: object properties: group: type: string enum: - http - origination - monitoring - export reason: type: string enum: - in_flight_limit - queue_full limit: type: integer minimum: 0 maximum: 9007199254740991 description: Effective admission limit. profile_id: type: string minLength: 1 profile_version: type: string minLength: 1 required: - group - reason - limit - profile_id - profile_version additionalProperties: false LargeResponseRecovery: type: object properties: export_request: $ref: '#/components/schemas/CreateExport' summary_available: type: boolean snapshot_expires_at: anyOf: - type: string minLength: 1 format: date-time - type: 'null' data_checkpoint: anyOf: - $ref: '#/components/schemas/DataCheckpoint' - type: 'null' required: - export_request - summary_available - snapshot_expires_at - data_checkpoint additionalProperties: false description: >- Complete authorized export source captured before the failed response. Existing export scopes and source permissions still apply. Snapshot expiry is null for immutable package/record sources; create snapshot exports before expiry. CreateExport: type: object properties: kind: type: string enum: - risk_package - evidence - billing - data description: >- Kind for CreateExport. Constraints, requiredness and allowed values are defined by this schema. risk_package_id: type: string minLength: 1 description: >- Opaque identifier, authorized within the API key workspace and environment. evidence_set_id: type: string minLength: 1 description: >- Opaque identifier, authorized within the API key workspace and environment. billing_report_type: type: string enum: - usage - credits - statements - funding - rates - workload description: >- Billing report type for CreateExport. Constraints, requiredness and allowed values are defined by this schema. window: $ref: '#/components/schemas/Window' description: >- Window for CreateExport. Constraints, requiredness and allowed values are defined by this schema. format: type: string enum: - json - csv - pdf description: >- Format for CreateExport. Constraints, requiredness and allowed values are defined by this schema. data_snapshot_id: type: string minLength: 1 description: Opaque ID within the authorized workspace and environment. data_record_id: type: string minLength: 1 description: >- Exact immutable DataRecord version, alternative to data_snapshot_id for kind=data. required: - kind - format additionalProperties: false oneOf: - properties: kind: const: risk_package format: type: string enum: - json - pdf required: - risk_package_id not: anyOf: - required: - evidence_set_id - required: - billing_report_type - required: - window - required: - data_snapshot_id - required: - data_record_id title: Risk-package export - properties: kind: const: evidence format: type: string enum: - json - csv required: - evidence_set_id not: anyOf: - required: - risk_package_id - required: - billing_report_type - required: - window - required: - data_snapshot_id - required: - data_record_id title: Evidence export - properties: kind: const: billing format: type: string enum: - json - csv required: - billing_report_type - window not: anyOf: - required: - risk_package_id - required: - evidence_set_id - required: - data_snapshot_id - required: - data_record_id title: Billing export - title: Collected data export properties: kind: const: data format: type: string enum: - json - csv required: [] not: anyOf: - required: - risk_package_id - required: - evidence_set_id - required: - billing_report_type - required: - window oneOf: - required: - data_snapshot_id not: required: - data_record_id - required: - data_record_id not: required: - data_snapshot_id DataCheckpoint: type: object properties: snapshot_id: type: string minLength: 1 as_of: type: string minLength: 1 format: date-time changes_cursor: type: string minLength: 1 expires_at: type: string minLength: 1 format: date-time required: - snapshot_id - as_of - changes_cursor - expires_at additionalProperties: false description: >- Atomic data snapshot and feed boundary retained even when the first record exceeds the response limit. Window: type: object properties: start: type: string minLength: 1 format: date-time description: >- Start for Window. Constraints, requiredness and allowed values are defined by this schema. end: type: string minLength: 1 format: date-time description: >- End for Window. Constraints, requiredness and allowed values are defined by this schema. required: - start - end additionalProperties: false description: UTC interval [start, end). The server rejects end <= start. 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.