Skip to content
APIs/Parties/Identity verification

Identity verification

Enable identity verification check on a party.

Operations

Perform identity verification

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
performIdentityVerificationbooleanwrite-only
{
  "performIdentityVerification": true
}

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

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

{
  "overall": {
    "identityVerificationState": "started",
    "identityVerificationMethod": "identityVerificationService"
  },
  "party": {
    "identityVerificationState": "started",
    "partyReference": "Euna925",
    "partyId": "par1Bbf6r80Q3mEvhp_xBKNM0"
  },
  "beneficialOwners": [
    {
      "identityVerificationState": "started",
      "beneficialOwnerReference": "Floy829",
      "beneficialOwnerId": "parsH2dSCcczQveB-GQNx0qq0"
    },
    {
      "identityVerificationState": "started",
      "beneficialOwnerReference": "Christina843",
      "beneficialOwnerId": "parbQR-8sRkYASaOzOVPX5d10"
    },
    {
      "identityVerificationState": "started",
      "beneficialOwnerReference": "Arlo912",
      "beneficialOwnerId": "pargosUuzW0vv8HrWsCTuadb0"
    }
  ]
}