供应商文件

上传、列出、下载和取消审核中的文件。文件以 Base64 格式放在请求体中。每个调用都有两个契约相同的版本：用于供应商的文件，以及用于每个关联方的文件。

只有审核处于 pending_submission 时才接受上传和取消（409，VRG000072）。审核在 QI Tech 处理期间，只能通过回复审核意见附加文件。如需自行修改，请将审核撤出队列。

文件类型

document_type	说明	自然人供应商	法人供应商	关联方
social_contract	公司章程（contrato social）		是	parent_company
company_statute	公司章程（estatuto social）		是	parent_company
board_election_record	董事会选举会议记录		是	parent_company
commercial_board_certificate	商业登记处证明		是	parent_company
organizational_chart	股权架构图		是	parent_company
financial_statements	财务报表		是	parent_company
power_of_attorney	授权委托书		是	是
cnh	CNH（驾驶证）	是		是
rg	RG（正反面在同一个文件中）	是		是
rg_front	RG 正面	是		是
rg_back	RG 反面	是		是
identification_document	未指定类型的身份证件；QI Tech 会将其重新归类为 cnh 或 rg	是		是
passport	护照			是，仅限有 passport_number 时
proof_of_residence	地址证明	是	是	是
extra_document	附加文件	是	是	是

“关联方”一列中的“是”适用于自然人关联方。parent_company 接受与法人供应商相同的文件类型。

提交审核的必需文件：

• 法人供应商：social_contract 或 company_statute。
• 自然人供应商：cnh、rg、rg_front + rg_back 或 identification_document。
• 每个 is_representative: true 的关联方：上述身份证件之一；有 passport_number 时可使用 passport。
• 每个 attorney 类型的关联方：自己的 power_of_attorney。

文件规则：

• PDF、PNG、JPEG 或 ZIP，最大 20 MB；
• 上传同类型的新文件会取消之前的文件。extra_document 除外，它可以重复上传。

文件状态

状态	说明
valid	已接受。不进行自动读取的类型（proof_of_residence、financial_statements、organizational_chart、extra_document、passport）上传后即为此状态；自然人身份证件在读取到的 CPF 与该人员一致时也为此状态。
in_manual_analysis	等待 QI Tech 读取或复核。其他文件的初始状态。
invalid	被 QI Tech 拒绝。
inconclusive	自动读取未得出结论；由分析师决定。
canceled	被管理人取消，或被同类型的其他文件替换。

上传供应商文件

适用范围

角色	主机	所需权限
管理人	manager-api	写入
顾问	consultant-api	有效集成

各主机的 Base URL：环境（主机）。

ENDPOINT

/vendor_registry/analysis/{analysis_key}/document

方法

POST

路径参数

参数	类型	说明
analysis_key	string	审核的 key（UUID）。

Corpo da requisição

{
    "name": "contrato_social.pdf",
    "document_type": "social_contract",
    "document_b64": "JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwKL0xlbmd0aCAzIDAgUgo..."
}

请求体属性

字段	类型	必填	说明
name	string	是	文件名，1 至 255 个字符。
document_type	string	是	文件类型。参见类型。
document_b64	string	是	Base64 格式的文件内容。

响应

STATUS

201

Corpo da resposta

{
    "document_name": "contrato_social.pdf",
    "document_key": "d1e2f3a4-b5c6-4d7e-8f9a-0b1c2d3e4f5a",
    "document_type": "social_contract",
    "file_type": "pdf",
    "analysis_key": "8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13",
    "status": "in_manual_analysis",
    "reference_date": null,
    "data": null
}

响应属性

字段	类型	说明
document_name	string	文件名。
document_key	string	文件的 key（UUID）。
document_type	string	文件类型。identification_document 返回时可能已被重新归类。
file_type	string	pdf、png、jpeg 或 zip，根据内容检测。
analysis_key	string	审核的 key。
status	string	文件状态。参见状态。
reference_date	string	从文件中提取的参考日期（最近一次合并修订日期或签发日期），YYYY-MM-DD，或 null。
data	object	自动读取提取的数据，或 null。
document_url	string	仅在按 key 查询时返回：用于下载文件的预签名 URL，有效期 24 小时。

上传关联方文件

请求体和响应与供应商文件相同，响应中多一个 related_party_key 字段。该关联方必须与此审核关联，且不能处于 inactive。

ENDPOINT

/vendor_registry/analysis/{analysis_key}/related_party/{related_party_key}/document

方法

POST

权限：管理人（manager-api）：写入。顾问（consultant-api）：有效集成。

列出文件

返回该审核（或该审核中某个关联方）的所有文件，包含任意状态，不含下载 URL，也不分页。

ENDPOINT

/vendor_registry/analysis/{analysis_key}/documents

方法

GET

ENDPOINT

/vendor_registry/analysis/{analysis_key}/related_party/{related_party_key}/documents

方法

GET

权限：管理人（manager-api）：读取。顾问（consultant-api）：有效集成。

Corpo da resposta

{
    "data": [
        {
            "document_name": "contrato_social.pdf",
            "document_key": "d1e2f3a4-b5c6-4d7e-8f9a-0b1c2d3e4f5a",
            "document_type": "social_contract",
            "file_type": "pdf",
            "analysis_key": "8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13",
            "status": "valid",
            "reference_date": "2025-03-14",
            "data": null
        }
    ]
}

按 key 查询文件

返回带有 document_url 的文件：这是一个有效期 24 小时的下载链接，并以文件的内容类型提供。过期后，请重新查询以获取新的链接。

ENDPOINT

/vendor_registry/analysis/{analysis_key}/documents/{document_key}

方法

GET

ENDPOINT

/vendor_registry/analysis/{analysis_key}/related_party/{related_party_key}/documents/{document_key}

方法

GET

权限：管理人（manager-api）：读取。顾问（consultant-api）：有效集成。

Corpo da resposta

{
    "document_name": "cnh_joao.pdf",
    "document_key": "e2f3a4b5-c6d7-4e8f-9a0b-1c2d3e4f5a6b",
    "document_type": "cnh",
    "file_type": "pdf",
    "analysis_key": "8c2a6f0e-1b3d-4f7a-9c1e-2a4b6d8f0c13",
    "status": "valid",
    "related_party_key": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
    "reference_date": null,
    "data": null,
    "document_url": "https://<link-temporario-de-download>"
}

取消文件

将文件标记为 canceled。要求审核处于 pending_submission。取消已取消的文件会返回 204，不做任何变更。

ENDPOINT

/vendor_registry/analysis/{analysis_key}/document/{document_key}

方法

DELETE

ENDPOINT

/vendor_registry/analysis/{analysis_key}/related_party/{related_party_key}/document/{document_key}

方法

DELETE

权限：管理人（manager-api）：写入。顾问（consultant-api）：有效集成。

STATUS

204

响应没有响应体。

错误

STATUS

409

登记已提交审核

审核不处于 pending_submission。提交后，请通过回复审核意见附加文件，或将审核撤出队列。

{
  "title": "Vendor Registration Already Submitted",
  "description": "The current analysis of the vendor 5d2e7b9a-3c4f-4e8a-b1d6-9f0a2c3e4b57 is no longer pending submission, so the registration cannot be edited.",
  "translation": "Cadastro ja enviado para analise.",
  "code": "VRG000072"
}

STATUS

400

code	发生情形
VRG000081	供应商的人员类型不接受该 document_type。
VRG000082	关联方的类型不接受该 document_type，或为没有 passport_number 的关联方上传 passport。
VRG000080	文件大于 20 MB。
VRG000067	document_b64 不是有效的 Base64。
VRG000097	内容不是 PDF、PNG、JPEG 或 ZIP。

Exemplo

{
  "title": "Invalid Document Type For Vendor",
  "description": "This person type of vendor does not accept the cnh document type.",
  "translation": "O tipo de pessoa deste fornecedor nao aceita documentos do tipo cnh.",
  "code": "VRG000081"
}

STATUS

404

code	发生情形
VRG000007	该 analysis_key 不存在。如果审核属于您看不到的供应商，错误码为 VRG000014。
VRG000053	该 related_party_key 未与此审核关联，或该关联方处于 inactive。
VRG000003	该 document_key 不属于此审核（或此关联方）。

认证、权限和主机相关的错误：参见 API 错误。

下一步

银行账户和签署人组，或直接进行**提交审核**。