New service | Last updated: 14 May 2025

Important

This documentation is for preview purposes only.

Testing

Test your integration in the Try environment by using the address2 field to trigger different outcomes for the identity verification process.

Input these magic values to simulate the following outcomes:

Identity Verification stateMagic valueResult description
startedstartedThe identity verification process was is initiated.
startedActionstartedActionOne or more mandatory fields are missing. Further information is required from the party, in order for the identity verification process to resume.
pendingpendingThe identity verification is in progress. The status will change once the validation has completed.
pendingStepUpActionpendingStepUpActionThe identity verification process pending user action (upload scanned document or perform a liveliness selfie).
pendingManualReviewpendingManualReviewThe identity verification process is pending manual review (no user action needed).
verifiedverifiedThe identity verification process has completed successfully and the party's identity is now verified.
rejectedrejectedThe identity verification process has failed and the party's identity is not verified successfully.

Example payload

Example request

{
    "merchant": {
      "entity": "default"
},
    "partyReference": "5htNU0XQ7V",
    "partyType": "beneficiary",
    "type": "person",
    "personalDetails": {
      "title": "Mr",
      "firstName": "Case",
      "middleName": "Henry",
      "lastName": "Mitchell",
      "residentialStatus": "resident",
      "dateOfBirth": "1983-10-12",
        "address": {
          "address1": "1847 Kingsbury Court",
          "address2": "pendingManualReview",
          "type": "home",
          "city": "Manchester",
          "countryCode": "GB",
          "postalCode": "M1 1AA"
      }
    },
    "email": "case.mitchell@example.com",
    "performIdentityVerification": true
}

Example response

{
    "identityVerificationState": "pendingManualReview",
    "identityVerificationMethod": "identityVerificationService",
    "merchant": {
        "entity": "default"
    },
    "partyReference": "5htNU0XQ7V",
    "partyId": "parpI1tAL2bK8Lb-52Rfblg30",
    "partyType": "beneficiary",
    "type": "person",
    "personalDetails": {
        "title": "Mr",
        "firstName": "Case",
        "middleName": "Henry",
        "lastName": "Mitchell",
        "residentialStatus": "resident",
        "dateOfBirth": "1983-10-12",
        "address": {
            "address1": "1847 Kingsbury Court",
            "address2": "pendingManualReview",
            "type": "home",
            "city": "Manchester",
            "countryCode": "GB",
            "postalCode": "M1 1AA"
        }
    },
    "email": "case.mitchell@example.com"
}