创建签名事件

此端点用于发送签名事件，包括文件及各自的签名人，这些内容被分组在一个名为 batch_group 的对象中。

定义

Request

ENDPOINT

/batch_group

MÉTODO

POST

Request Body

{
    "main_related_party": "ba",
    "webhook_url": "https://webhook.example.com/certifiqi",
    "send_to_fund_administrator": false,
    "is_asynchronous": false,
    "name": "Teste",
    "total_value": 0,
    "webhook_url_list": [
        "https://qi.example.com/arquivos/todos_os_arquivos.zip",
        "https://qi.example.com/arquivos/documento_original.pdf"
    ],
    "attached_document_number": "58020912000105",
    "send_emails": false,
    "batches": [{
        "signature_type": "cades",
        "document_type": "term_of_endorsement",
        "name": "Termo de Endosso",
        "related_parties":[
    {
            "name": "Empresa Exemplo LTDA",
            "role": "assignor",
            "signature_position":1,
            "signer_groups": [
                    {
                        "minimum_required_signers": 1,
                        "signers":[
                            {
                                "name": "João",
                                "document_number": "90203438906",
                                "email": "signatario@example.com",
                                "is_group_mandatory": true,
                                "signer_control_number": "1"
                            }
                        ]
                    }
                ]
            }
        ],
        "documents": [{
            "name": "documento_exemplo.pdf",
            "control_number": null,
            "url": "https://qi.example.com/arquivos/uuid/documento_exemplo_original.pdf",
            "document_key": "uuid",
            "file_size": 1681
        }]
    }]
}

STATUS

200

Response Body

```json
{
    "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",
    "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,
    "is_asynchronous": 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": []
}

Request Body Params

字段	类型	描述	必填
main_related_party	string	负责签署事件的主要相关方名称。	是
name	string	签名事件名称。	是
total_value	string	事件文件的总价值。	是
send_emails	布尔值	指示是否应为此事件发送签名电子邮件。如果值为 FALSE，则在流程的任何阶段都不会发送电子邮件。	是
attached_document_number	string	转让方的 CNPJ，当文件与特定转让方相关时使用。	否
batches	列表	不同类型文件及其各自相关方的列表。	是
webhook_url	string	通知 Webhook 的发送 URL。	否
webhook_url_list	列表	通知 Webhook 的发送 URL 列表。	否
is_asynchronous	布尔值	事件包含异步生成的文件。	否
send_to_fund_administrador	布尔值	签名完成后，事件应通过 SOAP 通知使用 Fromtis 软件的管理方。	否

信息

• webhook_url 或 webhook_url_list 字段仅在需要接收 Webhook 时发送。此外，每次请求只能提供其中一个选项。
• 当事件包含异步创建的文件时，is_asynchronous 字段必须设置为 True。

Batches 对象

字段	类型	描述	必填
related_parties	列表	参与一组文件签名的相关方列表。	是
documents	列表	文件列表。	是
name	string	Batch 名称。	是
signature_type	enum	签名类型。	是
document_type	enum	文件类型。	是

签名类型枚举值 (signature_type)

cades: Cades
pades: Pades

文件类型枚举值 (document_type)

endorsement: 背书
other: 其他
contract: 合同
term_of_assignment: 转让条款
term_of_endorsement: 背书条款
promissory_note: 本票
rural_term_of_assignment: 转让条款
term_of_fomentation: 促进条款
cpr: CPR
cprf: CPRF
trade_bill: 汇票
subscription_note: 认购公告
adhesion_term: 加入条款
limited_liability_term: 有限责任条款
account_request_document: 开户合同
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

Related Parties 对象

字段	类型	描述	必填
role	enum	签名人所扮演的角色。	是
name	string	相关方名称。	是
signature_position	整数	签名位置，当各相关方之间有签名顺序时需要填写。顺序按升序排列。	否
signer_groups	列表	签名人组列表。	是

相关方角色枚举值 (role)

assignor: 转让方
manager: 经理
underwriter: 承销商
issuer: 发行人
intervening_discharger: 介入清偿方
investor: 投资者
debtor: 债务人
secretary: 秘书
intervening_consentor: 介入同意方
surety: 保证人 guarantor: 担保人
fund_representative: 基金代表
company_representative: 公司代表
solidary_debtor: 连带债务人
attestant: 见证人
bestowal: 配偶赠与
owner: 所有人
attorney: 代理人
associate: 合伙人
co_issuer: 共同发行人
fiduciary_agent: 受托代理人
guest: 嘉宾
spouse: 配偶
intervening_guarantor: 介入担保人
fiduciary_debtor: 信托债务人
bonafide_depositary: 善意保管人
faithful_depositary: 忠实保管人
president: 总裁
endorser: 背书人
fund_administrator: 基金管理人
cosigner: 保证人
consulting: 顾问
fund_manager: 基金经理
director: 董事

Signer Groups 对象

字段	类型	描述	必填
minimum_required_signers	整数	组内签名被视为完成所需的最少签名人数。	是
signers	列表	构成签名人组的签名人列表。	是

Signer 对象

字段	类型	描述	必填
name	string	签名人姓名。	是
document_number	string	签名人的 CPF。	是
email	string	签名人的电子邮件。	是
is_group_mandatory	布尔值	填写 TRUE 表示该签名人必须签名才能使其所属签名人组被视为完成。	是
signer_control_number	string	可用于控制或外部引用的自由字段。	是

Documents 对象

重要

documents 字段应使用 /document 请求的响应来填充。

字段	类型	描述	必填
name	string	文件名称。	是
control_number	string	可用于控制或外部引用的自由字段。在涉及汇票的 Fromtis 集成中，此字段的值必须与异步生成文件端点中接收到的值保持一致。	是
file_size	float	文件大小。	是
url	string	文件 URL。	是
document_key	string	文件的标识键。	是

Response Body Params

字段	类型	描述
batch_group_key	string	签名事件的标识键。
signature_status	string	签名状态。
internal_status	string	事件的总体状态。
original_file_url	string	原始文件的 URL。
signed_file_url	string	带签名页的文件 URL。
file_url	string	签名文件的 URL。
signature_timestamp	date	签名日期。
webhook_key	string	Webhook 的标识键。