Create Signing Event
This endpoint should be used to submit the signing event, which includes the documents and their respective signers, grouped within an object called 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
| Field | Type | Description | Required |
|---|---|---|---|
main_related_party | string | Name of the main party responsible for signing the event. | YES |
name | string | Name of the signing event. | YES |
total_value | string | Total value of the documents in the event. | YES |
send_emails | boolean | Indicates whether signature emails should be sent for this event. If FALSE, no emails will be sent at any stage of the process. | YES |
attached_document_number | string | Assignor’s CNPJ, used when the document is related to a specific assignor. | NO |
batches | list | List of different document types and their respective related parties. | YES |
webhook_url | string | URL to which the notification webhook will be sent. | NO |
webhook_url_list | list | List of URLs to which the notification webhooks will be sent. | NO |
is_asynchronous | boolean | Indicates if the event includes a document generated asynchronously. | NO |
send_to_fund_administrador | boolean | After signing, the event should notify via SOAP an administrator using the Fromtis software. | NO |
- The fields webhook_url or webhook_url_list should be sent only if there is interest in receiving webhooks. Also, only one of these options should be provided per request.
- The field is_asynchronous must be set to True when the event contains a document created asynchronously.
Objeto Batches
| Field | Type | Description | Required |
|---|---|---|---|
related_parties | list | List of related parties involved in signing a list of documents. | YES |
documents | list | List of documents. | YES |
name | string | Name of the batch. | YES |
signature_type | enum | Type of signature. | YES |
document_type | enum | Type of document. | YES |
Enumerators for signature types (signature_type)
cades: Cades
pades: Pades
Enumerators for document types (document_type)
endorsement: Endorsement
other: Other
contract: Contract
term_of_assignment: Term of ssignment
term_of_endorsement: Term of endorsement
promissory_note: Promissory note
rural_term_of_assignment: Rural term of assignment
term_of_fomentation: Term of fomentation
cpr: CPR
cprf: CPRF
trade_bill: Trade bill
subscription_note: Subscription note
adhesion_term: Adhesion term
limited_liability_term: Limited liability term
account_request_document: Account request document
ccb_post_sac_cdi: CCB POST-SAC CDI
ccb_post_sac_ipca: CCB Post-SAC IPCA
ccb_post_sac_igpm: CCB Post-SAC IGPM
ccb_post_price_cdi: CCB Post-Price CDI
ccb_post_price_ipca: CCB Post-Price IPCA
ccb_post_price_igpm: CCB Post-Price IGPM
ccb_post_price_days_cdi: CCB Post-Price Days CDI
ccb_post_price_days_ipca: CCB Post-Price Days IPCA
ccb_post_price__days_igpm: CCB Post-Price Days IGPM
ncom_pre_sac: Nota Comercial Pre-Sac
ncom_pre_price: Nota Comercial Pre Price
ncom_pre_sac_days: Nota Comercial Pre-Price Days
ncom_post_sac_cdi: Nota Comercial Post-SAC CDI
ncom_post_sac_ipca: Nota Comercial Post-SAC IPCA
ncom_post_sac_igpm: Nota Comercial Post-SAC IGPM
ncom_post_price_cdi: Nota Comercial Post-Price CDI
ncom_post_price_ipca: Nota Comercial Post-Price IPCA
ncom_post_price_igpm: Nota Comercial Post-Price IGPM
ncom_post_price_days_cdi: Nota Comercial Post-Price Days CDI
ncom_post_price_days_ipca: Nota Comercial Post-Price Days IPCA
ncom_post_price__days_igpm: Nota Comercial Post-Price Days IGPM
ccb_cdi_perc: CCB CDI Perc
ccb_cdi_plus: CCB CDI+
ccb_pre_price: CCB Pre-Price
ccb_pre_sac: CCB (pre-sac)
cce_cdi_perc: CCE CDI Perc
cce_cdi_plus: CCE CDI+
cce_pre_price: CCE Pre-Price
cce_pre_sac: CCE Pre-Sac
cce_post_sac_cdi: CCE Post-SAC CDI
cce_post_sac_ipca: CCE Post-SAC IPCA
cce_post_sac_igpm: CCE Post-SAC IGPM
cce_post_price_cdi: CCE Post-Price CDI
cce_post_price_ipca: CCE Post-Price IPCA
cce_post_price_igpm: CCE Post-Price IGPM
cce_post_price_days_cdi: CCE Post-Price Days CDI
cce_post_price_days_ipca: CCE Post-Price Days IPCA
cce_post_price_daysigpm: CCE Post-Price Days IGPM
cci_cdi_perc: CCI CDI Perc
cci_cdi_plus: CCI CDI+
cci_pre_price: CCI Pre-Price
cci_pre_sac: CCI Pre-Sac
cci_post_sac_cdi: CCI Post-SAC CDI
cci_post_sac_ipca: CCI Post-SAC IPCA
cci_post_sac_igpm: CCI Post-SAC IGPM
cci_post_price_cdi: CCI Post-Price CDI
cci_post_price_ipca: CCI Post-Price IPCA
cci_post_price_igpm: CCI Post-Price IGPM
cci_post_price_days_cdi: CCI Post-Price Days CDI
cci_post_price_days_ipca: CCI Post-Price Days IPCA
cci_post_price_days_igpm: CCI Post-Price Days IGPM
nce_cdi_perc: NCE CDI Perc
nce_cdi_plus: NCE CDI+
nce_pre_price: NCE Pre-Price
nce_pre_sac: NCE Pre-Sac
nce_post_sac: NCE Post-SAC
nce_post_price: NCE Post-Price
nce_post_price_days: NCE Post-Price Days
Objeto Related Parties
Related Parties Object
| Field | Type | Description | Required |
|---|---|---|---|
role | enum | Role played by the signers. | YES |
name | string | Name of the related party. | YES |
signature_position | integer | Signature position; must be provided when there is a signing order among related parties. The order follows an ascending sequence. | NO |
signer_groups | list | List of signer groups. | YES |
### Enumerators for Related Party Roles (role)
assignor: Assignor
manager: Manager
underwriter: Underwriter
issuer: Issuer
intervening_discharger: Intervening discharger
investor: Investor
debtor: Debtor
secretary: Secretary
intervening_consentor: Intervening consentor
guarantor: Fiador
fund_representative: Fund representative
company_representative: Company representative
solidary_debtor: Solidary debtor
attestant: Attestant
bestowal: Bestowal
owner: Owner
attorney: Attorney
associate: Associate
co_issuer: Co_issuer
fiduciary_agent: Fiduciary agent
guest: Guest
spouse: Spouse
intervening_guarantor: Intervening guarantor
fiduciary_debtor: Fiduciary debtor
bonafide_depositary: Bonafide depositary
faithful_depositary: Faithful depositary
president: President
endorser: Endorser
fund_administrator: Fund administrator
cosigner: Cosigner
consulting: Consulting
fund_manager: Fund Manager
director: Director
Signer Groups Object
| Field | Type | Description | Required |
|---|---|---|---|
minimum_required_signers | integer | Minimum number of signers required to consider the group's signatures complete. | YES |
signers | list | List of signers that make up the signer group. | YES |
Signer Object
| Field | Type | Description | Required |
|---|---|---|---|
name | string | Signer's full name. | YES |
document_number | string | Signer's CPF. | YES |
email | string | Signer's email address. | YES |
is_group_mandatory | boolean | Set to TRUE to indicate that the signer is required for the group to be considered complete. | YES |
signer_control_number | string | Optional free-text field that can be used for control or external reference purposes. | YES |
Documents Object
The documents field must be populated using the response from the /document request.
| Field | Type | Description | Required |
|---|---|---|---|
name | string | Document name. | YES |
control_number | string | Free text field that can be used for control or external reference purposes. In the integration with Fromtis involving duplicates, this value must match the one received in the asynchronous document creation endpoint. | YES |
file_size | float | Document size. | YES |
url | string | URL of the document. | YES |
document_key | string | Unique key identifying the document. | YES |
Response Body Params
| Field | Type | Description |
|---|---|---|
batch_group_key | string | Unique key identifying the signing event. |
signature_status | string | Signature status. |
internal_status | string | General status of the event. |
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. |
signature_timestamp | date | Date of the signature. |
webhook_key | string | Unique key identifying the webhook. |