> ## Documentation Index
> Fetch the complete documentation index at: https://developer.uphold.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Core API introduction

> The building blocks to embed financial services in your app: onboard and verify users, hold assets in accounts and move value with transactions. Includes the data model and key concepts.

The Core API provides the essential building blocks to embed financial services into your application, with security, compliance and scalability built in. It's the foundational layer of the Uphold Enterprise API Suite: it manages your users and their verification, the accounts that hold their assets, and the transactions that move value into, out of and between those accounts.

Other APIs and the [widgets](https://developer.uphold.com/widgets/introduction.md) build on what the Core API manages. For example, the [On & Off Ramp API](https://developer.uphold.com/rest-apis/on-off-ramp-api/introduction.md) creates orders for Core users, and its deposits and withdrawals are Core transactions.

## Building blocks

| Area | Groups | Use them to |
| - | - | - |
| Users and compliance | [Users](https://developer.uphold.com/rest-apis/core-api/users/overview.md), [Countries](https://developer.uphold.com/rest-apis/core-api/countries/overview.md), [KYC](https://developer.uphold.com/rest-apis/core-api/kyc/overview.md), [KYB](https://developer.uphold.com/rest-apis/core-api/kyb/overview.md), [Terms of service](https://developer.uphold.com/rest-apis/core-api/terms-of-service/overview.md), [Files](https://developer.uphold.com/rest-apis/core-api/files/overview.md), [Capabilities](https://developer.uphold.com/rest-apis/core-api/capabilities/overview.md) | Onboard users, verify them and know what they can do. |
| Assets and accounts | [Assets](https://developer.uphold.com/rest-apis/core-api/assets/overview.md), [Accounts](https://developer.uphold.com/rest-apis/core-api/accounts/overview.md), [External accounts](https://developer.uphold.com/rest-apis/core-api/external-accounts/overview.md) | Find the supported assets, networks and rails, hold balances, and link payment methods. |
| Money movement | [Transactions](https://developer.uphold.com/rest-apis/core-api/transactions/overview.md), [Requests for information](https://developer.uphold.com/rest-apis/core-api/requests-for-information/list-requests-for-information.md) | Quote and execute deposits, withdrawals, trades and sends, and answer compliance requests on them. |
| Reporting | [Portfolio](https://developer.uphold.com/rest-apis/core-api/portfolio/overview.md), [Statements](https://developer.uphold.com/rest-apis/core-api/statements/overview.md) | Show holdings and performance, and produce monthly records for reporting and reconciliation. |

Across the groups, [webhooks](https://developer.uphold.com/rest-apis/webhooks.md) notify you as users, verifications, accounts and transactions change, [entity metadata](https://developer.uphold.com/rest-apis/entity-metadata.md) stores your own data on entities such as users, accounts and transactions, and [test helpers](https://developer.uphold.com/rest-apis/test-helpers.md) simulate events such as deposits or verification outcomes in Sandbox.

For end-to-end walkthroughs of each flow, such as onboarding a user or accepting card deposits, see the [Developer Guides](https://developer.uphold.com/developer-guides/introduction.md).

## Data model

![Core Data Model](https://mintcdn.com/uphold-d4756e17/wEVqiQJY_1BdGYCe/rest-apis/core-api/_media/core-data-model.png?fit=max\&auto=format\&n=wEVqiQJY_1BdGYCe\&q=85\&s=3cb9b0172cd80caa8c2099ee429cf0d5)

The diagram outlines the main entities of the Core API and how they relate to each other.

When a **User** registers, they must specify their **Country of residence** and accept the applicable **Terms of Service**, which establish the legal framework for using the platform. To ensure compliance, every **User** must complete a set of verification steps before accessing financial services: **Know Your Customer (KYC) processes** for individuals, or **Know Your Business (KYB) processes** for businesses. Some processes are forms the **User** answers, and others are file-based: the **User** uploads the required **Files**, such as a government ID or a proof of address, as documentation for the verification.

A **User's KYC or KYB status** and the **Terms of Service** they accept directly influence their **Capabilities** on the platform. **Capabilities** define what important actions a **User** is allowed to perform. Depending on the **Capabilities** granted, the **User** may be restricted from performing certain operations, such as transacting or linking an **External Account**, e.g., a bank or a credit card.

Each **User** owns one or more **Accounts**, each holding a balance of one **Asset**. **Users** interact with their accounts primarily through **Transactions**, which modify **Account balances** by **trading, depositing, or withdrawing assets**. Deposits and withdrawals are powered by **Rails**, which determine how assets are transferred within a **Network**.

You can also create **External Accounts**, which enable users to link bank accounts or credit/debit cards. Unlike push deposits, **External Accounts** allow the platform to **pull funds** to an Account, with the **User**'s authorization. **External Accounts** can also be used as a withdrawal destination, enabling two-way transactions.

## Key concepts

### Denomination

Denomination currency refers to the currency unit in which the value of a transaction, trade, or financial asset is expressed.
It provides a consistent way to measure value across different assets or currencies. Additionally, knowing the denomination helps in assessing exposure to foreign exchange fluctuations.

The denomination currency is not necessarily the same as the currency used to pay. A user can buy an asset priced in EUR (denomination currency), but pay in USD.

As another example, users might:

* Hold balances in one currency (e.g., GBP)
* View prices in another (e.g., USD)
* Transact in yet another (e.g., BTC)

Specific examples:

1. **Buying Crypto**
   * You buy 1 BTC priced at \$60,000 USD.
   * USD is the denomination currency (price reference).
   * You pay in EUR → conversion happens at settlement.
2. **Cross-Border Payment**
   * A vendor invoice is denominated in GBP.
   * You pay using USD.
   * GBP remains the denomination currency (the expected value); USD is converted to match that amount.
3. **Portfolio Holdings**
   * A portfolio lists all assets valued in a single denomination currency, like USD, giving a unified view even if balances are held in multiple currencies.
4. **Statements**
   * A portfolio statement expresses all holdings in the requested denomination asset using period-end exchange rates.
   * A transactions statement records the denomination asset and exchange rates at the time each transaction completed.
