Beneficial owners

Update a beneficial owner

put/parties/{partyId}/beneficialOwners/{beneficialOwnerId}

Request

Base URL
https://try.access.worldpay.com
Auth
HTTP basic

Path parameters

partyIdstring required

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

beneficialOwnerIdstring 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.

Request body

identityVerificationMethod'merchantCompliant' | 'identityVerificationService'

identityVerificationDatestring date

A valid date as YYYY-MM-DD

urlstring

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

messagestring

The message associated with link returned from Identity Verification Status (IVS).

beneficialOwnerReferencestring required

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

beneficialOwnerIdstring

A unique identifier for the beneficial owner generated by us.

emailstring email

dateTimeCreatedstring

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

versioninteger

dateTimeUpdatedstring

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

Example request

{
  "identityVerificationDate": "2033-11-22",
  "beneficialOwnerReference": "Hosaka27384910",
  "personalDetails": {
    "title": "Mr",
    "firstName": "Case",
    "middleName": "Henry",
    "lastName": "Mitchell",
    "alias": "Junior Case",
    "socialSecurityNumber": "004-54-6578",
    "dateOfBirth": "1983-10-12",
    "address": {
      "address1": "1847 Kingsbury Court",
      "address2": "Unit 42",
      "city": "London",
      "state": "Greater London",
      "countryCode": "GB",
      "postalCode": "NW9 0RR",
      "type": "home"
    },
    "customerReference": "7564389201",
    "previousHomeAddress": {
      "address1": "1847 Kingsbury Court",
      "address2": "Unit 42",
      "city": "London",
      "state": "Greater London",
      "countryCode": "GB",
      "postalCode": "NW9 0RR",
      "type": "home"
    },
    "website": "https://example.com/"
  },
  "relationshipToBusiness": {
    "isPrincipalOwner": true
  },
  "phones": [
    {
      "prefix": "44",
      "number": "4281234"
    }
  ],
  "identityDocuments": [
    {
      "issuingInstitution": "State Department",
      "issuingCountry": "JP",
      "validFrom": "2023-11-22",
      "validTo": "2023-11-22"
    }
  ],
  "dateTimeCreated": "2025-01-23T12:23:445.222Z",
  "dateTimeUpdated": "2025-01-25T14:57:012.302Z"
}

Response