开设个人账户
账户开设分两个必要步骤。首先,POST 请求发送初步数据以预留账户。随后,系统会触发状态为 pending_additional_data 的 account_request.status_change 类型 webhook。在第二步中,PATCH 请求完成开户,以补充信息正式确认账户。
申请预留账户
Request
ENDPOINT
/account_request/escrowMÉTODO
POSTRequest Body
{
"account_owner": {
"document_number": "64669455000187",
"email": "marcos.alves@yopmail.com",
"birthdate": "2017-09-16",
"name": "NOME",
"documents": {
"rg": {
"ocr_front_key": "9d6fefc0-77c9-4acc-8526-53523ff155b9",
"ocr_back_key": "30157d15-3b93-46ad-9c94-cd8bd533f9ed"
},
"cnh": {
"ocr_key": "f30cea56-dd66-415b-9a28-746f7330b708"
}
},
"face": "dbdaf3c9-cdf6-4737-8551-92910b213b7e"
}
}
CPF/CNPJ 模拟
要模拟审批、拒绝和人工审核等情况,可使用账户 owner 的 CPF/CNPJ 第一位数字:
0 至 6 -> 人工审核
7 -> 被 bacen protege+ 拒绝
8 -> KYC 自动拒绝
9 -> 自动审批
Request Body Params
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
account_owner * | object | 包含账户持有人信息的对象 | Objeto account_owner |
Objeto account_owner
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
document_number * | string | 账户持有人 CPF | 11 |
email * | string | 账户持有人邮箱 | 200 |
birthdate * | string | 出生日期(格式 YYYY-MM-DD) | 10 |
name * | string | 账户持有人姓名 | 50 |
documents * | object | 账户持有人证件 | Objeto documents |
face * | uuidv4 | 反欺诈人脸识别键(face_recognition_key) | 36 |
Objeto documents
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
rg | object | 持有人 RG 正反面 OCR 键 | Objeto rg |
cnh | object | 持有人 CNH OCR 键 | Objeto cnh |
cnh_digital | object | 持有人数字 CNH OCR 键 | Objeto cnh_digital |
national_registry_of_foreigners | object | 持有人 RNE 正反面 OCR 键 | Objeto national_registry_of_foreigners |
national_migration_registry | object | 持有人 CRNM 正反面 OCR 键 | Objeto national_migration_registry |
passport | object | 持有人护照 OCR 键 | Objeto passport |
cin_digital | object | 持有人数字国家身份证 OCR 键 | Objeto cin_digital |
信息
上传文档图片的 OCR 键(ocr_key 或 ocr_front_key 和 ocr_back_key)由反欺诈系统图片上传响应提供。face_recognition_key 在人脸识别响应中返回。
Objeto rg
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
ocr_front_key * | uuidv4 | RG 正 面图片 OCR 键 | 36 |
ocr_back_key * | uuidv4 | RG 背面图片 OCR 键 | 36 |
或
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
ocr_key * | uuidv4 | RG 图片 OCR 键 | 36 |
Objeto cnh
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
ocr_front_key * | uuidv4 | CNH 正面图片 OCR 键 | 36 |
ocr_back_key * | uuidv4 | CNH 背面图片 OCR 键 | 36 |
或
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
ocr_key * | uuidv4 | CNH 图片 OCR 键 | 36 |
Objeto cnh_digital
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
ocr_key * | uuidv4 | 数字 CNH 图片 OCR 键 | 36 |
Objeto national_registry_of_foreigners
| 字段 | 类型 | 描 述 | 字符数 |
|---|---|---|---|
ocr_front_key * | uuidv4 | RNE 正面图片 OCR 键 | 36 |
ocr_back_key * | uuidv4 | RNE 背面图片 OCR 键 | 36 |
或
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
ocr_key * | uuidv4 | RNE 图片 OCR 键 | 36 |
Objeto national_migration_registry
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
ocr_front_key * | uuidv4 | CRNM 正面图片 OCR 键 | 36 |
ocr_back_key * | uuidv4 | CRNM 背面图片 OCR 键 | 36 |
或
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
ocr_key * | uuidv4 | CRNM 图片 OCR 键 | 36 |
Objeto passport
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
ocr_key * | uuidv4 | 护照图片 OCR 键 | 36 |
Objeto cin_digital
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
ocr_key * | uuidv4 | 数字国家身份证图片 OCR 键 | 36 |
Response
STATUS
201Response Body
{
"account_info": {
"account_branch": "0001",
"account_digit": "0",
"account_number": "1693580"
},
"account_request_key": "f230f1b5-07af-4737-b0e3-8a472304f5e7",
"account_request_status": "pending_bacen_validation"
}
Bacen Protege+ 流程
提案从 pending_bacen_validation 状态开始。系统在继续 KYC 分析之前,先向 Bacen Protege+ 进行预验证。Bacen 批准后,状态将自动更新为 pending_kyc_analysis。
注意
account_request_key 字段需保存,将用于确认开户。
Response Body Params
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
account_info * | object | 包含账户持有人信息的对象 | Objeto account_info |
account_request_key * | string | 创建请求的标识键 | - |
account_request_status * | string | KYC 状态 | - |
Objeto account_info
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
account_branch * | string | 机构编号 | 4 |
account_digit * | string | 账户数字 | 11 |
account_number * | string | 账户号码 | 50 |
STATUS
4xxResponse Body: Error
{
"title": "titulo",
"description": "description in English",
"translation": "descrição em portugues",
"code": "codigo",
"extra_fields": {}
}
HTTP 代码status | QI 代码code | 标题title | 描述(英文)description | 描述(葡文)translation |
|---|---|---|---|---|
| 400 | QIT000001 | Bad Request | Schema Error | Erro de Schema |
| 404 | QIT000404 | Not Found | Resource could not be found | Recurso não encontrado |