Skip to main content
POST
Mint a beneficiary's verification link

Authorizations

Authorization
string
header
required

The data.access_token value from Get access token.

x-api-key
string
header
required

API key issued by Kira.

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

rfi_id
string<uuid>
required

RFI UUID.

item_id
string<uuid>
required

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

Response

The link was minted.

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, mint a new one instead of reusing this one.