私人薪资抵押贷款提案拍卖手册

注意！

QI Tech 的 webhook 不应进行严格映射。返回的 webhook payload 中可能包含额外字段。

重新发送 Webhook

您可以按照文档中的详细说明查询和重新发送 webhook：重新发送 Webhook。

简介

欢迎使用私人薪资抵押贷款提案拍卖 API

私人薪资抵押贷款提案拍卖是一项服务，允许查询工人发出的提案申请，受托方提交提案，并比较报价以选择条件最优的提案。

该 API 允许在拍卖中创建、更新、查询排名及取消提案。

遇到问题？

如有任何问题，请联系我们的支持团队（suporte@qitech.com.br），我们将尽快回复。

环境

** 我们为客户提供两个环境。API 的基本 URL 为：

生产环境 - https://api-auth.qitech.app/
沙盒环境 - https://api-auth.sandbox.qitech.app/

仅 HTTPS

出于安全考虑，与 QI Tech API 的所有通信必须使用 HTTPS。为防止误用 HTTP 调用，服务器仅开放 443 端口并使用 TLS 1.2 通信。使用其他协议的调用将被自动拒绝。

IssuerProposalRequest: 信贷提案申请

IssuerProposalRequest 代表工人（潜在信贷借款人）发出的信贷提案申请。申请有效的前提是工人有可用的薪资抵押额度。

信贷申请中的 Webhook 流程

收到信贷提案申请时，有两种可能的情形：

✅ 1. 存在预创建的保留提案

若提案已签署，合同将立即生效，无需经过拍卖过程。
若提案尚未签署，将发送给工人进行审核。
拍卖结束 webhook 将发送给提案的发起客户。
可以为同一借款人创建多个提案保留，前提是雇佣关系不同。

⚖️ 2. 不存在保留提案

拍卖开始 webhook 将发送给所有客户。
从此刻起，客户有 30 秒时间发送提案。
时间结束时：
- 若有在截止时间内的提案，最优提案将发送给工人。
- 若 30 秒内没有提案发送，则考虑之后发送的第一个提案。
一旦提案发送给工人，拍卖结束 webhook 将向所有参与者触发。

Webhook 示例 - 拍卖开始

WEBHOOK_TYPE

laas.private_payroll_auction.new_issuer_proposal_request

{
    "status": "ongoing",
    "event_datetime": "2025-03-20T14:47:43Z",
    "key": "88b0203d-31ad-48c6-a795-b6d45ab4898a",
    "webhook_type": "laas.private_payroll_auction.new_issuer_proposal_request",
    "data": {
        "issuer_proposal_request_key": "88b0203d-31ad-48c6-a795-b6d45ab4898a",
        "status": "ongoing",
        "expiration_datetime": "2025-03-21T11:47:12Z",
        "inclusion_limit_datetime": "2025-03-20T11:49:43Z",
        "issuer_proposal_request_data": {
            "issuer_registration_number": "TESTE123",
            "birth_date": "1973-03-14",
            "disbursed_issue_amount": 2100,
            "admission_date": "2020-03-10",
            "consigned_credit_balance": 10000,
            "eligible": true,
            "employer_document_type": "cnpj",
            "document_number": "00737823780",
            "employer_document_number": "29113956000181",
            "number_of_installments": 10,
            "political_exposition": "not_exposed",
            "name": "VALENTINA SANTOS"
        },
    }
}

Webhook 示例 - 拍卖结束

WEBHOOK_TYPE

laas.private_payroll_auction.end_of_auction

{
    "key": "150cfaa5-99dc-4c80-be3e-2231350cf9a2",
    "data": {
        "auction_proposal_key": "250cfea5-99dc-4c80-be3e-2231350cf9a2",
        "status": "won",
        "type": "auction",
        "rank_position": 1,
        "signature_url": "https://sandbox.sign.qitech.com.br/r/3D1s523",
        "credit_operation_key": "9e06ca79-3610-4794-8312-9663e0343f6b",
        "issuer_proposal_request_key": "262d0584-9827-4652-9b27-6a46c9832f38"
    },
    "status": "won",
    "event_datetime": "2025-03-20T14:48:43Z",
    "webhook_type": "laas.private_payroll_auction.end_of_auction"
}

信贷操作的密钥对于失败的提案将以 null 值发送。

注意

签名链接不会在生产环境中发送，仅在沙盒环境中通过应用程序的拍卖流程发送。

IssuerProposalRequest 对象定义

IssuerProposalRequest 的所有信息交换均使用以下定义。某些情况下，为便于实施并减少各方之间的数据流，部分信息可能被省略。

名称	类型	描述
issuer_proposal_request_key	string	提案申请的唯一标识符
issuer_proposal_request_data	object	描述提案申请数据的对象
status	string	提案申请的状态 (`ongoing`, `finished`, `expired`)

IssuerProposalRequestData 对象定义

名称	类型	描述
name	string	借款人全名
document_number	string	借款人 CPF
birth_date	string	借款人出生日期，格式 `YYYY-MM-DD`
disbursed_amount	float	借款人申请的放款金额
number_of_installments	integer	借款人申请的分期数
consigned_credit_balance	float	借款人可用薪资抵押余额
admission_date	string	工人当前职位的入职日期，格式 `YYYY-MM-DD`
issuer_registration_code	string	员工 eSocial 注册码
employer_document_number	string	雇主 CNPJ
eligible	boolean	符合条件为 True，不符合为 False
employer_document_type	string	CNPJ 或 CPF

提案申请状态详情

提案申请的状态可以是：

状态	描述
ongoing	提案申请进行中，拍卖仍处于活动状态。
finished	提案申请已完成，拍卖已结束且已提交的提案被接受并纳入。
expired	提案申请已过期，拍卖已结束但未及时纳入任何提案。

政治曝光程度详情

政治曝光的值可以是：

状态	描述
not_exposed	政治上未曝光人士。
level_1	政治曝光 1 级人士
level_2	政治曝光 2 级人士
not_informed	无政治曝光信息

提案类型

type 字段表示提案类型，即该提案是通过拍卖还是预保留方式产生的。将在拍卖结束 webhook 中发送。

类型	描述
"auction"	提案经过内部拍卖
"pre-auction"	提案为预保留

发送 Webhook 后查询提案申请

如有需要，仍可重新查询信贷借款人发出的提案申请（即使在发送自动 Webhook 之后）。通过 API 调用，使用通过自动 Webhook 发送的提案申请 ID。

ENDPOINT

- /private_payroll_auction/issuer_proposal_request/{issuer_proposal_request_key}

MÉTODO

- GET

路径参数

字段	类型	描述	字符数	必填
`issuer_proposal_request_key`	uuidv4	IssuerProposalRequest 的唯一识别键，采用 uuid v4 格式。	36	是

响应

返回的响应与拍卖开始 webhook 中发送的内容相同。

AuctionProposal – 信贷提案

AuctionProposal 是代表受托方向工人提交的信贷提案的对象。

提案有两种方式：拍卖前预保留，以及普通拍卖。

🎯 提案保留

如果客户与借款人已有联系，可以创建并签署带有 "private_payroll" 担保的信贷操作。然后可以保留提案，有效期为 24 小时。
如果在此期间该借款人有提案申请，将向客户发送拍卖结束 Webhook，信贷操作将立即放款并完成薪资抵押。
否则，提案将过期且不再有效。

AuctionProposal 对象定义

AuctionProposal 的所有信息交换均使用以下定义。某些情况下，为便于实施并减少各方之间的数据流，部分信息可能被省略。

名称	类型	描述
issuer_proposal_request_key	string	提案申请的唯一标识符。
auction_proposal_key	string	AuctionProposal 的唯一识别键，采用 uuid v4 格式。
proposal_data	object	描述合作方发送的 AuctionProposal 数据的对象。
status	string	拍卖中提案的状态 (`bid`, `lost`, `won`, `cancelled`, `awaiting_issuer_proposal_request`)。
proposal_score	float	拍卖中纳入提案的评分，proposal_score 的比较决定 rank_position。
inclusion_date	string	提案纳入或最后更新的日期，格式为 `YYYY-MM-DDTHH:MM:SSZ`。
rank_position	integer	提案在拍卖排名中对应提案申请的当前位置。

注：proposal_data 对象的内容由参与方在后续描述的请求中发送的信息组成。

提案状态详情

提案的状态可以是：

状态	描述
bid	提案已以其条件纳入拍卖 - 仍可修改。
awaiting_issuer_proposal_request	提案已预注册，等待提案申请。
lost	提案在该提案申请的拍卖中失败。拍卖已结束，本提案未被纳入。
won	提案赢得该提案申请的拍卖。拍卖已结束，本提案被纳入。
cancelled	提案被参与方取消。

在拍卖中创建提案保留

要在信贷拍卖中保留提案，请通过 API 调用相关端点，如以下示例所示：

ENDPOINT

/debt

MÉTODO

POST

无法定代理人
有法定代理人

Request Body
{
    "borrower": {
        "name": "Nome devedor",
        "phone": {
            "number": "999538380",
            "area_code": "84",
            "country_code": "055"
        },
        "gender": "female",
        "is_pep": false,
        "address": {
            "city": "Natal",
            "state": "RN",
            "number": "1984",
            "street": "Rua",
            "complement": "complemento",
            "postal_code": "59065720",
            "neighborhood": "bairro"
        },
        "role_type": "issuer",
        "birth_date": "1959-07-08",
        "mother_name": "NOME DA MAE",
        "nationality": "Brasileiro",
        "person_type": "natural",
        "marital_status": "single",
        "attached_documents_list": [],
        "individual_document_number": "14471835092",
        "document_identification_date": "2015-10-02",
        "document_identification_type": "rg",
        "document_identification_number": "003709888"
    },
    "financial": {
        "interest_type": "pre_price_days",
        "first_due_date": "2023-09-21",
        "disbursement_date": "2024-11-07",
        "fine_configuration": {
            "monthly_rate": 0.0166,
            "interest_base": "calendar_days",
            "contract_fine_rate": 0
        },
        "credit_operation_type": "ccb",
        "interest_grace_period": 0,
        "monthly_interest_rate": 0.0166,
        "installment_face_value": 101.84,
        "limit_days_to_disburse": 7,
        "number_of_installments": 10,
        "principal_grace_period": 0,
        "rebates": [ // Opcional
            {
                "amount": 20,
                "rebate_bank_account": {
                    "name": "Teste Ltda",
                    "document_number": "18533555000164",
                    "account_digit": "0",
                    "account_number": "4290001",
                    "branch_number": "0001",
                    "bank_code": "329"
                },
                "amount_type": "percentage",
                "fee_type": "spread"
            }
        ]
    },
    "simplified": true,
    "collaterals": [
        {
            "collateral_data": {
                "employer_document_number": "07940839000159",
                "registration_number": "99999999999-A"
            },
            "collateral_type": "private_payroll"
        }
    ],
    "additional_data": {
        "contract": {
            "contract_number": "TST0000644799"
        }
    },
    "purchaser_document_number": "32402502000135",
    "disbursement_bank_accounts": [
        {
            "name": "NOME DEVEDOR",
            "bank_code": "001",
            "account_digit": "0",
            "branch_number": "2874",
            "account_number": "000057555",
            "document_number": "14471835092",
            "transfer_method": "pix",
            "percentage_receivable": 100
        }
    ]
}

Request Body
{
    "borrower": {
        "name": "Nome devedor",
        "phone": {
            "number": "999538380",
            "area_code": "84",
            "country_code": "055"
        },
        "gender": "female",
        "is_pep": false,
        "address": {
            "city": "Natal",
            "state": "RN",
            "number": "1984",
            "street": "Rua",
            "complement": "complemento",
            "postal_code": "59065720",
            "neighborhood": "bairro"
        },
        "role_type": "issuer",
        "birth_date": "1959-07-08",
        "mother_name": "NOME DA MAE",
        "nationality": "Brasileiro",
        "person_type": "natural",
        "marital_status": "single",
        "attached_documents_list": [],
        "individual_document_number": "14471835092",
        "document_identification_date": "2015-10-02",
        "document_identification_type": "rg",
        "document_identification_number": "003709888"
    },
    "related_parties": [
        {
            "name": "Representante legal",
            "email": "teste@qitech.com.br",
            "phone": {
                "number": "991294043",
                "area_code": "55",
                "country_code": "055"
            },
            "address": {
                "street": "AV LEONOR",
                "state": "SP",
                "city": "GUARULHOS",
                "neighborhood": "",
                "number": "1",
                "postal_code": "07025200",
                "complement": ""
            },
            "role_type": "issuer_legal_representative",
            "person_type": "natural",
            "is_pep": false,
            "individual_document_number": "19125869086",
            "birth_date": "1970-04-20",
            "mother_name": " Ana Lúcia"
        }
    ],
    "financial": {
        "interest_type": "pre_price_days",
        "first_due_date": "2024-09-21",
        "disbursement_date": "2024-11-07",
        "fine_configuration": {
            "monthly_rate": 0.01,
            "interest_base": "calendar_days",
            "contract_fine_rate": 0
        },
        "credit_operation_type": "ccb",
        "interest_grace_period": 0,
        "monthly_interest_rate": 0.0166,
        "installment_face_value": 1000,
        "limit_days_to_disburse": 7,
        "number_of_installments": 84,
        "principal_grace_period": 0,
        "rebates": [ // Opcional
            {
                "amount": 20,
                "rebate_bank_account": {
                    "name": "Teste Ltda",
                    "document_number": "18533555000164",
                    "account_digit": "0",
                    "account_number": "4290001",
                    "branch_number": "0001",
                    "bank_code": "329"
                },
                "amount_type": "percentage",
                "fee_type": "spread"
            }
        ]
    },
    "simplified": true,
    "collaterals": [
        {
            "collateral_data": {
                "employer_document_number": "07940839000159",
                "registration_number": "99999999999-A"
            },
            "collateral_type": "private_payroll"
        }
    ],
    "additional_data": {
        "contract": {
            "contract_number": "TST0000644715"
        }
    },
    "purchaser_document_number": "32402502000135",
    "disbursement_bank_accounts": [
        {
            "name": "NOME DEVEDOR",
            "bank_code": "001",
            "account_digit": "0",
            "branch_number": "2874",
            "account_number": "000057555",
            "document_number": "14471835092",
            "transfer_method": "pix",
            "percentage_receivable": 100
        }
    ]
}

响应

STATUS

- 201 (Accepted)

注意

如果借款人在客户创建保留之前申请了提案，其申请将发送给所有客户，直到拍卖前提案到达。如果某个客户提交了提案，但拍卖前提案在 6 分钟内未到达，该申请的拍卖将关闭。

在拍卖中创建新提案

客户可以对给定的提案申请只提交一个提案。

要在信贷拍卖中纳入提案，请通过 API 调用，按以下示例发送相关提案数据：

ENDPOINT

- /private_payroll_auction/issuer_proposal_request/{issuer_proposal_request_key}/auction_proposal

MÉTODO

- POST

Request Body: 在拍卖中纳入 AuctionProposal

{
    "request_control_key" : "111e7ed3-4080-4cae-a853-8e12812817ea",
    "disbursed_issue_amount": 15000,
    "installment_face_value": 400.00,
    "number_of_installments": 48,
    "purchaser_document_number": "01272247000120",
    "days_to_expiration": 10,
    "rebates": [
        {
            "fee_type": "spread",
            "amount_type": "percentage",
            "amount": 4.17
        }
    ]
}

注意

对于 monthly_interest_rate 和 installment_face_value 字段，请求中只能填写这 2 个字段中的 1 个。另一个字段不需要包含在发送的 Payload 中；如果包含，则必须设为 null 值。

如果客户对同一提案申请再次发送提案，将返回一个错误，包含已发送提案的 auction proposal key 以及最后一次请求的 request control key。

错误：

{
    "code" : "PPA000006",
    "title" : "Conflict",
    "description" : "Proposal already exists for Proposal Request and Requester",
    "translation" : "Proposta para Solicitação de Proposta e Solicitante já existe."
}

及状态 409。

Body 参数

字段	类型	描述	必填
`issuer_proposal_request_key`	string	IssuerProposalRequest 的唯一识别键，采用 uuid v4 格式。	是
`auction_proposal_key`	string	AuctionProposal 的唯一识别键，采用 uuid v4 格式。	是
`disbursed_issue_amount`	float	提案预期的放款金额。	是
`monthly_interest_rate`	float	提案的月利率，范围 0 至 1（分别对应 0% 至 100%）。	否
`installment_face_value`	float	提案预期的分期金额。	否
`number_of_installments`	integer	提案的分期数。	是
`days_to_expiration`	integer	提案到期前的天数。若未包含该键，提案有效期为 7 天。	否
`rebates`	list	信贷操作的折扣列表。使用与主动发行 (/debt) 相同的标准。	否

响应

STATUS

- 202 (Accepted)

Response Body: 提案已创建

{
  "auction_proposal_key": "814e7ed3-4080-4cae-a853-8e12812817ea",
  "issuer_proposal_request_key" : "100e7ed3-4080-4cae-a853-8e12812817ea",
  "request_control_key" : "111e7ed3-4080-4cae-a853-8e12812817ea",
  "status": "bid",
  "proposal_score" : 0.4,
  "inclusion_date" : "2025-03-18T14:52:07.123456",
  "rank_position" : null,
  "proposal_data": {
        "simulation": {
            "total_iof": 15.46,
            "annual_cet": 0.0603,
            "monthly_cet": 0.0049,
            "issue_amount": 1015.46,
            "annual_interest_rate": 0.0180272568,
            "monthly_interest_rate": 0.00149,
            "disbursed_issue_amount": 1000.0,
            "installment_face_value": 102.25,
            "number_of_installments" : 48
        },
        "monthly_interest_rate": null,
        "disbursed_issue_amount": 15000,
        "installment_face_value": 102.25,
        "number_of_installments": 48
  },
}

响应 Body 参数

字段	类型	描述
`auction_proposal_key`	string	AuctionProposal 的唯一识别键，采用 uuid v4 格式。
`status`	string	提案的状态

取消提案

若要删除已纳入拍卖的提案，只需通过 API 调用，发送相关提案数据：

注意！

每个提案申请在拍卖中只有最后一个提案参与，其他提案将自动取消。

ENDPOINT

- /private_payroll_auction/auction_proposal/{auction_proposal_key}/cancel

MÉTODO

- PATCH

字段	类型	描述	字符数	必填
`issuer_proposal_request_key`	uuidv4	IssuerProposalRequest 的唯一识别键，采用 uuid v4 格式。	36	是
`auction_proposal_key`	uuidv4	AuctionProposal 的唯一识别键，采用 uuid v4 格式。	36	是

响应

STATUS

- 202 (Accepted)

Response Body: 提案已取消

{
  "auction_proposal_key": "814e7ed3-4080-4cae-a853-8e12812817ea",
  "status": "cancelled"
}

注意！

如果拍卖已结束，提案将无法再被取消。

提案已发送情况下的响应

STATUS

- 403 (Forbidden)

Response Body: 拍卖已结束，提案无法取消

{
  "auction_proposal_key": "814e7ed3-4080-4cae-a853-8e12812817ea",
  "status": "won"
}

响应 Body 参数

字段	类型	描述
`auction_proposal_key`	string	AuctionProposal 的唯一识别键，采用 uuid v4 格式。
`status`	string	提案的状态

查询提案

如需查询提案，只需通过 API 调用，使用创建提案时返回的 ID：

ENDPOINT

- /private_payroll_auction/auction_proposal/{auction_proposal_key}

MÉTODO

- GET

路径参数

字段	类型	描述	字符数	必填
`auction_proposal_key`	uuidv4	AuctionProposal 的唯一识别键，采用 uuid v4 格式。	36	是

响应

STATUS

- 200

Response Body: 提案查询

{
  "auction_proposal_key": "814e7ed3-4080-4cae-a853-8e12812817ea",
  "issuer_proposal_request_key" : "100e7ed3-4080-4cae-a853-8e12812817ea",
  "request_control_key" : "111e7ed3-4080-4cae-a853-8e12812817ea",
  "status": "bid",
  "proposal_score" : 0.4,
  "inclusion_date" : "2025-03-18T14:52:07.123456",
  "rank_position" : null,
  "proposal_data": {
        "simulation": {
            "total_iof": 15.46,
            "annual_cet": 0.0603,
            "monthly_cet": 0.0049,
            "issue_amount": 1015.46,
            "annual_interest_rate": 0.0180272568,
            "monthly_interest_rate": 0.00149,
            "disbursed_issue_amount": 1000.0,
            "installment_face_value": 102.25,
            "number_of_installments" : 48
        },
        "monthly_interest_rate": null,
        "disbursed_issue_amount": 15000,
        "installment_face_value": 102.25,
        "number_of_installments": 48
  }
}

拍卖结束时，rank_position 也会一并发送。

注：Response Body 中返回字段的详细说明请见上方 AuctionProposal 对象定义。

若提案类型为 "pre-auction"，proposal_data 字段的格式为：

{
  "proposal_data": {
    "total_iof": 7.69,
    "annual_cet": 0.2553,
    "monthly_cet": 0.0191,
    "issue_amount": 332.2,
    "annual_interest_rate": 0.1984483148,
    "monthly_interest_rate": 0.0152,
    "disbursed_issue_amount": 322.85,
    "number_of_installments": 12,
    "installment_face_value": 31.0
    }
}

更改放款账户

如需修改放款账户数据，须使用 auction_proposal_key 发起请求。

ENDPOINT

- /private_payroll_auction/auction_proposal/{auction_proposal_key}/disbursement_account

MÉTODO

- PUT

路径参数

字段	类型	描述	字符数	必填
`auction_proposal_key`	uuidv4	AuctionProposal 的唯一识别键，采用 uuid v4 格式。	36	是

响应

修改成功将返回状态 200。

STATUS

- 200

若发送的 payload 格式有误，将返回无效 schema 错误。

STATUS

- 400

错误码为：QIT000001。若发生与 schema 无关的错误，将返回相同状态码，错误码为 PPA000017。

允许的格式信息与文档 API Reference - Lending-as-a-Service - 债务 - 债务发行 - 放款 payload 示例中的内容相同。对于此 API，payload 名称从 disbursement_bank_accounts 改为 disbursement_account。以下是示例：

{
    "disbursement_account": {
        "document_number": "31233261000185",
        "name": "Jorge Augusto Salgado Salhani",
        "pix_key": "2f205c99-3161-4120-badd-854039d12de6",
        "pix_transfer_type": "key"
    }
}

债务重新呈报

要重新呈报债务，须使用 auction_proposal_key 发起请求。

ENDPOINT

- /private_payroll_auction/auction_proposal/{auction_proposal_key}/change_disbursement_date

MÉTODO

- PATCH

路径参数

字段	类型	描述	字符数	必填
`auction_proposal_key`	uuidv4	AuctionProposal 的唯一识别键，采用 uuid v4 格式。	36	是

disbursement_account 允许的格式信息与文档 API Reference - Lending-as-a-Service - 债务 - 债务发行 - 放款 payload 示例中的内容相同。对于此 API，payload 名称从 disbursement_bank_accounts 改为 disbursement_account。此外，还可以更改放款日期，只需传入 disbursement_date 字段并填写新日期。以下是示例：

{
    "disbursement_date": "2025-12-12",
    "disbursement_account": {
        "document_number": "31233261000185",
        "name": "Jorge Augusto Salgado Salhani",
        "pix_key": "2f205c99-3161-4120-badd-854039d12de6",
        "pix_transfer_type": "key"
    }
}

字段	类型	描述
`disbursement_date`	string	新的放款日期，格式为 YYYY-MM-DD
`disbursement_account`	dict	放款账户数据

响应

修改成功将返回状态 200。

STATUS

- 200

若发送的 payload 格式有误，将返回无效 schema 错误。

STATUS

- 400

错误码为：QIT000001。

修改过滤规则

对于有自定义申请过滤器的客户，可以修改这些过滤器。请求如下：

ENDPOINT

- /private_payroll_auction/requester_configuration/custom_data

MÉTODO

- PATCH

此请求中有两类可修改字段：客户状态和客户过滤器。关于客户状态，可在活跃和非活跃之间切换，表示客户是否希望接收新的拍卖申请，但无论哪种状态，客户均可操作拍卖前模式，并正常接收所有其他 webhook。

{
    "status": "active"
}

custom_data 字段包含实际过滤器。其中必须发送所有过滤字段，如以下示例所示：

{
    "custom_data": {
        "disbursed_issue_amount": {"min": null, "max": null},
        "number_of_installments": {"min": 12, "max": 24},
        "consigned_credit_balance": {"min": null, "max": null},
        "days_since_employment": {"min": null},
        "age": {"min": null, "max": 60},
        "received_daily_proposals": {"max": null},
    }
}

Body 参数

字段	类型	描述	必填
`status`	string	客户的新状态	否
`custom_data`	dict	客户的新过滤器	否

状态

状态	描述
active	客户希望接收拍卖中的新提案申请
inactive	客户不希望接收新的提案申请

Custom Data 参数

字段	类型	描述	必填
`disbursed_issue_amount`	dict	已发行合同金额（最小值和最大值）	是
`number_of_installments`	dict	分期数（最小值和最大值）	是
`consigned_credit_balance`	dict	薪资抵押信贷余额（最小值和最大值）	是
`days_since_employment`	dict	雇佣关系开始以来的天数（最小值）	是
`age`	dict	申请人年龄（最小值和最大值）	是
`received_daily_proposals`	dict	每日接收的提案数量（最大值）	是

除 received_daily_proposals 和 days_since_employment 外，每个字段都必须包含 min 和 max 键。 注：所有 custom data 字段都必须发送，即使不需要更改所有值。此外，所有 min/max 键的发送是强制性的，若不需要使用该过滤器，则传入 'null'。

Body 示例

{
    "status": "inactive",
    "custom_data": {
        "disbursed_issue_amount": {"min": 1000, "max": null},
        "number_of_installments": {"min": 12, "max": 24},
        "consigned_credit_balance": {"min": 200, "max": null},
        "days_since_employment": {"min": null},
        "age": {"min": null, "max": 60},
        "received_daily_proposals": {"max": 1000},
    }
}

响应

STATUS

- 201 (Accepted)

Response Body: 配置已更新

{
    "status": "active",
    "custom_data": {
        "disbursed_issue_amount": {"min": 1000, "max": null},
        "number_of_installments": {"min": 12, "max": 24},
        "consigned_credit_balance": {"min": 200, "max": null},
        "days_since_employment": {"min": null},
        "age": {"min": null, "max": 60},
        "received_daily_proposals": {"max": 1000},
    }
}

payload 无效时的响应

STATUS

- 400

将返回错误码 "QIT000001"。

与客户配置相关的错误响应

STATUS

- 403

此情况下返回的错误码为 "QIT000403"。客户应联系 Qi Tech 寻求配置支持。

添加过滤 CNPJ

对于只希望接收特定 CNPJ 员工申请的客户，可以批量添加这些 CNPJ：

ENDPOINT

- /private_payroll_auction/requester_configuration/related_employer

MÉTODO

- POST

Body

{
  "employer_document_numbers": [
    "01234567",
    "12345678"
  ]
}

CNPJ 只需发送前 8 位数字。

Body 参数

字段	类型	描述	必填
`employer_document_number`	字符串数组	CNPJ 根号列表（每个 8 位）。须包含 1 至 100 条记录。	是

列表最多可包含 100 个 CNPJ。

响应

STATUS

- 201

Response Body: 已添加 CNPJ

{
  "employer_document_numbers": [
    "01234567",
    "12345678"
  ]
}

说明

只返回实际添加的 CNPJ。如果某个 CNPJ 已注册，将不会出现在响应列表中。若没有 CNPJ 被添加，则返回空列表。

移除过滤 CNPJ

ENDPOINT

- /private_payroll_auction/requester_configuration/remove_related_employers

MÉTODO

- POST

Body

{
  "employer_document_numbers": [
    "01234567",
    "12345678"
  ]
}

CNPJ 只需发送前 8 位数字。

响应

STATUS

- 200

Response Body: 已移除 CNPJ

{
    "employer_document_numbers": ["01234567", "12345678"]
}

列表最多可包含 100 个 CNPJ。

若发送的 payload 格式有误，将返回无效 schema 错误。

STATUS

- 400

错误码为：QIT000001。

若该客户的 CNPJ 过滤器不存在，将返回错误：

STATUS

- 404

错误码：QIT000404

📄 查询过滤 CNPJ

要查询为申请方注册的过滤 CNPJ，请使用以下支持分页的端点。

📍 端点

ENDPOINT

- /private_payroll_auction/requester_configuration/related_employers

MÉTODO

- GET

🔍 查询参数

字段	类型	描述	默认值
`page_number`	int	当前页码	1
`page_rows`	int	每页记录数	100

✅ 响应示例 - 200

{
  "data": [
    {
      "employer_document_number": "01234567"
    },
    {
      "employer_document_number": "12345678"
    }
  ],
  "pagination": {
    "current_page": 1,
    "next_page": 2,
    "rows_per_page": 2,
    "total_pages": 3,
    "total_rows": 6
  }
}



## HTTP 状态码

签名 API 按照 <a href='https://tools.ietf.org/html/rfc7231'>RFC 7231</a> 标准使用以下 HTTP 返回状态：

| HTTP 状态码 | 含义           | 描述                                                                                                                                                                       |
| ----------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 400         | Bad Request           | 发送的请求存在格式错误。大多数情况下，我们会在消息正文中说明错误所在。                                 |
| 401         | Unauthorized          | 认证出现问题，请根据<a href='#autenticacao'>认证</a>章节的说明检查 API Key 是否正确且放置在正确的 header 中。                  |
| 403         | Forbidden             | 访问的端点为内部使用，此 API Key 无法使用。                                                                                                                                   |
| 404         | Not Found             | 使用的键未找到请求的数据。当请求无效端点时也会返回此状态。                                       |
| 405         | Method Not Allowed    | 使用的 HTTP 方法不适用于所访问的端点。                                                                                                                    |
| 406         | Not Acceptable        | 请求正文中发送的数据无效。通常意味着发送的数据不是有效的 JSON。                                                  |
| 409         | Conflict              | 请求 ID 与之前已处理的 ID 重复。当向服务器发送重复请求时会返回此状态。                             |
| 500         | Internal Server Error | 处理此请求时出现问题，遇到此错误时我们的专家会自动收到通知并立即开始分析和解决。 |
| 503         | Service Unavailable   | 您遭遇了我们服务器基础设施的计划内或计划外停机。                                                                           |

简介​

欢迎使用私人薪资抵押贷款提案拍卖 API​

遇到问题？​

环境​

仅 HTTPS​

IssuerProposalRequest: 信贷提案申请

信贷申请中的 Webhook 流程​

✅ 1. 存在预创建的保留提案​

⚖️ 2. 不存在保留提案​

Webhook 示例 - 拍卖开始​

Webhook 示例 - 拍卖结束​

IssuerProposalRequest 对象定义​

IssuerProposalRequestData 对象定义​

提案申请状态详情​

政治曝光程度详情​

提案类型​

发送 Webhook 后查询提案申请​

路径参数​

响应​

AuctionProposal – 信贷提案​

🎯 提案保留​

AuctionProposal 对象定义​

提案状态详情​

在拍卖中创建提案保留​

响应​

在拍卖中创建新提案​

Body 参数​

响应​

响应 Body 参数​

取消提案​

响应​

提案已发送情况下的响应​

响应 Body 参数​

查询提案​

路径参数​

响应​

更改放款账户​

路径参数​

响应​

债务重新呈报​

路径参数​

响应​

修改过滤规则​

Body 参数​

状态​

Custom Data 参数​

Body 示例​

响应​

payload 无效时的响应​

与客户配置相关的错误响应​

添加过滤 CNPJ​

Body​

Body 参数​

响应​

移除过滤 CNPJ​

Body​

响应​

📄 查询过滤 CNPJ​

📍 端点​

🔍 查询参数​

✅ 响应示例 - 200​

简介

欢迎使用私人薪资抵押贷款提案拍卖 API

遇到问题？

环境

仅 HTTPS

信贷申请中的 Webhook 流程

✅ 1. 存在预创建的保留提案

⚖️ 2. 不存在保留提案

Webhook 示例 - 拍卖开始

Webhook 示例 - 拍卖结束

IssuerProposalRequest 对象定义

IssuerProposalRequestData 对象定义

提案申请状态详情

政治曝光程度详情

提案类型

发送 Webhook 后查询提案申请

路径参数

响应

AuctionProposal – 信贷提案

🎯 提案保留

AuctionProposal 对象定义

提案状态详情

在拍卖中创建提案保留

响应

在拍卖中创建新提案

Body 参数

响应

响应 Body 参数

取消提案

响应

提案已发送情况下的响应

响应 Body 参数

查询提案

路径参数

响应

更改放款账户

路径参数

响应

债务重新呈报

路径参数

响应

修改过滤规则

Body 参数

状态

Custom Data 参数

Body 示例

响应

payload 无效时的响应

与客户配置相关的错误响应

添加过滤 CNPJ

Body

Body 参数

响应

移除过滤 CNPJ

Body

响应

📄 查询过滤 CNPJ

📍 端点

🔍 查询参数

✅ 响应示例 - 200