私人养老金手册 - 查询
下一步
API 开发中
该 API 仍处于开发阶段,因此本手册可能会有所变动。
1. 担保查询
担保查询允许核查与养老金产品相关的信息。此操作为异步操作,查询请求将被发送至我们的队列之一并随后处理。请求会立即返回与查询请求相关的唯一标识符及其处理状态。
Request
POST
/private_pension/inquiryPayload
{
"document_number": "\<CPF DO ASSINANTE\>",
"operating_entity": "\<CNPJ ENTIDADE OPERADORA\>",
"investment_funds": [
{
"susep_process_number": "",
"certificate": "",
"name": "",
"document_number": "",
"class": "",
"subclass": "",
},
{
"susep_process_number": "",
"certificate": "",
"name": "",
"document_number": "",
"class": "",
"subclass": "",
},
{
"susep_process_number": "",
"certificate": "",
"name": "",
"document_number": "",
"class": "",
"subclass": "",
},
],
"authorization_term": {
"signature": {
"signer": {
"name": "\<NOME DO ASSINANTE\>",
"birth_date": "\<DATA DE NASCIMENTO DO ASSINANTE\>",
"address": {
"street": "",
"neighborhood": "",
"city": "",
"state": "",
"postal_code": "",
},
"email": "\<EMAIL ASSINANTE\>",
"phone": {
"number": "\<NUMERO ASSINANTE\>",
"area_code": "\<DDD ASSINANTE\>",
"country_code": "55"
},
}
},
"authentication_type": "opt_in",
"authenticity": {
"timestamp": "\<DATA E HORA DA ASSINATURA\>",
"ip_address": "\<IP DO ASSINANTE\>",
"city": "\<CIDADE DA ASSINATURA\>",
"session_id": "\<ID DA SESSÃO DO ASSINANTE\>",
},
}
}
Body Details
| 字段 | 类型 | 描述 |
|---|---|---|
| document_number | string | 借款人 CPF |
| operating_entity | string | 运营实体枚举 |
| investment_funds | 对象 | 投资基金数据 |
| authorization_term | 对象 | 授权数据 |
对象 investment_funds
| 字段 | 类型 | 描述 |
|---|---|---|
| susep_process_number | string | SUSEP 流程编号 |
| certificate | string | 养老金产品证书 |
| name | string | 基金名称 |
| document_number | string | 基金 CNPJ |
| class | string | 基金类别 |
| subclass | string | 基金子类别 |
对象 authorization_term
| 字段 | 类型 | 描述 |
|---|---|---|
| signature | 对象 | 签名数据 |
| authentication_type | string | 认证类型 (opt_in) |
| authenticity | 对象 | 真实性数据 |
对象 signature
| 字段 | 类型 | 描述 |
|---|---|---|
| signer | 对象 | 签署人数据 |
对象 signer
| 字段 | 类型 | 描述 |
|---|---|---|
| name | string | 签署人姓名 |
| birth_date | string | 签署人出生日期 |
| address | 对象 | 签署人地址 |
| 对象 | 签署人电子邮件地址 | |
| phone | 对象 | 签署人电话 |
对象 address
| 字段 | 类型 | 描述 |
|---|---|---|
| street | string | 街道 |
| neighborhood | string | 街区 |
| city | string | 城市 |
| state | string | 州 |
| postal_code | string | 邮政编码 |
对象 phone
| 字段 | 类型 | 描述 |
|---|---|---|
| number | string | 电话号码 |
| area_code | string | 区号 (DDD) |
| country_code | string | 国家电话代码 |
对象 authenticity
| 字段 | 类型 | 描述 |
|---|---|---|
| timestamp | string | 借款人接受的时间戳 |
| ip_address | string | 用户会话 IP |
| city | string | 签署城市 |
| session_id | string | 用户会话内部标识键 |
Response
STATUS
201 (CREATED)Payload
{
"inquiry_key": "69aac130-35cb-4bdd-80e9-ba01d18002bd",
"inquiry_status": "pending_inquiry"
}
Response Body Details
| 字段 | 类型 |
|---|