End Users: Onboarding Individuals and Organizations

End users are the individuals and organizations that use your financial services. Learn about their lifecycle, statuses, and required data.

End users are the individuals and businesses your platform serves. When you onboard an end user through Diameter, the platform runs compliance checks, coordinates with partner banks, and automatically provisions a virtual account — all without you having to manage the underlying banking workflows directly.

​

End User Types

Diameter supports two end user types:

• Individual — a natural person (customer, sole trader, etc.)
• Organization — a registered business entity

The required fields and identity verification rules differ between the two types. See the Required Fields section below for details.

​

Onboarding Lifecycle

Onboarding an end user follows a sequential process:

1. Submit End User Data

   You send the end user’s identity and contact information to the Diameter API along with the target productId and the list of banks to onboard with (onboardInBanks).

2. Compliance Checks

   Diameter automatically runs compliance and sanctions screening on the submitted data.

3. Partner Bank Onboarding

   Once compliance passes, Diameter forwards the user’s details to the selected partner bank(s) for their own onboarding process.

4. Virtual Account Creation

   The partner bank provisions a virtual account for the end user. Account details become available via the accounts API.

5. Status Changes to ACTIVE

   The end user’s status updates to ACTIVE, indicating they are fully onboarded and able to make payments.

​

Status Values

Status	Meaning
INACTIVE	End user has been created and is going through onboarding
ACTIVE	Fully onboarded; can initiate and receive payments
BLOCKED	Account has been deactivated
REJECTED	End user was rejected during compliance screening

​

Banks: Input vs. Output Fields

Two bank-related fields are easy to confuse:

Field	Direction	Description
onboardInBanks	Input (request)	Specifies which partner banks to onboard this end user with
onboardedInBanks	Output (response)	Lists the banks where onboarding has been successfully completed

When you create an end user, you set onboardInBanks. As onboarding progresses, Diameter populates onboardedInBanks to reflect completed bank registrations.

​

Required Fields

​

Individual

Submit the following fields when onboarding an individual:

Field	Description
firstName	Legal first name
lastName	Legal last name
email	Contact email address
mobilePhone	Mobile phone number
dateOfBirth	Date of birth (ISO 8601)
nationality	Country code (ISO 3166-1 alpha-2)
idType	Type of identity document (see below)
idNumber	Identity document number
idCountry	Country of issue for the identity document
pepStatus	Politically Exposed Person status
primaryAddress	Full residential address
onboardInBanks	Partner banks to onboard with
productId	Product to associate the end user with

Accepted idType values:

Identity Document Types

Value	Description
PASSPORT	International passport
DRIVING_LICENSE	Driver’s licence
NATIONAL_ID_CARD	Government-issued national ID card
SSN	Social Security Number (US)
EIN	Employer Identification Number (US)
ITIN	Individual Taxpayer Identification Number (US)
OTHER_ID	Any other accepted identity document

​

Organization

Submit the following fields when onboarding an organization:

Field	Description
fullName	Registered legal name of the business
doingBusinessAs	Trading name (if different from legal name)
businessIndustry	Industry classification
businessEntityType	Legal entity type (e.g. LLC, corporation)
formationDate	Date the business was formed (ISO 8601)
incorporationCountry	Country where the business is incorporated
idType	Business identifier type (e.g. EIN)
idNumber	Business identifier number

​

Adding an End User to a Second Bank

If an end user is already onboarded with one bank and you want to add them to a second partner bank, use the onboard endpoint rather than creating a new end user record:

PATCH /v1/end-users/{id}/onboard

Pass the additional bank in onboardInBanks. Diameter runs compliance and bank onboarding for the new bank only, without duplicating the existing relationship.

​

Country Restrictions

Some countries are prohibited from onboarding due to sanctions and compliance requirements. For example, Afghanistan (AF) is a prohibited country. Submitting an end user with a nationality, address, or ID country matching a prohibited country will result in a REJECTED status or an immediate API error.

​

Name Field Encoding

All name fields (e.g. firstName, lastName, fullName) must contain ASCII characters only. Non-ASCII characters, including accented letters and non-Latin scripts, are not accepted and will cause a validation error.