RFIs

Create an item's verification link

Create a link for a ubo_link item whose answer_spec carries applicant_id rather than a ready-made url — see RFI values. A signature_link item gets its link the same way: the link opens the signing step of the legal representative its applicant_id names. A fatca_questions item gets a link into the sub-client’s U.S. tax form questions; once they are answered it answers 409.

Each link is short-lived, so create one when the person clicks rather than when the page renders.

POST

rfis

{rfi_id}

items

{item_id}

ubo-link

Create an item's verification link

curl --request POST \
  --url https://api.balampay.com/sandbox/v1/rfis/{rfi_id}/items/{item_id}/ubo-link \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.balampay.com/sandbox/v1/rfis/{rfi_id}/items/{item_id}/ubo-link"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.balampay.com/sandbox/v1/rfis/{rfi_id}/items/{item_id}/ubo-link', 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.balampay.com/sandbox/v1/rfis/{rfi_id}/items/{item_id}/ubo-link",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.balampay.com/sandbox/v1/rfis/{rfi_id}/items/{item_id}/ubo-link"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.balampay.com/sandbox/v1/rfis/{rfi_id}/items/{item_id}/ubo-link")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "url": "https://identity.example.com/websdk/p/aGVsbG8tdGhlcmU?t=eyJhbGciOi…",
  "expires_at": "2026-09-11T12:00:00.000Z"
}

Authorizations

Authorization

string

header

required

The data.access_token value from Get access token.

Headers

X-Api-Version

string

The date-versioned API version to apply for this request (e.g. 2026-04-14). When sent it always wins, even over your pinned account default. When omitted, the API uses your account's pinned version if set, otherwise a baseline default.

Example:

"2026-04-14"

Path Parameters

rfi_id

string<uuid>

required

RFI UUID.

item_id

string<uuid>

required

Item UUID. Must be a signature_link or fatca_questions item of this RFI, or a ubo_link item whose answer_spec carries applicant_id, not a pasted url.

Response

The link was created.

url

string<uri>

An https link to the identity-verification page for the person to open. Render it as a link, not a form field: nothing comes back through this API, and the item closes on its own once they finish. The host belongs to the service that runs the check rather than to Kira, so open the link exactly as it arrives and never rebuild it from parts.

expires_at

string<date-time>

When this specific link stops working — about an hour out, though read the field rather than hard-coding that. Past it, create a new one instead of reusing this one.

Create an item's verification link

curl --request POST \
  --url https://api.balampay.com/sandbox/v1/rfis/{rfi_id}/items/{item_id}/ubo-link \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.balampay.com/sandbox/v1/rfis/{rfi_id}/items/{item_id}/ubo-link"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.balampay.com/sandbox/v1/rfis/{rfi_id}/items/{item_id}/ubo-link', 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.balampay.com/sandbox/v1/rfis/{rfi_id}/items/{item_id}/ubo-link",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.balampay.com/sandbox/v1/rfis/{rfi_id}/items/{item_id}/ubo-link"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.balampay.com/sandbox/v1/rfis/{rfi_id}/items/{item_id}/ubo-link")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "url": "https://identity.example.com/websdk/p/aGVsbG8tdGhlcmU?t=eyJhbGciOi…",
  "expires_at": "2026-09-11T12:00:00.000Z"
}

Across the API

Authentication

Versioning

Users

Virtual Accounts

Recipients

Quotations

Payouts

Ultimate Payors

Capabilities

Catalogs

RFIs

Create an item's verification link

Authorizations

Headers

Path Parameters

Response