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

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

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

WP-CorrelationIdstring

Optional ID to trace requests, if not provided, it is generated.

Example: fa96ca86-0ae9-425a-b079-d5bcbcb6fdd3

Bodyapplication/jsonrequired

performIdentityVerificationbooleanwrite-only

application/json

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

{
  "performIdentityVerification": true
}

Responses

Bodyapplication/json

overallobject

identityVerificationStatestringread-only

Enum"verified""notVerified""pending""rejected""notApplicable"

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.

partyCompany (object) or Person (object) or SoleTrader (object)

One of:

A party represents the overall party record of your beneficiary (seller, vendor, provider). You can use this to store information about the party, to perform either an identity verification checks, a split payment, or a payout.

identityVerificationStatestringread-only

Enum"verified""notVerified""pending""rejected""notApplicable"

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.

merchantobjectrequired

An object that contains information about the merchant.

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

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

Example: "Hosaka27384910"

partyTypestringrequired

The type of this party.

beneficiary - the person or business that will receive funds.

payer - a transmitter of funds to a third party.

Enum"beneficiary""payer"

typestringrequired

What the party represents:

person - an individual

soleTrader - a single person enterprise

company - a corporation or partnership with multiple owners

Enum"company""person""soleTrader"

partyIdstringread-only

A unique identifier for the party generated by us.

emailstring

An email address for this party.

phonesArray of objects

A list of phone numbers associated with this party.

identityDocumentsArray of objects

A list of identity documents for this party.

balanceAccountsArray of objects

A list of balance accounts that have been set up for this party.

overallAccountStatusstring

The overallStatus provides an complete view of the parties identityVerificationState.

dateTimeCreatedstringread-only

The date and time that the party was created, as an ISO 8601 zoned date time

Example: "2025-01-23T12:23:445.222Z"

dateTimeUpdatedstringread-only

The date and time that the party was last updated, as an ISO 8601 zoned date time

Example: "2025-01-25T02:43:499.202Z"

versioninteger(int32)read-only

payoutInstrumentsArray of objects

companyDetailsobjectrequired

Object containing details about a company. Required for company.

beneficialOwnersArray of objects

identityVerificationStatestringread-only

Enum"verified""notVerified""pending""rejected""notApplicable"

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\-_ ]*$required

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.

personalDetailsobjectrequired

relationshipToBusinessobjectrequired

emailstring

phonesArray of objects

identityDocumentsArray of objects

dateTimeCreatedstringread-only

The date and time that the beneficial owner was created, as an ISO 8601 zoned date time.

Example: "2025-01-23T12:23:445.222Z"

versioninteger(int32)read-onlyrequired

dateTimeUpdatedstringread-only

The date and time that the beneficial owner was last updated, as an ISO 8601 zoned date time.

Example: "2025-01-25T02:43:499.202Z"

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"
    }
  ]
}

View identity verification status

Request

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

WP-CorrelationIdstring

Optional ID to trace requests, if not provided, it is generated.

Example: fa96ca86-0ae9-425a-b079-d5bcbcb6fdd3

No request payload

Responses

Bodyapplication/json

overallobject

identityVerificationStatestringread-only

Enum"verified""notVerified""pending""rejected""notApplicable"

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.

partyCompany (object) or Person (object) or SoleTrader (object)

One of:

identityVerificationStatestringread-only

Enum"verified""notVerified""pending""rejected""notApplicable"

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.

merchantobjectrequired

An object that contains information about the merchant.

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

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

Example: "Hosaka27384910"

partyTypestringrequired

The type of this party.

beneficiary - the person or business that will receive funds.

payer - a transmitter of funds to a third party.

Enum"beneficiary""payer"

typestringrequired

What the party represents:

person - an individual

soleTrader - a single person enterprise

company - a corporation or partnership with multiple owners

Enum"company""person""soleTrader"

partyIdstringread-only

A unique identifier for the party generated by us.

emailstring

An email address for this party.

phonesArray of objects

A list of phone numbers associated with this party.

identityDocumentsArray of objects

A list of identity documents for this party.

balanceAccountsArray of objects

A list of balance accounts that have been set up for this party.

overallAccountStatusstring

The overallStatus provides an complete view of the parties identityVerificationState.

dateTimeCreatedstringread-only

The date and time that the party was created, as an ISO 8601 zoned date time

Example: "2025-01-23T12:23:445.222Z"

dateTimeUpdatedstringread-only

The date and time that the party was last updated, as an ISO 8601 zoned date time

Example: "2025-01-25T02:43:499.202Z"

versioninteger(int32)read-only

payoutInstrumentsArray of objects

companyDetailsobjectrequired

Object containing details about a company. Required for company.

beneficialOwnersArray of objects

identityVerificationStatestringread-only

Enum"verified""notVerified""pending""rejected""notApplicable"

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\-_ ]*$required

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.

personalDetailsobjectrequired

relationshipToBusinessobjectrequired

emailstring

phonesArray of objects

identityDocumentsArray of objects

dateTimeCreatedstringread-only

The date and time that the beneficial owner was created, as an ISO 8601 zoned date time.

Example: "2025-01-23T12:23:445.222Z"

versioninteger(int32)read-onlyrequired

dateTimeUpdatedstringread-only

The date and time that the beneficial owner was last updated, as an ISO 8601 zoned date time.

Example: "2025-01-25T02:43:499.202Z"

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"
    }
  ]
}

Parties (2025-01-01)

Parties

Payout instruments

Balance accounts

Beneficial owners

Identity Verification

Perform identity verification

Request

Responses

Do you like our page?

View identity verification status

Request

Responses

Do you like our page?