> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nxos.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get organization

> Retrieve the organization currently in scope.

Without `Nxos-On-Behalf-Of`, this returns your own organization. With
a valid `Nxos-On-Behalf-Of` header pointing at a customer org you hold
an active LOA on, this returns that customer org. See
[Cross-org access](https://docs.nxos.io/guides/cross-org-access).



## OpenAPI

````yaml GET /v1/organizations
openapi: 3.0.0
info:
  title: nxos API
  version: 1.0.0
  contact:
    name: nxos
    url: https://nxos.io
  description: |-
    The nxos platform API provides programmatic access to accounts, balances,
    quotes, and trades. All endpoints require API key authentication.
servers:
  - url: https://api.nxos.io
    description: Production
    variables: {}
  - url: https://api.sandbox.nxos.io
    description: Sandbox
    variables: {}
security: []
tags:
  - name: Accounts
  - name: Quotes
  - name: Beneficiaries
  - name: Fiat Payouts
  - name: Crypto Payouts
  - name: Nxosnet
  - name: Fees
  - name: Funding Methods
  - name: Transactions
  - name: Organizations
  - name: Authorizations
  - name: Webhooks
    description: >-
      Register an HTTPS endpoint to receive events (organization verification
      and

      transaction status changes) instead of polling. Deliveries are signed;
      verify

      the `svix-signature` header before acting on an event.


      See the [Webhooks guide](https://docs.nxos.io/core-concepts/webhooks) for
      the

      delivery format, signature verification, retries, and broker behavior.
      Payload

      shapes are documented in the `…Event` models below.
paths:
  /v1/organizations:
    get:
      tags:
        - Organizations
      description: |-
        Retrieve the organization currently in scope.

        Without `Nxos-On-Behalf-Of`, this returns your own organization. With
        a valid `Nxos-On-Behalf-Of` header pointing at a customer org you hold
        an active LOA on, this returns that customer org. See
        [Cross-org access](https://docs.nxos.io/guides/cross-org-access).
      operationId: Organizations_get
      parameters:
        - $ref: '#/components/parameters/ApiKeyAuth'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Access is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '429':
          description: Client error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error429'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
components:
  parameters:
    ApiKeyAuth:
      name: Authorization
      in: header
      required: true
      description: 'Bearer token. Format: `Bearer <api_key>`'
      schema:
        type: string
  schemas:
    Organization:
      type: object
      required:
        - object
        - organizationId
        - name
        - type
        - verificationStatus
        - createdByOrganizationId
        - metadata
        - createdAt
        - updatedAt
      properties:
        object:
          type: string
          enum:
            - organization
          description: Object type. Always `organization`.
        organizationId:
          type: string
          description: Unique organization identifier.
        name:
          type: string
          description: Display name of the organization.
        type:
          allOf:
            - $ref: '#/components/schemas/OrganizationType'
          description: Legal-entity type.
        verificationStatus:
          allOf:
            - $ref: '#/components/schemas/VerificationStatus'
          description: >-
            Current verification status. The org may transact only when this is
            `APPROVED`.
        createdByOrganizationId:
          type: string
          nullable: true
          description: >-
            Organization that created this one via the platform API. `null` for
            direct sign-ups (the org created itself through the dashboard).
        metadata:
          type: object
          additionalProperties: {}
          description: >-
            Caller-supplied metadata. Free-form JSON, max 4 KB serialized and 50
            keys.
        createdAt:
          allOf:
            - $ref: '#/components/schemas/dateTimeString'
          description: ISO 8601 timestamp when the org was created.
        updatedAt:
          allOf:
            - $ref: '#/components/schemas/dateTimeString'
          description: ISO 8601 timestamp of the most recent state change.
      description: An organization on the platform.
      example:
        object: organization
        organizationId: org_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
        name: Acme Trading Co.
        type: BUSINESS
        verificationStatus: APPROVED
        createdByOrganizationId: org_b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5
        metadata: {}
        createdAt: '2025-12-01T10:30:00.000Z'
        updatedAt: '2026-03-15T14:30:00.000Z'
    Error401:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      description: Standard error response returned by all endpoints on failure.
      example:
        error:
          code: missing_api_key
          message: No Authorization header provided.
          requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
    Error403:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      description: Standard error response returned by all endpoints on failure.
      example:
        error:
          code: forbidden
          message: Your organization is not enabled for this action.
          requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
    Error404:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      description: Standard error response returned by all endpoints on failure.
      example:
        error:
          code: not_found
          message: The requested resource was not found.
          requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
    Error429:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      description: Standard error response returned by all endpoints on failure.
      example:
        error:
          code: rate_limited
          message: 'Rate limit exceeded: 1000 requests per minute. Retry in 23 seconds.'
          requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
    Error500:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      description: Standard error response returned by all endpoints on failure.
      example:
        error:
          code: internal_error
          message: An unexpected server error occurred.
          requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
    OrganizationType:
      type: string
      enum:
        - BUSINESS
        - INDIVIDUAL
      description: >-
        Legal-entity type of an organization. Determines which verification flow
        applies (KYB for businesses, KYC for individuals).
    VerificationStatus:
      type: string
      enum:
        - NOT_STARTED
        - PENDING
        - APPROVED
        - REJECTED
        - ON_HOLD
        - RESUBMISSION_REQUIRED
      description: >-
        Lifecycle status of an organization's verification record.


        - `NOT_STARTED` — record exists but no session has been opened.

        - `PENDING` — applicant is mid-flow or under review.

        - `APPROVED` — passed; the org can transact, hold balances, and back
        active LOAs.

        - `REJECTED` — declined; the org cannot transact. Contact support to
        dispute.

        - `ON_HOLD` — pending manual compliance review on our side.

        - `RESUBMISSION_REQUIRED` — provider flagged a fixable problem (blurry
        document, wrong type, etc.). Re-call `POST
        /v1/organizations/verification` to resume.
    dateTimeString:
      type: string
      description: ISO 8601 timestamp string.
    ErrorBody:
      type: object
      required:
        - code
        - message
        - requestId
      properties:
        code:
          allOf:
            - $ref: '#/components/schemas/ErrorCode'
          description: Machine-readable error code.
        message:
          type: string
          description: Human-readable error message.
        requestId:
          type: string
          description: Unique identifier for this request, useful for debugging.
    ErrorCode:
      type: string
      enum:
        - missing_api_key
        - authentication_failed
        - invalid_api_key
        - forbidden
        - not_found
        - organization_not_found
        - account_not_found
        - quote_not_found
        - beneficiary_not_found
        - transaction_not_found
        - funding_method_not_found
        - authorization_not_found
        - nxosnet_handle_not_found
        - quote_expired
        - quote_already_used
        - beneficiary_already_archived
        - beneficiary_not_archived
        - beneficiary_blocked
        - nxosnet_not_enabled
        - nxosnet_handle_taken
        - chain_send_failed
        - idempotency_key_in_use
        - idempotency_request_in_flight
        - invalid_request
        - insufficient_funds
        - validation_error
        - share_token_invalid
        - verification_import_unsupported
        - rate_limited
        - webhooks_unavailable
        - internal_error
      description: All possible error codes returned by the API.

````