跳到主要内容

私人薪资抵押贷款手册 - 外部签署形式

导航
开发中的 API

该 API 仍处于开发阶段，因此本手册可能会有所更改。

本节将提供使用 API 对活跃流程中产生的操作进行签署所需的指导，无需使用 QI Tech 的电子签名解决方案 QIsign。

此流程适用于选择使用外部电子签名解决方案（如 DocuSign、Clicksign 等）来正式化合同的客户。

1 - 文件提交​

必须提交合同的补充数据。

文件必须通过文件上传端点提交，并遵循以下格式：

验证值
格式JPEG
最小尺寸250 x 250 px

文件上传后，提交的文件密钥必须在创建操作的 payload 中提供，或之后通过以下端点提供：

ENDPOINT
/debt/DEBT-KEY/related_party/RELATED-PARTY-KEY/attached_document
MÉTODO
POST
Request Body
{
    "document_identification": "2893fc74-88fd-4cc9-a5c6-8a63d9d00f41",
    "document_identification_back": "e881ddf4-bc9a-48e0-9555-cac979f65431",
    "selfie": "ca37979e-6f11-4465-bf3b-69cd8307549c"
}
信息

related_party_key 在创建债务的响应中的 borrower 对象内返回

2 - 操作正式化​

文件输入后，操作可以进入正式化阶段。

在法定代理人签署的情况下，"data.contract.signers[i]"字段将返回法定代理人的数据，"data.contract.signers[i].signer_role"对象的值将为"issuer_legal_representative"。

在签署 payload 中，必须包含第 1 项中提交文件的必填字段。必填字段如下：ip_address 和 signature_datetime。

Request​

ENDPOINT
/debt/DEBT-KEY/signed
MÉTODO
POST

PAYLOAD 示例​

Request Body - 已签署 PDF
{
    "path-pdf-signed": "https://storage.googleapis.com/sandbox-doc-api-private/documents/8b740ca1-405d-4507-a7b3-e7de01c4e008/BENJAMINERAPHAELA-NOME_DEVEDOR-CCB-LCM3307596554-20250721184150_signed.pdf",
    "type": "pdf-signature",
    "biometry_analysis_reference": "serpro",
    "similarity_score": "0.96",
    "ip_address": "192.168.0.0",
    "signature_datetime": "2025-07-22T14:30:12.729Z"
}
Request Body - 凭证签署
{
    "biometry_analysis_reference": "serpro",
    "signature_datetime": "2025-07-21T10:38:23.382748Z",
    "similarity_score": 0.98,
    "ip_address": "179.104.42.245",
    "type": "data-signature",
    "signatures": [
        {
            "authenticity": {
                "timestamp": "2025-07-21 10:38:23",
                "ip_address": "179.104.42.245",
                "session_id": "ddb1d063-4fdf-4330-af9c-3316e9142ff3"
            },
            "signer": {
                "name": "Nome devedor",
                "email": "naotem@gmail.com",
                "phone": {
                    "country_code": "055",
                    "area_code": "84",
                    "number": "999538380"
                },
                "document_number": "11200770870"
            },
            "authentication_type": "opt-in"
        }
    ]
}
注意

签署 payload 根据合作伙伴的正式化流程而有所不同，必须与 QI Tech 的集成团队进行协调。

生物特征分析参考 枚举值​

枚举值描述
serpro当 similarity_score 通过查询 Detran 照片文件数据库（通过 Serpro 提供的服务）返回时使用
tse当 similarity_score 通过查询 TSE 照片文件数据库返回时使用
not_found当面部生物特征在上述任何政府数据库（serpro 或 tse）中均未找到时填写。在这种情况下，similarity_score 应为 null，或由合作伙伴返回的自拍与带照片官方文件的相似度分数。