Upload de documentos

Use esta rota para fazer o upload de documentos vinculados a um parceiro previamente cadastrado. O envio é feito via multipart/form-data e aceita o envio de múltiplos documentos em uma única requisição, com um limite de 40 documentos por sub_seller_id.

Atenção

O limite de 40 documentos por sub_seller_id é aplicado ao total de documentos enviados por sub_seller_id, não sendo possível enviar mais de 40 documentos em uma única requisição nem em requisições subsequentes.

PATCHv3/sub_sellers/:sub_seller_id/files

Request Variable Path

Atributo	Tipo	Descrição
sub_seller_id	string	ID do parceiro.

Atenção

É necessário salvar o sub_seller_id que a Marlim retorna nas solicitações de criação na sua aplicação. Somente com este id será possível prosseguir com o envio dos arquivos.

Request Body Params

Atenção

Esta rota não recebe um corpo no formato JSON. O Content-Type da requisição deve ser multipart/form-data.

Atributo	Tipo	Descrição
files	file	Arquivo(s) enviado(s) no corpo da requisição. Para enviar mais de um arquivo, repita o campo files na mesma requisição. Tipos aceitos: PDF, JPG, JPEG e PNG. Tamanho máximo: 1 MB por arquivo. Quantidade máxima: 40 arquivos por sub_seller_id.

Request

curl --location --request PATCH 'https://api.marlim.co/v3/sub_sellers/sub_k4m6Rw5rlQszEY7fiuRe/files' \
  --header 'api_key: api_key_value' \
  --form 'files=@"/caminho/para/informe_rendimentos.pdf"' \
  --form 'files=@"/caminho/para/comprovante_endereco.jpg"'

Dica

Ao usar o parâmetro --form do curl, o Content-Type: multipart/form-data (com o boundary) é definido automaticamente. Não defina esse cabeçalho manualmente.

Response Object

Atributo	Tipo	Descrição
sub_seller_id	string	ID do parceiro ao qual os documentos foram vinculados.
message	string	Mensagem de confirmação do envio.
total	int32	Quantidade de documentos enviados com sucesso.

Exemplo de Response

{
  "sub_seller_id": "sub_k4m6Rw5rlQszEY7fiuRe",
  "message": "Files uploaded successfully",
  "total": 2
}

Exemplos

Documentos enviados com sucesso

Request

curl --location --request PATCH 'https://api.marlim.co/v3/sub_sellers/sub_k4m6Rw5rlQszEY7fiuRe/files' \
  --header 'api_key: api_key_value' \
  --form 'files=@"/caminho/para/informe_rendimentos.pdf"' \
  --form 'files=@"/caminho/para/comprovante_endereco.jpg"' \
  --form 'files=@"/caminho/para/contrato_social.png"'

Response200

{
  "sub_seller_id": "sub_k4m6Rw5rlQszEY7fiuRe",
  "message": "Files uploaded successfully",
  "total": 2
}

Tipo de documento inválido

Request

curl --location --request PATCH 'https://api.marlim.co/v3/sub_sellers/sub_k4m6Rw5rlQszEY7fiuRe/files' \
  --header 'api_key: api_key_value' \
  --form 'files=@"/caminho/para/planilha.txt"'

Response400

{
  "errors": [
    {
      "type": "invalid_input",
      "message": "File [planilha.txt] has an invalid type. Allowed types: PDF, PNG, JPG and JPEG."
    }
  ]
}

Documento acima do tamanho máximo

Request

curl --location --request PATCH 'https://api.marlim.co/v3/sub_sellers/sub_k4m6Rw5rlQszEY7fiuRe/files' \
  --header 'api_key: api_key_value' \
  --form 'files=@"/caminho/para/contrato.pdf"'

Response400

{
  "errors": [
    {
      "type": "invalid_input",
      "message": "File [contrato.pdf] exceeds the maximum size of 1 MB."
    }
  ]
}

Mais de 40 documentos enviados

Request

curl --location --request PATCH 'https://api.marlim.co/v3/sub_sellers/sub_k4m6Rw5rlQszEY7fiuRe/files' \
  --header 'api_key: api_key_value' \
  --form 'files=@"/caminho/para/documento_1.pdf"' \
  --form 'files=@"/caminho/para/documento_2.pdf"' \
  --form 'files=@"/caminho/para/... (41 documentos no total)"'

Response400

{
  "errors": [
    {
      "type": "invalid_input",
      "message": "A maximum of 40 files can be sent per request."
    }
  ]
}