Capabilities API

List capabilities

🚧 Beta feature

This feature is currently in beta testing, and the final specification may still change.

Retrieve a list of capabilities for an organization.

This API provides detailed insights into the specific requirements and status of each client's onboarding journey.

Capabilities are at the organization level, indicating if the organization can perform a given capability. Capabilities may have requirements, which provide more information on what is needed to use this capability. Requirements may have a due date, which indicates the date by which the requirement should be fulfilled. If a requirement is past due, the capability is disabled until the requirement is fulfilled.

For payments, regardless them being at the profile level, the capability is listed at the organization level. This means that if at least one of the clients's profiles can receive payments, the payments capability is enabled, communicating that the organization can indeed receive payments.

get/v2/capabilities

Headers

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Response

A list of capabilities.

Changes

Changed in 3 of the 78 revisions of this API.13

    • added the non-success response with the status

      response-non-success-status-added

    • the endpoint scheme security advancedAccessToken was added to the API

      api-security-added

    • the endpoint scheme security organizationAccessToken was removed from the API

      api-security-removed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new undefined enum value to the /// response property for the response status

      response-property-enum-value-added

Of the 78 revisions, 9 have no diff computed.