Compliance Checks

Upload evidence file

post

Path parameters

prospectIdstringRequired

externalEvidenceIdstringRequired

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

multipart/form-data

filestring · binaryOptional

Responses

201

Upload evidence file.

400

Input validation error

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

/v1/partner/prospects/personal/compliance/{prospectId}/upload-evidence/{externalEvidenceId}

HTTPcURLJavaScriptPython

POST /v1/partner/prospects/personal/compliance/{prospectId}/upload-evidence/{externalEvidenceId} HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

No content

Start compliance checks personal prospect

post

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

Responses

200

Start compliance checks for 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/compliance/{prospectId}/start-checks

HTTPcURLJavaScriptPython

POST /v1/partner/prospects/personal/compliance/{prospectId}/start-checks HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 5455

{
  "adverseMedia": {
    "verified": true,
    "processType": "MANUAL",
    "remarks": [
      "Prospective customer provided multiple bank statements as address proof from AAA Bank and BBB Financial institution",
      "The customer manually provided a passport scan after the automated check failed with the expired ID document"
    ],
    "properties": [
      {
        "key": "passport_number",
        "value": "ALG123456"
      }
    ],
    "evidence": [
      {
        "externalEvidenceId": "123456789",
        "type": "BILL",
        "providedBy": "CUSTOMER",
        "issuingCountry": "GBR",
        "side": "FRONT",
        "kind": "IMAGE"
      }
    ]
  },
  "antiImpersonation": {
    "verified": true,
    "processType": "MANUAL",
    "remarks": [
      "Prospective customer provided multiple bank statements as address proof from AAA Bank and BBB Financial institution",
      "The customer manually provided a passport scan after the automated check failed with the expired ID document"
    ],
    "properties": [
      {
        "key": "passport_number",
        "value": "ALG123456"
      }
    ],
    "evidence": [
      {
        "externalEvidenceId": "123456789",
        "type": "BILL",
        "providedBy": "CUSTOMER",
        "issuingCountry": "GBR",
        "side": "FRONT",
        "kind": "IMAGE"
      }
    ]
  },
  "countryOfResidence": {
    "verified": true,
    "processType": "MANUAL",
    "remarks": [
      "Prospective customer provided multiple bank statements as address proof from AAA Bank and BBB Financial institution",
      "The customer manually provided a passport scan after the automated check failed with the expired ID document"
    ],
    "properties": [
      {
        "key": "passport_number",
        "value": "ALG123456"
      }
    ],
    "evidence": [
      {
        "externalEvidenceId": "123456789",
        "type": "BILL",
        "providedBy": "CUSTOMER",
        "issuingCountry": "GBR",
        "side": "FRONT",
        "kind": "IMAGE"
      }
    ]
  },
  "idDocument": {
    "verified": true,
    "processType": "MANUAL",
    "remarks": [
      "Prospective customer provided multiple bank statements as address proof from AAA Bank and BBB Financial institution",
      "The customer manually provided a passport scan after the automated check failed with the expired ID document"
    ],
    "properties": [
      {
        "key": "passport_number",
        "value": "ALG123456"
      }
    ],
    "evidence": [
      {
        "externalEvidenceId": "123456789",
        "type": "BILL",
        "providedBy": "CUSTOMER",
        "issuingCountry": "GBR",
        "side": "FRONT",
        "kind": "IMAGE"
      }
    ]
  },
  "nationality": {
    "verified": true,
    "processType": "MANUAL",
    "remarks": [
      "Prospective customer provided multiple bank statements as address proof from AAA Bank and BBB Financial institution",
      "The customer manually provided a passport scan after the automated check failed with the expired ID document"
    ],
    "properties": [
      {
        "key": "passport_number",
        "value": "ALG123456"
      }
    ],
    "evidence": [
      {
        "externalEvidenceId": "123456789",
        "type": "BILL",
        "providedBy": "CUSTOMER",
        "issuingCountry": "GBR",
        "side": "FRONT",
        "kind": "IMAGE"
      }
    ]
  },
  "pep": {
    "verified": true,
    "processType": "MANUAL",
    "remarks": [
      "Prospective customer provided multiple bank statements as address proof from AAA Bank and BBB Financial institution",
      "The customer manually provided a passport scan after the automated check failed with the expired ID document"
    ],
    "properties": [
      {
        "key": "passport_number",
        "value": "ALG123456"
      }
    ],
    "evidence": [
      {
        "externalEvidenceId": "123456789",
        "type": "BILL",
        "providedBy": "CUSTOMER",
        "issuingCountry": "GBR",
        "side": "FRONT",
        "kind": "IMAGE"
      }
    ]
  },
  "placeOfBirth": {
    "verified": true,
    "processType": "MANUAL",
    "remarks": [
      "Prospective customer provided multiple bank statements as address proof from AAA Bank and BBB Financial institution",
      "The customer manually provided a passport scan after the automated check failed with the expired ID document"
    ],
    "properties": [
      {
        "key": "passport_number",
        "value": "ALG123456"
      }
    ],
    "evidence": [
      {
        "externalEvidenceId": "123456789",
        "type": "BILL",
        "providedBy": "CUSTOMER",
        "issuingCountry": "GBR",
        "side": "FRONT",
        "kind": "IMAGE"
      }
    ]
  },
  "legalWarnings": {
    "verified": true,
    "processType": "MANUAL",
    "remarks": [
      "Prospective customer provided multiple bank statements as address proof from AAA Bank and BBB Financial institution",
      "The customer manually provided a passport scan after the automated check failed with the expired ID document"
    ],
    "properties": [
      {
        "key": "passport_number",
        "value": "ALG123456"
      }
    ],
    "evidence": [
      {
        "externalEvidenceId": "123456789",
        "type": "BILL",
        "providedBy": "CUSTOMER",
        "issuingCountry": "GBR",
        "side": "FRONT",
        "kind": "IMAGE"
      }
    ]
  },
  "sanction": {
    "verified": true,
    "processType": "MANUAL",
    "remarks": [
      "Prospective customer provided multiple bank statements as address proof from AAA Bank and BBB Financial institution",
      "The customer manually provided a passport scan after the automated check failed with the expired ID document"
    ],
    "properties": [
      {
        "key": "passport_number",
        "value": "ALG123456"
      }
    ],
    "evidence": [
      {
        "externalEvidenceId": "123456789",
        "type": "BILL",
        "providedBy": "CUSTOMER",
        "issuingCountry": "GBR",
        "side": "FRONT",
        "kind": "IMAGE"
      }
    ]
  },
  "intelligence": {
    "verified": true,
    "processType": "MANUAL",
    "remarks": [
      "Prospective customer provided multiple bank statements as address proof from AAA Bank and BBB Financial institution",
      "The customer manually provided a passport scan after the automated check failed with the expired ID document"
    ],
    "properties": [
      {
        "key": "passport_number",
        "value": "ALG123456"
      }
    ],
    "evidence": [
      {
        "externalEvidenceId": "123456789",
        "type": "BILL",
        "providedBy": "CUSTOMER",
        "issuingCountry": "GBR",
        "side": "FRONT",
        "kind": "IMAGE"
      }
    ]
  },
  "nfd": {
    "verified": true,
    "processType": "MANUAL",
    "remarks": [
      "Prospective customer provided multiple bank statements as address proof from AAA Bank and BBB Financial institution",
      "The customer manually provided a passport scan after the automated check failed with the expired ID document"
    ],
    "properties": [
      {
        "key": "passport_number",
        "value": "ALG123456"
      }
    ],
    "evidence": [
      {
        "externalEvidenceId": "123456789",
        "type": "BILL",
        "providedBy": "CUSTOMER",
        "issuingCountry": "GBR",
        "side": "FRONT",
        "kind": "IMAGE"
      }
    ]
  }
}

{
  "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-09T13:40:41.897Z",
  "identificationNumber": "",
  "onboardingStates": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "state": "IDLE",
      "createDate": "2026-03-09T13:40:41.897Z"
    }
  ],
  "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
      }
    }
  }
}