POST
/
v1
/
applications
/
{applicationId}
/
ubos
/
actions
UBO actions
curl --request POST \
  --url https://api.next.orenda.finance/v1/applications/{applicationId}/ubos/actions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "UBO_VERIFICATION_EMAIL",
  "uboIds": [
    "ubo_7c1d9e2f",
    "ubo_4a6b8c0d"
  ]
}
'
import requests

url = "https://api.next.orenda.finance/v1/applications/{applicationId}/ubos/actions"

payload = {
"action": "UBO_VERIFICATION_EMAIL",
"uboIds": ["ubo_7c1d9e2f", "ubo_4a6b8c0d"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({action: 'UBO_VERIFICATION_EMAIL', uboIds: ['ubo_7c1d9e2f', 'ubo_4a6b8c0d']})
};

fetch('https://api.next.orenda.finance/v1/applications/{applicationId}/ubos/actions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.next.orenda.finance/v1/applications/{applicationId}/ubos/actions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'action' => 'UBO_VERIFICATION_EMAIL',
'uboIds' => [
'ubo_7c1d9e2f',
'ubo_4a6b8c0d'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.next.orenda.finance/v1/applications/{applicationId}/ubos/actions"

payload := strings.NewReader("{\n \"action\": \"UBO_VERIFICATION_EMAIL\",\n \"uboIds\": [\n \"ubo_7c1d9e2f\",\n \"ubo_4a6b8c0d\"\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.next.orenda.finance/v1/applications/{applicationId}/ubos/actions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"action\": \"UBO_VERIFICATION_EMAIL\",\n \"uboIds\": [\n \"ubo_7c1d9e2f\",\n \"ubo_4a6b8c0d\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.next.orenda.finance/v1/applications/{applicationId}/ubos/actions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"action\": \"UBO_VERIFICATION_EMAIL\",\n \"uboIds\": [\n \"ubo_7c1d9e2f\",\n \"ubo_4a6b8c0d\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "action": "UBO_VERIFICATION_EMAIL",
  "results": [
    {
      "uboId": "ubo_7c1d9e2f",
      "link": "https://verify.next.orenda.finance/ubo/7c1d9e2f?token=eyJ..."
    }
  ]
}
{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}
{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}
{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}
{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}
{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}
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[]