CertifiQI 手册

请求

ENDPOINT

/document

MÉTODO

POST

Request Body

{
        "file_name": "nome.pdf",
        "document_type": "ccb",
        "document_identifier": "jfkjkd",
        "endorsement_page": true,
        "endorser_name": "NOME ENDOSSANTE",
        "endorser_document_number": "CNPM ENDOSSANTE",
        "receiver_name": "NOME ENDOSSATÁRIO",
        "receiver_document_number": "CNPJ ENDOSSATÁRIO",
        "control_number": "123456789"
}

POST /document 方法用于发送文档（PDF 或 CNAB）并将其与一组文档关联。

请求的 form-data 中需发送以下数据：

file - pdf 格式的文档。

此请求的返回

此请求的返回值应在后续的 POST /batch_group 请求中发送。与 batch_group 一起发送后，无需保存该信息。

响应

STATUS

200

Response Body

{
		"control_number": null,
		"document_key": "uuid",
		"file_size": 281195,
		"name": "contrato_343362_565466029.pdf",
		"url": "https://qi.example.com/arquivos/uuid/contrato_343362_565466029_original.pdf"
}

定义

请求体对象

字段	类型	描述	最大字符数
file_name *	string	将要发送的文件名。	-
document_type *	string	将要发送的文档类型。	-
document_identifier *	string	合作伙伴系统中的文档标识符。	-
endorsement_page *	boolean	表示是否应为文档生成背书。	-
endorser_name *	string	背书人姓名。	-
endorser_document_number *	string	背书人文件编号。	-
receiver_name *	string	接收人姓名。	-
receiver_document_number *	string	接收人文件编号。	-
control_number	string	可选字段，表示由 QI Tech 提供的转让控制号（当转让由 QI Tech 执行时）。	36

请求

ENDPOINT

/batch_group

MÉTODO

POST

Request Body

{
    "client_key": "uuid",
    "name": "Endosso",
    "main_related_party": "EMPRESA EXEMPLO LTDA",
    "batches": [{
        "documents": [
                {
		"control_number": null,
		"document_key": "uuid",
		"file_size": 281195,
		"name": "contrato_522634_335538908.pdf",
		"url": "https://qi.example.com/arquivos/uuid/contrato_522634_335538908_original.pdf"
                }
        ],
        "related_parties": [
            {
                "document_number": "00000000000000",
                "name": "EMPRESA EXEMPLO LTDA",
                "role": "endorser"
            }
        ],
        "document_type": "endorsement",
        "name": "Endosso",
        "signature_type": "cades"
    }],
    "total_value": 0,
    "send_emails": true,
    "send_to_fund_administrator": false,
    "requester_identifier": null
}

POST /batch_group 方法用于发送所有文档和事件签署方以进行签名。请求体中需要发送的数据请参见"创建 batch group"。

响应

STATUS

200

Response Body

{
	"batch_group_key": "uuid",
	"name": "Endosso",
	"main_related_party": "EMPRESA EXEMPLO LTDA",
	"number_of_documents": 131,
	"total_value": 0.0,
	"all_files_url": "",
	"send_to_fund_administrator": 0,
	"signature_expiration_date": null,
	"webhook_key": null,
	"client_key": "uuid",
	"requester_key": null,
	"signature_status": "pending",
	"internal_status": "pending",
	"attached_document_number": null,
	"current_signature_position": 0,
	"control_number": null,
	"internal_webhook_key": null,
	"created_at": "2022-12-28 14:02:07",
	"batch_group_type": "icp_signature",
	"requester_identifier": null,
	"send_emails": true,
	"batches": [{
		"document_batch_key": "uuid",
		"name": "Endosso",
		"document_type": "endorsement",
		"signature_type": "cades",
		"signature_status": "pending",
		"created_at": "2022-12-28 14:02:07",
		"related_parties": [{
			"related_party_key": "uuid",
			"name": "EMPRESA EXEMPLO LTDA",
			"role": "endorser",
			"signature_status": "pending",
			"signature_position": 0,
			"created_at": "2022-12-28 14:02:07",
			"auto_signature": 0,
			"notify_to": [],
			"signer_groups": [{
				"id": 3946028,
				"expiration": null,
				"minimum_required_signers": 1,
				"signable_limit": null,
				"signature_status": "pending",
				"created_at": "2022-12-28 14:02:07",
				"signers": [{
					"id": 19941144,
					"signer_control_number": "12033",
					"signature_timestamp": null,
					"signature_status": "pending",
					"name": "Signatário Exemplo",
					"is_group_mandatory": false,
					"email": "signatario@example.com",
					"document_number": "00000000000",
					"created_at": "2022-12-28 14:02:07"
				}]
			}]
		}],
		"documents": [{
			"document_key": "uuid",
			"control_number": "uuid",
			"file_size": 281195,
			"file_url": "https://qi.example.com/arquivos/uuid/contrato_897339_864424466_original.pdf",
			"name": "contrato_897339_864424466.pdf",
			"original_file_url": "https://qi.example.com/arquivos/uuid/contrato_248703_786280115_original.pdf",
			"status": "pending",
			"signed_file_url": null,
			"created_at": "2022-12-28 14:02:07",
			"signatures": []
		}]
	}],
	"watcher_clients": []
}

定义

请求体对象

字段	类型	描述	最大字符数
client_key *	string	代表合作伙伴密钥的 uuid。	-
name *	string	将要发送的文档组的名称。	-
main_related_party *	string	签署事件的主要关联方姓名（但这是一个自由字段）。	-
batches *	array of objects	不同类型文档的列表。	-
total_value *	float	事件文档的总价值。	-
send_emails *	boolean	表示是否应为此签名事件发送签名邮件。	-
send_to_fund_administrator *	boolean	表示如果基金管理员使用 FROMTIS，是否应将事件发送给基金管理员。	-
requester_identifier *	string	合作伙伴提供的事件标识符。

BATCHES 对象

字段	类型	描述	最大字符数
related_parties *	array of objects	签署该批次的关联方。	-
documents *	array of objects	POST /document 中发送的文档列表。	-
name *	string	文件名。	-
signature_type *	string	签名类型。	-
document_type *	string	文档类型。	-

字段	类型	描述	最大字符数
role *	string	职位/角色。	-
name *	string	公司名称。	-
document_number *	string	签署方文件编号。	-

请求

ENDPOINT

/batch_group/BATCH_GROUP_KEY/send_to_signature

MÉTODO

POST

路径参数

字段	描述
batch_group_key *	签名事件的唯一标识密钥。

POST /batch_group/BATCH_GROUP_KEY/send_to_signature 方法用于完成文档组并将批次发送以进行签名。

请求​

响应​

定义​

请求体对象​

请求​

响应​

定义​

请求体对象​

BATCHES 对象​

RELATED PARTIES 对象​

请求​

路径参数​

请求

响应

定义

请求体对象

请求

响应

定义

请求体对象

BATCHES 对象

RELATED PARTIES 对象

请求

路径参数