v2

latestSwagger 2.02026-08-0610101.9 MB

Organizations

Get organization

Yields the organization details

get/v0/organizations/{organization-id}

Path parameters

organization-idstring required

Response

organization-mode'test-mode' | 'live-mode' required

The organization can either be a sandbox organization or a live one; Check out our guide for sandbox mode vs live mode.

organization-memberships-urlstring required

Link to the memberships for this organization.

organization-invitations-urlstring required

Link to the resource that enables you to invite new users to this organization.

organization-onboarding-applications-urlstring

Link to the Reliance onboarding.

display-namestring required

The mutable display name for the Organisation

organization-api-keys-urlstring required

organization-live-access-urlstring required

Link to the resource that enables you to request live access.

organization-webhooks-urlstring required

Link to the endpoint which enables webhook creation.

organization-workflows-urlstring required

Link to the onboarding workflows configured for this organization.

organization-bank-accounts-urlstring required

Link to the bank accounts managed by this organization.

organization-urlstring required

Link to the organization.

organization-individuals-urlstring required

organization-corporations-urlstring required

organization-legal-persons-urlstring required

Link to the legal persons grouped under this organization.

organization-legal-persons-search-urlstring required

Link to search legal persons grouped under this organization.

organization-events-urlstring required

Link to the endpoint which lists an organization's events.

Example response

{
  "organization-memberships-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/memberships",
  "organization-invitations-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/invitations",
  "organization-onboarding-applications-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/onboarding/applications",
  "display-name": "Company Org",
  "organization-api-keys-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/api-keys",
  "organization-live-access-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/live-access",
  "organization-webhooks-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/webhooks",
  "organization-workflows-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/workflows",
  "organization-bank-accounts-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts",
  "available-roles": [
    {
      "display-name": "Company Org"
    }
  ],
  "organization-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA",
  "organization-individuals-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/individuals",
  "organization-corporations-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/corporations",
  "organization-legal-persons-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/legal-persons",
  "organization-legal-persons-search-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/legal-persons/search",
  "organization-events-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/events"
}