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.

WP-Api-Versionstring, (date)required

The API version.

Example:2025-01-01

curl -i -X GET \
  -u '<username>:<password>' \
  'https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/{partyId}/identityVerification' \
  -H 'WP-Api-Version: 2025-01-01'

Responses

OK

Bodyapplication/json

errorNamestring

An ordinal error type that is part of the API contract. It is machine readable, but also human readable for clarity and semantic understanding of the error.

Example:"bodyDoesNotMatchSchema"

messagestring

A human readable message giving a corrective action for the error. THIS IS NOT FOR MACHINE CONSUMPTION.

validationErrorsArray of objects

pathParameterstring

queryParameterstring

jsonPathstring

overallobject

partyobject

beneficialOwnersArray of objects

Response

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