Skip to main content

概览

getBusiness 查询会返回某个企业账户当前的 KYB 状态,并附带一份所有权名册快照,展示每位所有者在身份验证中的进度。 注册企业之后,它能帮助你回答两个问题:
  • 企业是否已经获批? 查看 kybStatus
  • 是什么在阻碍审批? 查看 owners —— 仍处于 PENDING_CIPPENDING_INVITE 的所有者通常就是原因。
你也可以订阅 KYB_STATUS_UPDATE webhook 来接收状态变更,从而避免定时读取。该 webhook 仅承载企业状态,因此当你需要所有者名册时仍应调用此查询。参见跟踪申请

必需的权限范围

该查询不接受参数——它始终解析与调用令牌的 accountId 绑定的企业。请使用为 registerBusiness 返回的企业账户铸造的令牌;你用于注册的消费者令牌将无法使用。
当 Fluz 在注册期间创建企业 OAuth 授权时,会强制将 REGISTER_BUSINESS 包含在该授权的 scopes 中,因此为新企业账户铸造的令牌始终可以调用此查询。

基本查询结构

响应详情

BusinessOwnerStatus

ExternalKybStatus(枚举)

registerBusiness 返回 SUBMITTED,它不属于该枚举的取值——同一时刻在这里会读作 PENDING
PENDING 将多个内部状态折叠为一个值。这在一个地方很重要:requestOwnerDocumentVerificationLink 仅在案件处于某个特定内部状态时可用,而 kybStatus 无法告知你当前所处的具体状态。

BusinessOwnerVerificationType(枚举)

ExternalBusinessOwnerStatus(枚举)

cURL 示例

示例响应

Jane 需要一个验证链接。Carol 已被邀请,Fluz 将会给她发送邮件。只有当两人都达到 READY 后,该企业才能获批。

错误代码

此查询将所有失败返回在顶层的 errors 数组中——不会有 success: false 的负载。

最佳实践

  • 优先使用 webhook,读取用于对账。 订阅 KYB_STATUS_UPDATE 以降低延迟;当用户返回你的引导页时或以低频后台计划进行读取——每小时一次,而非每次页面加载都读取。
  • 在上线前等待双重信号。 kybStatus: APPROVED,且每位所有者均为 READY
  • 不要将链接请求视为进度。 只有当所有者实际完成验证时,其 status 才会变化,而不是当你生成了他们的链接时。

相关页面

KYB 概览

状态生命周期以及如何将案件跟踪至决策。

所有者验证链接

为被报告为 DOCUMENTS 且处于 PENDING_CIP 的所有者生成链接。

注册企业

创建本查询所读取账户的 mutation。