{"info":{"name":"API Convertajá 1.3.0","_postman_id":"b6a1d2e0-8f3c-4c55-9d1e-convertaja01","description":"Gerada de https://convertaja.com.br/api/openapi.json. Preencha a variável apiKey (use uma chave cj_test_ para testar sem gastar créditos). Documentação: https://convertaja.com.br/api/docs","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"auth":{"type":"bearer","bearer":[{"key":"token","value":"{{apiKey}}","type":"string"}]},"variable":[{"key":"baseUrl","value":"https://convertaja.com.br"},{"key":"apiKey","value":""}],"item":[{"name":"Conta","item":[{"name":"Conta, plano e créditos","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/me","host":["{{baseUrl}}"],"path":["v1","me"],"query":[],"variable":[]},"description":"Mostra a conta dona da chave, o plano, os créditos (franquia, pacotes, saldo) e os limites."}},{"name":"Uso por dia","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/usage","host":["{{baseUrl}}"],"path":["v1","usage"],"query":[{"key":"from","value":"","description":"Data inicial AAAA-MM-DD.","disabled":true},{"key":"to","value":"","description":"Data final AAAA-MM-DD (padrão: hoje).","disabled":true}],"variable":[]},"description":"Créditos e chamadas por dia e por endpoint. Padrão: últimos 30 dias. Máximo de 366 dias."}}]},{"name":"Ferramentas de arquivo","item":[{"name":"Listar ferramentas","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/tools","host":["{{baseUrl}}"],"path":["v1","tools"],"query":[],"variable":[]},"description":"Todas as ferramentas de arquivo com extensões aceitas, opções em JSON Schema e custo em créditos."}},{"name":"Detalhes de uma ferramenta","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/tools/:toolId","host":["{{baseUrl}}"],"path":["v1","tools",":toolId"],"query":[],"variable":[{"key":"toolId","value":"comprimir-pdf","description":"Id da ferramenta (ex.: unir-pdf)."}]},"description":"Uma ferramenta, com o JSON Schema das opções."}},{"name":"Criar tarefa","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Repetir com a mesma chave não cobra de novo."}],"url":{"raw":"{{baseUrl}}/v1/tools/:toolId","host":["{{baseUrl}}"],"path":["v1","tools",":toolId"],"query":[{"key":"wait","value":"true","description":"true (até 60 s) ou número de segundos (1–60).","disabled":false},{"key":"webhook_url","value":"","description":"URL HTTPS que recebe o aviso de conclusão.","disabled":true}],"variable":[{"key":"toolId","value":"comprimir-pdf","description":"Id da ferramenta."}]},"description":"Envia os arquivos e cria a tarefa. Responde 202 com a tarefa; use ?wait=true para esperar até 60 s pelo resultado.\n\nCusto: 1, 5 ou 10 por arquivo crédito(s).","body":{"mode":"formdata","formdata":[{"key":"files","type":"file","src":[]},{"key":"options","value":"{}","type":"text"}]}}}]},{"name":"Tarefas","item":[{"name":"Listar tarefas","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/jobs","host":["{{baseUrl}}"],"path":["v1","jobs"],"query":[{"key":"limit","value":"","description":"1 a 100 (padrão 20).","disabled":true},{"key":"starting_after","value":"","description":"Id da última tarefa da página anterior (next_cursor). cursor também é aceito.","disabled":true},{"key":"status","value":"","description":"queued, running, done ou error (vários separados por vírgula).","disabled":true},{"key":"tool","value":"","description":"Id da ferramenta (ex.: comprimir-pdf).","disabled":true},{"key":"created_after","value":"","description":"Criadas depois de (ISO 8601 ou Unix em segundos; data sem hora = 00:00 de Brasília).","disabled":true},{"key":"created_before","value":"","description":"Criadas antes de (mesmo formato).","disabled":true}],"variable":[]},"description":"Tarefas da conta, da mais recente para a mais antiga (guardadas por 90 dias; os arquivos, por 1 hora). Pagine com next_cursor em starting_after."}},{"name":"Consultar tarefa","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/jobs/:id","host":["{{baseUrl}}"],"path":["v1","jobs",":id"],"query":[],"variable":[{"key":"id","value":"","description":"Id da tarefa."}]},"description":"Situação, progresso e arquivos gerados. Só a conta que criou a tarefa consegue consultar. Depois de 1 hora a tarefa continua consultável (90 dias), com files_available: false."}},{"name":"Apagar arquivos da tarefa","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/v1/jobs/:id/delete","host":["{{baseUrl}}"],"path":["v1","jobs",":id","delete"],"query":[],"variable":[{"key":"id","value":"","description":"Id da tarefa."}]},"description":"Apaga os arquivos gerados antes de 1 hora (LGPD, dados sensíveis). A tarefa continua listada, com files_available: false. Também aceito como DELETE /v1/jobs/{id}. Tarefa em andamento: 409 job_running (não há cancelamento no meio)."}},{"name":"Baixar um arquivo","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/jobs/:id/files/:index","host":["{{baseUrl}}"],"path":["v1","jobs",":id","files",":index"],"query":[],"variable":[{"key":"id","value":"","description":"Id da tarefa."},{"key":"index","value":"","description":"Posição do arquivo (0, 1, …)."}]},"description":"Baixa o arquivo gerado na posição index."}},{"name":"Baixar tudo","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/jobs/:id/download","host":["{{baseUrl}}"],"path":["v1","jobs",":id","download"],"query":[],"variable":[{"key":"id","value":"","description":"Id da tarefa."}]},"description":"Baixa o arquivo gerado ou, se houver vários, um ZIP com todos."}}]},{"name":"Dados","item":[{"name":"Consultar CNPJ","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/cnpj/:cnpj","host":["{{baseUrl}}"],"path":["v1","cnpj",":cnpj"],"query":[],"variable":[{"key":"cnpj","value":"","description":"CNPJ com ou sem pontuação (numérico ou alfanumérico)."}]},"description":"Razão social, situação, endereço, CNAEs e Simples Nacional, da base pública da Receita Federal. Aceita o CNPJ alfanumérico. Sem quadro de sócios (LGPD). Grátis: vale só o limite de requisições por minuto."}},{"name":"Consultar CEP","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/cep/:cep","host":["{{baseUrl}}"],"path":["v1","cep",":cep"],"query":[],"variable":[{"key":"cep","value":"","description":"CEP com 8 números."}]},"description":"Logradouro, bairro, cidade e UF. Fonte: BrasilAPI, com ViaCEP de reserva. Grátis: vale só o limite de requisições por minuto."}},{"name":"Validar documentos","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Repetir com a mesma chave não cobra de novo."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/validate","host":["{{baseUrl}}"],"path":["v1","validate"],"query":[],"variable":[]},"description":"Confere os dígitos verificadores de CPF, CNPJ (inclusive alfanumérico), CNH, PIS/PASEP, título de eleitor, RENAVAM e CNS. Sem tipo, deduz pelo tamanho.\n\nCusto: 1 (lote: 1 a cada 50) crédito(s).","body":{"mode":"raw","raw":"{\n  \"type\": \"cnpj\",\n  \"value\": \"12.ABC.345/01DE-35\"\n}","options":{"raw":{"language":"json"}}}}},{"name":"Ler boleto","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Repetir com a mesma chave não cobra de novo."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/boleto/parse","host":["{{baseUrl}}"],"path":["v1","boleto","parse"],"query":[],"variable":[]},"description":"Linha digitável (47 bancário, 48 arrecadação) ou código de barras (44) → confere os DVs, converte e mostra banco, valor e vencimento (com o novo fator de vencimento de 22/02/2025).\n\nCusto: 1 crédito(s).","body":{"mode":"raw","raw":"{\n  \"code\": \"23793.38128 86000.782713 36950.000632 1 10000000012345\"\n}","options":{"raw":{"language":"json"}}}}},{"name":"Pix copia e cola (BR Code)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Repetir com a mesma chave não cobra de novo."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/pix/brcode","host":["{{baseUrl}}"],"path":["v1","pix","brcode"],"query":[],"variable":[]},"description":"Gera o BR Code estático (padrão do Banco Central) e, conforme format, o QR Code em SVG, PNG ou uma folha em PDF. format: json (só o copia e cola), svg, png, both (padrão: SVG e PNG) ou pdf (folha 10×15 cm com QR, nome, cidade, valor e copia e cola, em pdf_base64).\n\nCusto: 1 crédito(s).","body":{"mode":"raw","raw":"{\n  \"key\": \"123e4567-e12b-12d1-a456-426655440000\",\n  \"name\": \"Fulano de Tal\",\n  \"city\": \"BRASILIA\",\n  \"amount\": 10.5,\n  \"format\": \"png\"\n}","options":{"raw":{"language":"json"}}}}},{"name":"Gerar QR Code","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Repetir com a mesma chave não cobra de novo."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/qrcode","host":["{{baseUrl}}"],"path":["v1","qrcode"],"query":[],"variable":[]},"description":"QR Code de qualquer texto ou link, em SVG e/ou PNG.\n\nCusto: 1 crédito(s).","body":{"mode":"raw","raw":"{\n  \"text\": \"https://convertaja.com.br\",\n  \"format\": \"svg\"\n}","options":{"raw":{"language":"json"}}}}},{"name":"Gerar código de barras","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Repetir com a mesma chave não cobra de novo."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/barcode","host":["{{baseUrl}}"],"path":["v1","barcode"],"query":[],"variable":[]},"description":"Code 128, EAN-13, EAN-8, UPC-A, Code 39, ITF (boleto), ITF-14, DataMatrix e QR, em SVG e/ou PNG. EAN/UPC sem o último dígito recebem o DV calculado.\n\nCusto: 1 crédito(s).","body":{"mode":"raw","raw":"{\n  \"type\": \"ean13\",\n  \"value\": \"789123456789\",\n  \"format\": \"png\"\n}","options":{"raw":{"language":"json"}}}}}]},{"name":"Webhooks","item":[{"name":"Testar webhook","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/webhooks/test","host":["{{baseUrl}}"],"path":["v1","webhooks","test"],"query":[],"variable":[]},"description":"Envia um evento webhook.test assinado (mesmo formato e cabeçalhos dos eventos reais) para a URL e devolve o que o receptor respondeu. Uma tentativa, sem novas tentativas. Use para conferir a verificação da assinatura antes de ir para produção.","body":{"mode":"raw","raw":"{\n  \"url\": \"https://seusite.com.br/webhooks/convertaja\"\n}","options":{"raw":{"language":"json"}}}}}]},{"name":"Assinatura eletrônica","item":[{"name":"Criar envelope","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Repetir com a mesma chave não cobra de novo."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/v1/esign/envelopes","host":["{{baseUrl}}"],"path":["v1","esign","envelopes"],"query":[],"variable":[]},"description":"Sobe o PDF, define signatários e campos e (por padrão) envia os convites por e-mail. Envie multipart/form-data com \"file\" (PDF até 20 MB e 100 páginas) e \"data\" (JSON com os campos abaixo), ou JSON com \"file\": { \"base64\": \"…\", \"name\": \"…\" } ou { \"url\": \"https://…\" } mais os mesmos campos. Responde 201 com o envelope. Além dos créditos, vale a cota mensal de documentos do plano do site (Grátis 3, Pro 30, Empresas 200); acima dela, 402 esign_quota.\n\nCusto: 20 quando enviado (rascunho: 0) crédito(s).","body":{"mode":"raw","raw":"{\n  \"file\": {\n    \"url\": \"https://seusite.com.br/contratos/123.pdf\"\n  },\n  \"name\": \"Contrato de prestação de serviços\",\n  \"message\": \"Olá! Segue o contrato para assinatura.\",\n  \"signers\": [\n    {\n      \"name\": \"Ana Souza\",\n      \"email\": \"ana@cliente.com.br\",\n      \"role\": \"sign\"\n    },\n    {\n      \"name\": \"Bruno Lima\",\n      \"email\": \"bruno@empresa.com.br\",\n      \"role\": \"witness\"\n    }\n  ],\n  \"fields\": [\n    {\n      \"signer\": 0,\n      \"type\": \"signature\",\n      \"page\": 0,\n      \"x\": 0.1,\n      \"y\": 0.75,\n      \"w\": 0.3,\n      \"h\": 0.07\n    },\n    {\n      \"signer\": 1,\n      \"type\": \"signature\",\n      \"page\": 0,\n      \"x\": 0.55,\n      \"y\": 0.75,\n      \"w\": 0.3,\n      \"h\": 0.07\n    }\n  ],\n  \"webhook_url\": \"https://seusite.com.br/webhooks/convertaja\"\n}","options":{"raw":{"language":"json"}}}}},{"name":"Listar envelopes","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/esign/envelopes","host":["{{baseUrl}}"],"path":["v1","esign","envelopes"],"query":[{"key":"limit","value":"","description":"1 a 100 (padrão 20).","disabled":true},{"key":"cursor","value":"","description":"next_cursor da página anterior.","disabled":true},{"key":"offset","value":"","description":"Alternativa ao cursor: pula N envelopes.","disabled":true},{"key":"status","value":"","description":"draft, pending, completed, refused, expired ou canceled.","disabled":true}],"variable":[]},"description":"Envelopes da conta (criados pela API ou pelo site), do mais recente para o mais antigo. Pagine com next_cursor (ou offset)."}},{"name":"Consultar envelope","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/esign/envelopes/:id","host":["{{baseUrl}}"],"path":["v1","esign","envelopes",":id"],"query":[{"key":"events","value":"","description":"true para incluir os eventos (IP, porta, dispositivo, horário).","disabled":true},{"key":"links","value":"","description":"true para incluir signers[].sign_url (links pessoais de assinatura; só depois do envio).","disabled":true}],"variable":[{"key":"id","value":"","description":"Id do envelope (XXXX-XXXX-XXXX-XXXX)."}]},"description":"Situação do envelope e de cada signatário (convidado, abriu, confirmou o código, assinou ou recusou, com horários). Com ?events=true, inclui a trilha de auditoria."}},{"name":"Enviar rascunho","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Repetir com a mesma chave não cobra de novo."}],"url":{"raw":"{{baseUrl}}/v1/esign/envelopes/:id/send","host":["{{baseUrl}}"],"path":["v1","esign","envelopes",":id","send"],"query":[{"key":"return_links","value":"","description":"true para devolver os links de assinatura (também aceito no corpo JSON).","disabled":true}],"variable":[{"key":"id","value":"","description":"Id do envelope (XXXX-XXXX-XXXX-XXXX)."}]},"description":"Envia um envelope criado com send: false. Cobra 20 créditos (estornados se o envio falhar) e conta na cota mensal do plano. Devolve signers[].sign_url se o rascunho foi criado com return_links: true ou se você mandar {\"return_links\": true} (ou ?return_links=true).\n\nCusto: 20 crédito(s)."}},{"name":"Lembrar quem falta","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/v1/esign/envelopes/:id/remind","host":["{{baseUrl}}"],"path":["v1","esign","envelopes",":id","remind"],"query":[],"variable":[{"key":"id","value":"","description":"Id do envelope (XXXX-XXXX-XXXX-XXXX)."}]},"description":"Reenvia o convite para quem está com a vez e ainda não assinou. No máximo um lembrete a cada 30 minutos por pessoa (429 reminder_too_soon)."}},{"name":"Cancelar envelope","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/v1/esign/envelopes/:id/cancel","host":["{{baseUrl}}"],"path":["v1","esign","envelopes",":id","cancel"],"query":[],"variable":[{"key":"id","value":"","description":"Id do envelope (XXXX-XXXX-XXXX-XXXX)."}]},"description":"Cancela um rascunho ou um envelope aguardando assinaturas e avisa quem estava com a vez. Os créditos do envio não são devolvidos."}},{"name":"Excluir envelope","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/v1/esign/envelopes/:id/delete","host":["{{baseUrl}}"],"path":["v1","esign","envelopes",":id","delete"],"query":[],"variable":[{"key":"id","value":"","description":"Id do envelope (XXXX-XXXX-XXXX-XXXX)."}]},"description":"Apaga o envelope, os arquivos e a trilha de auditoria, em qualquer situação. Também aceito como DELETE /v1/esign/envelopes/{id}."}},{"name":"Baixar PDF assinado","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/esign/envelopes/:id/files/final","host":["{{baseUrl}}"],"path":["v1","esign","envelopes",":id","files","final"],"query":[],"variable":[{"key":"id","value":"","description":"Id do envelope (XXXX-XXXX-XXXX-XXXX)."}]},"description":"PDF final com as assinaturas aplicadas e o relatório de assinaturas anexado (application/pdf). Só depois que todos assinam (409 envelope_not_completed antes disso). Fica guardado 90 dias."}},{"name":"Baixar relatório de assinaturas","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/esign/envelopes/:id/files/audit","host":["{{baseUrl}}"],"path":["v1","esign","envelopes",":id","files","audit"],"query":[],"variable":[{"key":"id","value":"","description":"Id do envelope (XXXX-XXXX-XXXX-XXXX)."}]},"description":"Só o relatório de assinaturas (evidências: IP/porta, dispositivo, horários, hash SHA-256 e QR Code de verificação), em PDF."}}]},{"name":"Central de Expedição","item":[{"name":"Criar lote de expedição","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Repetir com a mesma chave não cobra de novo."}],"url":{"raw":"{{baseUrl}}/v1/expedicao/lotes","host":["{{baseUrl}}"],"path":["v1","expedicao","lotes"],"query":[{"key":"wait","value":"true","description":"true (até 60 s) ou número de segundos (1–60).","disabled":false}],"variable":[]},"description":"Recebe os PDFs das etiquetas de envio (Mercado Livre, Shopee, Amazon, Correios, Magalu…) em \"labels\" e, opcionalmente, os XMLs (ou um ZIP) das NF-e em \"xmls\". Recorta as etiquetas em 10×15, associa cada etiqueta à nota (pelo número da NF, rastreio ou destinatário) e gera os PDFs prontos para a térmica, intercalando etiqueta e DANFE simplificado quando intercalar=true (padrão quando há XMLs). Custa 2 créditos por pedido novo no mês: o mesmo rastreio processado de novo no mesmo mês não é cobrado. Sem saldo para o lote inteiro, nada é processado (402). Use ?wait=true para esperar até 60 s.\n\nCusto: 2 por pedido novo no mês crédito(s).","body":{"mode":"formdata","formdata":[{"key":"labels","type":"file","src":[]},{"key":"xmls","type":"file","src":[]},{"key":"intercalar","value":"","type":"text","description":"Intercalar etiqueta e DANFE simplificado."}]}}},{"name":"Consultar lote","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/expedicao/lotes/:id","host":["{{baseUrl}}"],"path":["v1","expedicao","lotes",":id"],"query":[],"variable":[{"key":"id","value":"","description":"Id do lote."}]},"description":"Situação, resumo (pedidos por marketplace e transportadora, etiquetas sem nota) e os PDFs gerados. Histórico por 30 dias; arquivos por 7 dias."}},{"name":"Baixar um PDF do lote","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/expedicao/lotes/:id/files/:name","host":["{{baseUrl}}"],"path":["v1","expedicao","lotes",":id","files",":name"],"query":[],"variable":[{"key":"id","value":"","description":"Id do lote."},{"key":"name","value":"","description":"Nome do arquivo."}]},"description":"Baixa um dos PDFs do lote (nome em outputs[].name)."}},{"name":"Baixar o lote (ZIP)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/expedicao/lotes/:id/download","host":["{{baseUrl}}"],"path":["v1","expedicao","lotes",":id","download"],"query":[],"variable":[{"key":"id","value":"","description":"Id do lote."}]},"description":"ZIP com todos os PDFs do lote. 409 lote_not_ready antes de terminar."}}]}],"_openapi_version":"1.3.0"}