Consultar Evento de Assinatura

Essa requisição retorna os dados de um evento de assinatura.

Request

ENDPOINT

/batch_group/batch_group_key

MÉTODO

GET

Path Params

Campo	Descrição
batch_group_key	Chave única de identificação do evento de assinatura.

Response Body Params

STATUS

200

Response Body

{
    "batch_group_key": "c0394fb2-34f6-4d70-be70-776022fe15b8",
    "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": "ac73c564-989d-4c53-932b-d8f96b007585",
    "client_key": "5aaf98d2-0264-48dd-8167-eab859ce5a75",
    "requester_key": null,
    "signature_status": "pending",
    "internal_status": "pending",
    "attached_document_number": "74766848000162",
    "current_signature_position": "1",
    "internal_webhook_key": "ac73c564-989d-4c53-932b-d8f96b007584",
    "created_at": "2023-05-15 23:54:35",
    "batch_group_type": "icp_signature",
    "requester_identifier": null,
    "send_emails": false,
    "batches": [
        {
            "document_batch_key": "cd65292e-6748-4c1a-9520-de019f2f341b",
            "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": "41cf4d2a-fa9a-4cd1-93a0-5a1847b14fb3",
                    "name": "nome da empresa ",
                    "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": "teste@qitech.com.br",
                                    "document_number": "85653681067",
                                    "created_at": "2023-05-15 23:54:35"
                                }
                            ]
                        }
                    ]
                }
            ],
            "documents": [
                {
                    "document_key": "19f3c0ib-3926-4274-b2ab-720014b35f53",
                    "control_number": "96a8cd68-76b4-4abf-8180-7d8ebe39567e",
                    "file_size": 1681,
                    "file_url": "https://storage.googleapis.com/certifier-api-storage-sandbox/093f1aef-437e-405b-9ef9-51efd73dbd57/teste_of_original.pdf",
                    "name": "teste_of.pdf",
                    "original_file_url": "https://storage.googleapis.com/certifier-api-storage-sandbox/093f1aef-437e-405b-9ef9-51efd73dbd57/teste_of_original.pdf",
                    "status": "pending",
                    "signed_file_url": null,
                    "created_at": "2023-05-15 23:54:35",
                    "signatures": []
                }
            ]
        }
    ],
    "watcher_clients": []
}

Campo	Tipo	Descrição
main_related_party	string	Nome da parte principal responsável por assinar o evento
name	string	Nome do evento.
batch_group_key	string	Chave do evento de assinatura.
signature_status	string	Status da assinatura.
internal_status	string	Status geral do evento.
total_value	string	Valor total dos documentos do evento.
client_key	string	Chave de identificação do cliente.
send_emails	booleano	Indica se os e-mails de assinatura devem ser enviados para este evento.
attached_document_number	string	CNPJ do cedente.
batches	lista	Lista dos diferentes tipos de documentos e suas respectivas partes relacionadas.
webhook_url	string	Link para onde será enviado o webhook.
webhook_url_list	lista	Lista de links para onde será enviado o webhook.

Objeto Batches

Campo	Tipo	Descrição
related_parties	lista	Lista das partes relacionadas envolvidas na assinatura de uma lista de documentos.
documents	lista	Lista de documentos.
name	string	Nome do batch.
signature_type	enum	Tipo de assinatura.
document_type	enum	Tipo de documento.

Objeto Related Parties

Campo	Tipo	Descrição
role	enum	Papel desempenhado pelos assinantes.
name	string	Nome da parte relacionada.
signature_position	inteiro	Posição de assinatura.
signer_groups	lista	Lista dos grupos de assinantes.

Objeto Signer Groups

Campo	Tipo	Descrição
minimum_required_signers	inteiro	Número mínimo de assinantes que devem ter assinado para que as assinaturas do grupo sejam consideradas concluídas.
signers	lista	Lista dos assinantes que compõem o grupo de assinantes.

Objeto Signer

Campo	Tipo	Descrição
name	string	Nome do assinante.
document_number	string	CPF do assinante.
email	string	Email do assinante.
is_group_mandatory	booleano	indicar se o assinante é obrigatório assinar para que o grupo de assinantes ao qual pertence seja considerado concluído.
signer_control_number	string	Campo livre que pode ser utilizado para fins de controle ou referência externa.
signature_timestamp	date	data da assinatura.

Objeto Documents

Campo	Tipo	Descrição
name	string	Nome do documento.
control_number	string	Campo livre que pode ser utilizado para fins de controle ou referência externa.
file_size	float	Tamanho do documento.
url	string	URL do documento.
document_key	string	Chave de identificação do documento.
original_file_url	string	URL do documento original.
signed_file_url	string	URL do documento com página de assinatura.
file_url	string	URL do arquivo de assinatura.