个人账户开户
Request
ENDPOINT
/accountMÉTODO
POSTRequest Body
{
"account_owner": {
"address": {
"street": "Av. Brigadeiro Faria Lima",
"state": "SP",
"city": "São Paulo",
"neighborhood": "Jardim Paulistano",
"number": "2391",
"postal_code": "01452905",
"complement": "1o. Andar"
},
"birth_date": "1990-05-06",
"document_identification": "3c24579b-9810-4fa6-9b08-fe67d237160a",
"email": "api@qitech.com.br",
"individual_document_number": "34651104630",
"is_pep": false,
"mother_name": "Maria Mariane",
"name": "Qi Tech Ltda.",
"nationality": "nationality",
"person_type": "natural",
"phone": {
"country_code": "055",
"area_code": "11",
"number": "999999999"
},
"proof_of_residence": "780456bd-1eec-4e5f-82c0-d8c3921497ea"
},
"signed_contract": {
"document_key": "4d7f4e29-4b58-4905-9a69-b1f9215263f5",
"signatures": [
{
"authenticity": {
"timestamp": "1970-01-01T00:00:01.080100Z",
"facial_recognition_key": "79003de0-2590-455d-9b73-426b8ca284eb",
"lang": "-35.8916627",
"lat": "-7.2226067",
"ip_address": "177.51.1.000",
"session_id": "jdifj329842"
},
"signer": {
"name": "IVANILDO DE SENA LIMA",
"email": "teste@gmail.com",
"phone": {
"country_code": "055",
"area_code": "11",
"number": "999999999"
},
"document_number": "99999999999"
},
"authentication_type": "opt-in"
}
]
}
}
复制粘贴示例载荷
开始测试之前,document_identification 字段中的 document_key 必须替换为上传账户持有人文件时返回的密钥。
CPF/CNPJ 模拟
为模拟审批、拒绝和人工审查情况,可使用账户 owner 的 CPF/CNPJ 首位数字:
0 至 7 -> 人工审查
8 -> 自动拒绝
9 -> 自动审批
请求体参数
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
account_owner | object | 账户持有人对象 | account_owner 对象 |
signed_contract * | object | 包含合同签署信息的对象 | signed_contract 对象 |
account_owner 对象
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
address | string | 客户地址 | address 对象 |
birth_date * | string | 出生日期("YYYY-MM-DD" 格式) | |
document_identification * | string | 带照片身份证件(身份证或驾照)PDF 的 DOCUMENT_KEY(提前上传) | |
document_identification_back * | string | 带照片身份证件背面(身份证或驾照)PDF 的 DOCUMENT_KEY(提前上传) | |
document_identification_type * | string | 提前上传的证件类型(身份证或驾照) | |
email * | string | 客户电子邮箱 | |
individual_document_number | string | CPF(仅数字,限 11 位) | |
is_pep * | string | 声明该人是否为政治公众人物(PEP) | |
mother_name * | string | 个人账户情况下的客户母亲姓名 | 100 |
name * | string | 法人账户情况下的公司名称,或个人账户情况下的个人姓名 | 100 |
nationality * | string | 客户国籍 | 50 |
person_type * | string | 标识所发送对象为个人还是法人 | |
phone | string | 电话数据对象 | phone 对象 |
proof_of_residence | string | 所提供地址的居住证明 PDF 的 DOCUMENT_KEY(提前上传) |
address 对象
此对象在个人和法人对象中均存在,是用于表示地址的简单对象。
| 字段 | 描述 | 示例 | 最大字符数 |
|---|---|---|---|
street * | string | 街道名称 | 100 |
state * | string | 州(两位大写字母) | 2 |
city * | string | 城市 | 100 |
neighborhood * | string | 社区/街区 | 100 |
number * | string | 门牌号 | 10 |
postal_code * | string | CEP(仅数字) | 8 |
complement * | string | 地址补充说明(自由文本) | 100 |
signed_contract 对象
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
| document_key * | uuidv4 | 开户条款或托管账户合同文件的唯一识别密钥(DOCUMENT_KEY 在上传文件端点的响应中返回) | 36 |
| signatures * | list | 已发送文件的签名数据,列表中的每个项目对应一位签署人 | signatures 对象 |
signatures 对象
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
| authenticity * | object | 证明签署人完成电子签名的一组数据 | authenticity 对象 |
| signer * | object | 包含文件某位签署人数据的对象 | signer 对象 |
| authentication_type * | enumerator | 签署类型,始终为 "opt-in" | "opt-in" |
authenticity 对象
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
| timestamp * | string | 文件签署时的日期和时间 | 27 |
| facial_recognition_key | uuidv4 | 账户持有人自拍照片的唯一识别密钥(DOCUMENT_KEY 在上传文件端点的响应中返回) | 36 |
| lang | string | 签署时捕获的签署人地理定位经度坐标 | - |
| lat | string | 签署时捕获的签署人地理定位纬度坐标 | - |
| ip_address | string | 签署人设备的 IP 地址 | - |
| session_id | string | 签署时签署人的会话 ID | - |
signer 对象
| 字段 | 类型 | 描述 | 字符数 |
|---|---|---|---|
| name * | string | 签署人姓名 | - |
| email * | string | 签署人电子邮箱 | - |
| phone * | object | 签署人电话数据对象 | phone 对象 |
| document_number * | string | 签署人 CPF | 11 |
phone 对象
| 字段 | 描述 | 示例 | 最大字符数 |
|---|---|---|---|
country_code * | string | 电话 DDI 代码 | 3 |
area_code * | string | 电话 DDD 代码 | 2 |
number * | string | 电话号码(仅数字) | 10 |
Response
STATUS
200Response Body
{
"data": {
"account_info": {
"account_branch": "0001",
"account_digit": "3",
"account_number": "70091",
"financial_institution_code": "329",
"account_key": "7986dcc7-4331-478f-af47-adfbdf7f4a36"
},
"account_owner": {
"document_number": "08141163701",
"name": "Aurora Simone Catarina Nogueira"
}
},
"event_datetime": "2019-11-04 16:34:41",
"key": "f834af4d-ab4b-442f-96c9-f9940d8066d4",
"status": "pending_kyc_analysis",
"webhook_type": "account"
}
STATUS
400Response Body
{
"data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}