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

externalReferencestring · uuid · nullableOptional

External unique prospect reference on partners platform

externalAccountReferencestring · uuid · nullableOptional

External unique account reference on partners platform

firstNamestringOptionalExample: John

middleNamestring · nullableOptionalExample: James

lastNamestringOptionalExample: Doe

emailstringRequiredExample: [email protected]

addressone of · nullableOptional

or

dateOfBirthstring · dateOptional

phoneNumberstringOptional

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

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

post

/v1/partner/prospects/personal

HTTPcURLJavaScriptPython

POST /v1/partner/prospects/personal HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 410

{
  "externalReference": "123e4567-e89b-12d3-a456-426614174000",
  "externalAccountReference": "123e4567-e89b-12d3-a456-426614174000",
  "firstName": "John",
  "middleName": "James",
  "lastName": "Doe",
  "email": "[email protected]",
  "address": {
    "type": "STRUCTURED",
    "line1": "",
    "line2": "",
    "line3": "",
    "state": "",
    "postcode": "SW1A 2AB",
    "country": "GBR"
  },
  "dateOfBirth": "2026-03-10",
  "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-10",
  "phoneNumber": "[phone]",
  "createDate": "2026-03-10T00:05:07.675Z",
  "identificationNumber": "",
  "onboardingStates": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "state": "IDLE",
      "createDate": "2026-03-10T00:05:07.675Z"
    }
  ],
  "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
      }
    }
  }
}