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

Create a beneficial owner

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

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

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

Example: "Hosaka27384910"

personalDetailsobjectrequired

titlestringrequired

The title for this person/soleTrader.

Enum"Mr""Mrs""Miss""Ms""Dr""Mx""Misc"

Example: "Mr"

firstNamestring[ 2 .. 35 ] characters^[\p{L}\-.,'()&]{2,}$required

The person's/soleTrader's first name.

Example: "Case"

middleNamestring[ 1 .. 35 ] characters^(?:\p{L}\.?)*+$required

The person's/soleTrader's middle name or initial.

Example: "Henry"

lastNamestring[ 2 .. 35 ] characters^(?:[\p{L}\-.,'()&]{2,} *)*+$required

The person's/soleTrader's last name.

Example: "Mitchell"

dateOfBirthstring

The date the person/soleTrader was born.

Example: "1983-10-12"

addressobjectrequired

The address of the person/soleTrader.

residentialStatusstring

The residential status of the person/soleTrader.

Enum"resident""nonResident""other"

customerReferencestring[ 1 .. 255 ] characters

Unique reference provided by the payee. Only required for certain payout destinations.

Example: "7564389201"

nationalitystring

The nationality of the person/soleTrader.

currentAddressLessThanThreeYearsboolean

previousHomeAddressobject

The previous home address of the person/soleTrader.

websitestring

The URL of the merchant's website.

Example: "https://example.com/"

relationshipToBusinessobjectrequired

ownershipPercentagenumber(double)<= 100required

directorbooleanrequired

positionstringrequired

Enum"soleTrader""accountant""bursar""ceo""chairman""chairwoman""chiefExecutiveOfficer""clerk""companySecretary""creditController"

emailstring

phonesArray of objects

prefixstring^[0-9]{1,3}$required

The dialing prefix for the phone number.

Example: "44"

numberstring[0-9]{1,20}required

The phone number, without dashes.

Example: "4281234"

identityDocumentsArray of objects

typestringrequired

The type of the identity document.

Enum"passport""nationalId""driverLicence""workPermit""employmentPass""studentPass""permanentResidentCard""companyRegistrationNumber""companyVATNumber""citizenshipCard"

numberstringnon-emptyrequired

issuingInstitutionstring

The name of the institution that issued this document.

Example: "State Department"

issuingCountrystringnon-emptyrequired

The country code of the issuing country specified in ISO 3166-1 Alpha-2 code format.

Example: "JP"

validFromstring

The ISO 8601 date since when this document is valid from.

Example: "2023-11-22"

validTostring

The ISO 8601 date until which this document is valid to.

Example: "2023-11-22"

application/json

Create beneficial owner for existing company (modular)

{
  "beneficialOwnerReference": "xdl12goH60",
  "personalDetails": {
    "title": "Dr",
    "firstName": "John",
    "middleName": "Illusionet",
    "lastName": "Bailey",
    "residentialStatus": "nonResident",
    "dateOfBirth": "1972-05-22",
    "nationality": "GB",
    "address": {
      "address1": "200 Downing Street",
      "address2": "Flat 404",
      "city": "London",
      "type": "home",
      "countryCode": "GB",
      "postalCode": "SW1A 2AA"
    },
    "currentAddressLessThanThreeYears": true,
    "previousHomeAddress": {
      "address1": "425 Oxford Street",
      "address2": "Flat 101",
      "city": "London",
      "type": "home",
      "countryCode": "GB",
      "postalCode": "W1D 1LP"
    }
  },
  "relationshipToBusiness": {
    "ownershipPercentage": 10,
    "director": false,
    "position": "partner"
  },
  "identityDocuments": [
    {
      "type": "passport",
      "number": "B98765432",
      "issuingInstitution": "UK Passport Office",
      "issuingCountry": "GB",
      "validFrom": "2018-05-15",
      "validTo": "2028-05-15"
    }
  ],
  "email": "John.bailey@example.com",
  "phones": [
    {
      "number": "0205556789",
      "prefix": "44"
    }
  ]
}

Responses

Created

Bodyapplication/json

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

titlestringrequired

The title for this person/soleTrader.

Enum"Mr""Mrs""Miss""Ms""Dr""Mx""Misc"

Example: "Mr"

firstNamestring[ 2 .. 35 ] characters^[\p{L}\-.,'()&]{2,}$required

The person's/soleTrader's first name.

Example: "Case"

middleNamestring[ 1 .. 35 ] characters^(?:\p{L}\.?)*+$required

The person's/soleTrader's middle name or initial.

Example: "Henry"

lastNamestring[ 2 .. 35 ] characters^(?:[\p{L}\-.,'()&]{2,} *)*+$required

The person's/soleTrader's last name.

Example: "Mitchell"

dateOfBirthstring

The date the person/soleTrader was born.

Example: "1983-10-12"

addressobjectrequired

The address of the person/soleTrader.

residentialStatusstring

The residential status of the person/soleTrader.

Enum"resident""nonResident""other"

customerReferencestring[ 1 .. 255 ] characters

Unique reference provided by the payee. Only required for certain payout destinations.

Example: "7564389201"

nationalitystring

The nationality of the person/soleTrader.

currentAddressLessThanThreeYearsboolean

previousHomeAddressobject

The previous home address of the person/soleTrader.

websitestring

The URL of the merchant's website.

Example: "https://example.com/"

relationshipToBusinessobjectrequired

ownershipPercentagenumber(double)<= 100required

directorbooleanrequired

positionstringrequired

Enum"soleTrader""accountant""bursar""ceo""chairman""chairwoman""chiefExecutiveOfficer""clerk""companySecretary""creditController"

emailstring

phonesArray of objects

prefixstring^[0-9]{1,3}$required

The dialing prefix for the phone number.

Example: "44"

numberstring[0-9]{1,20}required

The phone number, without dashes.

Example: "4281234"

identityDocumentsArray of objects

typestringrequired

The type of the identity document.

Enum"passport""nationalId""driverLicence""workPermit""employmentPass""studentPass""permanentResidentCard""companyRegistrationNumber""companyVATNumber""citizenshipCard"

numberstringnon-emptyrequired

issuingInstitutionstring

The name of the institution that issued this document.

Example: "State Department"

issuingCountrystringnon-emptyrequired

The country code of the issuing country specified in ISO 3166-1 Alpha-2 code format.

Example: "JP"

validFromstring

The ISO 8601 date since when this document is valid from.

Example: "2023-11-22"

validTostring

The ISO 8601 date until which this document is valid to.

Example: "2023-11-22"

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-only

dateTimeUpdatedstringread-only

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

Example: "2025-01-25T14:57:012.302Z"

Response

application/json

Beneficial owner for existing party type company (modular)

{
  "identityVerificationState": "notVerified",
  "identityVerificationMethod": "identityVerificationService",
  "beneficialOwnerReference": "owner28",
  "beneficialOwnerId": "parNtJbNC8_fd_HRKyQRekiN0",
  "personalDetails": {
    "title": "Dr",
    "firstName": "John",
    "middleName": "Illusionet",
    "lastName": "Bailey",
    "dateOfBirth": "1972-05-22",
    "address": {
      "address1": "200 Downing Street",
      "address2": "Flat 404",
      "city": "London",
      "countryCode": "GB",
      "postalCode": "SW1A 2AA",
      "type": "home"
    },
    "residentialStatus": "nonResident",
    "nationality": "GB",
    "currentAddressLessThanThreeYears": true,
    "previousHomeAddress": {
      "address1": "425 Oxford Street",
      "address2": "Flat 101",
      "city": "London",
      "countryCode": "GB",
      "postalCode": "W1D 1LP",
      "type": "home"
    }
  },
  "relationshipToBusiness": {
    "ownershipPercentage": 10,
    "director": false,
    "position": "partner"
  },
  "email": "John.bailey@example.com",
  "phones": [
    {
      "prefix": "44",
      "number": "0205556789"
    }
  ],
  "identityDocuments": [
    {
      "type": "passport",
      "number": "B98765432",
      "issuingInstitution": "UK Passport Office",
      "issuingCountry": "GB",
      "validFrom": "2018-05-15",
      "validTo": "2028-05-15"
    }
  ],
  "dateTimeCreated": "2025-03-20T18:33:41.480Z",
  "version": 1
}

View a beneficial owner

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.

beneficialOwnerIdstring= 25 characterspar.*0$required

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

Headers

WP-Api-Versionstring(date)required

The API version.

Example: 2025-01-01

No request payload

Responses

Bodyapplication/json

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

titlestringrequired

The title for this person/soleTrader.

Enum"Mr""Mrs""Miss""Ms""Dr""Mx""Misc"

Example: "Mr"

firstNamestring[ 2 .. 35 ] characters^[\p{L}\-.,'()&]{2,}$required

The person's/soleTrader's first name.

Example: "Case"

middleNamestring[ 1 .. 35 ] characters^(?:\p{L}\.?)*+$required

The person's/soleTrader's middle name or initial.

Example: "Henry"

lastNamestring[ 2 .. 35 ] characters^(?:[\p{L}\-.,'()&]{2,} *)*+$required

The person's/soleTrader's last name.

Example: "Mitchell"

dateOfBirthstring

The date the person/soleTrader was born.

Example: "1983-10-12"

addressobjectrequired

The address of the person/soleTrader.

residentialStatusstring

The residential status of the person/soleTrader.

Enum"resident""nonResident""other"

customerReferencestring[ 1 .. 255 ] characters

Unique reference provided by the payee. Only required for certain payout destinations.

Example: "7564389201"

nationalitystring

The nationality of the person/soleTrader.

currentAddressLessThanThreeYearsboolean

previousHomeAddressobject

The previous home address of the person/soleTrader.

websitestring

The URL of the merchant's website.

Example: "https://example.com/"

relationshipToBusinessobjectrequired

ownershipPercentagenumber(double)<= 100required

directorbooleanrequired

positionstringrequired

Enum"soleTrader""accountant""bursar""ceo""chairman""chairwoman""chiefExecutiveOfficer""clerk""companySecretary""creditController"

emailstring

phonesArray of objects

prefixstring^[0-9]{1,3}$required

The dialing prefix for the phone number.

Example: "44"

numberstring[0-9]{1,20}required

The phone number, without dashes.

Example: "4281234"

identityDocumentsArray of objects

typestringrequired

The type of the identity document.

Enum"passport""nationalId""driverLicence""workPermit""employmentPass""studentPass""permanentResidentCard""companyRegistrationNumber""companyVATNumber""citizenshipCard"

numberstringnon-emptyrequired

issuingInstitutionstring

The name of the institution that issued this document.

Example: "State Department"

issuingCountrystringnon-emptyrequired

The country code of the issuing country specified in ISO 3166-1 Alpha-2 code format.

Example: "JP"

validFromstring

The ISO 8601 date since when this document is valid from.

Example: "2023-11-22"

validTostring

The ISO 8601 date until which this document is valid to.

Example: "2023-11-22"

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-only

dateTimeUpdatedstringread-only

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

Example: "2025-01-25T14:57:012.302Z"

Response

application/json

Get a beneficial owner

{
  "identityVerificationState": "started",
  "identityVerificationMethod": "identityVerificationService",
  "beneficialOwnerReference": "Santino227",
  "beneficialOwnerId": "parNKRss9vllWyX1MUVOj7b-0",
  "personalDetails": {
    "title": "Dr",
    "firstName": "John",
    "middleName": "Illusionet",
    "lastName": "Bailey",
    "dateOfBirth": "1972-05-22",
    "address": {
      "address1": "200 Downing Street",
      "address2": "Flat 404",
      "city": "London",
      "countryCode": "GB",
      "postalCode": "SW1A 2AA",
      "type": "home"
    },
    "residentialStatus": "nonResident",
    "nationality": "GB",
    "currentAddressLessThanThreeYears": true,
    "previousHomeAddress": {
      "address1": "425 Oxford Street",
      "address2": "Flat 101",
      "city": "London",
      "countryCode": "GB",
      "postalCode": "W1D 1LP",
      "type": "home"
    }
  },
  "relationshipToBusiness": {
    "ownershipPercentage": 10,
    "director": false,
    "position": "partner"
  },
  "email": "John.bailey@example.com",
  "phones": [
    {
      "prefix": "44",
      "number": "0205556789"
    }
  ],
  "identityDocuments": [
    {
      "type": "passport",
      "number": "B98765432",
      "issuingInstitution": "UK Passport Office",
      "issuingCountry": "GB",
      "validFrom": "2018-05-15",
      "validTo": "2028-05-15"
    }
  ],
  "dateTimeCreated": "2025-04-07T20:47:59.479Z",
  "version": 1
}

Update a beneficial owner

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.

beneficialOwnerIdstring= 25 characterspar.*0$required

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

Headers

WP-Api-Versionstring(date)required

The API version.

Example: 2025-01-01

Bodyapplication/jsonrequired

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

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

Example: "Hosaka27384910"

personalDetailsobjectrequired

titlestringrequired

The title for this person/soleTrader.

Enum"Mr""Mrs""Miss""Ms""Dr""Mx""Misc"

Example: "Mr"

firstNamestring[ 2 .. 35 ] characters^[\p{L}\-.,'()&]{2,}$required

The person's/soleTrader's first name.

Example: "Case"

middleNamestring[ 1 .. 35 ] characters^(?:\p{L}\.?)*+$required

The person's/soleTrader's middle name or initial.

Example: "Henry"

lastNamestring[ 2 .. 35 ] characters^(?:[\p{L}\-.,'()&]{2,} *)*+$required

The person's/soleTrader's last name.

Example: "Mitchell"

dateOfBirthstring

The date the person/soleTrader was born.

Example: "1983-10-12"

addressobjectrequired

The address of the person/soleTrader.

residentialStatusstring

The residential status of the person/soleTrader.

Enum"resident""nonResident""other"

customerReferencestring[ 1 .. 255 ] characters

Unique reference provided by the payee. Only required for certain payout destinations.

Example: "7564389201"

nationalitystring

The nationality of the person/soleTrader.

currentAddressLessThanThreeYearsboolean

previousHomeAddressobject

The previous home address of the person/soleTrader.

websitestring

The URL of the merchant's website.

Example: "https://example.com/"

relationshipToBusinessobjectrequired

ownershipPercentagenumber(double)<= 100required

directorbooleanrequired

positionstringrequired

Enum"soleTrader""accountant""bursar""ceo""chairman""chairwoman""chiefExecutiveOfficer""clerk""companySecretary""creditController"

emailstring

phonesArray of objects

prefixstring^[0-9]{1,3}$required

The dialing prefix for the phone number.

Example: "44"

numberstring[0-9]{1,20}required

The phone number, without dashes.

Example: "4281234"

identityDocumentsArray of objects

typestringrequired

The type of the identity document.

Enum"passport""nationalId""driverLicence""workPermit""employmentPass""studentPass""permanentResidentCard""companyRegistrationNumber""companyVATNumber""citizenshipCard"

numberstringnon-emptyrequired

issuingInstitutionstring

The name of the institution that issued this document.

Example: "State Department"

issuingCountrystringnon-emptyrequired

The country code of the issuing country specified in ISO 3166-1 Alpha-2 code format.

Example: "JP"

validFromstring

The ISO 8601 date since when this document is valid from.

Example: "2023-11-22"

validTostring

The ISO 8601 date until which this document is valid to.

Example: "2023-11-22"

application/json

Update a Beneficial Owner

{
  "beneficialOwnerReference": "uWBzL2nzx3",
  "personalDetails": {
    "title": "Dr",
    "firstName": "John",
    "middleName": "Illusionet",
    "lastName": "Bailey",
    "residentialStatus": "nonResident",
    "dateOfBirth": "1972-05-22",
    "nationality": "GB",
    "address": {
      "address1": "200 Downing Street",
      "address2": "Flat 404",
      "city": "London",
      "type": "home",
      "countryCode": "GB",
      "postalCode": "SW1A 2AA"
    },
    "currentAddressLessThanThreeYears": true,
    "previousHomeAddress": {
      "address1": "200 Oxford Street",
      "address2": "Flat 101",
      "city": "London",
      "type": "home",
      "countryCode": "GB",
      "postalCode": "W1D 1LP"
    }
  },
  "relationshipToBusiness": {
    "ownershipPercentage": 10,
    "director": false,
    "position": "partner"
  },
  "identityDocuments": [
    {
      "type": "passport",
      "number": "B98765432",
      "issuingInstitution": "UK Passport Office",
      "issuingCountry": "GB",
      "validFrom": "2018-05-15",
      "validTo": "2028-05-15"
    }
  ],
  "email": "John.bailey@example.com",
  "phones": [
    {
      "number": "0205556789",
      "prefix": "44"
    }
  ]
}

Responses

Bodyapplication/json

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

titlestringrequired

The title for this person/soleTrader.

Enum"Mr""Mrs""Miss""Ms""Dr""Mx""Misc"

Example: "Mr"

firstNamestring[ 2 .. 35 ] characters^[\p{L}\-.,'()&]{2,}$required

The person's/soleTrader's first name.

Example: "Case"

middleNamestring[ 1 .. 35 ] characters^(?:\p{L}\.?)*+$required

The person's/soleTrader's middle name or initial.

Example: "Henry"

lastNamestring[ 2 .. 35 ] characters^(?:[\p{L}\-.,'()&]{2,} *)*+$required

The person's/soleTrader's last name.

Example: "Mitchell"

dateOfBirthstring

The date the person/soleTrader was born.

Example: "1983-10-12"

addressobjectrequired

The address of the person/soleTrader.

residentialStatusstring

The residential status of the person/soleTrader.

Enum"resident""nonResident""other"

customerReferencestring[ 1 .. 255 ] characters

Unique reference provided by the payee. Only required for certain payout destinations.

Example: "7564389201"

nationalitystring

The nationality of the person/soleTrader.

currentAddressLessThanThreeYearsboolean

previousHomeAddressobject

The previous home address of the person/soleTrader.

websitestring

The URL of the merchant's website.

Example: "https://example.com/"

relationshipToBusinessobjectrequired

ownershipPercentagenumber(double)<= 100required

directorbooleanrequired

positionstringrequired

Enum"soleTrader""accountant""bursar""ceo""chairman""chairwoman""chiefExecutiveOfficer""clerk""companySecretary""creditController"

emailstring

phonesArray of objects

prefixstring^[0-9]{1,3}$required

The dialing prefix for the phone number.

Example: "44"

numberstring[0-9]{1,20}required

The phone number, without dashes.

Example: "4281234"

identityDocumentsArray of objects

typestringrequired

The type of the identity document.

Enum"passport""nationalId""driverLicence""workPermit""employmentPass""studentPass""permanentResidentCard""companyRegistrationNumber""companyVATNumber""citizenshipCard"

numberstringnon-emptyrequired

issuingInstitutionstring

The name of the institution that issued this document.

Example: "State Department"

issuingCountrystringnon-emptyrequired

The country code of the issuing country specified in ISO 3166-1 Alpha-2 code format.

Example: "JP"

validFromstring

The ISO 8601 date since when this document is valid from.

Example: "2023-11-22"

validTostring

The ISO 8601 date until which this document is valid to.

Example: "2023-11-22"

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-only

dateTimeUpdatedstringread-only

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

Example: "2025-01-25T14:57:012.302Z"

Response

application/json

Update the beneficial owner for a party company (modular)

{
  "identityVerificationState": "notVerified",
  "identityVerificationMethod": "identityVerificationService",
  "beneficialOwnerReference": "Gerson337",
  "beneficialOwnerId": "pardPhiwdlp8VcnS8U7LHVbE0",
  "personalDetails": {
    "title": "Dr",
    "firstName": "John",
    "middleName": "Illusionet",
    "lastName": "Bailey",
    "dateOfBirth": "1972-05-22",
    "address": {
      "address1": "200 Downing Street",
      "address2": "Flat 404",
      "city": "London",
      "countryCode": "GB",
      "postalCode": "SW1A 2AA",
      "type": "home"
    },
    "residentialStatus": "nonResident",
    "nationality": "GB",
    "currentAddressLessThanThreeYears": true,
    "previousHomeAddress": {
      "address1": "200 Oxford Street",
      "address2": "Flat 101",
      "city": "London",
      "countryCode": "GB",
      "postalCode": "W1D 1LP",
      "type": "home"
    }
  },
  "relationshipToBusiness": {
    "ownershipPercentage": 10,
    "director": false,
    "position": "partner"
  },
  "email": "John.bailey@example.com",
  "phones": [
    {
      "prefix": "44",
      "number": "0205556789"
    }
  ],
  "identityDocuments": [
    {
      "type": "passport",
      "number": "B98765432",
      "issuingInstitution": "UK Passport Office",
      "issuingCountry": "GB",
      "validFrom": "2018-05-15",
      "validTo": "2028-05-15"
    }
  ],
  "dateTimeCreated": "2025-04-10T15:45:06.349Z",
  "version": 2,
  "dateTimeUpdated": "2025-04-10T15:45:09.389Z"
}

Delete a beneficial owner

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.

beneficialOwnerIdstring= 25 characterspar.*0$required

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

Headers

WP-Api-Versionstring(date)required

The API version.

Example: 2025-01-01

No request payload

Responses

No Content

Response

No content

Identity Verification

Enable Identity Verification check on a party.

Operations

Parties (2025-01-01)

Parties

Payout instruments

Balance accounts

Beneficial owners

Create a beneficial owner

Request

Responses

Do you like our page?

View a beneficial owner

Request

Responses

Do you like our page?

Update a beneficial owner

Request

Responses

Do you like our page?

Delete a beneficial owner

Request

Responses

Do you like our page?

Identity Verification

Parties (2025-01-01)

Parties

Payout instruments

Balance accounts

Beneficial owners

Create a beneficial owner

RequestExpand all

Responses

Do you like our page?

View a beneficial owner

Request

Responses

Do you like our page?

Update a beneficial owner

RequestExpand all

Responses

Do you like our page?

Delete a beneficial owner

Request

Responses

Do you like our page?

Identity Verification

Request

Request