跳到主要内容

确认开设企业账户

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

Request​

ENDPOINT
/account_request/ACCOUNT_REQUEST_KEY/escrow
MÉTODO
PATCH

Path Params​

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

开设 Escrow 账户​

Request Body
{
    "account_owner": {
        "address": {
            "city": "Caraguatatuba",
            "complement": "complemento",
            "neighborhood": "Jaraguazinho",
            "number": "924",
            "postal_code": "11675200",
            "state": "SP",
            "street": "Praça Jorge Vitório de Souza"
        },
        "cnae_code": "4721-1/02",
        "company_document_number": "64669455000187",
        "company_statute": "8b0d8c33-01c9-4cf5-a0fa-1d2a96f4b34d",
        "company_type": "ltda",
        "email": "marcos.alves@yopmail.com",
        "foundation_date": "2017-09-16",
        "name": "NOME DA EMPRESA",
        "person_type": "legal",
        "phone": {
            "area_code": "19",
            "country_code": "055",
            "number": "988888888"
        },
        "trading_name": "Pães e Doces",
        "monthly_revenue": 100000,
        "company_representatives": [
            {
                "name": "Marcos Felipe Henrique Alves",
                "address": {
                    "city": "Recife",
                    "complement": null,
                    "neighborhood": "Fundão",
                    "number": "137",
                    "postal_code": "52221110",
                    "state": "PE",
                    "street": "Rua Camapuã"
                },
                "email": "marcos.alves@yopmail.com",
                "birth_date": "1972-02-02",
                "individual_document_number": "08531309069",
                "document_identification": "8b0d8c33-01c9-4cf5-a0fa-1d2a96f4b34d",
                "document_identification_number": "339122924",
                "is_pep": false,
                "marital_status": "single",
                "mother_name": "Sueli Isadora Alves",
                "nationality": "Brasileira",
                "person_type": "natural",
                "phone": {
                    "area_code": "88",
                    "country_code": "055",
                    "number": "995924634"
                }
            }
        ]
    },
    "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.186",
                    "session_id": "jdifj329842"
                },
                "signer": {
                    "name": "IVANILDO DE SENA LIMA",
                    "email": "ivanlima2604@gmail.com",
                    "phone": {
                        "country_code": "055",
                        "area_code": "11",
                        "number": "999999999"
                    },
                    "document_number": "61766976204"
                },
                "authentication_type": "opt-in"
            }
        ]
    },
    "destinations": [
        {
            "account_branch": "0001",
            "account_number": "1234567",
            "account_digit": "1",
            "document_number": "04252012000123",
            "name": "Conta do FIDC",
            "ispb_number": "32402502",
            "financial_institution_code_number": "329"
        }
    ],
    "additional_documents": ["b12c8807-8f3f-4083-9cb1-7cce641f3786"]
}

Request Body Params​

字段类型描述字符数
account_owner *object包含账户持有人信息的对象Objeto account_owner
signed_contract *object包含账户持有人信息的对象Objeto signed_contract
destinations *list授权接收转账的目标账户列表。Objeto destinations
additional_documentslist额外/可选文件 ID 列表。UUID 数组

Objeto account_owner​

字段类型描述字符数
address *object账户持有人地址。Objeto adress
cnae_code *string全国经济活动分类代码9
company_document_number *stringCNPJ14
company_statute uuidv4企业章程 PDF 的 DOCUMENT_KEY（事先上传）。36
company_type *enumerator企业类型Enumeradores company_type
email *string账户持有人邮箱。200
foundation_date *string企业成立日期（格式 "AAAA-MM-DD"）。10
name *string账户持有人公司名称（社会名称）。50
person_type *enumerator标识发送的对象是自然人还是法人。Enumeradores person_type
phone *object包含电话数据的对象Objeto phone
trading_name *string商业名称。200
company_representativeslist企业法定代表人列表Objeto company_representatives
monthly_revenue*number企业月营业额

Objeto signed_contract​

字段类型描述字符数
document_key *uuidv4账户开设条款或 Escrow 账户合同文件的唯一标识键。（DOCUMENT_KEY 在文件上传端点响应中返回）36
signatures *list发送文件的签名数据。列表中每一项对应一位文件签署人。Objeto signatures

Objeto destinations​

字段类型描述字符数
account_branch *string目标账户机构编号。4
account_number *string目标账户号码。-
account_digit *string目标账户号码校验位。1
document_number *string目标账户持有人 CPF/CNPJ。-
name string目标账户持有人姓名/公司名称。-
ispb_number *string目标账户金融机构的 ISPB（CNPJ 基础）。8
financial_institution_code_number *string目标账户金融机构代码。3

Objeto company_representatives​

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

Objeto address​

此对象在个人和企业对象中均存在，是一个简单的地址表示对象。

字段描述示例字符数
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

Objeto signed_contract​

字段类型描述字符数
document_key *uuidv4账户开设条款或 Escrow 账户合同文件的唯一标识键。（DOCUMENT_KEY 在文件上传端点响应中返回）36
signatures *list发送文件的签名数据。列表中每一项对应一位文件签署人。Objeto signatures

Objeto signatures​

字段类型描述字符数
authenticity *object证明签署人完成电子签名的数据集。Objeto authenticity
signer *object包含文件签署人之一数据的对象。Objeto signer
authentication_type *enumerator签名类型。始终为 "opt-in""opt-in"

Objeto authenticity​

字段类型描述字符数
timestamp *string文件签署的日期和时间。27
facial_recognition_key *uuidv4账户持有人自拍照的唯一标识键。36
langstring签署时捕获的签署人地理位置经度坐标。-
latstring签署时捕获的签署人地理位置纬度坐标。-
ip_addressstring签署人设备的 IP 地址。-
session_id *string签署时签署人的会话 ID。-

Objeto signer​

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

Objeto phone​

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

Enumeradores person_type​

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

Enumeradores document_identification_type​

枚举值描述
rgRG - 注册证件
cnhCNH - 全国驾驶执照

Enumeradores 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私人协会
association协会
others其他

Enumeradores marital_status​

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

Response​

STATUS
201
Response Body
{
    "account_key": "e48eb139-448e-43b9-9aee-df5f4b51158c"
}
注意

account_key 将成为账户的唯一标识键。所有与账户的交互都将通过它进行。

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