Skip to main content
POST

Authorizations

Authorization
string
header
required

Use Bearer {your_api_token} in the Authorization header.

Headers

Accept
string
default:application/json
Content-Type
string
default:application/json

Body

application/json
type
integer
default:1
required

Trust Flow link type. Use 1 for a single-use link. Only one verification can be completed with this link. Use 2 for a time-use link. The link can be reused multiple times until it reaches its expiry time. Must be an integer — string values such as single_use or time_use are not supported.

trustFlowId
integer
required

Trust Flow ID used to generate the link.

expiry
string<date-time>

Expiry date and time in ISO 8601 format, including timezone offset. Required when type is 2. Optional when type is 1. Example: 2026-06-20T16:00:00+08:00.

metadata
string

Optional custom key-value data appended to the generated URL as the m query parameter. Example: accid:112233,transactionId:aabb-1234-000.

Response

200 - application/json

Trust Flow link generated successfully

success
boolean

Indicates whether the link was generated successfully.

Full generated Trust Flow link.