跳到主要内容

查询文件


返回转让合同的附件文件(合同或管理人声明),以及最新版本的下载 URL。

适用范围
角色主机所需权限
管理人manager-api读取
顾问consultant-apiView assignment contracts

各主机的 Base URL:环境(主机)。

Request​

ENDPOINT
/assignment_contract/assignment_contract/ASSIGNMENT_CONTRACT_KEY/attached_document/DOCUMENT_KEY
MÉTODO
GET

Path Params​

参数描述
assignment_contract_key转让合同的 key
document_key文件的 key

Response​

STATUS
200
Response Body
{
"document_key": "8f1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"document_type": "assignment_contract",
"status": "signed",
"generation_method": "internal",
"signature_validation_method": "internal",
"document_template_key": "2a7c9e1b-3d5f-4b8a-9c0e-6f1a2b3c4d5e",
"required_parties": ["manager", "assignor"],
"upload_document_analyses": [],
"download_url": "document download URL"
}
说明

download_url 字段提供文件最新版本的签名下载 URL:如文件已签署,则为签署版本。该 URL 会过期,不应保存以供日后查询。

附件文件定义​

字段类型描述字符数
document_key *string文件的唯一标识 key。36
document_type *string文件类型。--
status *string文件状态。见 Attached Document Status。
document_template_keystring生成该文件的模板的唯一标识 key。36
required_partiesarray签署该文件的各方列表。--
generation_methodstring文件的生成方式:internal(由平台生成)或 external(通过上传提交)。--
signature_validation_methodstring签名的校验方式(例如 internal 或 external)。--
upload_document_analysesarray通过上传提交的文件的分析结果。无上传时为空。--
download_urlstringPDF 的下载 URL。--

错误​

状态码代码触发条件
404ACT000023未找到 assignment_contract_key。
404ACT000087未找到 document_key,或其不属于所指定的合同。

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