Gerenciar documentos

POST /api/company/v1/{company_role_id}/documents

O que este endpoint faz

Este endpoint centraliza uma ação operacional relacionada a documentos. Ele pertence ao domínio de envio, validação, extração e download de documentos.

Use POST /api/company/v1/{company_role_id}/documents quando a integração precisar acionar esse comportamento exatamente como o app da Antecipa Fácil faz pelo gateway público. A rota depende de company_role_id, então a chamada deve ser feita no contexto correto da empresa, título ou recurso informado.

Para que serve

Ele ajuda a compor fluxos de integração do backend do parceiro com a plataforma, mantendo autenticação via Bearer token e tráfego pelo APIM. Consulte os parâmetros, corpo de requisição e respostas desta página antes de usar em produção.

Gateway

Chame sempre https://api.antecipafacil.net.br/api/company/v1/{company_role_id}/documents. O APIM repassa a rota para o backend correto; serviços internos não devem ser chamados diretamente.

Parâmetros

company_role_id path obrigatório

Valor usado para compor a chamada deste endpoint.

Corpo da requisição

Envie o payload em JSON conforme o contrato do backend.

[
  {
    "name": "<name>",
    "size": 123,
    "document_type": "<document_type>",
    "owner_type": "company",
    "owner_id": 123,
    "format": "pdf"
  }
]

Respostas

201 Operação executada com sucesso.

Try it POST

URL Bearer token Body JSON [ { "name": "<name>", "size": 123, "document_type": "<document_type>", "owner_type": "company", "owner_id": 123, "format": "pdf" } ] Try it!

Clique em Try it! para executar a chamada pelo navegador.

Exemplos

ShellNodeDenoPythonC#Rust

curl --request POST \
  --url 'https://api.antecipafacil.net.br/api/company/v1/123/documents' \
  --header 'accept: application/json' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'content-type: application/json' \
  --data '[
  {
    "name": "<name>",
    "size": 123,
    "document_type": "<document_type>",
    "owner_type": "company",
    "owner_id": 123,
    "format": "pdf"
  }
]'

const response = await fetch('https://api.antecipafacil.net.br/api/company/v1/123/documents', {
  method: 'POST',
  headers: {
    accept: 'application/json',
    Authorization: 'Bearer <access_token>',
    'content-type': 'application/json',
  },
  body: JSON.stringify([
  {
    "name": "<name>",
    "size": 123,
    "document_type": "<document_type>",
    "owner_type": "company",
    "owner_id": 123,
    "format": "pdf"
  }
]),
});

const data = await response.json();
console.log(data);

const response = await fetch('https://api.antecipafacil.net.br/api/company/v1/123/documents', {
  method: 'POST',
  headers: {
    accept: 'application/json',
    Authorization: 'Bearer <access_token>',
    'content-type': 'application/json',
  },
  body: JSON.stringify([
  {
    "name": "<name>",
    "size": 123,
    "document_type": "<document_type>",
    "owner_type": "company",
    "owner_id": 123,
    "format": "pdf"
  }
]),
});

console.log(await response.json());

import requests

url = "https://api.antecipafacil.net.br/api/company/v1/123/documents"
headers = {
    "accept": "application/json",
    "Authorization": "Bearer <access_token>",
    "content-type": "application/json",
}
payload = [
    {
        "name": "<name>",
        "size": 123,
        "document_type": "<document_type>",
        "owner_type": "company",
        "owner_id": 123,
        "format": "pdf"
    }
]

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.antecipafacil.net.br/api/company/v1/123/documents");
request.Headers.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<access_token>");
request.Content = new StringContent("""[
  {
    "name": "<name>",
    "size": 123,
    "document_type": "<document_type>",
    "owner_type": "company",
    "owner_id": 123,
    "format": "pdf"
  }
]""", Encoding.UTF8, "application/json");

using var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

let client = reqwest::Client::new();
let response = client
    .request(reqwest::Method::POST, "https://api.antecipafacil.net.br/api/company/v1/123/documents")
    .bearer_auth("<access_token>")
    .header("accept", "application/json")
    .json(&serde_json::json!([
  {
    "name": "<name>",
    "size": 123,
    "document_type": "<document_type>",
    "owner_type": "company",
    "owner_id": 123,
    "format": "pdf"
  }
]))
    .send()
    .await?;

let body = response.text().await?;
println!("{}", body);

Copiar exemplo