🚧 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.

{
  "count": 2,
  "_embedded": {
    "capabilities": [
      {
        "resource": "capability",
        "name": "payments",
        "status": "pending",
        "statusReason": "requirement-past-due",
        "requirements": [
          {
            "id": "needs-data",
            "status": "past-due",
            "dueDate": "2024-01-01T12:00:00+00:00",
            "_links": {
              "dashboard": {
                "href": "https://...",
                "type": "application/hal+json"
              }
            }
          }
        ]
      }
    ]
  },
  "_links": {
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}