Criar evento
Este endpoint deve ser utilizado para enviar todos os documentos e os assinantes do evento para assinatura, aqui denominado batch_group.
Para a criação de um batch_group primeiro temos o envio dos dados completos dos assinantes. Em todos os eventos de assinatura enviados, os dados dos assinantes deverão vir completos, como no payload a seguir:
Definições
Request
ENDPOINT
/batch_groupMÉTODO
POSTRequest Body
{
"main_related_party": "ba",
"webhook_url": "google.com.br",
"watcher_document_number": [],
"send_to_fund_administrator": false,
"name": "Teste",
"total_value": 0,
"client_key": "5aaf98d2-0264-48dd-8167-eab859ce5a75",
"webhook_url_list": [
"https://google.com",
"https://google2.com"
],
"control_number": "Control Number",
"attached_document_number": "74766848000162",
"send_emails": false,
"batches": [{
"signature_type": "cades",
"document_type": "term_of_endorsement",
"name": "Termo de Endosso",
"related_parties":[
{
"name": "nome da empresa ",
"role": "assignor",
"signature_position":1,
"signer_groups": [
{
"minimum_required_signers": 1,
"signers":[
{
"name": "João",
"document_number": "85653681067",
"email": "teste@qitech.com.br",
"is_group_mandatory": true,
"signer_control_number": "1"
}
]
}
]
}
],
"documents": [{
"name": "teste_of.pdf",
"control_number": null,
"url": "https://storage.googleapis.com/certifier-api-storage-sandbox/093f1aef-437e-405b-9ef9-51efd73dbd57/teste_of_original.pdf",
"document_key": "19f3c0ib-3926-4274-b2ab-720014b35f53",
"file_size": 1681
}]
}]
}
Nesta primeira opção, as related_parties, signer_groups e signers sempre precisam ser enviados. O campo notify_to é opcional.
STATUS
200Response Body
```json
{
"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",
"control_number": "Control Number",
"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": []
}
Importante
O campo 'documentos' no 'grupo de documentos' ('batches') deve ser populado como resposta da requisição /document.
Body Params
| Campo | Tipo | Descrição |
|---|---|---|
name (obrigatório) | string | Nome do evento. |
total_value (obrigatório) | string | Valor total dos documentos do evento. |
client_key | string | Chave de integração do cliente. |
send_to_fund_administrator (obrigatório) | booleano | Indica se o evento deve ser enviado para o FROMTIS caso o administrador do fundo o utilize. |
main_related_party (obrigatório) | string | Nome da principal parte relacionada para assinar o evento (porém é um campo livre) |
control_number (obrigatório) | string | Número de controle externo. |
batch_group_type (obrigatório) | string | Indica o tipo de assinatura (digital ou eletrônica). |
send_emails (obrigatório) | string | Indica se os e-mails de assinatura devem ser enviados para este evento de assinatura. |
watcher_document_number | string | Lista com client_keys que podem visualizar seus documentos. |
batches (obrigatório) | string | Lista de diferentes tipos de documentos. |
webhook_url | string | Link para onde será enviado o webhook. |
webhook_url_list | lista | Lista de Links para onde será enviado o webhook. |
info
O campo "control_number" também deve ser enviado (uuid identificador do lote de cessão com 36 caracteres).
info
O campo "webhook_url" ou "webhook_url_list" deve ser enviado apenas se o recebimento de webhooks for desejado, e apenas uma dessas opções deve ser escolhida na requisição.
Envio de Observador
Caso uma empresa "b" tenha criado o evento e deseja que a empresa "a" consiga visualizar, sendo que a empresa "a" não tem assinante. A empresa "b" precisa incluir durante a criação do batch group, o seguinte campo:
Request Body
"watcher_document_number": []
cuidado
O campo watcher_document_number campo deve ser preenchido pela client key da empresa "a"
Objeto Batches
| Campo | Descrição |
|---|---|
related_parties | Partes relacionadas que assinam este batch |
documents | lista de documentos enviados no POST /document |
name | Nome do arquivo |
signature_type | Tipo de assinatura |
document_type | Tipo de documento |
Objeto Related Parties
| Campo | Descrição |
|---|---|
role | Cargo |
name | Nome da Empresa |
signature_position | Posição de assinatura |
notify_to | Notificação |
signer_groups | Grupo de assinantes |
Objeto Documents
| Campo | Descrição |
|---|---|
name | Nome do arquivo. |
control_number | Número de controle. |
file_size | Tamanho do arquivo |
url | Url do arquivo |
document_key | Chave do documento |
Notificação Webhook
Para melhor descrição da estrutura e recebimento do webhook acesse o trecho 10.4.2.