increase-test
GET/entity_beneficial_owners

List beneficial owners

Lists beneficial owners associated with a corporation entity. Supply entity_id to select the corporation, and use cursor and limit to navigate the paginated results.

4 parameters
cursorstringoptional
Return the page of beneficial owners after this cursor.
limitintegeroptional
Maximum number of beneficial owners to return, from 1 to 100. Defaults to 100 when omitted.
Default:100
entity_idstringrequired
The identifier of the corporation entity whose beneficial owners to list.
idempotency_keystringoptional
Filter for the beneficial owner with this idempotency key. Must contain 1 to 200 characters.

3 status codes
200Returns a page of beneficial owner objects in `data` and a `next_cursor` for retrieving the next page, or null when there is no next page.
dataarray<BeneficialOwner>required
The contents of the list.
next_cursorstringrequired
A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.
4XXReturned when the request encounters a client-side error.
5XXReturned when the server encounters an error.

Error handling

The entity_id query parameter is required and must identify a corporation entity. The limit query parameter must be at least 1 and cannot exceed 100; it defaults to 100 when omitted. idempotency_key must contain 1 to 200 characters.