轻松查公积 - 天远API

## 请求头 | 字段名 | 类型 | 必填 | 描述 | |--------|------|------|------| | Access-Id | string | 是 | 账号的 Access-Id | 对于业务请求参数 通过加密后得到 Base64 字符串，将其放入到请求体中，字段名为 `data`，以此方式进行传参。 ```json { "data": "xxxx(base64)" } ``` 对接响应得到的公共参数 ```json { "code": "int", "message": "string", "transaction_id": "string", // 流水号 "data": "string" } ``` **data** 字段为加密的数据，需要解密后查看。 ## 加密和解密机制 账户获得的密钥（**Access Key**）是一个 16 进制字符串，使用 AES-128 加密算法。 ### 加密过程： - 加密模式：**AES-CBC 模式**。 - 密钥长度：**128 位（16 字节）**。 - 填充方式：**PKCS7 填充**。 - **IV（初始化向量）**：IV 长度为 16 字节（128 位），每次加密时随机生成。 - 加密后，将 **IV** 和密文拼接在一起进行传输。 - 最后，将拼接了 IV 的密文通过 **Base64 编码**，方便在网络或文件中传输。 ### 解密过程： - 解密时，首先从 Base64 解码后的数据中提取前 16 字节作为 **IV**。 - 然后使用提取的 **IV**，通过 AES-CBC 模式解密剩余部分的密文。 - 解密后去除 **PKCS7 填充**，即可得到原始明文。

## 请求参数 ```json { "id_card": "string", "name": "string", "mobile_no": "string", "return_url": "string", "authorization_url": "string" } ``` ### 请求体参数 (Request Body Parameters) | 字段名 (Field Name) | 类型 (Type) | 必填 (Required) | 描述 | |---------------------|-------------|-----------------|------| | id_card | string | 是 | 用户的身份证号码。 | | name | string | 是 | 用户的真实姓名。 | | mobile_no | string | 是 | 用户的手机号码。 | | return_url | string | 是 | 授权完成后的前端回调地址。 | | authorization_url | string | 是 | 授权流程相关的 URL 地址。 | ```json { "data": "xxxx(base64)" } ```

### 公积金数据报告字段说明 #### 主体结构 (Main Structure) | 字段名 (Field Name) | 类型 (Type) | 说明 (Description) | | :--- | :--- | :--- | | `tranId` | String | 流水号 | | `identityVerification` | String | 身份核验结果（例如：一致、不一致） | | `gjjBaseInfo` | Object | 账户基础信息 | | `loanInfo` | Object | 贷款信息 | | `depositData` | List | 缴存信息 | | `withdrawData` | List | 提取信息 | | `repaymentData` | List | 还贷信息 | | `depositDataMore` | List | 更多缴存明细 | | `repaymentDataMore` | List | 更多还贷明细 | | `withdrawDataMore` | List | 更多提取明细 | | `balanceDataMore` | List | 账户余额明细 | --- #### 2. gjjBaseInfo (账户基础信息) | 字段名 (Field Name) | 类型 (Type) | 说明 (Description) | | :--- | :--- | :--- | | `name` | String | 姓名 | | `idType` | String | 证件类型 | | `idNumber` | String | 证件号码 | | `phoneNumber` | String | 手机号码 | | `personalAccount` | String | 个人账号 | | `accountStatus` | String | 个人账户状态 | | `accountBalance` | String | 个人账户余额 | | `personalContrBase` | String | 个人缴存基数 | | `employerContrRate` | String | 单位缴存比例 | | `personalContrRate` | String | 个人缴存比例 | | `employerMonthlyContr` | String | 单位月缴存额 | | `personalMonthlyContr` | String | 个人月缴存额 | | `centerName` | String | 中心名称 | | `centerCode` | String | 中心编号 | | `employerName` | String | 单位名称 | --- #### 3. loanInfo (贷款信息) | 字段名 (Field Name) | 类型 (Type) | 说明 (Description) | | :--- | :--- | :--- | | `currentRepaymentAmount` | String | 本期应还(元) | | `loanBalance` | String | 贷款余额(元) | | `totalPrincipalRepaid` | String | 累计已还本金(元) | | `totalInterestRepaid` | String | 累计已还利息(元) | | `totalLoanAmount` | String | 贷款总额(元) | | `loanAccountNumber` | String | 贷款账号 | | `loanContractNumber` | String | 借款合同编号 | | `loanAmount` | String | 贷款金额(元) | | `loanInterestRate` | String | 贷款利息 | | `repaymentMethod` | String | 还款方式 | | `loanTermMonths` | String | 贷款期次 | | `scheduledDisbursementDate` | String | 约定放款日期 | | `scheduledMaturityDate` | String | 约定到期日期 | | `borrowerName` | String | 借款人姓名 | | `borrowerIdNumber` | String | 借款人证件号码 | | `coBorrowerName` | String | 共同借款人姓名 | | `coBorrowerIdNumber` | String | 共同借款人证件号码 | | `propertyType` | String | 房屋类型 | | `purchaseContractNumber` | String | 购房合同号 | | `buildingArea` | String | 建筑面积 | | `totalPurchasePrice` | String | 购房总价 | | `propertyAddress` | String | 房屋坐落 | --- #### 4. depositData（缴存信息）、depositDataMore（更多缴存明细） | 字段名 (Field Name) | 类型 (Type) | 说明 (Description) | | :--- | :--- | :--- | | `serialNumber` | String | 序号 | | `oprDate` | String | 时间 | | `businessType` | String | 业务类型 | | `depositAmount` | String | 缴存金额(元) | | `accountBalance` | String | 账户余额(元) | --- #### 5. withdrawData（提取信息）、withdrawDataMore（更多提取明细） | 字段名 (Field Name) | 类型 (Type) | 说明 (Description) | | :--- | :--- | :--- | | `serialNumber` | String | 序号 | | `oprDate` | String | 时间 | | `businessType` | String | 业务类型 | | `withdrawalAmount` | String | 提取金额(元) | | `accountBalance` | String | 账户余额(元) | --- #### 6. repaymentData（还贷信息） | 字段名 (Field Name) | 类型 (Type) | 说明 (Description) | | :--- | :--- | :--- | | `serialNumber` | String | 序号 | | `oprDate` | String | 时间 | | `repaymentAmount` | String | 还贷金额(元) | --- #### 7. repaymentDataMore（更多还贷明细） | 字段名 (Field Name) | 类型 (Type) | 说明 (Description) | | :--- | :--- | :--- | | `serialNumber` | String | 序号 | | `oprDate` | String | 时间 | | `period` | String | 还款期次 | | `repaymentAmount` | String | 还贷金额(元) | | `principal` | String | 本金(元) | | `interest` | String | 利息(元) | | `penalty` | String | 罚息(元) | --- #### 8. balanceDataMore（账户余额明细） | 字段名 (Field Name) | 类型 (Type) | 说明 (Description) | | :--- | :--- | :--- | | `serialNumber` | String | 序号 | | `oprDate` | String | 时间 | | `businessType` | String | 业务类型 | | `incurredAmount` | String | 发生金额(元) | | `accountBalance` | String | 账户余额(元) |