跳到主要内容

投资者分页查询


Request

ENDPOINT
/quota_distributor/investors
MÉTODO
GET
STATUS
200

Query Params

参数描述
document_number投资者证件号
注意

在集成过程中,将要求对发送的哈希值进行身份验证。

情况01:返回仅一个投资者
{
"data": [
{
"investor_key":"UUID",
"name":"SAMPLE INVESTOR NAME",
"document_number":"00.000.000/0000-00",
"person_type":"natural_person / legal_person",
"status":"approved / pending_update",
"associations":[
{
"manager":{
"manager_key":"UUID",
"name":"SAMPLE MANAGER NAME",
"document_number":"00.000.000/0000-00"
}
}
],
"distributor":{
"distributor_key":"UUID",
"document_number":"00.000.000/0000-00",
"name":"SAMPLE DISTRIBUTOR NAME",
"account_data":{
"owner":{
"name":"SAMPLE OWNER NAME",
"document_number":"00.000.000/0000-00"
},
"account_digit": "0",
"account_branch": "0000",
"account_number": "00000",
"financial_institution_code": "000",
"financial_institution_ispb": "00000000"
}
},
"account_data": {
"account_digit": "0",
"account_branch": "0000",
"account_number": "00000",
"financial_institution_code": "000",
"financial_institution_ispb": "00000000"
},
"investor_sub_type": "person / financial_institution / fund class"
}
],
"limit": 50,
"page": 0,
"is_last_page": true
}

Investor

字段类型描述
investor_keystring投资者唯一标识键
namestring投资者姓名
document_numberstring投资者 CPF 或 CNPJ
person_typestring投资者类型(natural person 表示自然人,legal person 表示法人)
statusstring投资者状态(approved 表示已批准,pending update 表示待更新)
associationsarray与投资者相关的 Association 对象列表
distributorJSON代表投资者分销商的 Distributor 对象
account_dataJSON包含投资者银行信息的 Account Data 对象
investor_sub_typestring投资者子类型(personfinancial institutionfund class

Association

注:只能与一位经理、一位分销商或两者同时关联

字段类型描述
managerJSON代表关联经理的 Manager 对象
distributorJSON代表关联分销商的 Distributor 对象

Manager

字段类型描述
manager_keystring经理唯一标识键
namestring经理姓名
document_numberstring经理 CNPJ

Distributor

字段类型描述
distributor_keystring分销商唯一标识键
document_numberstring分销商 CNPJ
namestring分销商名称
account_dataJSON包含分销商银行信息的 Account Data 对象

Account Data

字段类型描述
account_digitstring账户校验位
account_branchstring支行编号
account_numberstring账户号码
financial_institution_codestring金融机构代码
financial_institution_ispbstring金融机构 ISPB

Owner

字段类型描述
namestring账户持有人姓名
document_numberstring账户持有人 CPF 或 CNPJ