跳到主要内容

托管账户开户（法人）

Request​

ENDPOINT
/escrow
MÉTODO
POST
Request Body
{
    "account_manager": {
        "address": {
            "city": "São Paulo",
            "complement": "",
            "neighborhood": "Vila Madalena",
            "number": "40",
            "postal_code": "05435030",
            "state": "SP",
            "street": "Rua das batatas"
        },
        "cnae_code": "6619-3/99",
        "company_document_number": "99999999000188",
        "company_representatives": [
            {
                "address": {
                    "city": "São Paulo",
                    "complement": "",
                    "neighborhood": "Vila Madalena",
                    "number": "40",
                    "postal_code": "05435030",
                    "state": "SP",
                    "street": "Rua da Alegria"
                },
                "birth_date": "1982-12-30",
                "email": "teste@email.tech",
                "individual_document_number": "99999999999",
                "is_pep": false,
                "final_beneficiary": true,
                "mother_name": "Ana Perdigão",
                "name": "João Victor",
                "nationality": "Brasileira",
                "person_type": "natural",
                "phone": {
                    "area_code": "12",
                    "country_code": "055",
                    "number": "999999999"
                },
                "document_identification": "a28b9c7d-f0c3-4310-ac6d-61898d29b18d",
                "proof_of_residence": "a28b9c7d-f0c3-4310-ac6d-61898d29b18d"
            }
        ],
        "company_statute": "a28b9c7d-f0c3-4310-ac6d-61898d29b18d",
        "directors_election_minute": "a28b9c7d-f0c3-4310-ac6d-61898d29b18d",
        "email": "email@teste.tech",
        "foundation_date": "2021-10-05",
        "name": "TESTE TECH LTDA.",
        "person_type": "legal",
        "phone": {
            "area_code": "11",
            "country_code": "55",
            "number": "999999999"
        },
        "trading_name": "TESTE TECH LTDA."
    },
    "account_owner": {
        "address": {
            "city": "Caraguatatuba",
            "complement": "complemento",
            "neighborhood": "Jaraguazinho",
            "number": "924",
            "postal_code": "11675200",
            "state": "SP",
            "street": "Praça da Rua"
        },
        "cnae_code": "4721-1/02",
        "company_statute": "70448962-8f01-4835-b031-755514192641",
        "company_document_number": "49999999000130",
        "company_type": "ltda",
        "email": "email@yteste.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",
        "company_representatives": [
            {
                "name": "Marco Ayo",
                "address": {
                    "city": "Recife",
                    "complement": null,
                    "neighborhood": "Fundão",
                    "number": "137",
                    "postal_code": "522222220",
                    "state": "PE",
                    "street": "Rua dos Camaroes"
                },
                "email": "marcos.teste@teste.com",
                "birth_date": "1972-02-02",
                "individual_document_number": "55555555555",
                "document_identification": "70448962-8454-4835-b031-755514192641",
                "document_identification_number": "999999999",
                "is_pep": false,
                "final_beneficiary": true,
                "marital_status": "single",
                "mother_name": "Sueli da Mata",
                "nationality": "Brasileira",
                "person_type": "natural",
                "phone": {
                    "area_code": "88",
                    "country_code": "055",
                    "number": "999999999"
                }
            }
        ]
    },
    "destination_list": [
        {
            "account_branch": "0001",
            "account_digit": "2",
            "account_number": "123321",
            "document_number": "99999999999",
            "financial_institutions_code_number": "341",
            "name": "Conta Destino Teste SA."
        }
    ],
    "allowed_user": {
        "email": "teste@email.com",
        "individual_document_number": "99999999999",
        "name": "Luiz Alberto ",
        "person_type": "natural",
        "phone": {
            "country_code": "055",
            "area_code": "12",
            "number": "999999999"
        }
    },
    "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"
            }
        ]
    }
}

Body Params​

字段类型描述字符
account_manager *object负责账户操作的人员对象。address 对象
account_owner *object账户所有人对象。account_owner 对象
allowed_user *object拥有账户查询访问权限的人员对象。allowed_user 对象
destination_list *object目标账户列表，即允许转入资金的账户列表。destination_list 对象
signed_contract *object包含合同签名信息的对象。signed_contract 对象

account_manager 对象​

字段类型描述字符
address *object客户地址。address 对象
cnae_code *string国家经济活动分类代码14
company_document_numberobjectCNPJ14
company_statute *string公司章程 PDF 的 DOCUMENT_KEY（预先上传）。uuid 密钥
directors_election_minute *string公司法定代表人会议纪要 PDF 的 DOCUMENT_KEY（预先上传）。uuid 密钥
email *string公司机构电子邮件。
foundation_date *date公司成立日期（格式"YYYY-MM-DD"）。
name *string公司名称。
person_type *string标识发送对象为法人的标识符。法人（PJ）对象必须始终包含值"legal"。
phonestring包含电话数据的对象phone 对象
trading_name *string公司商号名称

company_representatives 对象​

字段类型描述字符
person_type *string标识发送对象为个人的标识符。个人（PF）对象必须始终包含值"natural"。11
name *string法人情况下的公司名称，或个人情况下的人员姓名。限制为 100 个字符。11
mother_name *string人员母亲姓名。11
birth_date *string人员出生日期（格式"YYYY-MM-DD"）11
nationality *string客户国籍。限制为 50 个字符。11
is_pep *string声明该人员是否为 PEP（http://www.portaldatransparencia.gov.br/download-de-dados/pep）。11
final_beneficiaryboolean声明该人是否为公司的最终受益人。-
individual_document_numberstring人员 CPF（仅数字）。11
document_identification *string带照片的身份证件 PDF 的 DOCUMENT_KEY（RG 或 CNH）（预先上传）UUID
proof_of_residence *UUID居住证明 PDF 的 DOCUMENT_KEY（预先上传）UUID
email *string人员电子邮件。11
addressstring人员地址对象。11

address 对象​

该对象存在于个人（PF）和法人（PJ）对象中，是一个简单的地址表示对象。

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

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

allowed_user 对象​

字段描述示例最大字符数
email *string账户用户的电子邮件。10
individual_document_number *string账户用户的 CPF（仅数字）。10
name *string账户用户的姓名。10
person_type *string标识发送对象为个人的标识符。必须始终包含值"natural"。10
phonestring用户电话对象。phone 对象

destination_list 对象​

字段描述示例最大字符数
account_branch *string银行支行号。3
account_digit *string账户校验位（如有）。3
account_number *string账户号码。3
document_number *stringCPF 或 CNPJ（仅数字）。3
financial_institutions_code_number *string金融机构 COMPE 代码（https://www.bcb.gov.br/pom/spb/estatistica/port/ASTR003.pdf）3
name *string个人姓名或法人公司名称。
ted_account_type *enum目标账户类型。枚举值

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

Response​

STATUS
200
Response Body
{
  "data": {
    "account_info": {
      "account_branch": "0001",
      "account_digit": "3",
      "account_number": "66777",
      "financial_institution_code": "329"
    },
    "account_manager": {
      "company_representatives": [
        {
          "document_number": "08141163701",
          "name": "Aurora Simone Catarina Nogueira"
        }
      ],
      "document_number": "09456933000162",
      "name": "Kaique e Giovanna Contábil ME"
    },
    "account_owner": {
      "company_representatives": [
        {
          "document_number": "38689533370",
          "name": "Priscila Rayssa Barros"
        },
        {
          "document_number": "85324558400",
          "name": "Caio Bruno Dias"
        }
      ],
      "document_number": "98916615000167",
      "name": "Alice e Isis Advocacia ME"
    },
    "allowed_transfer_account_list": [
      {
        "account_branch": "0001",
        "account_digit": "2",
        "account_number": "532312",
        "document_number": "49067117153",
        "financial_institution": {
          "code": 341,
          "ispb": 60701190,
          "name": "Itaú Unibanco  S.A."
        },
        "name": "Juan Anthony Farias"
      },
      {
        "account_branch": "0002",
        "account_digit": "9",
        "account_number": "537612",
        "document_number": "39063217000123",
        "financial_institution": {
          "code": 33,
          "ispb": 90400888,
          "name": "Banco Santander (Brasil) S. A."
        },
        "name": "Farias Advogados"
      }
    ],
    "allowed_user": {
      "document_number": "13708610440",
      "name": "Renato Noah Pinto"
    }
  },
  "event_datetime": "2019-11-07 18:15:07",
  "key": "61341599-790b-4236-b42f-060634eba88f",
  "status": "waiting_administrator_approval",
  "webhook_type": "escrow"
}
STATUS
400
Response Body
{
  "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}