Criar Evento de Assinatura
Este endpoint deve ser utilizado para o envio do evento de assinatura, que inclui os documentos e os respectivos assinantes, agrupados em um objeto denominado batch_group.
Definições
Request
Request Body
{
"main_related_party": "ba",
"webhook_url": "google.com.br",
"send_to_fund_administrator": false,
"is_asynchronous": false,
"name": "Teste",
"total_value": 0,
"webhook_url_list": [
"https://google.com",
"https://google2.com"
],
"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
}]
}]
}
Response 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",
"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,
"is_asynchronous": 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": []
}
Request Body Params
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
main_related_party | string | Nome da parte principal responsável por assinar o evento. | SIM |
name | string | Nome do evento de assinatura. | SIM |
total_value | string | Valor total dos documentos do evento. | SIM |
send_emails | booleano | Indica se os e-mails de assinatura devem ser enviados para este evento. Caso o valor seja FALSE, nenhum e-mail será enviado em nenhuma etapa do processo. | SIM |
attached_document_number | string | CNPJ do cedente, utilizado quando o documento estiver relacionado a um cedente específico. | NÃO |
batches | lista | Lista dos diferentes tipos de documentos e suas respectivas partes relacionadas. | SIM |
webhook_url | string | URL para a qual o webhook de notificação será enviado. | NÃO |
webhook_url_list | lista | Lista de URLs para as quais os webhooks de notificação serão enviados. | NÃO |
is_asynchronous | booleano | O evento inclui um documento gerado de forma assíncrona. | NÃO |
send_to_fund_administrador | booleano | Após a assinatura, o evento deve notificar via SOAP uma administradora que utiliza o software Fromtis. | NÃO |
- Os campos webhook_url ou webhook_url_list devem ser enviados somente se houver interesse no recebimento de webhooks. Além disso, apenas uma dessas opções deve ser informada por requisição.
- O campo is_asynchronous deve ser informado como True quando o evento contiver um documento criado de forma assíncrona.
Objeto Batches
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
related_parties | lista | Lista das partes relacionadas envolvidas na assinatura de uma lista de documentos. | SIM |
documents | lista | lista de documentos. | SIM |
name | string | Nome do batch. | SIM |
signature_type | enum | Tipo de assinatura. | SIM |
document_type | enum | Tipo de documento. | SIM |
Enumeradores para os tipos de assinatura (signature_type)
cades: Cades
pades: Pades
Enumeradores para os tipos de documentos (document_type)
endorsement: Endosso
other: Outros
contract: Contrato
term_of_assignment: Termo de cessão
term_of_endorsement: Termo de Endosso
promissory_note: Nota promissória
rural_term_of_assignment: Termo de cessão
term_of_fomentation: Termo de Fomento
cpr: CPR
cprf: CPRF
trade_bill: Duplicata
subscription_note: Boletim de Subscrição
adhesion_term: Termo de Adesão
limited_liability_term: Termo de responsabilidade limitada
account_request_document: Contrato de abertura de conta
ccb_post_sac_cdi: CCB Pós-SAC CDI
ccb_post_sac_ipca: CCB Pós-SAC IPCA
ccb_post_sac_igpm: CCB Pós-SAC IGPM
ccb_post_price_cdi: CCB Pós-Price CDI
ccb_post_price_ipca: CCB Pós-Price IPCA
ccb_post_price_igpm: CCB Pós-Price IGPM
ccb_post_price_days_cdi: CCB Pós-Price Days CDI
ccb_post_price_days_ipca: CCB Pós-Price Days IPCA
ccb_post_price__days_igpm: CCB Pós-Price Days IGPM
ncom_pre_sac: Nota Comercial Pré-Sac
ncom_pre_price: Nota Comercial Pré Price
ncom_pre_sac_days: Nota Comercial Pré-Price Days
ncom_post_sac_cdi: Nota Comercial Pós-SAC CDI
ncom_post_sac_ipca: Nota Comercial Pós-SAC IPCA
ncom_post_sac_igpm: Nota Comercial Pós-SAC IGPM
ncom_post_price_cdi: Nota Comercial Pós-Price CDI
ncom_post_price_ipca: Nota Comercial Pós-Price IPCA
ncom_post_price_igpm: Nota Comercial Pós-Price IGPM
ncom_post_price_days_cdi: Nota Comercial Pós-Price Days CDI
ncom_post_price_days_ipca: Nota Comercial Pós-Price Days IPCA
ncom_post_price__days_igpm: Nota Comercial Pós-Price Days IGPM
ccb_cdi_perc: CCB CDI Perc
ccb_cdi_plus: CCB CDI+
ccb_pre_price: CCB Pré-Price
ccb_pre_sac: CCB (pre-sac)
cce_cdi_perc: CCE CDI Perc
cce_cdi_plus: CCE CDI+
cce_pre_price: CCE Pré-Price
cce_pre_sac: CCE Pré-Sac
cce_post_sac_cdi: CCE Pós-SAC CDI
cce_post_sac_ipca: CCE Pós-SAC IPCA
cce_post_sac_igpm: CCE Pós-SAC IGPM
cce_post_price_cdi: CCE Pós-Price CDI
cce_post_price_ipca: CCE Pós-Price IPCA
cce_post_price_igpm: CCE Pós-Price IGPM
cce_post_price_days_cdi: CCE Pós-Price Days CDI
cce_post_price_days_ipca: CCE Pós-Price Days IPCA
cce_post_price_daysigpm: CCE Pós-Price Days IGPM
cci_cdi_perc: CCI CDI Perc
cci_cdi_plus: CCI CDI+
cci_pre_price: CCI Pré-Price
cci_pre_sac: CCI Pré-Sac
cci_post_sac_cdi: CCI Pós-SAC CDI
cci_post_sac_ipca: CCI Pós-SAC IPCA
cci_post_sac_igpm: CCI Pós-SAC IGPM
cci_post_price_cdi: CCI Pós-Price CDI
cci_post_price_ipca: CCI Pós-Price IPCA
cci_post_price_igpm: CCI Pós-Price IGPM
cci_post_price_days_cdi: CCI Pós-Price Days CDI
cci_post_price_days_ipca: CCI Pós-Price Days IPCA
cci_post_price_days_igpm: CCI Pós-Price Days IGPM
nce_cdi_perc: NCE CDI Perc
nce_cdi_plus: NCE CDI+
nce_pre_price: NCE Pré-Price
nce_pre_sac: NCE Pré-Sac
nce_post_sac: NCE Pós-SAC
nce_post_price: NCE Pós-Price
nce_post_price_days: NCE Pós-Price Days
Objeto Related Parties
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
role | enum | Papel desempenhado pelos assinantes. | SIM |
name | string | Nome da parte relacionada. | SIM |
signature_position | inteiro | Posição da assinatura, deve ser informada quando houver ordem de assinatura entre as partes relacionadas. A ordem segue uma sequência crescente. | NÃO |
signer_groups | lista | Lista dos grupos de assinantes. | SIM |
Enumeradores que representam os papéis das partes relacionadas (role)
assignor: Cedente
manager: Gestor
underwriter: Subscritor
issuer: Emissor
intervening_discharger: Interveniente Quitante
investor: Cotista
debtor: Devedor
secretary: Secretário
intervening_consentor: Interveniente Anuente
guarantor: Fiador
fund_representative: Representante do Fundo
company_representative: Representante da Empresa
solidary_debtor: Devedor Solidário
attestant: Testemunha
bestowal: Outorga Uxória
owner: Titular
attorney: Procurador
associate: Sócio
co_issuer: Co-emissor
fiduciary_agent: Agente Fiduciário
guest: Convidado
spouse: Cônjuge
intervening_guarantor: Interveniente Fiador
fiduciary_debtor: Devedor Fiduciário
bonafide_depositary: Fiel Depositário
faithful_depositary: Fiel Depositário
president: Presidente
endorser: Endossante
fund_administrator: Administrador do Fundo
cosigner: Avalista
consulting: Consultor
fund_manager: Gestor do Fundo
director: Diretor
Objeto Signer Groups
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
minimum_required_signers | inteiro | Número mínimo de assinantes que devem ter assinado para que as assinaturas do grupo sejam consideradas concluídas. | SIM |
signers | lista | Lista dos assinantes que compõem o grupo de assinantes. | SIM |
Objeto Signer
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
name | string | Nome do assinante. | SIM |
document_number | string | CPF do assinante. | SIM |
email | string | Email do assinante. | SIM |
is_group_mandatory | booleano | Informe TRUE para indicar que o assinante é obrigatório assinar para que o grupo de assinantes ao qual pertence seja considerado concluído. | SIM |
signer_control_number | string | Campo livre que pode ser utilizado para fins de controle ou referência externa. | SIM |
Objeto Documents
O campo documents deve ser populado com a resposta da requisição /document.
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
name | string | Nome do documento. | SIM |
control_number | string | Campo livre que pode ser utilizado para fins de controle ou referência externa. Na integração com o Fromtis envolvendo duplicatas, o valor deste campo deve ser mantido igual ao recebido no endpoint de geração de documentos de forma assíncrona. | SIM |
file_size | float | Tamanho do documento. | SIM |
url | string | URL do documento. | SIM |
document_key | string | Chave de identificação do documento. | SIM |
Response Body Params
| Campo | Tipo | Descrição |
|---|---|---|
batch_group_key | string | Chave de identificação do evento de assinatura. |
signature_status | string | Status da assinatura. |
internal_status | string | Status geral do evento. |
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. |
signature_timestamp | date | Data da assinatura. |
webhook_key | string | Chave de identificação do webhook. |