跳到主要内容

PDF 文件上传

使用说明

此方法用于以 PDF 格式发送文件。

Request​

ENDPOINT
/document
MÉTODO
POST

Request Body Params​

以下数据需作为 form-data 发送到请求体中：

字段类型描述必填
filefile需要发送的文件的二进制内容。是
control_numberstring可用于控制或外部引用的自由字段。否
endorsement_page布尔值如果设置为 true，将在文件末尾添加背书页否
endorser_namestring背书页上的背书受让人姓名否
endorser_document_numberstring背书页上的背书受让人文件号码否
receiver_namestring背书页上的收款人姓名否
receiver_document_numberstring背书页上的收款人文件号码否
document_identifierstring背书页上的文件标识符否
document_typestring背书页上的文件类型否

Response​

STATUS
200
Response Body
[
    {
        "control_number": "1123",
        "document_key": "d559e3dc-d19c-494e-b02e-b7199e5325ea",
        "file_size": 1679,
        "name": "document.pdf",
        "url": "https://storage.googleapis.com/certifier-api-storage-sandbox/d559e3dc-d19c-494e-b02e-b7199e5325ea/teste_of_original.pdf"
    },
]

STATUS
400
Response Body
{
    "title": "Bad Request",
    "description": "Document size larger than 20 MB"
}
Response Body
{
    "title": "Bad Request",
    "description": "PDF has editable format fields"
}
Response Body
{
    "title": "Bad Request",
    "description": "PDF file can't have a password."
}

请求示例​

curl --location 'https://api.certifiqi.com.br/document' \
--header 'x-api-token: chave de api' \
--form 'file=@"/seu_arquivo.pdf"' \
--form 'endorsement_page="true"' \
--form 'endorser_name="Endorser"' \
--form 'endorser_document_number="123456789112"' \
--form 'receiver_name="Receiver"' \
--form 'receiver_document_number="123456789113"' \
--form 'document_type="Termo de Cessão"' \
--form 'document_identifier="1234"' \
--form 'control_number="999"'

添加背书页​

要在发送的 PDF 末尾添加黑色背书页，需要填写以下字段：

  • endorsement_page 设置为 True
  • endorser_name
  • endorser_document_number
  • receiver_name
  • receiver_document_number
  • document_identifier
  • document_type

填写这些字段后，背书的附加文本将按以下格式呈现：

机构 endorser_name，CNPJ 号为 endorser_document_number， 将本 document_type 编号 document_identifier 背书给 receiver_name，CNPJ 号为 receiver_document_number，依据适用法律， 特别是 2004 年 8 月 2 日第 10.931 号法律第 29 条第 1 款的规定，以将完整所有权转让给 上述指定机构。本背书以电子方式进行，双方自此同意并承认其电子签名的有效性，依据 2001 年 8 月 24 日第 2.200 号临时措施第 10 条第 2 款，或取代该措施的规范。