How to Onboard an End User with Diameter

Step-by-step guide to creating individual or organization end users, tracking their onboarding status, and retrieving their virtual accounts.

The Diameter API lets you onboard individual consumers or business organizations as end users on behalf of your product. Once onboarded, each end user receives a virtual account at the partner bank you specify, which you can then fund and transact against. This guide walks you through every step — from creating the end user record to retrieving their account details.

---

​

Onboarding organization end users

The flow for organizations is identical to individuals. The only difference is the endpoint and required fields. Send a POST to /v1/end-users/organizations with the following business-specific fields instead of personal identity fields:

Field	Description
fullName	Legal business name
doingBusinessAs	Trading name, if different from legal name
businessIndustry	Industry classification code
businessEntityType	e.g. LLC, CORPORATION, PARTNERSHIP
formationDate	Date the entity was formed (ISO 8601)
incorporationCountry	Two-letter country code
idType	Business identifier type, e.g. EIN
idNumber	The actual identifier number

cURL

curl -X POST https://api.sandbox.diameterpay.com/v1/end-users/organizations \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "x-idempotency-key: 550e8400-e29b-41d4-a716-446655440001" \
  -H "Content-Type: application/json" \
  -d '{
    "productId": "YOUR_PRODUCT_ID",
    "fullName": "Acme Fintech LLC",
    "doingBusinessAs": "Acme Pay",
    "businessIndustry": "FINANCIAL_SERVICES",
    "businessEntityType": "LLC",
    "formationDate": "2018-03-20",
    "incorporationCountry": "US",
    "idType": "EIN",
    "idNumber": "12-3456789",
    "onboardInBanks": ["PORTAGE"]
  }'

Once submitted, track status and retrieve accounts exactly as described in the steps above — the onboardingStatus lifecycle and webhook events are the same for both end user types.