Sign in

v2

latestSwagger 2.02026-08-0610101.9 MB
Pooled account membership

List legal person in a pooled account membership

List legal persons in a pooled account membership

get/v0/bank/accounts/{bank-account-id}/membership

Path parameters

bank-account-idstring required

Query parameters

includestring[]

For each member returned, include its legal person details, latest verification (if one exists), and/or latest risk rating (if one exists) in the response under the included attribute.

page[size]integer
page[after]string byte

A base64 encoded opaque string returned in paginated responses.

page[before]string byte

A base64 encoded opaque string returned in paginated responses.

Response

OK

Example response

{
  "included": {
    "verifications": [
      {
        "verification-url": "/v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA",
        "verification-resources-url": "/v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA/resources",
        "workflow-url": "/v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA",
        "verification-checks-url": "/v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA/checks",
        "verification-risk-assessments-url": "/v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA/risk-assessments"
      }
    ],
    "risk-rating-entries": [
      {
        "risk-rating-url": "/v0/risk-ratings/rr.ICByaXNrLXJhdGluZy1pZA",
        "verification-url": "/v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA"
      }
    ],
    "legal-persons": [
      {
        "latest-decision": {
          "verification-url": "/v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA",
          "decision-user-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA",
          "decision-user-username": "user@example.com"
        },
        "latest-risk-rating-url": "/v0/risk-ratings/rr.ICByaXNrLXJhdGluZy1pZA"
      }
    ]
  }
}