SuperAPI AI 工具集

alpaca-broker-account-onboarding

智能体与模型

查看项目

更新于 10-16 05:00

技能介绍

用途:在 Alpaca Broker API 下为你的公司创建并管理终端用户经纪账户,是 Broker API 集成的第一步;账户达到 ACTIVE 前无法入金、记账或交易。使用前需先阅读 alpaca-broker-integration 了解 base URL、认证与约定,本技能假定使用 Broker API + HTTP Basic 认证。

主要能力与端点:POST /v1/accounts 创建账户(提交申请);GET /v1/accounts 列出/查询账户(最多 1000);GET /v1/accounts/{account_id} 获取单个账户;PATCH /v1/accounts/{account_id} 更新账户;POST /v1/accounts/{account_id}/actions/close 关闭账户(返回 204);POST /v1/accounts/{account_id}/documents/upload 上传所有者/KYC 文档;GET /v1/accounts/{account_id}/documents 列出已上传文档;POST/GET /v1/accounts/{account_id}/cip 提交/获取 CIP 结果;GET /v1/country-info 支持国家数据;GET /v1/events/accounts/status 账户状态变更 SSE 流。

创建账户请求需四个对象:contact、identity、disclosures、agreements;documents 与 trusted_contact 可选但 KYC 通常需要。contact.street_address 为数组(最多 3 行),当国家/税务居住地为 USA 时 state 必填;identity.funding_source 为数组,取值含 employment_income、investments、inheritance、business_income、savings、family;tax_id_type 枚举庞大且按国家区分(如 USA_SSN、USA_ITIN、IND_PAN、MEX_RFC、GBR_NINO 及 NATIONAL_ID、PASSPORT 等),应查询规范而非硬编码。可选顶层字段:account_type、account_sub_type、enabled_assets。响应:200 返回账户对象,409 邮箱已注册,422 值无效,400 请求体格式错误。

协议:每项含 agreement、signed_at(RFC3339)、ip_address(IPv4),可选 revision;必须向用户展示协议文本并记录真实签署时间与 IP。文档:documents[] 项含 document_type 与 content(base64)或 content_data;mime_type 支持 application/pdf、image/png、image/jpeg,w8ben 额外支持 application/json。W-8BEN 可上传结构化 W8benDocument JSON 由 Alpaca 渲染官方表单。使用 Alpaca KYC 即服务时单文件上限 10 MB。

状态生命周期:ONBOARDING、SUBMITTED、SUBMISSION_FAILED、ACTION_REQUIRED、APPROVAL_PENDING、APPROVED、ACTIVE、REJECTED、ACCOUNT_UPDATED、ACCOUNT_CLOSED、INACTIVE;正常路径为 SUBMITTED → APPROVAL_PENDING → APPROVED → ACTIVE。所有下游操作须以 ACTIVE 为门槛,创建返回 200 不代表可交易,应订阅状态 SSE 或轮询。

KYC 与 CIP:kyc_results 含 reject/accept/indeterminate 类别及 additional_information;自行 KYC 可通过 POST /v1/accounts/{id}/cip 提交 CIPInfo。个人账户最低需验证姓名、出生日期、地址和身份证号。WATCHLIST_HIT / COUNTRY_NOT_SUPPORTED 由 Alpaca 人工处理。

集成建议:国家字段须为 ISO 3166-1 alpha-3 并对照 GET /v1/country-info 校验;创建视为异步,立即持久化 account_id;防止生产代码路径混入 paper/test 账户;重复邮箱 409 时查找已有账户;关闭前须先平仓并提取全部现金,账户记录不会删除而是变为 ACCOUNT_CLOSED。相关技能:入金、记账、交易、SSE 事件。