> ## 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.

# API overview

> Build workspace-scoped integrations with the AMLOK API 1.4.2.

The AMLOK API organizes authorized financial evidence into a common data model and coordinates verification, underwriting, monitoring, and analytical investigation workflows. AMLOK identifies changes and risk signals so your institution can decide when to intervene. Borrower outreach and intervention take place in your institution's own systems.

This reference contains **192 operations**, **63 financial-data resource types plus credit and billing reporting resources**, **27 event types**, and schema-checked example payloads. Endpoint pages include cURL, Python, and Node.js request examples, response bodies, required scopes, and error definitions.

> **[Make your first request](https://docs.amlok.io/api-reference/quickstart.md)**
>
> Follow a complete connection and data-read flow.

> **[Authentication and scopes](https://docs.amlok.io/api-reference/authentication.md)**
>
> Understand API keys, workspace boundaries, and permissions.

> **[Webhooks](https://docs.amlok.io/api-reference/webhooks.md)**
>
> Verify signatures, deduplicate deliveries, and process changes.

> **[OpenAPI and examples](https://docs.amlok.io/api-reference/downloads.md)**
>
> Download the specification, Postman collection, and verification code.

## How the API fits together

1. Create or identify a business or person under your institution tenant.
2. Record actual authorization and connect an enabled provider.
3. Synchronize evidence and read normalized records with their coverage and provenance.
4. Start approved workflows and retrieve asynchronous results.
5. Process signed events and keep your local records in sync.

Financial-data and reporting operations use a server-side bearer API key. The healthcheck and service-status endpoints are public and require no key. Each key authorizes exactly one workspace. Resources are workspace-scoped; a resource ID alone never grants access. Source capabilities, consent, scopes, and field entitlements all constrain the returned data.

## Explore the API

| Area | Start with |
| - | - |
| Connections and consent | [Create a connection](https://docs.amlok.io/api-reference/endpoints/platform/create-connection.md), [record consent](https://docs.amlok.io/api-reference/endpoints/platform/create-consent.md), [discover provider capabilities](https://docs.amlok.io/api-reference/endpoints/platform/list-providers.md) |
| Identity and evidence | [Start verification](https://docs.amlok.io/api-reference/endpoints/identity/start-verification.md), [upload a document](https://docs.amlok.io/api-reference/endpoints/identity/upload-document.md) |
| Banking | [List accounts](https://docs.amlok.io/api-reference/endpoints/banking/list-bank-accounts.md), [list transactions](https://docs.amlok.io/api-reference/endpoints/banking/list-bank-transactions.md) |
| Payments, commerce, accounting, inventory | Browse the endpoint groups in the sidebar and the [data dictionary](https://docs.amlok.io/data-model/field-dictionary.md). |
| Lending and assessment | [Create an application](https://docs.amlok.io/api-reference/endpoints/lending/create-application.md), [run a workflow](https://docs.amlok.io/api-reference/endpoints/operations/start-workflow-run.md), [calculate attributes](https://docs.amlok.io/api-reference/endpoints/risk/calculate-attributes.md) |
| Monitoring and risk review | [Create a monitor](https://docs.amlok.io/api-reference/endpoints/risk/create-monitor.md), [review intervention signals](https://docs.amlok.io/api-reference/workflows.md#review-intervention-signals) |
| Reporting | [Credit reporting](https://docs.amlok.io/api-reference/credit-reporting.md), [consumption reporting](https://docs.amlok.io/api-reference/consumption-reporting.md), [cancellation and refunds](https://docs.amlok.io/pricing/refunds-and-payouts.md) |
| Delivery | [Register a webhook](https://docs.amlok.io/api-reference/endpoints/webhooks/create-webhook-endpoint.md), [read changes](https://docs.amlok.io/api-reference/endpoints/platform/read-change-feed.md) |
| Service availability | [Healthcheck](https://docs.amlok.io/api-reference/endpoints/platform/healthcheck.md), [service status](https://docs.amlok.io/api-reference/endpoints/platform/service-status.md) |

## Version and availability

Use the [integration status catalog](https://docs.amlok.io/integrations/status.md) to check provider availability and supported markets. Returned resources and fields depend on your enabled products, source permissions, and account entitlements.

This reference covers **AMLOK API 1.4.2**. Endpoint paths use the `/v1` major-version namespace. Configure `AMLOK_API_BASE_URL` with the environment URL issued to your institution.

See [integration onboarding](https://docs.amlok.io/api-reference/onboarding.md) for environment setup and [versioning](https://docs.amlok.io/api-reference/versioning.md) for compatibility rules.

Your account manager provides client portal access information. Authorized administrators create workspace-bound API keys in the portal. Start with [configuration discovery](https://docs.amlok.io/api-reference/configuration.md) and [sandbox journeys](https://docs.amlok.io/api-reference/sandbox-journeys.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.