getList enterprises

Required capabilityenterprises.list

Authentication: Send Authorization: Bearer <access_token>.

Inspect the enterprise perimeter already visible to the caller.

Lists enterprises under an enterprise_wildcard grant anchored at platform-operators/<id> for enterprises.list. Holding the capability on a narrower scope is insufficient and returns 403 forbidden_capability_scope. Each row includes first_access_method and iam_hosting; both are null when the onboarding record is absent or unavailable. Only platform staff can list, so rows always carry kyc_source, kyb_source and kyb_state_reason.

Parameters

Name Location Type Required Description and constraints
page_size query integer No Cursor pagination page size. The canonical contract accepts integers from 1 to 500. minimum: 1; maximum: 500; default: 100
page_token query string No Opaque cursor returned by a previous page.
admission_state query "admission_review" / "admitted" / "operational" / "restricted" / "offboarding" / "terminated" or "admission_review" / "admitted" / "operational" / "restricted" / "offboarding" / "terminated"[] No
restriction_state query "none" / "restricted" or "none" / "restricted"[] No
restriction_kind query "restricted" / "suspended" or "restricted" / "suspended"[] No
jurisdiction query string or string[] No Country of registration, ISO 3166-1 alpha-2.

Request

Request URL

GET
GET /enterprises

Responses

Response

application/json
{
  "items": [
    {
      "admission_state": "operational",
      "created_at": "2026-05-01T10:00:00Z",
      "default_master_account": "master-accounts/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
      "etag": "2026-05-01T10:00:00.000Z",
      "external_id": "ent-ext-0001",
      "first_access_method": "enterprise_idp",
      "iam_hosting": "platform",
      "id": "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
      "jurisdiction": "DE",
      "jurisdiction_selected": true,
      "kyb_source": "sumsub",
      "kyb_stage": "verified",
      "kyb_state": "verified",
      "kyb_state_reason": null,
      "kyb_state_updated_at": "2026-05-01T10:00:00.000Z",
      "kyc_source": null,
      "kyc_stage": null,
      "legal_form": "GmbH",
      "legal_name": "Acme Fintech GmbH",
      "metadata": {
        "hq_country": "DE",
        "industry": "fintech"
      },
      "resource": "enterprise",
      "restriction_kind": null,
      "restriction_reason": null,
      "restriction_state": "none",
      "terminated_at": null,
      "termination_reason": null,
      "updated_at": "2026-05-01T10:00:00.000Z"
    }
  ],
  "next_page_token": null
}

Operation succeeded.

Response 200 schema

Content type: application/json.

application/json body

Field Type Required Description and constraints
items object[] Yes
next_page_token string or null Yes

Additional fields are not accepted.

application/json body.items

Type: object[].

application/json body.items item
Field Type Required Description and constraints
admission_state "admission_review" / "admitted" / "operational" / "restricted" / "offboarding" / "terminated" Yes
created_at string Yes format: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
default_master_account string or null No
etag string Yes minLength: 1
external_id string or null No
first_access_method "magic_link" / "passkey_enrolment" / "enterprise_idp" or null Yes
iam_hosting "enterprise" / "platform" or null Yes
id string Yes format: uuid; pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
jurisdiction string Yes Country of registration, ISO 3166-1 alpha-2. pattern: ^[A-Z]{2}$; minLength: 2; maxLength: 2
jurisdiction_selected boolean Yes
kyb_source "bootstrap" / "sumsub" or null No Present only for callers with platform-wide enterprises.read authority; omitted for tenant callers.
kyb_stage "form_k_ready" / "verified" or null Yes
kyb_state "not_started" / "in_progress" / "submitted" / "in_review" / "resubmission_required" / "form_k_ready" / "verified" / "rejected" or null Yes
kyb_state_reason string or null No Present only for callers with platform-wide enterprises.read authority; omitted for tenant callers.
kyb_state_updated_at string or null Yes
kyc_source "bootstrap" / "sumsub" or null No Present only for callers with platform-wide enterprises.read authority; omitted for tenant callers.
kyc_stage "verified" or null Yes
legal_form string or null Yes
legal_name string Yes minLength: 1
metadata object or null No
resource "enterprise" Yes
restriction_kind "restricted" / "suspended" or null Yes
restriction_reason string or null Yes
restriction_state "none" / "restricted" Yes
terminated_at string or null Yes
termination_reason string or null Yes
updated_at string Yes format: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Additional fields are not accepted.

application/json body.items item.default_master_account

At least one alternative must match.

application/json body.items item.default_master_account: alternative 1

Type: string. pattern: ^(master-accounts)\/([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

application/json body.items item.default_master_account: alternative 2

Type: null.

application/json body.items item.external_id

At least one alternative must match.

application/json body.items item.external_id: alternative 1

Type: string.

application/json body.items item.external_id: alternative 2

Type: null.

application/json body.items item.first_access_method

At least one alternative must match.

application/json body.items item.first_access_method: alternative 1

Type: "magic_link" / "passkey_enrolment" / "enterprise_idp".

application/json body.items item.first_access_method: alternative 2

Type: null.

application/json body.items item.iam_hosting

At least one alternative must match.

application/json body.items item.iam_hosting: alternative 1

Type: "enterprise" / "platform".

application/json body.items item.iam_hosting: alternative 2

Type: null.

application/json body.items item.kyb_source

Present only for callers with platform-wide enterprises.read authority; omitted for tenant callers.

At least one alternative must match.

application/json body.items item.kyb_source: alternative 1

Type: "bootstrap" / "sumsub".

application/json body.items item.kyb_source: alternative 2

Type: null.

application/json body.items item.kyb_stage

At least one alternative must match.

application/json body.items item.kyb_stage: alternative 1

Type: "form_k_ready" / "verified".

application/json body.items item.kyb_stage: alternative 2

Type: null.

application/json body.items item.kyb_state

At least one alternative must match.

application/json body.items item.kyb_state: alternative 1

Type: "not_started" / "in_progress" / "submitted" / "in_review" / "resubmission_required" / "form_k_ready" / "verified" / "rejected".

application/json body.items item.kyb_state: alternative 2

Type: null.

application/json body.items item.kyb_state_reason

Present only for callers with platform-wide enterprises.read authority; omitted for tenant callers.

At least one alternative must match.

application/json body.items item.kyb_state_reason: alternative 1

Type: string.

application/json body.items item.kyb_state_reason: alternative 2

Type: null.

application/json body.items item.kyb_state_updated_at

At least one alternative must match.

application/json body.items item.kyb_state_updated_at: alternative 1

Type: string. format: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

application/json body.items item.kyb_state_updated_at: alternative 2

Type: null.

application/json body.items item.kyc_source

Present only for callers with platform-wide enterprises.read authority; omitted for tenant callers.

At least one alternative must match.

application/json body.items item.kyc_source: alternative 1

Type: "bootstrap" / "sumsub".

application/json body.items item.kyc_source: alternative 2

Type: null.

application/json body.items item.kyc_stage

At least one alternative must match.

application/json body.items item.kyc_stage: alternative 1

Type: "verified".

application/json body.items item.kyc_stage: alternative 2

Type: null.

application/json body.items item.legal_form

At least one alternative must match.

application/json body.items item.legal_form: alternative 1

Type: string. minLength: 1

application/json body.items item.legal_form: alternative 2

Type: null.

application/json body.items item.metadata

At least one alternative must match.

application/json body.items item.metadata: alternative 1

Type: object.

application/json body.items item.metadata: alternative 2

Type: null.

application/json body.items item.restriction_kind

At least one alternative must match.

application/json body.items item.restriction_kind: alternative 1

Type: "restricted" / "suspended".

application/json body.items item.restriction_kind: alternative 2

Type: null.

application/json body.items item.restriction_reason

At least one alternative must match.

application/json body.items item.restriction_reason: alternative 1

Type: string.

application/json body.items item.restriction_reason: alternative 2

Type: null.

application/json body.items item.terminated_at

At least one alternative must match.

application/json body.items item.terminated_at: alternative 1

Type: string. format: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

application/json body.items item.terminated_at: alternative 2

Type: null.

application/json body.items item.termination_reason

At least one alternative must match.

application/json body.items item.termination_reason: alternative 1

Type: string.

application/json body.items item.termination_reason: alternative 2

Type: null.

application/json body.next_page_token

At least one alternative must match.

application/json body.next_page_token: alternative 1

Type: string.

application/json body.next_page_token: alternative 2

Type: null.

Response 400 schema

Content type: application/json.

application/json body

Field Type Required Description and constraints
code string Yes
data object No No additional fields
details object No Additional fields allowed
message string Yes

Additional fields are not accepted.

application/json body.data
Field Type Required Description and constraints
acr_values string No RFC 9470 step-up challenge (insufficient_user_authentication).
blockers object[] No For closure_preconditions_not_met on a terminal lifecycle verb: what must be resolved before the transition.
code string No For legal refusals: the document code the refusal is about.
max_age string No RFC 9470 step-up challenge (insufficient_user_authentication).
max_source_amount object No For amount_below_minimum / amount_above_maximum: the product maximum in source asset units; null means no maximum. No additional fields
min_source_amount object No For amount_below_minimum / amount_above_maximum: the effective minimum in source asset units, fees included. No additional fields
published_version string No For document_version_superseded: the version currently published.
reason string No Typed refinement of code, from the failing service's contract.
resource string No Resource kind a resource_not_found refers to.
retry_after_ms integer No Suggested back-off in milliseconds for throttling or temporary unavailability; null means no delay is known. minimum: 0
source string No For not_admissible: the gate that denied (verification, lifecycle, policy, compliance).

Additional fields are not accepted.

application/json body.data.blockers

For closure_preconditions_not_met on a terminal lifecycle verb: what must be resolved before the transition.

Type: object[].

application/json body.data.blockers item
Field Type Required Description and constraints
description string Yes
type "non_zero_balance" / "active_sub_resources" / "pending_operations" / "active_users" / "active_service_accounts" / "active_role_assignments" Yes
assets object[] No minItems: 1
count integer No minimum: 0; maximum: 9007199254740991

Additional fields are not accepted.

application/json body.data.blockers item.assets

Type: object[]. minItems: 1

application/json body.data.blockers item.assets item
Field Type Required Description and constraints
asset string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
kind "balance" / "held" / "owed" / "unsettled" Yes

Additional fields are not accepted.

application/json body.data.max_source_amount

For amount_below_minimum / amount_above_maximum: the product maximum in source asset units; null means no maximum.

Field Type Required Description and constraints
currency string Yes
value string Yes

Additional fields are not accepted.

application/json body.data.min_source_amount

For amount_below_minimum / amount_above_maximum: the effective minimum in source asset units, fees included.

Field Type Required Description and constraints
currency string Yes
value string Yes

Additional fields are not accepted.

Response 401 schema

Content type: application/json.

application/json body

Field Type Required Description and constraints
code string Yes
data object No No additional fields
details object No Additional fields allowed
message string Yes

Additional fields are not accepted.

application/json body.data
Field Type Required Description and constraints
acr_values string No RFC 9470 step-up challenge (insufficient_user_authentication).
blockers object[] No For closure_preconditions_not_met on a terminal lifecycle verb: what must be resolved before the transition.
code string No For legal refusals: the document code the refusal is about.
max_age string No RFC 9470 step-up challenge (insufficient_user_authentication).
max_source_amount object or null No For amount_below_minimum / amount_above_maximum: the product maximum in source asset units; null means no maximum. No additional fields
min_source_amount object No For amount_below_minimum / amount_above_maximum: the effective minimum in source asset units, fees included. No additional fields
published_version string No For document_version_superseded: the version currently published.
reason string No Typed refinement of code, from the failing service's contract.
resource string No Resource kind a resource_not_found refers to.
retry_after_ms integer or null No Suggested back-off in milliseconds for throttling or temporary unavailability; null means no delay is known. minimum: 0
source string No For not_admissible: the gate that denied (verification, lifecycle, policy, compliance).

Additional fields are not accepted.

application/json body.data.blockers

For closure_preconditions_not_met on a terminal lifecycle verb: what must be resolved before the transition.

Type: object[].

application/json body.data.blockers item
Field Type Required Description and constraints
description string Yes
type "non_zero_balance" / "active_sub_resources" / "pending_operations" / "active_users" / "active_service_accounts" / "active_role_assignments" Yes
assets object[] No minItems: 1
count integer No minimum: 0; maximum: 9007199254740991

Additional fields are not accepted.

application/json body.data.blockers item.assets

Type: object[]. minItems: 1

application/json body.data.blockers item.assets item
Field Type Required Description and constraints
asset string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
kind "balance" / "held" / "owed" / "unsettled" Yes

Additional fields are not accepted.

application/json body.data.max_source_amount

For amount_below_minimum / amount_above_maximum: the product maximum in source asset units; null means no maximum.

Field Type Required Description and constraints
currency string Yes
value string Yes

Additional fields are not accepted.

application/json body.data.min_source_amount

For amount_below_minimum / amount_above_maximum: the effective minimum in source asset units, fees included.

Field Type Required Description and constraints
currency string Yes
value string Yes

Additional fields are not accepted.

Response 403 schema

Content type: application/json.

See response 401 schema.

Response 500 schema

Content type: application/json.

See response 401 schema.

Response 502 schema

Content type: application/json.

See response 400 schema.

Response 503 schema

Content type: application/json.

See response 400 schema.