跳到主要内容

托管账户开户（个人）

Request​

ENDPOINT
/escrow
MÉTODO
POST
Request Body
{
  "account_owner": {
        "person_type": "natural",
        "name": "Patrícia Tereza Bernardes",
        "mother_name": "Maria Mariane",
        "birth_date": "1990-05-06",
        "nationality": "nationality",
        "is_pep": false,
        "individual_document_number": "34651104630",
        "document_identification": "3c24579b-9810-4fa6-9b08-fe67d237160a",
        "email": "api@qitech.com.br",
        "address": {
            "street": "Av. Brigadeiro Faria Lima",
            "state": "SP",
            "city": "São Paulo",
            "neighborhood": "Jardim Paulistano",
            "number": "2391",
            "postal_code": "01452905",
            "complement": "1o. Andar"
        },
        "phone": {
            "country_code": "055",
            "area_code": "11",
            "number": "999999999"
        },
        "proof_of_residence": "780456bd-1eec-4e5f-82c0-d8c3921497ea"
    },
  "destination_list": [
        {
            "account_branch": "0001",
            "account_digit": "4",
            "account_number": "15570",
            "document_number": "34651104630",
            "financial_institutions_code_number": "329",
            "name": "Patrícia Tereza Bernardes",
            "ted_account_type": "deposit_account"
        }
    ],
  "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_owner *object账户所有人对象account_owner 对象
destination_listobject目标账户列表，即允许转入资金的账户列表。destination_list 对象
signed_contract *object包含合同签名信息的对象。signed_contract 对象

account_owner 对象​

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

address 对象​

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

字段描述示例最大字符数
street *string地址街道100
state *string地址所在州（两个大写字母）2
city *string地址城市100
neighborhood *string地址社区100
number *string门牌号10
postal_code *string地址邮政编码（http://www.buscacep.correios.com.br/sistemas/buscacep/）（仅数字）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_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

destination_list 对象​

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

ted_account_type 枚举值​

枚举值翻译
checking_account支票账户
deposit_account存款账户
guaranteed_account担保账户
investment_account投资账户
payment_account支付账户
saving_account储蓄账户

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\"}"
}