Get Organization End User by ID

GET /v1/end-users/organizations/ — Retrieves a single organization end user by UUID. Requires end-users:read scope.

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

​

Endpoint

GET /v1/end-users/organizations/{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 organization end user to retrieve. This is the id returned when the organization was created.

​

Response

Returns 200 OK with the organization end user object.

id · string

Diameter-assigned UUID v4 for this organization.

productId · string

UUID of the associated product.

fullName · string

Full legal name of the organization.

doingBusinessAs · string

DBA or trade name.

businessIndustry · string

Industry description as submitted.

businessEntityType · string

Legal entity type (e.g. CORPORATION, LLC).

formationDate · string

Formation date in YYYY-MM-DD format.

incorporationCountry · string

ISO 3166-1 alpha-2 country code of incorporation.

incorporationState · string

State of incorporation, if provided.

idType · string

Business identification document type.

idNumber · string

Business identification number.

email · string

Organization’s primary contact email.

mobilePhone · string

Organization’s primary contact phone in E.164 format.

pepStatus · string

PEP status: YES or NO.

website · string

Organization’s website, if provided.

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 including the primaryAddress and optional mailingAddress submitted at creation.

internalEndUserIdentifier · string

Your internal identifier for this organization, if provided.

internalEndUserActivity · integer

Internal activity code, if provided.

internalEndUserStartDate · string

Internal start date, if provided.

createdAt · string

ISO 8601 timestamp of when the organization 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/organizations/3fa85f64-5717-4562-b3fc-2c963f66afa6 \
  --header 'Authorization: Bearer {access_token}'

​

Example Response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "productId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "fullName": "Acme Technologies Inc.",
  "doingBusinessAs": "Acme Tech",
  "businessIndustry": "Computer Systems Design (NAICS 541512)",
  "businessEntityType": "CORPORATION",
  "formationDate": "2010-03-22",
  "incorporationCountry": "US",
  "incorporationState": "DE",
  "idType": "EIN",
  "idNumber": "12-3456789",
  "email": "[e-mail]",
  "mobilePhone": "[phone]",
  "pepStatus": "NO",
  "website": "https://acmetech.com",
  "onboardingStatus": "ACTIVE",
  "onboardedInBanks": ["PORTAGE"],
  "addresses": [
    {
      "addressType": "BUSINESS",
      "country": "US",
      "postalCode": "19801",
      "townName": "Wilmington",
      "streetName": "Market Street",
      "buildingNumber": "100",
      "countrySubdivision": "DE"
    }
  ],
  "internalEndUserIdentifier": null,
  "internalEndUserActivity": null,
  "internalEndUserStartDate": null,
  "createdAt": "2024-06-01T14:30:00.000Z",
  "updatedAt": "2024-06-01T14:35:00.000Z"
}