Users

Request a liveness verification link

Issue hosted liveness-check link(s) for a user. Liveness cannot be performed through an API upload — it needs an interactive session — so relay each returned link to the right end user. Returns one link for an individual user and one link per beneficial owner for a business; each entry is tagged with subject (and, for a beneficial owner, person_reference_id and name) so you can route it. The request body is optional; supply redirect to send the user back to your own page after the session (see below). Calling this again for a subject whose link is still active returns that same link rather than issuing a new one — unless you supply a different redirect, which mints a fresh link. Completion is reported per link via the user.liveness_completed webhook and, on approval, a verification report is attached to the user. A liveness result never changes the user’s status. The redirect landing is a UX convenience, not the result — always treat the user.liveness_completed webhook as the source of truth, since a session can still be held or expire after the user sees a success page.

POST

users

{user_id}

liveness-link

Request a liveness verification link

curl --request POST \
  --url https://api.balampay.com/v1/users/{user_id}/liveness-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "redirect": {
    "success_url": "https://app.example.com/kyc/done",
    "reject_url": "https://app.example.com/kyc/failed"
  }
}
'

import requests

url = "https://api.balampay.com/v1/users/{user_id}/liveness-link"

payload = { "redirect": {
        "success_url": "https://app.example.com/kyc/done",
        "reject_url": "https://app.example.com/kyc/failed"
    } }
headers = {
    "Authorization": "Bearer <token>",
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'x-api-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    redirect: {
      success_url: 'https://app.example.com/kyc/done',
      reject_url: 'https://app.example.com/kyc/failed'
    }
  })
};

fetch('https://api.balampay.com/v1/users/{user_id}/liveness-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/v1/users/{user_id}/liveness-link",
  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([
    'redirect' => [
        'success_url' => 'https://app.example.com/kyc/done',
        'reject_url' => 'https://app.example.com/kyc/failed'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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.balampay.com/v1/users/{user_id}/liveness-link"

	payload := strings.NewReader("{\n  \"redirect\": {\n    \"success_url\": \"https://app.example.com/kyc/done\",\n    \"reject_url\": \"https://app.example.com/kyc/failed\"\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("x-api-key", "<api-key>")
	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.balampay.com/v1/users/{user_id}/liveness-link")
  .header("Authorization", "Bearer <token>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"redirect\": {\n    \"success_url\": \"https://app.example.com/kyc/done\",\n    \"reject_url\": \"https://app.example.com/kyc/failed\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.balampay.com/v1/users/{user_id}/liveness-link")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"redirect\": {\n    \"success_url\": \"https://app.example.com/kyc/done\",\n    \"reject_url\": \"https://app.example.com/kyc/failed\"\n  }\n}"

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

{
  "links": [
    {
      "subject": "user",
      "liveness_link": "https://kyc.example.com/websdk/...",
      "expires_at": "2026-01-16T20:30:00.000Z"
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "error": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "details": "<array>"
}

{
  "message": "<string>",
  "code": "<string>",
  "statusCode": 123,
  "error": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": "<unknown>"
}

{
  "message": "<string>",
  "code": "<string>",
  "statusCode": 123,
  "error": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": "<unknown>"
}

{
  "message": "<string>",
  "code": "<string>",
  "statusCode": 123,
  "error": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": "<unknown>"
}

Stable since 2025-01-01 — unchanged in 2026-04-14.

Authorizations

Authorization

string

header

required

Access token from POST /auth (the data.access_token value).

x-api-key

string

header

required

API key issued by Kira. Required on every request, including /auth.

Headers

X-Api-Version

string

Optional. 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

user_id

string<uuid>

required

User UUID.

Body

application/json

redirect

object

Optional. Where to send the user after the hosted session, instead of the default completion screen. Opt-in per client: each URL must be HTTPS and its host must be on your redirect allowlist; an unlisted or non-HTTPS URL is rejected with 422. The allowlist is configured by the Kira team — there is no API or dashboard for it: email support@kirafin.ai with the domains you want allowlisted (subdomain matches are allowed) and the environments they apply to. Until they are registered, any request carrying a redirect returns 422. Omit to keep the default completion screen. Bound to the link when it is issued — a repeat call with a different redirect mints a new link.

Show child attributes

Response

Liveness link(s) issued — one entry per subject.

links

object[]

One entry for an individual user, one per beneficial owner for a business.

Show child attributes

Request a liveness verification link

curl --request POST \
  --url https://api.balampay.com/v1/users/{user_id}/liveness-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "redirect": {
    "success_url": "https://app.example.com/kyc/done",
    "reject_url": "https://app.example.com/kyc/failed"
  }
}
'

import requests

url = "https://api.balampay.com/v1/users/{user_id}/liveness-link"

payload = { "redirect": {
        "success_url": "https://app.example.com/kyc/done",
        "reject_url": "https://app.example.com/kyc/failed"
    } }
headers = {
    "Authorization": "Bearer <token>",
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'x-api-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    redirect: {
      success_url: 'https://app.example.com/kyc/done',
      reject_url: 'https://app.example.com/kyc/failed'
    }
  })
};

fetch('https://api.balampay.com/v1/users/{user_id}/liveness-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/v1/users/{user_id}/liveness-link",
  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([
    'redirect' => [
        'success_url' => 'https://app.example.com/kyc/done',
        'reject_url' => 'https://app.example.com/kyc/failed'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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.balampay.com/v1/users/{user_id}/liveness-link"

	payload := strings.NewReader("{\n  \"redirect\": {\n    \"success_url\": \"https://app.example.com/kyc/done\",\n    \"reject_url\": \"https://app.example.com/kyc/failed\"\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("x-api-key", "<api-key>")
	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.balampay.com/v1/users/{user_id}/liveness-link")
  .header("Authorization", "Bearer <token>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"redirect\": {\n    \"success_url\": \"https://app.example.com/kyc/done\",\n    \"reject_url\": \"https://app.example.com/kyc/failed\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.balampay.com/v1/users/{user_id}/liveness-link")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"redirect\": {\n    \"success_url\": \"https://app.example.com/kyc/done\",\n    \"reject_url\": \"https://app.example.com/kyc/failed\"\n  }\n}"

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

{
  "links": [
    {
      "subject": "user",
      "liveness_link": "https://kyc.example.com/websdk/...",
      "expires_at": "2026-01-16T20:30:00.000Z"
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "error": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "details": "<array>"
}

{
  "message": "<string>",
  "code": "<string>",
  "statusCode": 123,
  "error": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": "<unknown>"
}

{
  "message": "<string>",
  "code": "<string>",
  "statusCode": 123,
  "error": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": "<unknown>"
}

{
  "message": "<string>",
  "code": "<string>",
  "statusCode": 123,
  "error": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": "<unknown>"
}

Authentication

Versioning

Users

Virtual Accounts

Quotations

Payouts

Recipients

Reference

Request a liveness verification link

Authorizations

Headers

Path Parameters

Body

Response