> ## 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 borrowers > List borrowers. List borrower. All IDs and cursors must belong to the authorized workspace and environment. Required scope: borrowers:read. Examples use synthetic IDs. Replace them with values returned by your environment. ## OpenAPI ````yaml openapi/amlok.json GET /v1/borrowers 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/borrowers: get: tags: - Borrowers summary: List borrowers description: >- List borrower. All IDs and cursors must belong to the authorized workspace and environment. Required scope: borrowers:read. operationId: listBorrower parameters: - name: cursor in: query required: false schema: type: string minLength: 1 description: cursor - name: limit in: query required: false schema: type: integer minimum: 1 maximum: 100 default: 25 description: limit - name: client_reference in: query required: false schema: type: string minLength: 1 description: client reference responses: '200': description: Successful response. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Borrower' meta: $ref: '#/components/schemas/Meta' page: $ref: '#/components/schemas/Page' required: - data - meta - page additionalProperties: false example: data: - id: bor_synthetic type: business subject_id: biz_synthetic created_at: '2026-11-06T12:00:00Z' client_reference: LOS-B-0042 profile: type: business business: legal_name: Synthetic Borrower Inc. incorporation_country: CA client_reference: LOS-B-0042 meta: request_id: req_synthetic schema_version: 1.0.0 environment: sandbox page: next_cursor: null has_more: false snapshot_id: snap_synthetic expires_at: '2026-11-06T13:00:00Z' 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: - BearerAuth: [] x-codeSamples: - lang: Shell label: cURL source: |- curl --request GET --fail-with-body --max-time 30 \ "${AMLOK_API_BASE_URL}/v1/borrowers" \ --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/borrowers', 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/borrowers", { 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: Borrower: type: object properties: id: type: string minLength: 1 description: >- Opaque identifier, authorized within the API key workspace and environment. type: type: string enum: - business - person description: >- Type for Borrower. Constraints, requiredness and allowed values are defined by this schema. subject_id: type: string minLength: 1 description: >- Opaque identifier, authorized within the API key workspace and environment. created_at: type: string minLength: 1 format: date-time description: UTC time the record was created. client_reference: anyOf: - type: string minLength: 1 - type: 'null' description: >- Client reference for Borrower. Constraints, requiredness and allowed values are defined by this schema. profile: $ref: '#/components/schemas/CreateBorrower' description: >- Profile for Borrower. Constraints, requiredness and allowed values are defined by this schema. required: - id - type - subject_id - created_at - client_reference - profile 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 Page: type: object properties: next_cursor: anyOf: - type: string minLength: 1 - type: 'null' description: >- Next cursor for Page. Constraints, requiredness and allowed values are defined by this schema. has_more: type: boolean description: >- Has more for Page. Constraints, requiredness and allowed values are defined by this schema. snapshot_id: type: string minLength: 1 description: >- Opaque identifier, authorized within the API key workspace and environment. expires_at: type: string minLength: 1 description: >- Snapshot expiry. After expiry, respond 410 and restart with a new snapshot; never continue on a new snapshot silently. format: date-time required: - next_cursor - has_more - snapshot_id - expires_at additionalProperties: false description: >- Opaque cursor binds filters, authorization and a stable snapshot. Expired cursors return 410; never silently restart. 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 CreateBorrower: oneOf: - type: object properties: type: const: business business: $ref: '#/components/schemas/BusinessInput' required: - type - business additionalProperties: false title: Business borrower - type: object properties: type: const: person person: $ref: '#/components/schemas/PersonInput' required: - type - person additionalProperties: false title: Consumer borrower BusinessInput: type: object properties: legal_name: type: string minLength: 1 description: Client-asserted legal name. client_reference: type: string minLength: 1 description: Optional caller-owned correlation identifier. registration_number: type: string minLength: 1 description: Company or registry registration identifier. incorporation_country: type: string minLength: 1 description: Country of formation. required: - legal_name additionalProperties: false PersonInput: type: object properties: given_name: type: string minLength: 1 description: Authorized individual given name. family_name: type: string minLength: 1 description: Authorized individual family name. email: type: string minLength: 1 description: Contact email. phone: type: string minLength: 1 description: Contact telephone. residence_country: type: string minLength: 1 description: Current country of residence when established. client_reference: type: string minLength: 1 description: >- Institution borrower reference, unique by borrower type in the workspace/environment when supplied. required: - given_name - family_name 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.