Managing Prospects

List personal prospects

get

Query parameters

searchKeywordstring | nullableOptional

Search in names and emails.

pagenumberRequired

Page number for paginated results.

Default: 1Example: 1

limitnumber · max: 100Required

Number of prospects per page.

Default: 10Example: 10

Header parameters

authorizationstringOptional

Authorization header containing your API Token

x-alg-noncestringOptional

Nonce used to generate the payload signature

x-alg-signaturestringOptional

Payload signature

datestringOptional

Date of the request un UTC/GMT

Responses

200

List of personal prospects available to the partner

application/json

400

Input validation error

application/json

403

Forbidden

application/json

get

/v1/partner/prospects/personal

HTTPcURLJavaScriptPython

GET /v1/partner/prospects/personal?page=1&limit=10 HTTP/1.1
Host: api-url
Accept: */*

{
  "items": [
    {
      "id": "a2b9649e-df7f-4349-adff-1c57283fef10",
      "partnerId": "2ecf0e23-3215-462c-97c4-9e5a147656d7",
      "externalId": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "John",
      "middleName": "James",
      "lastName": "Doe",
      "email": "[email protected]",
      "address": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "STRUCTURED",
        "line1": "",
        "line2": "",
        "line3": "",
        "postcode": "SW1A 2AB",
        "country": "GBR"
      },
      "dateOfBirth": "2025-12-26",
      "phoneNumber": "[phone]",
      "identificationNumber": "",
      "onboardingStates": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "state": "IDLE",
          "createDate": "2025-12-26T13:40:17.883Z"
        }
      ],
      "createDate": "2025-12-26T13:40:17.883Z"
    }
  ],
  "meta": {
    "currentPage": 1,
    "itemCount": 10,
    "itemsPerPage": 10,
    "totalItems": 100,
    "totalPages": 10
  }
}

Get personal prospect by externalId

get

Path parameters

externalIdstringRequired

Header parameters

authorizationstringOptional

Authorization header containing your API Token

x-alg-noncestringOptional

Nonce used to generate the payload signature

x-alg-signaturestringOptional

Payload signature

datestringOptional

Date of the request un UTC/GMT

Responses

200

Get personal prospects by externalId.

application/json

400

Input validation error

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Prospect not found

application/json

get

/v1/partner/prospects/personal/externalId/{externalId}

HTTPcURLJavaScriptPython

GET /v1/partner/prospects/personal/externalId/{externalId} HTTP/1.1
Host: api-url
Accept: */*

{
  "id": "a2b9649e-df7f-4349-adff-1c57283fef10",
  "partnerId": "2ecf0e23-3215-462c-97c4-9e5a147656d7",
  "externalId": "123e4567-e89b-12d3-a456-426614174000",
  "firstName": "John",
  "middleName": "James",
  "lastName": "Doe",
  "email": "[email protected]",
  "address": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "STRUCTURED",
    "line1": "",
    "line2": "",
    "line3": "",
    "postcode": "SW1A 2AB",
    "country": "GBR"
  },
  "dateOfBirth": "2025-12-26",
  "phoneNumber": "[phone]",
  "identificationNumber": "",
  "onboardingStates": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "state": "IDLE",
      "createDate": "2025-12-26T13:40:17.883Z"
    }
  ],
  "createDate": "2025-12-26T13:40:17.883Z"
}