Get Individual End User by ID

GET /v1/end-users/individuals/ — Retrieves a single individual end user by their UUID. Requires end-users:read scope.

Retrieves the full profile of a single individual end user using their Diameter-assigned UUID. The response includes all submitted identity details, current onboarding status, the list of bank partners where onboarding is complete, and all associated addresses. Use this endpoint to check onboarding progress after creation or to refresh a locally cached record.

​

Endpoint

GET /v1/end-users/individuals/{id}

Required scope: com.diameterpay.api/end-users.read

​

Request Headers

Authorization · string · required

Bearer token obtained from your OAuth 2.0 token endpoint. Format: Bearer {access_token}

​

Path Parameters

id · string · required

UUID v4 of the individual end user to retrieve. This is the id returned when the end user was created.

​

Response

Returns 200 OK with the IndividualEndUserOutput object.

id · string

Diameter-assigned UUID v4 for this end user.

productId · string

UUID of the associated product.

firstName · string

Individual’s first name.

middleName · string

Individual’s middle name, if provided.

lastName · string

Individual’s last name.

fullName · string

Auto-built full name combining firstName, optional middleName, and lastName.

email · string

Individual’s email address.

mobilePhone · string

Mobile phone number in E.164 format.

dateOfBirth · string

Date of birth in YYYY-MM-DD format.

nationality · string

ISO 3166-1 alpha-2 nationality code.

idType · string

Identity document type (e.g. PASSPORT, DRIVING_LICENSE).

idNumber · string

Identity document number.

idCountry · string

ISO 3166-1 alpha-2 code of the country that issued the ID.

pepStatus · string

Politically Exposed Person status: YES or NO.

gender · string

Gender, if provided (MALE or FEMALE).

onboardingStatus · string

Current overall onboarding status (e.g. INACTIVE, PENDING, ACTIVE).

onboardedInBanks · array

List of bank partner identifiers where onboarding has completed successfully.

addresses · array

Array of address objects. Each object contains the address fields submitted at creation (addressType, country, postalCode, townName, streetName, and any optional fields provided).

internalEndUserIdentifier · string

Your system’s internal identifier for this user, if provided.

internalEndUserActivity · integer

Internal activity code, if provided.

internalEndUserStartDate · string

Internal start date, if provided.

createdAt · string

ISO 8601 timestamp of when the end user was created.

updatedAt · string

ISO 8601 timestamp of the most recent update.

​

Example Request

curl --request GET \
  --url https://api.sandbox.diameterpay.com/v1/end-users/individuals/f47ac10b-58cc-4372-a567-0e02b2c3d479 \
  --header 'Authorization: Bearer {access_token}'

​

Example Response

{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "productId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "firstName": "Jane",
  "middleName": null,
  "lastName": "Smith",
  "fullName": "Jane Smith",
  "email": "[e-mail]",
  "mobilePhone": "[phone]",
  "dateOfBirth": "1990-07-15",
  "nationality": "US",
  "idType": "PASSPORT",
  "idNumber": "A12345678",
  "idCountry": "US",
  "pepStatus": "NO",
  "gender": null,
  "onboardingStatus": "ACTIVE",
  "onboardedInBanks": ["PORTAGE"],
  "addresses": [
    {
      "addressType": "RESIDENTIAL",
      "country": "US",
      "postalCode": "10001",
      "townName": "New York",
      "streetName": "5th Avenue",
      "buildingNumber": "350",
      "countrySubdivision": "NY"
    }
  ],
  "internalEndUserIdentifier": null,
  "internalEndUserActivity": null,
  "internalEndUserStartDate": null,
  "createdAt": "2024-06-01T12:00:00.000Z",
  "updatedAt": "2024-06-01T12:05:00.000Z"
}