A LedgerBlock User represents an individual customer or end user that a merchant manages through LedgerBlock.

Creating a User establishes the identity that LedgerBlock uses to associate customer-related services, compliance records, wallets, and other financial capabilities.

A User is typically the starting point for providing financial services to an individual through LedgerBlock.

Why is a User Required?

A User is required because LedgerBlock associates customer-level financial activities and compliance information with a specific user.

Creating a User allows your application to establish a customer record that can subsequently be used for services such as:

KYC and identity verification
Wallet-related services
Customer financial accounts
Transactions and other user-related financial operations

The User record provides a consistent reference that allows LedgerBlock to associate these services with the correct customer.

User Reference

When a User is created, LedgerBlock provides a user reference that can be used to identify that customer in subsequent API requests.

Your application should store this reference and use it whenever an API endpoint requires a user_ref.

Setting Up a User

Before a customer can access user-specific LedgerBlock capabilities, your application should first create a User.

The general flow is:

Your Customer
      ↓
Create LedgerBlock User
      ↓
User Created
      ↓
Create / Complete KYC
      ↓
KYC Approved
      ↓
User Gains Access to Eligible Capabilities

Step 1: Create a User

Create a LedgerBlock User using the Create User API.

The User creation request establishes the customer record within LedgerBlock.

For the required request parameters, headers, and response structure, see:

Create User API → [Link to Create User API documentation]

Once the User has been successfully created, save the returned user_ref. This reference is required when performing subsequent operations for that user.

Step 2: Complete KYC

After creating the User, the customer may need to complete the required KYC level before accessing certain financial capabilities.

KYC requirements depend on the capability being provided and the applicable KYC tier.

See:

Create KYC API → [Link to Create KYC API documentation]

Step 3: Access User Capabilities

Once the required KYC requirements have been satisfied, the User can access the capabilities available for their KYC level.

KYC as a Requirement for a User

KYC is used to verify and establish the identity of a LedgerBlock User before providing certain financial services.

A User can exist before KYC is completed, but KYC may be required before the User can access specific capabilities.

LedgerBlock uses different KYC tiers to determine the capabilities available to a User.

For example, a lower KYC tier may provide basic capabilities, while a higher tier may unlock additional financial functionality.

KYC Flow

Create User
     ↓
User Created
     ↓
Submit KYC
     ↓
KYC Verification
     ↓
KYC Tier Assigned / Approved
     ↓
Capabilities Available Based on Tier

To create KYC for a User, use the Create KYC API.

Create KYC API → [Link to Create KYC API documentation]

The KYC request is associated with the User using the user_ref.

User Capabilities

The capabilities available to a User depend on the User's KYC status and applicable KYC tier.

For example, a User who has completed the required KYC may be able to access capabilities such as:

Wallet functionality
Financial accounts
Transactions
Other services enabled for the User's KYC level

Not every capability is necessarily available at every KYC tier.

When integrating a capability that requires a specific KYC level, verify the applicable requirement in the corresponding API documentation.

Example: Wallet PIN

Certain User capabilities require the User to meet a specific KYC requirement.

For example, Tier 1 KYC allows a User to create a wallet PIN.

The general relationship is:

User
  ↓
KYC Tier
  ↓
Eligible Capabilities
  ↓
Financial Services

This means that creating a User alone does not automatically grant access to every LedgerBlock service. The User's KYC status and tier determine which capabilities can be enabled.

Recommended Integration Flow

For most User-based integrations, the recommended sequence is:

Create the User
Store the user_ref
Create the required KYC
Wait for / verify the KYC status
Provide capabilities available to the User's KYC tier
Use the user_ref for subsequent User-related API operations

API Documentation

Use the following API references when implementing the flow:

Create User — Create a LedgerBlock User.
Create KYC — Submit KYC information for an existing User.
KYC Status — Check the User's KYC status where applicable.
User-related financial APIs — Use the user_ref to perform operations associated with the User.