申请开立个人账户
账户开立分两个必要步骤。首先,通过 POST 请求发送初步数据以预留账户。随后,系统触发状态为 pending_additional_data 的 account_request.status_change 类型 webhook。在第二步中,通过 PATCH 请求完成账户开立,以补充信息正式确认账户。
申请账户预留
Request
ENDPOINT
/account_request/checkingMÉTODO
POSTRequest Body
{
"request_control_key": "5ef0f67a-7672-4d00-8a02-faf847157c4b",
"account_owner": {
"document_number": "99999999999",
"email": "email@teste.com",
"birthdate": "2017-09-16",
"name": "Titular da Conta",
"documents": {
"rg": {
"ocr_front_key": "2ef0f67a-7672-4d00-8a02-faf847157b4a",
"ocr_back_key": "1bd0e0a1-c1fa-4f9c-a230-f7a4163864be"
},
"cnh": {
"ocr_key": "7a73be1a-0b66-4c0a-932a-1d1d02efdc4c"
}
},
"face": "d38dd3c0-6f24-43b9-a37a-425d6700620f"
}
}
CPF/CNPJ 模拟
要模拟批准、拒绝和人工审核场景,可使用账户所有者 CPF/CNPJ 的第一位数字:
0 至 7 -> 人工审核
8 -> KYC 自动拒绝
9 -> 自动批准
Request Body 参数
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
account_owner * | object | 包含账户持有人信息的对象 | account_owner 对象 |
request_control_key * | UUID | 合作伙伴每次请求的唯一标识符 | 36 |
account_owner 对象
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
document_number * | string | 账户持有人 CPF | 11 |
email * | string | 电子邮件 | 11 |
birthdate * | string | 账户持有人出生日期(格式 YYYY-MM-DD) | 10 |
name * | string | 账户持有人全名 | 50 |
documents* | object | 账户持有人文件 | documents 对象 |
face* | uuidv4 | 反欺诈人脸识别密钥(face_recognition_key) | 36 |
documents 对象
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
rg | object | 持有人身份证正反面上传的 OCR 密钥 | rg 对象 |
cnh | object | 持有人驾驶证上传的 OCR 密钥 | cnh 对象 |
cnh_digital | object | 持有人电子驾驶证上传的 OCR 密钥 | cnh_digital 对象 |
national_registry_of_foreigners | object | 持有人外国人登记证(RNE)正反面上传的 OCR 密钥 | national_registry_of_foreigners 对象 |
national_migration_registry | object | 持有人移民登记证(CRNM)正反面上传的 OCR 密钥 | national_migration_registry 对象 |
passport | object | 持有人护照上传的 OCR 密钥 | passport 对象 |
cin_digital | object | 持有人电子国家身份证上传的 OCR 密钥 | cin_digital 对象 |
说明
文件图像上传的 OCR 密钥(ocr_key 或 ocr_front_key 和 ocr_back_key)作为反欺诈系统中图像上传的响应返回。face_recognition_key 在人脸识别响应中返回。
rg 对象
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
ocr_front_key * | uuidv4 | 身份证正面图像上传的 OCR 密钥 | 36 |
ocr_back_key * | uuidv4 | 身份证背面图像上传的 OCR 密钥 | 36 |
或
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
ocr_key * | uuidv4 | 身份证图像上传的 OCR 密钥 | 36 |
cnh 对象
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
ocr_front_key * | uuidv4 | 驾驶证正面图像上传的 OCR 密钥 | 36 |
ocr_back_key * | uuidv4 | 驾驶证背面图像上传的 OCR 密钥 | 36 |
或
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
ocr_key * | uuidv4 | 驾驶证图像上传的 OCR 密钥 | 36 |
cnh_digital 对象
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
ocr_key * | uuidv4 | 电子驾驶证图像上传的 OCR 密钥 | 36 |
national_registry_of_foreigners 对象
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
ocr_front_key * | uuidv4 | 外国人登记证正面图像上传的 OCR 密钥 | 36 |
ocr_back_key * | uuidv4 | 外国人登记证背面图像上传的 OCR 密钥 | 36 |
或
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
ocr_key * | uuidv4 | 外国人登记证图像上传的 OCR 密钥 | 36 |
national_migration_registry 对象
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
ocr_front_key * | uuidv4 | 移民登记证正面图像上传的 OCR 密钥 | 36 |
ocr_back_key * | uuidv4 | 移民登记证背面图像上传的 OCR 密钥 | 36 |
或
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
ocr_key * | uuidv4 | 移民登记证图像上传的 OCR 密钥 | 36 |
passport 对象
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
ocr_key * | uuidv4 | 护照图像上传的 OCR 密钥 | 36 |
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 参数
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
account_info * | object | 包含账户持有人信息的对象 | account_info 对象 |
account_request_key * | string | 创建请求的标识键 | - |
account_request_status * | string | KYC 状态 | - |
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 |