/rfi

RFI 事件通知。仅在合作方开通 notify_rfi 后发送;开通后 Legend 会跳过 RFI 相关邮件/短信,由合作方负责通知用户。

当 Legend 向用户发起 RFI、重发 RFI、审核通过 RFI 或关闭 RFI 时,都会调用这个 API 来通知交易所,并附带本次 RFI 需要用户补充的事项明细。此 API 为可选。

开通此接口后,Legend 会停止发送 RFI 相关邮件与短信,改由交易所自行通知用户。若只需要同步 RFI 状态、仍希望 Legend 继续发送邮件,请只开通 /rfi-status。

请求参数说明

参数名类型必传说明
user_external_idstring是用户在交易所侧的唯一标识符
rfi_idint是RFI 记录 ID
rfi_unique_idstring是RFI 唯一编号,建议优先用作幂等主键
emailstring是用户账号邮箱
first_namestring是用户的名字,可能为空字符串
middle_namestring是用户的中间名,可能为空字符串
last_namestring是用户的姓氏,可能为空字符串
additional_itemstring是本次 RFI 需要用户补充的事项列表。该值为 JSON 字符串,需二次解析后得到数组。税号索取会以 Tax Number 出现在该列表中
created_atstring是RFI 创建时间,UTC,格式 YYYY-MM-DDTHH:mm:ssZ
updated_atstring是RFI 最近更新时间,格式同上
rfi_statusstring否用户当前最新的 RFI 状态,仅在开通该选项时下发。注意此处为原始值(如 In Review),与 /rfi-status 的小写下划线格式不同
cuteid_uuidstring否CuteID 用户唯一标识,仅 CuteID 体系用户在有值时下发

推送数据示例

{
  "user_external_id": "417ubQ==",
  "rfi_id": 20481,
  "rfi_unique_id": "a1b2c3d4e5f6",
  "email": "i******[email protected]",
  "first_name": "I******S",
  "middle_name": "",
  "last_name": "B******S",
  "additional_item": "[\"Proof of Address\",\"Source of Funds\"]",
  "created_at": "2026-08-20T02:11:05Z",
  "updated_at": "2026-08-26T03:40:22Z",
  "rfi_status": "Requested"
}

接口要求

  • 请求成功以 HTTP 状态码 200 判定,响应内容不参与判定,建议返回 {"code":0,"message":"ok"}。
  • 请在 3 秒内返回,业务逻辑建议异步处理。
  • Legend 会在通知失败(网络异常或非 200 响应)时通过队列重试,最多尝试 3 次,重试间隔 60 秒。仍失败时会记录错误日志;如需补推历史事件,请联系 Legend 技术支持。
  • 同一 RFI 可能因多次状态变更或队列重试收到重复通知,请按 rfi_unique_id(/rfi)或 rfi_unique_id + rfi_status(/rfi-status)做幂等处理。
  • 异步通知可能乱序到达,请按 updated_at 判断是否为最新状态,避免旧状态覆盖新状态。
  • Legend 会在请求头中携带约定的鉴权信息,请务必校验后再处理。

开通方式

请联系 Legend 对接人员,提供以下信息:

  1. 回调服务的基础地址(Base URL);
  2. 需要开通的接口(/rfi-status / /rfi);
  3. 是否需要由交易所接管 RFI 用户通知。开通 /rfi 后,Legend 不再发送 RFI 相关邮件与短信;
  4. 如需自定义回调路径,请一并提供。
Query Params
string
required

User identifier in the exchange system.

integer
required

RFI record ID.

string
required

Unique RFI identifier. Use it as the primary idempotency key when available.

string
required

User account email.

string
required

User first name. May be an empty string.

string
required

User middle name. May be an empty string.

string
required

User last name. May be an empty string.

string
required

JSON-encoded string of requested additional materials. Parse it again to get the array.

date-time
required

RFI creation time in UTC, formatted as YYYY-MM-DDTHH:mm:ssZ.

date-time
required

RFI last update time in UTC, formatted as YYYY-MM-DDTHH:mm:ssZ.

string
enum

Raw RFI status. Only sent when kyc_status_webhook.include_rfi_status is enabled.

Allowed:
string

CuteID user UUID. Only sent for CuteID users when available.

Headers
string
required

API Key agreed with Legend. CuteID-specific integrations use signed JSON body requests instead.

Response
200

Webhook received. Legend only uses HTTP 200 as the success signal.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!