The representatives endpoint allows you to search for individuals, who may or may not be associated with existing profiles. The results include both natural persons and legal entities, which may, in some cases, represent a company rather than an individual.

This includes individuals or legal entities added via the portal, case management, or converted from external data sources.

Currently, the following types of individuals are supported:

<h3>Introduction</h3>
The representatives endpoint allows you to search for individuals, who may or may not be associated with existing profiles. The results include both natural persons and legal entities, which may, in some cases, represent a company rather than an individual.

This includes individuals or legal entities added via the portal, case management, or converted from external data sources.
Currently, the following types of individuals are supported:
<ol>
<li><code>director</code></li>
<li><code>identity</code></li>
<li><code>ownership</code></li>
<li><code>declaratory</code></li>
<li><code>principal</code></li>
<li><code>director_company</code></li>
</ol>
<h3>Pagination</h3>
This endpoint is paginated.

Retrieve associated representatives to the current account

Authorization

Order results in ascending (<code>asc</code>) or descending (<code>desc</code>) order. This parameter only works when <code>sort_by</code> is specified.

order_by

The <code>sort_by</code> parameter allows you to specify most fields to sort the results in either ascending (<code>asc</code>) or descending (<code>desc</code>) order.

This parameter works in conjunction with <code>order_by</code>. If <code>order_by</code> is not specified, the default sorting order is ascending (<code>asc</code>).
Currently, we support these fields:
<ol>
<li><code>created_at</code></li>
<li><code>updated_at</code></li>
<li><code>id</code></li>
<li><code>email</code></li>
<li><code>country</code></li>
<li><code>types</code>, this can be a single value or a comma separated list e.g <code>principal,director</code></li>
</ol>

sort_by

page

The <code>id</code> parameter filters by an internal <code>id</code>. If a match is found, the response will return a single result.

The <code>is_company</code> parameter allows you to filter for individuals who are legal entities rather than natural persons.

is_company

Filter by <code>customer_reference</code>. If provided and valid, the response will return a single result.

customer_reference

The <code>profile_id</code> parameter allows to filter people by their assigned profile/case

profile_id

email

The <code>type</code> parameter allows you to filter people based on their assigned types. Note that some individuals may have multiple types assigned to them.