POST
UBO actions

Authorizations

Authorization
string
header
required

The user's id_token from authentication — the ID token, not the access_token. The program and environment (sandbox/prod) are read from the token.

Path Parameters

applicationId
string
required

The application id from create / get.

Body

application/json
action
enum<string>
required

Required.

Available options:
UBO_VERIFICATION_EMAIL,
UBO_RESET
uboIds
string[]
required

Required. The UBOs to act on.

Minimum array length: 1
redirectSuccessUrl
string

Optional. Where the verification flow sends the UBO on success.

redirectRejectUrl
string

Optional. Where it sends them on rejection.

ttlInSecs
number

Optional. How long the verification link stays valid.

Response

Action results (may be partial — check each entry)

success
boolean
Example:

true

action
string
Example:

"UBO_VERIFICATION_EMAIL"

results
object[]