Upload de documentos

Utilização

Essse método deve ser utilizado para enviar os documentos (PDF ou CNAB) e vincular a um grupo de documentos.

Para upload de arquivos PDF, os dados do cedente não serão usados.

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

• file - documento no formato pdf.

Resposta desta request

O retorno desta request deverá ser enviado posteriormente na request POST /batch_group. Depois de enviado junto com o batch_group não há necessidade de salvar esta informação.

Também retornará retornará uma document_key, que é o identificador da documento na QI SCD. A document_key do retorno deve ir na criação do batch_group, é uma chave de identificação única do documento. O file_size também deve ir na criação do documento.

Request

ENDPOINT

/document

MÉTODO

POST

Request Body

{
    "control_number": "1123",
    "document_type": "Termo De Cessão",
    "file": "teste_of.pdf",
    "document_identifier": "1234566",
    "endorsement_page": true,
    "endorser_name": "Capital Cash",
    "endorser_document_number": "46488972000178",
    "receiver_name": "Fundo XYZ",
    "receiver_document_number": "61341692000126",
    "assignor_address": "Rua das Palmeiras",
    "assignor_address_number": "360",
    "assignor_address_city": "São Paulo",
    "assignor_address_state": "SP",
    "assignor_address_CEP": "13.604-036",
    "assignor_neighborhood": "Jardim São Paulo"
}

Request Body

Campo	Tipo	Descrição	Caracteres
control_number	string	Número de controle do documento (enviado pelo cliente).
document_type	enum	Tipo de documento.	Enumeradores document_type
document_identifier	string	Identificador do documento.
file (obrigatório)	string	Binário com o documento a ser enviado.
assignor_address	string	Endereço do cedente
assignor_address_number	string	Número do endereço do cedente
assignor_address_city	string	Cidade dp cedente
assignor_address_state	string	Estado do cedente
assignor_address_CEP	string	CEP do cedente
assignor_neighborhood	string	Vizinho do cedente
endorsement_page	boolean	Página de Endosso	true/false
endorser_name	string	Nome do Endossatário
endorser_document_number	string	Número do documento do endossatário
receiver_name	string	Nome do recebedor
receiver_document_number	string	Número do docuemnto do recebedor

Enumeradores document_type

Campo
trade_bill
term_of_assignment
promissory_note
contract
ccb_pre_sac
endorsement
other
account_request_document
term_of_fomentation
term_of_endorsement
rural_term_of_assignment

Endosso em Preto

Obrigatório

Por padrão o campo endorsement_page é false, caso seja necessário a adição da página de endosso em preto, é necessário o envio do endorsement_page como true. Nesse último caso, os parâmetros abaixo serão necessários na request.

Request Body

  {
        "document_identifier": "46465",
        "endorser_name": "Teste",
        "endorsement_page": true,
        "receiver_name": "Teste",
        "endorser_document_number": "12345678911",
        "receiver_document_number": "12345678911",
        "document_type": "contrato",
        "file": "arquivo.pdf"
  }

Response

STATUS

200

Response Body

[
    {
        "control_number": "1123",
        "document_key": "d559e3dc-d19c-494e-b02e-b7199e5325ea",
        "file_size": 1679,
        "name": "teste_of.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."
}