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

objectOptional

and

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
Accept: */*

{
  "items": [
    {
      "id": "a2b9649e-df7f-4349-adff-1c57283fef10",
      "externalReference": "text",
      "firstName": "John",
      "middleName": "James",
      "lastName": "Doe",
      "email": "[email protected]",
      "address": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "STRUCTURED",
        "line1": "",
        "line2": "",
        "line3": "",
        "state": "TX",
        "postcode": "SW1A 2AB",
        "country": "GBR"
      },
      "dateOfBirth": "2026-03-09",
      "phoneNumber": "[phone]",
      "onboardingState": "IDLE",
      "createDate": "2026-03-09T19:16:14.832Z"
    }
  ],
  "meta": {
    "currentPage": 1,
    "itemCount": 10,
    "itemsPerPage": 10,
    "totalItems": 100,
    "totalPages": 10
  }
}

Update personal prospect partially

patch

Path parameters

prospectIdstringRequired

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

Body

application/json

firstNamestring · nullableOptionalExample: John

middleNamestring · nullableOptionalExample: James

lastNamestring · nullableOptionalExample: Doe

emailstring · nullableOptionalExample: [email protected]

addressone of · nullableOptional

or

dateOfBirthstring · date · nullableOptional

phoneNumberstring · nullableOptional

Phone number with no special characters or spaces

Example: [phone]

identificationNumberstring · nullableOptional

National Id Number, SSN or similar

Responses

200

Updates a personal prospect partially.

application/json

idstring · uuidRequired

Unique identifier of the account

Example: a2b9649e-df7f-4349-adff-1c57283fef10

externalReferencestring · nullableRequired

External unique reference on partners platform

firstNamestring · nullableRequiredExample: John

middleNamestring · nullableRequiredExample: James

lastNamestring · nullableRequiredExample: Doe

emailstringRequiredExample: [email protected]

addressone of · nullableOptional

or

dateOfBirthstring · date · nullableRequired

phoneNumberstring · nullableRequiredExample: [phone]

createDatestring · date-timeRequired

identificationNumberstring · nullableOptional

400

Input validation error

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

patch

/v1/partner/prospects/personal/{prospectId}

HTTPcURLJavaScriptPython

PATCH /v1/partner/prospects/personal/{prospectId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 285

{
  "firstName": "John",
  "middleName": "James",
  "lastName": "Doe",
  "email": "[email protected]",
  "address": {
    "type": "STRUCTURED",
    "line1": "",
    "line2": "",
    "line3": "",
    "state": "",
    "postcode": "SW1A 2AB",
    "country": "GBR"
  },
  "dateOfBirth": "2026-03-09",
  "phoneNumber": "[phone]",
  "identificationNumber": ""
}

{
  "id": "a2b9649e-df7f-4349-adff-1c57283fef10",
  "externalReference": "text",
  "firstName": "John",
  "middleName": "James",
  "lastName": "Doe",
  "email": "[email protected]",
  "address": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "STRUCTURED",
    "line1": "",
    "line2": "",
    "line3": "",
    "state": "TX",
    "postcode": "SW1A 2AB",
    "country": "GBR"
  },
  "dateOfBirth": "2026-03-09",
  "phoneNumber": "[phone]",
  "createDate": "2026-03-09T19:16:14.832Z",
  "identificationNumber": "",
  "onboardingStates": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "state": "IDLE",
      "createDate": "2026-03-09T19:16:14.832Z"
    }
  ],
  "dueDiligence": {
    "clear": true,
    "details": {
      "address": {
        "required": true,
        "valid": true
      },
      "antiImpersonation": {
        "required": true,
        "valid": true
      },
      "funds": {
        "required": true,
        "valid": true
      },
      "identity": {
        "required": true,
        "valid": true
      },
      "mediaScreening": {
        "required": true,
        "valid": true
      },
      "legalWarnings": {
        "required": true,
        "valid": true
      },
      "backgroundCheck": {
        "required": true,
        "valid": true
      },
      "sanctions": {
        "required": true,
        "valid": true
      }
    }
  }
}

Get personal prospect by id

get

Path parameters

prospectIdstringRequired

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 id.

application/json

idstring · uuidRequired

Unique identifier of the account

Example: a2b9649e-df7f-4349-adff-1c57283fef10

externalReferencestring · nullableRequired

External unique reference on partners platform

firstNamestring · nullableRequiredExample: John

middleNamestring · nullableRequiredExample: James

lastNamestring · nullableRequiredExample: Doe

emailstringRequiredExample: [email protected]

addressone of · nullableOptional

or

dateOfBirthstring · date · nullableRequired

phoneNumberstring · nullableRequiredExample: [phone]

createDatestring · date-timeRequired

identificationNumberstring · nullableOptional

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/{prospectId}

HTTPcURLJavaScriptPython

GET /v1/partner/prospects/personal/{prospectId} HTTP/1.1
Accept: */*

{
  "id": "a2b9649e-df7f-4349-adff-1c57283fef10",
  "externalReference": "text",
  "firstName": "John",
  "middleName": "James",
  "lastName": "Doe",
  "email": "[email protected]",
  "address": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "STRUCTURED",
    "line1": "",
    "line2": "",
    "line3": "",
    "state": "TX",
    "postcode": "SW1A 2AB",
    "country": "GBR"
  },
  "dateOfBirth": "2026-03-09",
  "phoneNumber": "[phone]",
  "createDate": "2026-03-09T19:16:14.832Z",
  "identificationNumber": "",
  "onboardingStates": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "state": "IDLE",
      "createDate": "2026-03-09T19:16:14.832Z"
    }
  ],
  "dueDiligence": {
    "clear": true,
    "details": {
      "address": {
        "required": true,
        "valid": true
      },
      "antiImpersonation": {
        "required": true,
        "valid": true
      },
      "funds": {
        "required": true,
        "valid": true
      },
      "identity": {
        "required": true,
        "valid": true
      },
      "mediaScreening": {
        "required": true,
        "valid": true
      },
      "legalWarnings": {
        "required": true,
        "valid": true
      },
      "backgroundCheck": {
        "required": true,
        "valid": true
      },
      "sanctions": {
        "required": true,
        "valid": true
      }
    }
  }
}

Get personal prospect by externalId

get

Path parameters

externalReferencestringRequired

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

idstring · uuidRequired

Unique identifier of the account

Example: a2b9649e-df7f-4349-adff-1c57283fef10

externalReferencestring · nullableRequired

External unique reference on partners platform

firstNamestring · nullableRequiredExample: John

middleNamestring · nullableRequiredExample: James

lastNamestring · nullableRequiredExample: Doe

emailstringRequiredExample: [email protected]

addressone of · nullableOptional

or

dateOfBirthstring · date · nullableRequired

phoneNumberstring · nullableRequiredExample: [phone]

createDatestring · date-timeRequired

identificationNumberstring · nullableOptional

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/externalReference/{externalReference}

HTTPcURLJavaScriptPython

GET /v1/partner/prospects/personal/externalReference/{externalReference} HTTP/1.1
Accept: */*

{
  "id": "a2b9649e-df7f-4349-adff-1c57283fef10",
  "externalReference": "text",
  "firstName": "John",
  "middleName": "James",
  "lastName": "Doe",
  "email": "[email protected]",
  "address": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "STRUCTURED",
    "line1": "",
    "line2": "",
    "line3": "",
    "state": "TX",
    "postcode": "SW1A 2AB",
    "country": "GBR"
  },
  "dateOfBirth": "2026-03-09",
  "phoneNumber": "[phone]",
  "createDate": "2026-03-09T19:16:14.832Z",
  "identificationNumber": "",
  "onboardingStates": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "state": "IDLE",
      "createDate": "2026-03-09T19:16:14.832Z"
    }
  ],
  "dueDiligence": {
    "clear": true,
    "details": {
      "address": {
        "required": true,
        "valid": true
      },
      "antiImpersonation": {
        "required": true,
        "valid": true
      },
      "funds": {
        "required": true,
        "valid": true
      },
      "identity": {
        "required": true,
        "valid": true
      },
      "mediaScreening": {
        "required": true,
        "valid": true
      },
      "legalWarnings": {
        "required": true,
        "valid": true
      },
      "backgroundCheck": {
        "required": true,
        "valid": true
      },
      "sanctions": {
        "required": true,
        "valid": true
      }
    }
  }
}