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

# Data model

> Understand the normalized data model and find the right reference.

The model organizes data from provider systems into consistent resources while preserving source evidence. Use it to understand record meaning, field definitions, and resource coverage.

| Reference | Scope |
| - | - |
| Domains | 11 |
| Resource types | 63 + inherited common metadata |
| Field definitions | 957 |
| Source shared-type fields | 134 |
| Derived attributes | 56 |
| Field mappings | 71 |
| Provider/resource references | 2,036 |

## Read the model

> **[Core](#core)**
>
> Understand the domains, resources, and relationships that form the model.

> **[Fields / Types](#fields-/-types)**
>
> Look up field definitions, reusable structures, and allowed values.

> **[Rules](#rules)**
>
> Follow normalization, calculations, lifecycle events, and data workflows.

> **[Coverage](#coverage)**
>
> Review provider coverage, upstream mappings, and coverage considerations.

## How to interpret the definitions

### Source / derived / managed

**Three distinct origins**

Normalized source records preserve provider evidence. Derived attributes require calculations. AMLOK-managed records describe workflows and governance.

### Availability

**Conditional per source and entitlement**

An active integration does not make every field universally available. Optional data depends on source, country, module, permissions and history.

### Required fields

**Contract requirement when a resource exists**

Required does not mean the upstream provider guarantees this field. Reject or quarantine records that cannot meet identity requirements.

### Missing values

**Null is not zero**

Use missing\_fields reasons; \[] means a known empty collection. Partial results remain partial.

### Resource prefixes

**Documentation context**

bank\_transaction.amount.amount refers to data.amount.amount on a bank\_transaction response. Common fields are inherited at the same object level.

### Excluded assumptions

**No invented credit-bureau, payroll, tax-authority or title feeds**

These require additional sources or explicit lender-supplied evidence. See [coverage considerations](https://docs.amlok.io/data-model/coverage-considerations.md).

### Change control

**Version definitions and mappings together**

Changes to meanings, types, requiredness or calculations require review and versioned client communication.

## Reference pages

### Core

* [Domains](https://docs.amlok.io/data-model/domains.md) - The 11 data domains that organize the normalized AMLOK contract.
* [Entities](https://docs.amlok.io/data-model/entities.md) - Record meaning, identity, and population conditions for 63 resources and shared metadata.
* [Relationships](https://docs.amlok.io/data-model/relationships.md) - How resources connect, including cardinality and integrity rules.

### Fields / Types

* [Field Dictionary](https://docs.amlok.io/data-model/field-dictionary.md) - 957 field definitions, organized by domain and resource.
* [Shared Types](https://docs.amlok.io/data-model/shared-types.md) - 134 reusable nested fields for addresses, money, provenance, and other shared structures.
* [Enumerations](https://docs.amlok.io/data-model/enumerations.md) - Allowed values and handling rules for normalized statuses and categories.

### Rules

* [Normalization rules](https://docs.amlok.io/data-model/normalization-rules.md) - Rules for evidence, missing values, money, identity, and normalized data.
* [Derived Attributes](https://docs.amlok.io/data-model/derived-attributes.md) - 56 attributes with inputs, calculations, units, and availability rules.
* [Events](https://docs.amlok.io/data-model/events.md) - Event names, resource triggers, and minimal event details.
* [Workflow Guide](https://docs.amlok.io/data-model/workflow-guide.md) - How data supports Verify, Underwrite, Fund, Monitor, Investigate, and Re-underwrite.

### Coverage

* [Provider Coverage](https://docs.amlok.io/data-model/provider-coverage.md) - Data scope and evidence for the integration catalog.
* [Resource Coverage](https://docs.amlok.io/data-model/resource-coverage.md) - 2,036 provider-to-resource references and field mappings.
* [Field Mappings](https://docs.amlok.io/data-model/field-mappings.md) - 71 upstream field mappings and normalization transformations.
* [Coverage considerations](https://docs.amlok.io/data-model/coverage-considerations.md) - Source permissions, data completeness, and supported workflow boundaries.

> [!NOTE]
>
> For endpoint definitions, authentication, error codes, and request/response examples, see the [API reference](https://docs.amlok.io/api-reference/overview.md). This section focuses on the data model.


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