APIs
/
Parties
/
Identity Verification
/
Perform identity verification

Parties (2025-01-01)

Create parties, manage your payout instruments and beneficial owners and carry out identity verification checks.

Authentication

Set your headers

Authorization: {your_credentials}
WP-Api-Version: 2025-01-01

Replace {your_credentials} with your base64-encoded Basic Auth username and password.

DNS Whitelisting

Whitelist the following URLs:

  • https://try.access.worldpay.com/
  • https://access.worldpay.com/

Please ensure you use DNS whitelisting, not explicit IP whitelisting.

API Collection

A full set of API examples based on different scenarios.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License

Worldpay

Languages
Servers
Live

http://access.worldpay.com/

Try

http://try.access.worldpay.com/

Parties

Create and maintain parties.

Operations

Payout instruments

Create and maintain payout instruments.

Operations

Balance accounts

Create and maintain balance accounts.

Operations

Beneficial owners

Create and maintain beneficial owners.

Operations

Identity Verification

Enable Identity Verification check on a party.

Operations

Perform identity verification

Request

Security
basicAuth
Path
partyIdstring= 25 characters^par[a-zA-Z0-9-_]*0$required

A unique identifier for the party generated by us. This is sent in the response of your party creation call.

Headers
WP-Api-Versionstring(date)required

The API version.

Example: 2025-01-01
Bodyapplication/jsonrequired
performIdentityVerificationbooleanwrite-only
application/json
{
  "performIdentityVerification": true
}

Responses

OK

Bodyapplication/json
overallobject
identityVerificationStatestringread-only
Enum"verified""notVerified""pending""rejected""notApplicable""started""startedAction""pendingStepUpAction""pendingManualReview"
identityVerificationMethodstringread-only
Enum"merchantCompliant""identityVerificationService"
identityVerificationDatestring(date)read-only

A valid date as YYYY-MM-DD

Example: "2033-11-22"
urlstringread-only

The link returned from Identity Verification Status (IVS) used to retrieve additional details from the user.

partyobject
identityVerificationStatestringread-only
Enum"verified""notVerified""pending""rejected""notApplicable""started""startedAction""pendingStepUpAction""pendingManualReview"
identityVerificationMethodstringread-only
Enum"merchantCompliant""identityVerificationService"
identityVerificationDatestring(date)read-only

A valid date as YYYY-MM-DD

Example: "2033-11-22"
urlstringread-only

The link returned from Identity Verification Status (IVS) used to retrieve additional details from the user.

partyIdstringread-only

A unique identifier for the party generated by us.

partyReferencestring[ 3 .. 64 ] characters^[A-Za-z0-9\-_ ]*$

Your reference for this party, must be unique within an entity.

Example: "Hosaka27384910"
beneficialOwnersArray of objects
identityVerificationStatestringread-only
Enum"verified""notVerified""pending""rejected""notApplicable""started""startedAction""pendingStepUpAction""pendingManualReview"
identityVerificationMethodstringread-only
Enum"merchantCompliant""identityVerificationService"
identityVerificationDatestring(date)read-only

A valid date as YYYY-MM-DD

Example: "2033-11-22"
urlstringread-only

The link returned from Identity Verification Status (IVS) used to retrieve additional details from the user.

beneficialOwnerReferencestring[ 3 .. 64 ] characters^[A-Za-z0-9\-_ ]*$

Your reference for this beneficial owner, must be unique within an entity.

Example: "Hosaka27384910"
beneficialOwnerIdstringread-only

A unique identifier for the beneficial owner generated by us.

Response
application/json

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

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

View identity verification status

Request

Security
basicAuth
Path
partyIdstring= 25 characters^par[a-zA-Z0-9-_]*0$required

A unique identifier for the party generated by us. This is sent in the response of your party creation call.

Headers
WP-Api-Versionstring(date)required

The API version.

Example: 2025-01-01
No request payload

Responses

OK

Bodyapplication/json
overallobject
identityVerificationStatestringread-only
Enum"verified""notVerified""pending""rejected""notApplicable""started""startedAction""pendingStepUpAction""pendingManualReview"
identityVerificationMethodstringread-only
Enum"merchantCompliant""identityVerificationService"
identityVerificationDatestring(date)read-only

A valid date as YYYY-MM-DD

Example: "2033-11-22"
urlstringread-only

The link returned from Identity Verification Status (IVS) used to retrieve additional details from the user.

partyobject
identityVerificationStatestringread-only
Enum"verified""notVerified""pending""rejected""notApplicable""started""startedAction""pendingStepUpAction""pendingManualReview"
identityVerificationMethodstringread-only
Enum"merchantCompliant""identityVerificationService"
identityVerificationDatestring(date)read-only

A valid date as YYYY-MM-DD

Example: "2033-11-22"
urlstringread-only

The link returned from Identity Verification Status (IVS) used to retrieve additional details from the user.

partyIdstringread-only

A unique identifier for the party generated by us.

partyReferencestring[ 3 .. 64 ] characters^[A-Za-z0-9\-_ ]*$

Your reference for this party, must be unique within an entity.

Example: "Hosaka27384910"
beneficialOwnersArray of objects
identityVerificationStatestringread-only
Enum"verified""notVerified""pending""rejected""notApplicable""started""startedAction""pendingStepUpAction""pendingManualReview"
identityVerificationMethodstringread-only
Enum"merchantCompliant""identityVerificationService"
identityVerificationDatestring(date)read-only

A valid date as YYYY-MM-DD

Example: "2033-11-22"
urlstringread-only

The link returned from Identity Verification Status (IVS) used to retrieve additional details from the user.

beneficialOwnerReferencestring[ 3 .. 64 ] characters^[A-Za-z0-9\-_ ]*$

Your reference for this beneficial owner, must be unique within an entity.

Example: "Hosaka27384910"
beneficialOwnerIdstringread-only

A unique identifier for the beneficial owner generated by us.

Response
application/json

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

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