Skip to main content
This page is for the engineer sending investors through hosted KYC. After reading it you will know how to create a link, how to lock one to a single wallet, and which links can no longer be revoked or resent. The idLinks sub-module manages KYC verification links powered by . Each link directs an investor to a hosted verification flow where they complete identity checks and optionally connect a wallet.
The created link carries: At least one of recipientEmail, recipientWallet, or recipientPhone is required. If recipientWallet is set, the investor must verify from that specific address. If omitted, any wallet can be connected during verification. Links can carry a fee the investor pays before verification starts. feeCents is in integer cents, so 2500 is 25.00 in the given currency.
The created link echoes feeCents and currency. List items expose feeCents, currency, and paidAt so you can track outstanding payments. status filters on PENDING, COMPLETED, or EXPIRED. The result carries links as IdLinkListItem[] and total as a number.
Expires a link immediately so it can no longer be used. Completed links cannot be revoked.
Only links with status PENDING can be resent. Completed or expired links throw a TrussetError.
The result returns verificationUrl and a per-channel delivery object, as { email: { sent: true }, sms: { sent: true } }.