CHcheckout
Representatives

Get a sub-entity's representatives

Retrieve the representatives of one of your sub-entities, onboarded through our <a href="https://www.checkout.com/docs/platforms" target="_blank">Platforms solution</a>.

Representatives are the individuals disclosed against the sub-entity, such as its ultimate beneficial owners (UBOs), control person, and authorised signatories. If a change to them is under review, this endpoint returns the submitted list with a pending status by default, so you can retrieve a change you've already submitted.

To retrieve the representatives currently in effect while a change is under review, send GET /accounts/entities/{id}/representatives?status=active. To retrieve only a change under review, send GET /accounts/entities/{id}/representatives?status=pending.

get/accounts/entities/{id}/representatives

Request

Path parameters

idstring required

The sub-entity's ID.

Query parameters

status'active' | 'pending'

The version of the sub-entity's representatives to return. Selects which version the endpoint returns, rather than filtering the list.

Use active to retrieve the representatives currently in effect. This shows you the list a pending change would replace once approved.

Use pending to retrieve the list submitted in a change that is still under review. The request returns 404 if no change is under review.

If you omit this parameter and a change is under review, the endpoint returns the pending list. Otherwise, it returns the active list.

Response

Representatives retrieved successfully

status'active' | 'pending'

The status of the representatives. This describes the data in this response, not the sub-entity's own status.

active means the list is live. pending means a change has been submitted and is still under review, so the list shown is the one you submitted, not the one currently in effect.

Read-only on input. You can send a response body back unchanged in a PUT request, and this field is ignored.

Example response

{
  "status": "active",
  "representatives": [
    {
      "id": "rep_76f79595dbdf575d554e41e5aa",
      "roles": [
        "ubo",
        "control_person"
      ],
      "ownership_percentage": 60,
      "company_position": "ceo",
      "individual": {
        "first_name": "Toby",
        "last_name": "Arden",
        "email_address": "toby.arden@example.com",
        "date_of_birth": {
          "day": 15,
          "month": 1,
          "year": 1990
        },
        "place_of_birth": {
          "country": "US"
        },
        "citizenships": [
          {
            "type": "citizenship",
            "country": "US"
          }
        ],
        "national_id_type": "ssn",
        "national_id_number": "123456789",
        "phone": {
          "country_code": "US",
          "number": "4155678901"
        },
        "address": {
          "address_line1": "123 Anywhere St.",
          "address_line2": "Apt. 456",
          "city": "Anytown",
          "state": "AL",
          "zip": "12345",
          "country": "US"
        }
      }
    },
    {
      "id": "rep_3c1a0b9e4f7d2e8a6b5c4d3e2f",
      "roles": [
        "authorised_signatory"
      ],
      "individual": {
        "first_name": "Hannah",
        "last_name": "Bret",
        "email_address": "hannah.bret@example.com",
        "date_of_birth": {
          "day": 22,
          "month": 6,
          "year": 1985
        },
        "place_of_birth": {
          "country": "GB"
        },
        "citizenships": [
          {
            "type": "citizenship",
            "country": "GB"
          }
        ],
        "national_id_type": "passport",
        "national_id_number": "987654321",
        "phone": {
          "country_code": "US",
          "number": "4155671234"
        },
        "address": {
          "address_line1": "444 Test Avenue",
          "city": "Anytown",
          "state": "FL",
          "zip": "67890",
          "country": "US"
        }
      },
      "documents": {
        "identity_verification": {
          "type": "passport",
          "front": "file_5h6ss42ezvoufcb2beo76rv4fg"
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.