Read the model
Core
Understand the domains, resources, and relationships that form the model.
Fields / Types
Look up field definitions, reusable structures, and allowed values.
Rules
Follow normalization, calculations, lifecycle events, and data workflows.
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.Change control
Version definitions and mappings together Changes to meanings, types, requiredness or calculations require review and versioned client communication.Reference pages
Core
- Domains - The 11 data domains that organize the normalized AMLOK contract.
- Entities - Record meaning, identity, and population conditions for 63 resources and shared metadata.
- Relationships - How resources connect, including cardinality and integrity rules.
Fields / Types
- Field Dictionary - 957 field definitions, organized by domain and resource.
- Shared Types - 134 reusable nested fields for addresses, money, provenance, and other shared structures.
- Enumerations - Allowed values and handling rules for normalized statuses and categories.
Rules
- Normalization rules - Rules for evidence, missing values, money, identity, and normalized data.
- Derived Attributes - 56 attributes with inputs, calculations, units, and availability rules.
- Events - Event names, resource triggers, and minimal event details.
- Workflow Guide - How data supports Verify, Underwrite, Fund, Monitor, Investigate, and Re-underwrite.
Coverage
- Provider Coverage - Data scope and evidence for the integration catalog.
- Resource Coverage - 2,036 provider-to-resource references and field mappings.
- Field Mappings - 71 upstream field mappings and normalization transformations.
- Coverage considerations - Source permissions, data completeness, and supported workflow boundaries.
For endpoint definitions, authentication, error codes, and request/response examples, see the API reference. This section focuses on the data model.