POST
UBO actions
For business (KYB) applications: each ultimate beneficial owner (UBO) has to verify their own identity. After submitting the KYB application with its UBOs, use this endpoint to drive their verification:
  • UBO_VERIFICATION_EMAIL — emails each listed UBO a hosted verification link. You can set redirectSuccessUrl / redirectRejectUrl for where they land afterwards, and ttlInSecs for link validity.
  • UBO_RESET — resets a UBO’s verification so they can resubmit (after a rejection, for example).
The response carries a per-UBO results array — it can be partial, so check each entry. Track overall progress with verification status using includeUbos=true.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

applicationId
string
required

The unique identifier of the application.

Query Parameters

programId
string
required

The program the application/customer belongs to. Appended as a query parameter on every back-office request.

Body

application/json
action
enum<string>
required

The action to run against the listed UBOs.

Available options:
UBO_VERIFICATION_EMAIL,
UBO_RESET
uboIds
string[]
required

The UBOs to act on.

Minimum array length: 1

Response

Action results (may be partial — check each entry).

success
boolean
Example:

true

action
string
Example:

"UBO_VERIFICATION_EMAIL"

results
object[]