跳到主要内容

开立企业账户

账户开立分两个必要步骤。首先，通过 POST 请求发送初步数据以预留账户。随后，系统触发状态为 pending_additional_data 的 account_request.status_change 类型 webhook。在第二步中，通过 PATCH 请求完成账户开立，以补充信息正式确认账户。

Request​

ENDPOINT
/account_request/checking
MÉTODO
POST

Path Params​

字段类型描述字符数
account_request_keyuuidv4账户预留请求的唯一标识键。36

开立自由流动账户​

Request Body
{
    "account_owner": {
        "phone": {
            "country_code": "55",
            "area_code": "11",
            "number": "999999999"
        },
        "email": "email@teste.com.br",
        "person_type": "legal",
        "name": "Empresa de Teste",
        "address": {
            "street": "Rua Abrahão Calux",
            "state": "SP",
            "city": "São Paulo",
            "neighborhood": "Vila Teste",
            "number": "116",
            "postal_code": "04286100",
            "complement": "Complemento"
        },
        "trading_name": "Nome fantasia",
        "company_document_number": "99999999000130",
        "cnae_code": "4721102",
        "foundation_date": "1980-07-11",
        "company_statute": "99999999-01c9-4cf5-a0fa-1d2a96f4b34d",
        "company_representatives": [
            {
                "name": "Nome do Socio",
                "individual_document_number": "99999999999",
                "document_identification_number": "999999999",
                "birth_date": "1989-09-01",
                "mother_name": "Maria da Silva",
                "email": "teste@gmail.com",
                "is_pep": false,
                "person_type": "natural",
                "nationality": "brasileiro(a)",
                "marital_status": "single",
                "document_identification": "88888-0ddf-4932-874f-9231794963da",
                "phone": {
                    "country_code": "055",
                    "area_code": "19",
                    "number": "999999999"
                },
                "address": {
                    "street": "Rua dos Limões",
                    "neighborhood": "Vila Moinho Velho",
                    "city": "São Paulo",
                    "state": "SP",
                    "postal_code": "04286100",
                    "number": "116",
                    "complement": "complemento"
                }
            }
        ],
        "company_type": "ltda"
    },
    "signed_contract": {
        "document_key": "57cda530-d469-4427-a9d4-2523a510dee1",
        "signatures": [
            {
                "authenticity": {
                    "timestamp": "2024-05-10T14:15:03.114895Z",
                    "ip_address": "192168161",
                    "lang": "-35.8916627",
                    "lat": "-7.2226067",
                    "session_id": "54b8e3cf-15de-41e5-9305-0ecf059d6e2a",
                    "facial_recognition_key": "c367a540-2e7e-4373-a167-61bc43c30dc1"
                },
                "signer": {
                    "name": "Nome do assinante",
                    "email": "teste@gmail.com.br",
                    "phone": {
                        "country_code": "55",
                        "area_code": "11",
                        "number": "999999999"
                    },
                    "document_number": "99999999"
                },
                "authentication_type": "opt-in"
            }
        ]
    },
    "additional_documents": [
        "61f2a65e-0ddf-4932-874f-9231794963da"
    ]
}

Request Body 参数​

字段类型描述字符数
account_owner *object账户所有者对象account_owner 对象
allowed_user *object与账户关联的用户。allowed_user 对象
account_managerobject将通过 API 操作账户的合作集成商数据。account_manager 对象
signed_contract *object包含合同签署信息的对象。signed_contract 对象

account_owner 对象​

字段类型描述字符数
address *object账户持有人地址对象address 对象
cnae_code *string国家经济活动分类代码9
company_document_number *stringCNPJ14
company_statute *string公司章程 PDF 的 DOCUMENT_KEY（预先上传）。36
company_typeenum公司类型company_type 枚举值
company_representatives *list公司法定代表人列表company_representatives 对象
email *string公司机构电子邮件。254
foundation_date *string公司成立日期（格式 "YYYY-MM-DD"）。10
name *string公司法定名称。100
person_type *enum标识所提交对象为法人。PJ 对象始终应包含值 "legal"。person_type 枚举值
phone *object账户持有人电话。phone 对象
trading_name *string商业名称。200

company_representatives 对象​

字段类型描述字符数
name *string公司代表姓名100
address *object公司代表地址对象address 对象
email *string公司代表电子邮件254
birth_date *string公司代表出生日期（格式 "YYYY-MM-DD"）10
individual_document_number *string公司代表 CPF（仅数字）。11
document_identificationstring附有照片的身份证明文件（RG 或 CNH）PDF 的 DOCUMENT_KEY（预先上传）36
document_identification_numberstring附有照片的身份证明文件号码（RG 或 CNH）16
document_identification_typeenum附有照片的身份证明文件类型（RG 或 CNH）document_identification_type 枚举值
is_pep *boolean声明该人是否为 PEP（http://www.portaldatransparencia.gov.br/download-de-dados/pep）。-
marital_statusenum公司代表婚姻状况marital status 枚举值
mother_name *string公司代表母亲姓名100
nationalitystring公司代表国籍50
person_type *enum标识所提交对象为自然人person_type 枚举值
phone *object公司代表电话数据对象phone 对象

address 对象​

此对象出现在 PF 和 PJ 对象中，用于表示地址信息。

字段描述示例字符数
street *string街道地址500
state *enum州（两位大写字母）2
city *string城市255
neighborhood *string区/社区500
number *string门牌号10
postal_code *string邮政编码（http://www.buscacep.correios.com.br/sistemas/buscacep/）（仅数字）8
complementstring地址补充信息（自由文本）500

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_keyuuidv4账户持有人自拍照片的唯一标识键。（DOCUMENT_KEY 由文件上传端点的响应返回）36
langstring签署时捕获的签署人地理位置经度坐标。-
latstring签署时捕获的签署人地理位置纬度坐标。-
ip_addressstring签署人设备的 IP 地址。-
session_idstring签署时签署人的会话 ID。-

signer 对象​

字段类型描述字符数
name *string签署人姓名。-
email *string签署人电子邮件。-
phone *object签署人电话数据对象phone 对象
document_number *string签署人 CPF。11

phone 对象​

字段描述示例最大字符数
country_code *string电话国际区号（https://ddi.guiamais.com.br/）3
area_code *string区号（https://ddd.guiamais.com.br/）2
number *string电话号码（仅数字）10

person_type 枚举值​

枚举值描述
natural自然人
legal法人

document_identification_type 枚举值​

枚举值描述
rgRG - 身份证
cnhCNH - 驾驶证

company_type 枚举值​

枚举值描述
ltda有限责任公司
sa股份公司
micro_enterprise微型企业
freelancer自由职业者
sa_opened开放式股份公司
sa_closed封闭式股份公司
se_ltda有限公司制企业
se_cn合名公司制企业
se_cs简单合资公司制企业
se_ca股份合资公司制企业
scp参与账户公司
ei个体工商户
ese在巴西境内的外国公司机构
eeab在巴西境内的阿根廷-巴西双边公司机构
ssp纯简单公司
ss_ltda有限简单公司
ss_cn合名简单公司
ss_cs简单合资简单公司
eireli_ne商业性个人有限责任公司
eireli_ns简单性个人有限责任公司
eireli个人责任公司
mei个体微型创业者
me微型企业
cop合作社
private_association私人协会

marital_status 枚举值​

枚举值描述
single未婚
married已婚
widower丧偶
divorced离婚
separated分居

Response​

STATUS
201
Response Body
{
    "account_info": {
        "account_branch": "0001",
        "account_digit": "0",
        "account_number": "1693580"
    },
    "account_request_key": "f230f1b5-07af-4737-b0e3-8a472304f5e7",
    "account_request_status": "pending_kyc_analysis"
}
注意

account_request_key 字段需要保存，将用于确认账户开立。

Response Body 参数​

字段类型描述字符数
account_info *object包含账户持有人信息的对象account_info 对象
account_request_key *string创建请求的标识键-
account_request_status *stringKYC 状态-

account_info 对象​

字段类型描述字符数
account_branch *string支行号4
account_digit *string电子邮件11
account_number *string账户持有人全名50
STATUS
4xx
Response Body: Error
{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}
HTTP 代码
status		QI 代码
code		标题
title		描述（英文）
description		描述（葡文）
translation
400QIT000001Bad RequestSchema ErrorErro de Schema
404QIT000404Not FoundResource could not be foundRecurso não encontrado