Skip to main content
GET
cURL

Headers

Authorization
string
required

Bearer token. Format: Bearer <api_key>

Response

The request has succeeded.

An organization on the platform.

object
enum<string>
required

Object type. Always organization.

Available options:
organization
organizationId
string
required

Unique organization identifier.

name
string
required

Display name of the organization.

type
enum<string>
required

Legal-entity type.

Available options:
BUSINESS,
INDIVIDUAL
verificationStatus
enum<string>
required

Current verification status. The org may transact only when this is APPROVED.

Available options:
NOT_STARTED,
PENDING,
APPROVED,
REJECTED,
ON_HOLD,
RESUBMISSION_REQUIRED
createdByOrganizationId
string | null
required

Organization that created this one via the platform API. null for direct sign-ups (the org created itself through the dashboard).

metadata
object
required

Caller-supplied metadata. Free-form JSON, max 4 KB serialized and 50 keys.

createdAt
string
required

ISO 8601 timestamp when the org was created.

updatedAt
string
required

ISO 8601 timestamp of the most recent state change.

subOrgTier
object | null
required

Sub-org tier this organization is on, or null when it is on none. Set via PUT /v1/organizations/sub-org-tier.

referrerShareBps is present only when a broker reads one of its clients through Nxos-On-Behalf-Of. Reading your own organization omits it: the share your referrer earns is a term of their agreement with us, not yours.