Verify parties

Verify the identity of your parties and make sure you stay compliant when dealing with different entities.

Prerequisite

To successfully verify a party, you must add certain required details to your party which differ from country to country. You can find the specifications of these details in our coverage guide.

You can verify the identity of a person, a sole trader, or a company either during or after the creation of a party.

To verify a party during and orchestrated party creation call, you can include the performIdentityVerification field in your request and set the value as "true".

"performIdentityVerification": true

Verify identity of your party

Perform an identity verification check after a party is created.

POST https://access.worldpay.com/parties/{partyId}/identityVerification

Request/response example

application/json

Perform Identity Verification on a party of a company (modular)

{
  "performIdentityVerification": true
}

Response

application/json

Identity Verification Status on a party of a company (modular)

{
  "overall": {
    "identityVerificationState": "pending",
    "identityVerificationMethod": "identityVerificationService"
  },
  "party": {
    "identityVerificationState": "pending",
    "partyReference": "Euna925",
    "partyId": "par1Bbf6r80Q3mEvhp_xBKNM0"
  },
  "beneficialOwners": [
    {
      "identityVerificationState": "pending",
      "beneficialOwnerReference": "Floy829",
      "beneficialOwnerId": "parsH2dSCcczQveB-GQNx0qq0"
    },
    {
      "identityVerificationState": "pending",
      "beneficialOwnerReference": "Christina843",
      "beneficialOwnerId": "parbQR-8sRkYASaOzOVPX5d10"
    },
    {
      "identityVerificationState": "pending",
      "beneficialOwnerReference": "Arlo912",
      "beneficialOwnerId": "pargosUuzW0vv8HrWsCTuadb0"
    }
  ]
}

See full schema to verify your party.

View verification outcomes

Query the status of your identity verification check periodically to get status updates.

GET https://access.worldpay.com/parties/{partyId}/identityVerification

Request/response example:

No request payload

Response

application/json

Get Identiy Verification Status on a party of a company (modular)

{
  "overall": {
    "identityVerificationState": "pending",
    "identityVerificationMethod": "identityVerificationService"
  },
  "party": {
    "identityVerificationState": "pending",
    "partyReference": "Linnea474",
    "partyId": "parWcAyq5G2-1KwvsEkFAKwz0"
  },
  "beneficialOwners": [
    {
      "identityVerificationState": "pending",
      "beneficialOwnerReference": "Mac551",
      "beneficialOwnerId": "parAZo80iViOTdKRJi4Oq14Z0"
    },
    {
      "identityVerificationState": "pending",
      "beneficialOwnerReference": "Thea799",
      "beneficialOwnerId": "parB5ON-IEK4olrLuHvjEDpE0"
    },
    {
      "identityVerificationState": "pending",
      "beneficialOwnerReference": "Santino227",
      "beneficialOwnerId": "parNKRss9vllWyX1MUVOj7b-0"
    }
  ]
}

You can get the following status outcomes:

Event	Description	Action required?
`notVerified`	The identity verification process has not yet started.
`started`	The identity verification process was is initiated.
`startedAction`	One or more mandatory fields are missing. Further information is required from the party, in order for the verification process to resume.
`pending`	The identity verification is in progress. The status will change once the validation has completed.
`pendingStepUpAction`	The identity verification process is not yet complete. You will receive a URL in the response of your `GET`request with further details on next actions (e.g. uploading a scan of the ID or a liveness check).
`pendingManualReview`	The identity verification process is being manually reviewed
`rejected`	The identity verification process has failed and the party's identity is not verified successfully.
`verified`	The identity verification process has completed successfully and the party's identity is now verified.

Important

Once the party has been successfully verified, you'll receive an expiryDate of your party record within your response. The validity of the verification expires depending on the type of party and specific country/region. After this, you must verify the identity of the party again.

Next Steps

Add a payout instrument
Manage beneficial owners or
Add balance accounts

Verify parties

Verify identity of your party

Request/response example

View verification outcomes

Request/response example:

Next Steps

Do you like our page?