> ## 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. # Healthcheck > Healthcheck. Healthcheck. All IDs and cursors must belong to the authorized workspace and environment. No API key is required. Examples use synthetic IDs. Replace them with values returned by your environment. ## OpenAPI ````yaml openapi/amlok.json GET /v1/healthcheck 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: [] paths: /v1/healthcheck: get: tags: - Reliability summary: Healthcheck description: >- Healthcheck. All IDs and cursors must belong to the authorized workspace and environment. No API key is required. operationId: healthcheck parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/Healthcheck' meta: $ref: '#/components/schemas/Meta' required: - data - meta additionalProperties: false example: data: status: ok 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: >- 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: 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: [] x-codeSamples: - lang: Shell label: cURL source: |- curl --request GET --fail-with-body --max-time 30 \ "${AMLOK_API_BASE_URL}/v1/healthcheck" \ --header 'Accept: application/json' - lang: Python source: > import os import requests headers = {'Accept': 'application/json'} response = requests.request('GET', os.environ["AMLOK_API_BASE_URL"] + '/v1/healthcheck', headers=headers, timeout=30, allow_redirects=False) response.raise_for_status() print(response.json()) - lang: JavaScript source: > const headers = {"Accept": "application/json"}; const response = await fetch(process.env.AMLOK_API_BASE_URL + "/v1/healthcheck", { 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: Healthcheck: type: object properties: status: type: string enum: - ok - degraded description: >- Current lifecycle state. See the product lifecycle and recovery guides. required: - status 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 description: >- Code for Error. Constraints, requiredness and allowed values are defined by this schema. 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. required: - code - message - retryable - request_id - field additionalProperties: false 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.