v1

latestOpenAPI 3.1.0UNLICENSED2026-07-2613101.1 MB
Onboarding

List associated people

Returns a paginated list of associated people. Supports filtering by first name, last name, and email. Results are sorted by createdAt descending (newest first).

get/applications/associated-people

Query parameters

limitinteger

The maximum number of results to return.

Example:200
offsetinteger

The number of items to skip before returning results.

Example:100
searchstring

Search associated people by first name, last name, or email.

Example:John

Response

OK

limitinteger

The maximum number of results to return.

offsetinteger

The number of items to skip before returning results.

countinteger required

The total amount of records matching the querying when "limit" is ignored.

Example response

{
  "limit": 200,
  "offset": 100,
  "count": 67,
  "rows": [
    {
      "id": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
      "firstName": "John",
      "lastName": "Smith",
      "dateOfBirth": "1990-01-01",
      "emailAddress": "john.smith@example.com",
      "phoneNumber": "+447798121212",
      "nationalities": [
        "GB"
      ],
      "taxId": "123-45-678",
      "address": {
        "streetName": "Upper Thames Street",
        "buildingNumber": "68",
        "buildingName": "Vintners Place",
        "postcode": "EC4V 3BJ",
        "city": "London",
        "region": "Greater London",
        "countryCode": "GB"
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}