Creating Personal Prospects

Create personal prospect

post

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

externalIdstring · uuid | nullableOptional

External unique prospect identifier on partners platform

externalAccountIdstring · uuid | nullableOptional

External unique account identifier on partners platform

firstNamestringRequiredExample: John

middleNamestring | nullableOptionalExample: James

lastNamestringRequiredExample: Doe

emailstringRequiredExample: [email protected]

addressone of | nullableOptional

or

dateOfBirthstring · dateRequired

phoneNumberstringRequired

Phone number with no special characters or spaces

Example: [phone]

identificationNumberstring | nullableOptional

National Id Number, SSN or similar

Responses

200

Creates a personal prospect.

application/json

400

Input validation error

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

/v1/partner/prospects/personal

HTTPcURLJavaScriptPython

POST /v1/partner/prospects/personal HTTP/1.1
Host: api-url
Content-Type: application/json
Accept: */*
Content-Length: 385

{
  "externalId": "123e4567-e89b-12d3-a456-426614174000",
  "externalAccountId": "123e4567-e89b-12d3-a456-426614174000",
  "firstName": "John",
  "middleName": "James",
  "lastName": "Doe",
  "email": "[email protected]",
  "address": {
    "type": "STRUCTURED",
    "line1": "",
    "line2": "",
    "line3": "",
    "postcode": "SW1A 2AB",
    "country": "GBR"
  },
  "dateOfBirth": "2025-12-26",
  "phoneNumber": "[phone]",
  "identificationNumber": ""
}

{
  "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:21:58.146Z"
    }
  ],
  "createDate": "2025-12-26T13:21:58.146Z"
}