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.
http://access.worldpay.com/
http://try.access.worldpay.com/
Your reference for this beneficial owner, must be unique within an entity.
The title for this person
/soleTrader
.
The person
's/soleTrader
's first name.
The person
's/soleTrader
's middle name or initial.
The person
's/soleTrader
's last name.
The residential status of the person
/soleTrader
.
Unique reference provided by the payee. Only required for certain payout destinations.
The type of the identity document.
The name of the institution that issued this document.
The country code of the issuing country specified in ISO 3166-1 Alpha-2 code format.
http://access.worldpay.com/parties/{partyId}/beneficialOwners
http://try.access.worldpay.com/parties/{partyId}/beneficialOwners
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" } ] }
Created
The link returned from Identity Verification Status (IVS) used to retrieve additional details from the user.
Your reference for this beneficial owner, must be unique within an entity.
The title for this person
/soleTrader
.
The person
's/soleTrader
's first name.
The person
's/soleTrader
's middle name or initial.
The person
's/soleTrader
's last name.
The residential status of the person
/soleTrader
.
Unique reference provided by the payee. Only required for certain payout destinations.
The type of the identity document.
The name of the institution that issued this document.
The country code of the issuing country specified in ISO 3166-1 Alpha-2 code format.
The date and time that the beneficial owner was created, as an ISO 8601 zoned date time.
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 }
http://access.worldpay.com/parties/{partyId}/beneficialOwners/{beneficialOwnerId}
http://try.access.worldpay.com/parties/{partyId}/beneficialOwners/{beneficialOwnerId}
No request payload
OK
The link returned from Identity Verification Status (IVS) used to retrieve additional details from the user.
Your reference for this beneficial owner, must be unique within an entity.
The title for this person
/soleTrader
.
The person
's/soleTrader
's first name.
The person
's/soleTrader
's middle name or initial.
The person
's/soleTrader
's last name.
The residential status of the person
/soleTrader
.
Unique reference provided by the payee. Only required for certain payout destinations.
The type of the identity document.
The name of the institution that issued this document.
The country code of the issuing country specified in ISO 3166-1 Alpha-2 code format.
The date and time that the beneficial owner was created, as an ISO 8601 zoned date time.
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 }
A unique identifier for the party generated by us. This is sent in the response of your party creation call.
Your reference for this beneficial owner, must be unique within an entity.
The title for this person
/soleTrader
.
The person
's/soleTrader
's first name.
The person
's/soleTrader
's middle name or initial.
The person
's/soleTrader
's last name.
The residential status of the person
/soleTrader
.
Unique reference provided by the payee. Only required for certain payout destinations.
The type of the identity document.
The name of the institution that issued this document.
The country code of the issuing country specified in ISO 3166-1 Alpha-2 code format.
http://access.worldpay.com/parties/{partyId}/beneficialOwners/{beneficialOwnerId}
http://try.access.worldpay.com/parties/{partyId}/beneficialOwners/{beneficialOwnerId}
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" } ] }
OK
The link returned from Identity Verification Status (IVS) used to retrieve additional details from the user.
Your reference for this beneficial owner, must be unique within an entity.
The title for this person
/soleTrader
.
The person
's/soleTrader
's first name.
The person
's/soleTrader
's middle name or initial.
The person
's/soleTrader
's last name.
The residential status of the person
/soleTrader
.
Unique reference provided by the payee. Only required for certain payout destinations.
The type of the identity document.
The name of the institution that issued this document.
The country code of the issuing country specified in ISO 3166-1 Alpha-2 code format.
The date and time that the beneficial owner was created, as an ISO 8601 zoned date time.
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" }
http://access.worldpay.com/parties/{partyId}/beneficialOwners/{beneficialOwnerId}
http://try.access.worldpay.com/parties/{partyId}/beneficialOwners/{beneficialOwnerId}
No request payload