/v3/businesses/ 下的六个公开 endpoint 完成。本页介绍概念性流程;完整的请求与响应架构,请参阅 API 参考。
列出企业
GET /v3/businesses/
为您的应用返回分页的企业列表,可按状态、搜索关键词、国家/地区和日期范围进行筛选。
获取企业
GET /v3/businesses/{vendor_data}/
通过 vendor_data 获取单个企业。
创建企业
POST /v3/businesses/create/
在企业验证(KYB)会话运行之前,预先创建企业:
vendor_data 相同的企业已存在,则返回冲突错误。如需更新已有企业,请使用 PATCH。
更新企业
PATCH /v3/businesses/{vendor_data}/
更新可变的资料字段。通过登记信息查询得到的字段(legal_name、registration_number、country_code)在验证后为只读,但仍可被覆盖;覆盖操作会在审计日志中标记。
可变字段:display_name、metadata、tags。
验证后只读:所有源自登记信息的字段、汇总计数器以及 features 映射。
business.data.updated。
变更状态
PATCH /v3/businesses/{vendor_data}/update-status/
在 ACTIVE、FLAGGED 和 BLOCKED 之间切换企业状态。
触发
business.status.updated。
批量删除企业
POST /v3/businesses/delete/
删除一个或多个企业。企业记录将被永久删除。此 endpoint 不涵盖这些企业的验证会话:会话会保留,但与企业的关联会被清除;如需删除会话,请使用删除会话。此 endpoint 也不涵盖交易记录;请在控制台中删除这些交易。
权限模型
所有/v3/businesses/* endpoint 均受 businesses 权限资源的范围限定:
参阅角色与权限。
这些操作触发的 Webhook
后续步骤
数据模型
完整的字段参考。
列表 API
GET /v3/businesses/ 的架构。
创建 API
POST /v3/businesses/create/ 的架构。