查询签名事件

此请求返回签名事件的数据。

Request

ENDPOINT

/batch_group/batch_group_key

MÉTODO

GET

Path Params

字段	描述
batch_group_key	签名事件的唯一标识键。

Response Body Params

STATUS

200

Response Body

{
    "batch_group_key": "uuid",
    "name": "Teste",
    "main_related_party": "ba",
    "number_of_documents": 1,
    "total_value": 0.0,
    "all_files_url": "",
    "send_to_fund_administrator": 0,
    "signature_expiration_date": null,
    "webhook_key": "uuid",
    "client_key": "uuid",
    "requester_key": null,
    "signature_status": "pending",
    "internal_status": "pending",
    "attached_document_number": "58020912000105",
    "current_signature_position": "1",
    "internal_webhook_key": "uuid",
    "created_at": "2023-05-15 23:54:35",
    "batch_group_type": "icp_signature",
    "requester_identifier": null,
    "send_emails": false,
    "batches": [
        {
            "document_batch_key": "uuid",
            "name": "Termo de Endosso",
            "document_type": "term_of_endorsement",
            "signature_type": "cades",
            "signature_status": "pending",
            "created_at": "2023-05-15 23:54:35",
            "related_parties": [
                {
                    "related_party_key": "uuid",
                    "name": "Empresa Exemplo LTDA",
                    "role": "assignor",
                    "signature_status": "pending",
                    "signature_position": "1",
                    "created_at": "2023-05-15 23:54:35",
                    "auto_signature": 0,
                    "notify_to": [],
                    "signer_groups": [
                        {
                            "id": 38586,
                            "expiration": null,
                            "minimum_required_signers": 1,
                            "signable_limit": null,
                            "signature_status": "pending",
                            "created_at": "2023-05-15 23:54:35",
                            "signers": [
                                {
                                    "id": 65062,
                                    "signer_control_number": "1",
                                    "signature_timestamp": null,
                                    "signature_status": "pending",
                                    "name": "João",
                                    "is_group_mandatory": true,
                                    "email": "signatario@example.com",
                                    "document_number": "90203438906",
                                    "created_at": "2023-05-15 23:54:35"
                                }
                            ]
                        }
                    ]
                }
            ],
            "documents": [
                {
                    "document_key": "uuid",
                    "control_number": "uuid",
                    "file_size": 1681,
                    "file_url": "https://qi.example.com/arquivos/uuid/documento_exemplo_original.pdf",
                    "name": "documento_exemplo.pdf",
                    "original_file_url": "https://qi.example.com/arquivos/uuid/documento_exemplo_original.pdf",
                    "status": "pending",
                    "signed_file_url": null,
                    "created_at": "2023-05-15 23:54:35",
                    "signatures": []
                }
            ]
        }
    ],
    "watcher_clients": [],
    "zip_file_keys_list": [
        "uuid",
        "uuid"
    ]
}

字段	类型	描述
main_related_party	string	负责签署事件的主要相关方名称
name	string	事件名称。
batch_group_key	string	签名事件的标识键。
signature_status	string	签名状态。
internal_status	string	事件的总体状态。
total_value	string	事件文件的总价值。
client_key	string	客户的标识键。
send_emails	布尔值	指示是否应为此事件发送签名电子邮件。
attached_document_number	string	转让方的 CNPJ。
batches	列表	不同类型文件及其各自相关方的列表。
webhook_url	string	Webhook 的发送地址。
webhook_url_list	列表	Webhook 的发送地址列表。
zip_file_keys_list	列表	ZIP 文件的标识键。

Batches 对象

字段	类型	描述
related_parties	列表	参与一组文件签名的相关方列表。
documents	列表	文件列表。
name	string	Batch 名称。
signature_type	enum	签名类型。
document_type	enum	文件类型。

Related Parties 对象

字段	类型	描述
role	enum	签名人所扮演的角色。
name	string	相关方名称。
signature_position	整数	签名位置。
signer_groups	列表	签名人组列表。

Signer Groups 对象

字段	类型	描述
minimum_required_signers	整数	组内签名被视为完成所需的最少签名人数。
signers	列表	构成签名人组的签名人列表。

Signer 对象

字段	类型	描述
name	string	签名人姓名。
document_number	string	签名人的 CPF。
email	string	签名人的电子邮件。
is_group_mandatory	布尔值	指示该签名人是否必须签名才能使其所属签名人组被视为完成。
signer_control_number	string	可用于控制或外部引用的自由字段。
signature_timestamp	date	签名日期。

Documents 对象

字段	类型	描述
name	string	文件名称。
control_number	string	可用于控制或外部引用的自由字段。
file_size	float	文件大小。
url	string	文件 URL。
document_key	string	文件的标识键。
original_file_url	string	原始文件的 URL。
signed_file_url	string	带签名页的文件 URL。
file_url	string	签名文件的 URL。