GET Batch Group

This request returns the data of a batch group.

Request

ENDPOINT

/batch_group/batch_group_key

MÉTODO

GET

Path Params

Campo	Descrição
batch_group_key	Unique key identifying the batch group.

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"
    ]
}

Field	Type	Description
main_related_party	string	Name of the main party responsible for signing the event.
name	string	Name of the event.
batch_group_key	string	Key of the batch group.
signature_status	string	Status of the signature.
internal_status	string	Overall status of the event.
total_value	string	Total value of the event’s documents.
client_key	string	Client identification key.
send_emails	boolean	Indicates whether signature emails should be sent for this event.
attached_document_number	string	Assignor’s CNPJ
batches	lista	List of different document types and their respective related parties.
webhook_url	string	URL to which the webhook will be sent.
webhook_url_list	lista	List of URLs to which the webhook will be sent.
zip_file_keys_list	list	Identification key of the ZIP files.

Batches Object

Field	Type	Description
related_parties	list	List of related parties involved in signing a list of documents.
documents	list	List of documents.
name	string	Name of the batch.
signature_type	enum	Type of signature.
document_type	enum	Type of document.

Related Parties Object

Field	Type	Description
role	enum	Role played by the signers.
name	string	Name of the related party.
signature_position	integer	Signature position.
signer_groups	list	List of signer groups.

Signer Groups Object

Field	Type	Description
minimum_required_signers	integer	Minimum number of signers required to have signed for the group's signatures to be considered complete.
signers	list	List of signers that make up the signer group.

Signer Object

Field	Type	Description
name	string	Name of the signer.
document_number	string	Signer’s CPF (Brazilian individual tax ID).
email	string	Signer's email.
is_group_mandatory	boolean	Indicates if the signer is required to sign for the signer group to be considered complete.
signer_control_number	string	Free field that can be used for control purposes or external reference.
signature_timestamp	date	Date of the signature.

Documents Object

Field	Type	Description
name	string	Name of the document.
control_number	string	Free field that can be used for control purposes or external reference.
file_size	float	Size of the document.
url	string	Document URL.
document_key	string	Document identification key.
original_file_url	string	URL of the original document.
signed_file_url	string	URL of the document with signing page.
file_url	string	URL of the signature file.