--- title: "Get a sub-entity's representatives" method: GET path: "/accounts/entities/{id}/representatives" tags: ["Representatives"] --- # Get a sub-entity's representatives `GET /accounts/entities/{id}/representatives` ## Request - Base URL: `https://{prefix}.api.sandbox.checkout.com` - URL: `https://{prefix}.api.sandbox.checkout.com/accounts/entities/{id}/representatives` - Auth: one of: - OAuth 2 - Client credentials - Token URL: `string` scopes: `accounts` - API key in header `Authorization` - TypeScript: (a function with typed inputs; its response is checked against the schema) Retrieve the representatives of one of your sub-entities, onboarded through our Platforms solution. 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`. ## Path parameters - `id` string, required ## Query parameters - `status` 'active' | 'pending' ## Response `200` Representatives retrieved successfully - SubEntityRepresentatives: The representatives of a sub-entity. Only individuals are supported. - `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. - `representatives` object[], required: The complete list of the sub-entity's representatives. When you submit a change, any current representative you leave out of this list is removed. - `id` string: The representative's unique identifier. Include the `id` to keep or update an existing representative. Leave it out to add a new representative, and an `id` is assigned when you submit the change. - `roles` string[], required: The individual's roles within the company. - `ownership_percentage` integer: The representative's percentage ownership of the company. Provide for representatives with the `ubo` role. - `company_position` 'ceo' | 'cfo' | 'coo' | 'managing_member' | 'general_partner' | 'president' | 'vice_president' | 'treasurer' | 'other_senior_management' | 'other_executive_officer' | 'other_non_executive_non_senior': The representative's position within the company. Provide for representatives with the `control_person` role. - `individual` object, required: The representative's personal details. - `first_name` string, required: The representative's first name. - `middle_name` string: The representative's middle name. Provide if it appears in official documents. - `last_name` string, required: The representative's last name. - `email_address` string, email, required: The representative's email address. - `date_of_birth` object, required: The representative's date of birth according to the Gregorian calendar. Cannot be changed for an existing representative. Include it unchanged when you keep or update the representative. To correct it, remove the representative and add them again without an `id`. - `day` integer, required: The calendar day of the month they were born. - `month` integer, required: The month of the year they were born. - `year` integer, required: The year they were born. - `address` object, required: The representative's residential address. - `address_line1` string, required: The first line of the address. - `address_line2` string: The second line of the address. - `city` string, required: The address city. - `state` string: The address state. For US addresses, provide the two-letter ISO 3166-2 code. - `zip` string, required: The address ZIP code or postal code. - `country` string, iso-3166-1-alpha-2, required: The two-letter ISO 3166-1 alpha-2 country code. For more information, see Country codes. - `place_of_birth` object, required: The representative's place of birth. - `country` string, iso-3166-1-alpha-2, required: The two-letter ISO 3166-1 alpha-2 country code. Cannot be changed for an existing representative. Include it unchanged when you keep or update the representative. To correct it, remove the representative and add them again without an `id`. - `citizenships` object[], required: The representative's citizenships or legal statuses. If the representative is a US citizen, `national_id_type` must be `ssn` or `itin`. If they are not a US citizen, provide `documents.identity_verification`. - `type` string: The type of citizenship or legal status. For example, `citizenship` or `residency`. - `country` string, iso-3166-1-alpha-2, required: The two-letter ISO 3166-1 alpha-2 country code. - `national_id_type` 'ssn' | 'itin' | 'passport' | 'driving_license' | 'national_id_card' | 'residence_permit' | 'other', required: The type of national identification number provided. Must be `ssn` or `itin` for US citizens. - `national_id_number` string, required: When `national_id_type` is `ssn` or `itin`, provide the SSN or ITIN. Otherwise, provide the identifier from the chosen document type. - `phone` object, required: The representative's phone number. - `country_code` string, iso-3166-1-alpha-2, required: The two-letter ISO 3166-1 alpha-2 country code where the phone number is registered. - `number` string, required: The phone number, without the country calling code. - `documents` object: The representative's verification documents. - `identity_verification` object: The document used to confirm the representative's identity. Provide if the representative isn't a US citizen. - `type` 'passport' | 'national_identity_card' | 'driving_license' | 'citizen_card' | 'residence_permit' | 'electoral_id', required: The type of document used for identity verification. - `front` string, required: The ID of the front side of the document. - `back` string: The ID of the back side of the document. - `certified_authorised_signatory` object: A power of attorney for a representative with the `authorised_signatory` role. Optional. - `type` 'power_of_attorney', required: The type of document. - `front` string, required: The ID of the front side of the document. ## Other responses - `401`: Unauthorized - `404`: Sub-entity not found or not yet onboarded, or no change is under review when you request `status=pending` - `422`: Invalid data sent - `429`: Too many requests --- [API](https://skmtc.dev/checkout/apis/checkout-com-api-reference.md) - [All operations](https://skmtc.dev/checkout/apis/checkout-com-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/checkout/apis/checkout-com-api-reference/revisions/0f1abdb1c3e9?raw)