---
title: List representatives
slug: andrei/list-representatives
createdAt: 2026-10-05T10:36:01.732Z
---

{
  "id": "upZXTZZeUozZpNQXL9khW",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api.detected.app/api/v2/public/representatives",
    "servers": [
      {
        "url": "https://api.detected.app/api/v2/public/representatives",
        "description": "Production"
      }
    ],
    "name": "List representatives",
    "description": "<p>Returns a list of representatives for your account. A representative can be a natural person or a legal entity, and may or may not be linked to a profile. The list includes representatives added through the portal or case management, and those converted from external data sources. Use the query parameters to filter the results.</p>\n<p>The representative types are: <code>director</code>, <code>identity</code>, <code>ownership</code>, <code>declaratory</code>, <code>principal</code>, <code>director_company</code>, <code>treasurer</code>, <code>secretary</code>, <code>syndicator</code>, <code>member</code>, <code>agent</code>, <code>designated_member</code>, <code>club_manager</code>, <code>authorised_representative</code>, <code>authorised_signatory</code>, <code>trustee_company</code>, <code>trustee</code>, <code>partner_company</code>, <code>partner</code>, <code>syndicate_manager</code>, <code>individual</code>, <code>lead_partner</code>, <code>shareholder</code>, <code>shareholder_company</code>, <code>shareholder_entity</code>.</p>\n<p>This endpoint is paginated. Use the <code>page</code> parameter to request further pages. The <code>meta</code> and <code>links</code> objects in the response describe the current page and link to the others.</p>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        }
      ],
      "queryParameters": [
        {
          "kind": "optional",
          "name": "order_by",
          "type": "string",
          "description": "<p>Direction to sort the results in: <code>asc</code> for ascending or <code>desc</code> for descending. Use it together with <code>sort_by</code>; it has no effect if <code>sort_by</code> is omitted. The default is <code>asc</code>.</p>",
          "enum": [
            "desc",
            "asc"
          ]
        },
        {
          "kind": "optional",
          "name": "sort_by",
          "type": "string",
          "description": "<p>The field to sort the results by. Use it together with <code>order_by</code> to choose the direction; if <code>order_by</code> is omitted, results are sorted in ascending order (<code>asc</code>). If <code>sort_by</code> is omitted, results are returned in no guaranteed order.</p>\n<p>Supported fields:</p>\n<ul>\n<li><code>created_at</code></li>\n<li><code>updated_at</code></li>\n<li><code>id</code></li>\n<li><code>email</code></li>\n<li><code>country</code></li>\n<li><code>types</code> (a single value or a comma-separated list, for example <code>principal,director</code>)</li>\n</ul>"
        },
        {
          "kind": "optional",
          "name": "page",
          "type": "string",
          "description": "<p>Page number of the results to return, starting from 1. The number of items per page is returned in <code>meta.per_page</code>.</p>"
        },
        {
          "kind": "optional",
          "name": "id",
          "type": "string",
          "description": "<p>Filter by representative UUID. If a match is found, only that representative is returned.</p>"
        },
        {
          "kind": "optional",
          "name": "is_company",
          "type": "string",
          "description": "<p>Filter by whether the representative is a legal entity (<code>true</code>) or a natural person (<code>false</code>).</p>"
        },
        {
          "kind": "optional",
          "name": "customer_reference",
          "type": "string",
          "description": "Filter by the customer reference that was set when the profile was created."
        },
        {
          "kind": "optional",
          "name": "profile_id",
          "type": "string",
          "description": "Filter by profile ID. Returns the representatives linked to that profile."
        },
        {
          "kind": "optional",
          "name": "email",
          "type": "string",
          "description": "Filter by email address."
        },
        {
          "kind": "optional",
          "name": "types",
          "type": "string",
          "description": "<p>Filter by representative type. To filter by more than one type, separate the types with commas, for example <code>principal,director</code>. A representative can have more than one type.</p>",
          "enum": [
            "director",
            "identity",
            "ownership",
            "declaratory",
            "principal",
            "director_company"
          ]
        }
      ],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "AccessToken",
          "name": "AccessToken",
          "kind": "optional",
          "type": "http",
          "description": "<p>The API uses OAuth 2.0. Request an access token from <code>POST /oauth/token</code> with the client ID and client secret of your integration client, and your account slug. Send the access token in the <code>Authorization</code> header of every request, in the format <code>Authorization: Bearer &#x3C;access_token></code>. The access token carries the scopes set on your integration client in the dashboard. Access tokens expire. When one expires, request a new one.</p>",
          "scheme": "bearer"
        }
      ],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "OK",
        "jsonExample": "",
        "isExpanded": true,
        "headers": [
          {
            "kind": "optional",
            "name": "X-RateLimit-Limit",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "X-RateLimit-Remaining",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "x-ratelimit-reset",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "retry-after",
            "description": ""
          }
        ],
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "schema": [
              {
                "name": "data",
                "kind": "optional",
                "type": "array",
                "description": "List of representatives",
                "modelRef": "#/components/schemas/RepresentativesResource",
                "customType": "RepresentativesResource[]",
                "schema": [
                  {
                    "name": "id",
                    "kind": "required",
                    "type": "string",
                    "description": "Representative UUID."
                  },
                  {
                    "name": "profile_id",
                    "kind": "required",
                    "type": "string",
                    "description": "ID of the profile the representative is linked to."
                  },
                  {
                    "name": "customer_reference",
                    "kind": "required",
                    "type": "string",
                    "description": "<p>The customer reference of the profile the representative belongs to, as set when the profile was created.</p>"
                  },
                  {
                    "name": "is_company",
                    "kind": "required",
                    "type": "boolean",
                    "description": "<p>Whether the representative is a legal entity (<code>true</code>) or a natural person (<code>false</code>).</p>"
                  },
                  {
                    "name": "review_status",
                    "kind": "optional",
                    "type": "object",
                    "description": "Review status of the representative.",
                    "example": "",
                    "schema": [
                      {
                        "name": "status",
                        "kind": "optional",
                        "type": "string<pending | needs_review | verified | rejected | fraud | additional_information | previously_verified>",
                        "description": "Current review status.",
                        "enum": [
                          "pending",
                          "needs_review",
                          "verified",
                          "rejected",
                          "fraud",
                          "additional_information",
                          "previously_verified"
                        ]
                      },
                      {
                        "name": "verified_at",
                        "kind": "optional",
                        "type": "string",
                        "description": "<p>Date and time the representative was verified, or <code>null</code> if they have not been verified.</p>"
                      },
                      {
                        "name": "updated_at",
                        "kind": "optional",
                        "type": "string",
                        "description": "Date and time the review status was last updated."
                      },
                      {
                        "name": "created_at",
                        "kind": "optional",
                        "type": "string",
                        "description": "Date and time the review status was created."
                      }
                    ]
                  },
                  {
                    "name": "types",
                    "kind": "required",
                    "type": "array",
                    "description": "Types assigned to the representative.",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  },
                  {
                    "name": "full_name",
                    "kind": "optional",
                    "type": "string",
                    "description": "<p>Full name of the representative, or the company/legal entity name.</p>"
                  },
                  {
                    "name": "title",
                    "kind": "optional",
                    "type": "string",
                    "description": "<p>Title of the representative, for example <code>Mr</code> or <code>Dr</code>.</p>"
                  },
                  {
                    "name": "professional_profile",
                    "kind": "optional",
                    "type": "string",
                    "description": "URL of the representative's professional profile."
                  },
                  {
                    "name": "country",
                    "kind": "optional",
                    "type": "string",
                    "description": "Name of the country of the address."
                  },
                  {
                    "name": "country_code",
                    "kind": "optional",
                    "type": "string",
                    "description": "<p>Country of the address, ISO 3166-1 alpha-2 country code.</p>"
                  },
                  {
                    "name": "country_of_residence",
                    "kind": "optional",
                    "type": "string",
                    "description": "Name of the country of residence."
                  },
                  {
                    "name": "residence_country_code",
                    "kind": "optional",
                    "type": "string",
                    "description": "<p>Country of residence, ISO 3166-1 alpha-2 country code.</p>"
                  },
                  {
                    "name": "personal_number",
                    "kind": "optional",
                    "type": "string",
                    "description": "Personal phone number."
                  },
                  {
                    "name": "first_name",
                    "kind": "optional",
                    "type": "string",
                    "description": "First name."
                  },
                  {
                    "name": "last_name",
                    "kind": "optional",
                    "type": "string",
                    "description": "Last name."
                  },
                  {
                    "name": "dob",
                    "kind": "optional",
                    "type": "string",
                    "description": "Date of birth."
                  },
                  {
                    "name": "email",
                    "kind": "optional",
                    "type": "string",
                    "description": "Email address of the representative."
                  },
                  {
                    "name": "job_title",
                    "kind": "optional",
                    "type": "string",
                    "description": "Job title."
                  },
                  {
                    "name": "apartment_number",
                    "kind": "optional",
                    "type": "string",
                    "description": "Apartment number."
                  },
                  {
                    "name": "address_1",
                    "kind": "optional",
                    "type": "string",
                    "description": "First line of the address."
                  },
                  {
                    "name": "address_2",
                    "kind": "optional",
                    "type": "string",
                    "description": "Second line of the address."
                  },
                  {
                    "name": "city",
                    "kind": "optional",
                    "type": "string",
                    "description": "City."
                  },
                  {
                    "name": "state",
                    "kind": "optional",
                    "type": "string",
                    "description": "State or region."
                  },
                  {
                    "name": "post_code",
                    "kind": "optional",
                    "type": "string",
                    "description": "Postcode."
                  },
                  {
                    "name": "country_of_birth",
                    "kind": "optional",
                    "type": "string",
                    "description": "Name of the country of birth."
                  },
                  {
                    "name": "birth_country_code",
                    "kind": "optional",
                    "type": "string",
                    "description": "<p>Country of birth, ISO 3166-1 alpha-2 country code.</p>"
                  },
                  {
                    "name": "nationality",
                    "kind": "optional",
                    "type": "string",
                    "description": "Nationality."
                  },
                  {
                    "name": "person_type_details",
                    "kind": "optional",
                    "type": "object",
                    "description": "<p>Extra details that depend on the representative's type, such as the appointment date or ownership percentage.</p>",
                    "example": "",
                    "schema": [
                      {
                        "name": "appointment_date",
                        "kind": "optional",
                        "type": "string",
                        "description": "Date the representative was appointed."
                      },
                      {
                        "name": "majority",
                        "kind": "optional",
                        "type": "boolean",
                        "description": "<p>Whether the representative's ownership meets the majority threshold given in <code>majority_percentage</code>.</p>"
                      },
                      {
                        "name": "governing",
                        "kind": "optional",
                        "type": "boolean",
                        "description": "Whether the representative has a governing role."
                      },
                      {
                        "name": "responsibility",
                        "kind": "optional",
                        "type": "boolean",
                        "description": "Whether the representative has significant responsibility."
                      },
                      {
                        "name": "majority_percentage",
                        "kind": "optional",
                        "type": "string",
                        "description": "<p>The majority ownership threshold percentage, taken from the portal configuration.</p>"
                      },
                      {
                        "name": "specific_ownership_percentage",
                        "kind": "optional",
                        "type": "string",
                        "description": "Percentage of the company owned by the representative."
                      }
                    ]
                  },
                  {
                    "name": "copy_address",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "<p>Whether the trading address is the same as the registered address. Only set for <code>director_company</code> representatives.</p>"
                  },
                  {
                    "name": "updated_at",
                    "kind": "optional",
                    "type": "string",
                    "description": "Date and time the representative was last updated."
                  },
                  {
                    "name": "created_at",
                    "kind": "optional",
                    "type": "string",
                    "description": "Date and time the representative was created."
                  },
                  {
                    "name": "screenings",
                    "kind": "optional",
                    "type": "object",
                    "description": "AML screening results for the representative.",
                    "example": "",
                    "schema": [
                      {
                        "name": "details",
                        "kind": "optional",
                        "type": "object",
                        "description": "Details of the screening search that was performed.",
                        "example": "",
                        "schema": [
                          {
                            "name": "provider",
                            "kind": "optional",
                            "type": "string<ion_group | comply_advantage | lseg_zfs>",
                            "description": "Screening provider the search was performed with.",
                            "enum": [
                              "ion_group",
                              "comply_advantage",
                              "lseg_zfs"
                            ]
                          },
                          {
                            "name": "performed_at",
                            "kind": "optional",
                            "type": "string",
                            "description": "Date the screening was performed."
                          },
                          {
                            "name": "search_term",
                            "kind": "optional",
                            "type": "string",
                            "description": "Term the representative was searched with against the provider."
                          },
                          {
                            "name": "search_payload",
                            "kind": "optional",
                            "type": "object",
                            "description": "<p>Search request sent to the provider; its shape is provider-specific.</p>",
                            "example": "",
                            "schema": []
                          },
                          {
                            "name": "is_monitored",
                            "kind": "optional",
                            "type": "boolean",
                            "description": "Whether the representative is enrolled in ongoing monitoring with the provider."
                          }
                        ]
                      },
                      {
                        "name": "screenings",
                        "kind": "optional",
                        "type": "array",
                        "description": "List of screening matches returned by the provider.",
                        "example": "",
                        "itemType": "object",
                        "customType": "object[]",
                        "itemExample": "",
                        "itemDefault": ""
                      }
                    ]
                  }
                ]
              },
              {
                "name": "links",
                "kind": "optional",
                "type": "object",
                "description": "",
                "modelRef": "#/components/schemas/LinksResource",
                "customType": "LinksResource",
                "schema": [
                  {
                    "name": "first",
                    "kind": "optional",
                    "type": "string",
                    "description": "URL of the first page of results."
                  },
                  {
                    "name": "last",
                    "kind": "optional",
                    "type": "string",
                    "description": "URL of the last page of results."
                  },
                  {
                    "name": "prev",
                    "kind": "optional",
                    "type": "string",
                    "description": "<p>URL of the previous page of results, or null if there is none.</p>"
                  },
                  {
                    "name": "next",
                    "kind": "optional",
                    "type": "string",
                    "description": "<p>URL of the next page of results, or null if there is none.</p>"
                  }
                ]
              },
              {
                "name": "meta",
                "kind": "optional",
                "type": "object",
                "description": "",
                "modelRef": "#/components/schemas/MetaResource",
                "customType": "MetaResource",
                "schema": [
                  {
                    "name": "current_page",
                    "kind": "optional",
                    "type": "number",
                    "description": "Number of the current page."
                  },
                  {
                    "name": "from",
                    "kind": "optional",
                    "type": "number",
                    "description": "<p>Position of the first item on this page, counted across all pages.</p>"
                  },
                  {
                    "name": "last_page",
                    "kind": "optional",
                    "type": "number",
                    "description": "Number of the last page."
                  },
                  {
                    "name": "links",
                    "kind": "optional",
                    "type": "array",
                    "description": "<p>Pagination links, including links to the previous and next pages.</p>",
                    "example": "",
                    "itemType": "object",
                    "customType": "object[]",
                    "schema": [
                      {
                        "name": "url",
                        "kind": "optional",
                        "type": "string",
                        "description": "<p>URL of the page, or <code>null</code> if there is no such page.</p>"
                      },
                      {
                        "name": "label",
                        "kind": "optional",
                        "type": "string",
                        "description": "<p>Text to display for the link, for example a page number or \"Previous\".</p>"
                      },
                      {
                        "name": "active",
                        "kind": "optional",
                        "type": "boolean",
                        "description": "Whether this link is for the current page."
                      }
                    ]
                  },
                  {
                    "name": "path",
                    "kind": "optional",
                    "type": "string",
                    "description": "<p>Base URL of the endpoint, without query parameters.</p>"
                  },
                  {
                    "name": "per_page",
                    "kind": "optional",
                    "type": "number",
                    "description": "Number of items per page."
                  },
                  {
                    "name": "to",
                    "kind": "optional",
                    "type": "number",
                    "description": "<p>Position of the last item on this page, counted across all pages.</p>"
                  },
                  {
                    "name": "total",
                    "kind": "optional",
                    "type": "number",
                    "description": "Total number of items across all pages."
                  }
                ]
              }
            ],
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "401",
        "description": "<p>Unauthorized. The access token is missing, invalid or has expired.</p>",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "schema": [
              {
                "name": "message",
                "kind": "optional",
                "type": "string",
                "description": "<p>A human-readable description of the error.</p>"
              }
            ],
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "429",
        "description": "<p>Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the <code>Retry-After</code> header before trying again.</p>",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "schema": [
              {
                "name": "message",
                "kind": "optional",
                "type": "string",
                "description": "<p>A human-readable description of the error.</p>"
              }
            ],
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "example-0-curl",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://api.detected.app/api/v2/public/representatives \\\n     --header 'accept: application/json'"
        },
        {
          "id": "example-1-javascript",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.detected.app/api/v2/public/representatives\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "example-2-ruby",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.detected.app/api/v2/public/representatives\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "example-3-python",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.detected.app/api/v2/public/representatives\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "example-0-curl"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-200",
          "language": "200",
          "code": "// OK\n{\n  \"data\": [\n    {\n      \"id\": \"\",\n      \"profile_id\": \"\",\n      \"customer_reference\": \"\",\n      \"is_company\": false,\n      \"review_status\": {\n        \"status\": \"\",\n        \"verified_at\": \"\",\n        \"updated_at\": \"\",\n        \"created_at\": \"\"\n      },\n      \"types\": [\n        \"\"\n      ],\n      \"full_name\": \"\",\n      \"title\": \"\",\n      \"professional_profile\": \"\",\n      \"country\": \"\",\n      \"country_code\": \"\",\n      \"country_of_residence\": \"\",\n      \"residence_country_code\": \"\",\n      \"personal_number\": \"\",\n      \"first_name\": \"\",\n      \"last_name\": \"\",\n      \"dob\": \"\",\n      \"email\": \"\",\n      \"job_title\": \"\",\n      \"apartment_number\": \"\",\n      \"address_1\": \"\",\n      \"address_2\": \"\",\n      \"city\": \"\",\n      \"state\": \"\",\n      \"post_code\": \"\",\n      \"country_of_birth\": \"\",\n      \"birth_country_code\": \"\",\n      \"nationality\": \"\",\n      \"person_type_details\": {\n        \"appointment_date\": \"\",\n        \"majority\": false,\n        \"governing\": false,\n        \"responsibility\": false,\n        \"majority_percentage\": \"\",\n        \"specific_ownership_percentage\": \"\"\n      },\n      \"copy_address\": false,\n      \"updated_at\": \"\",\n      \"created_at\": \"\",\n      \"screenings\": {\n        \"details\": {\n          \"provider\": \"\",\n          \"performed_at\": \"\",\n          \"search_term\": \"\",\n          \"search_payload\": {},\n          \"is_monitored\": false\n        },\n        \"screenings\": [\n          {}\n        ]\n      }\n    }\n  ],\n  \"links\": {\n    \"first\": \"\",\n    \"last\": \"\",\n    \"prev\": \"\",\n    \"next\": \"\"\n  },\n  \"meta\": {\n    \"current_page\": 0,\n    \"from\": 0,\n    \"last_page\": 0,\n    \"links\": [\n      {\n        \"url\": \"\",\n        \"label\": \"\",\n        \"active\": false\n      }\n    ],\n    \"path\": \"\",\n    \"per_page\": 0,\n    \"to\": 0,\n    \"total\": 0\n  }\n}"
        },
        {
          "id": "response-1-401",
          "language": "401",
          "code": "// Unauthorized. The access token is missing, invalid or has expired.\n{\n  \"message\": \"\"\n}"
        },
        {
          "id": "response-2-429",
          "language": "429",
          "code": "// Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the Retry-After header before trying again.\n{\n  \"message\": \"\"\n}"
        }
      ],
      "selectedLanguageId": "response-0-200"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}