Upload de Documentos em PDF

Utilização

Esse método deve ser utilizado para enviar os documentos no formato PDF.

Request

ENDPOINT

/document

MÉTODO

POST

Request Body Params

Deverão ser enviados os seguintes dados, como form-data, no body da request:

Campo	Tipo	Descrição	Obrigatório
file	file	Binário com o documento a ser enviado.	SIM
control_number	string	Campo livre que pode ser utilizado para fins de controle ou referência externa.	NÃO
endorsement_page	booleano	Caso seja passado como true será adicionado uma Página de Endosso	NÃO
endorser_name	string	Nome do Endossatário na página de endosso	NÃO
endorser_document_number	string	Número do documento do endossatário na página de endosso	NÃO
receiver_name	string	Nome do recebedor na página de endosso	NÃO
receiver_document_number	string	Número do documento do recebedor na página de endosso	NÃO
document_identifier	string	Identificador do documento na página de endosso	NÃO
document_type	string	Tipo do documento na página de endosso	NÃO

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."
}

Request de Exemplo

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"'

Adição da Página de Endosso

Para adicionar uma página de endosso em preto ao final do PDF enviado, os seguintes campos devem ser informados:

• endorsement_page como True
• endorser_name
• endorser_document_number
• receiver_name
• receiver_document_number
• document_identifier
• document_type

Tendo esses campos enviados, o texto adicionado do endosso seguirá o seguinte formato:

A instituição endorser_name, inscrita no CNPJ sob o nº endorser_document_number, endossa este(a) document_type de nº document_identifier para o(a) receiver_name, inscrito no CNPJ sob o nº receiver_document_number, nos termos da legislação aplicável, em especial do parágrafo 1º do artigo 29 da Lei nº 10.931, de 02 de agosto de 2004, com o objetivo de transferir a propriedade plena para a instituição ora indicada. O presente endosso é realizado em formato eletrônico, sendo que as partes, desde já, concordam e reconhecem a validade de sua assinatura eletrônica, nos termos do parágrafo 2º do artigo 10, da Medida Provisória nº 2.200, de 24 de agosto de 2001, ou norma que venha a substituí-la.