Documentos

Envie todos os dados do transporte. A resposta é entregue depois de gerar e armazenar o PDF cifrado.

Uma referência não nula é única por organização e ambiente. Repetir a referência com os mesmos dados normalizados e metadata devolve o resultado original no prazo de 24 horas (200), sem emitir outro PDF. Uma nova criação devolve 201. Dados diferentes ou uma referência de outra credencial produzem 409 sem divulgar documentos. Sem referência não se garante a deduplicação.

Uma referência cujo resultado expirou devolve 409 DOCUMENT_WINDOW_EXPIRED. Se o documento estiver eliminado, o conteúdo não é devolvido e a referência não é reutilizada; a nova tentativa devolve 404. Para retificar, utilize os endpoints PUT.

Podes pedir um token sk_demo_ sem uma conta nem o registo de uma organização. Dura 24 horas a partir da emissão e funciona apenas a partir do IP público que o pediu. Mudar de rede ou de IP exige outro token. A demo acrescenta demo: true, expires_at, qr_url (alias de url) e pdf_url (alias de pdf_download_url). document_locale é o idioma escolhido ao solicitar o token (es por predefinição). Os dados e PDF temporários estão separados do arquivo real e não são encriptados como os documentos reais.

Identifique o documento anterior pelo UUID e envie todos os dados corrigidos, sem alterações parciais. Só pode ser retificada a última versão da mesma credencial. É permitido retificar um documento com mais de 24 horas sem devolver o conteúdo anterior. Um documento eliminado devolve 404 e não pode ser retificado.

É gerado um documento retificativo com novos UUID, PDF e QR; o original e o seu QR são conservados. Entregue o novo PDF ao condutor. O campo reference do corpo corresponde à nova versão, não ao documento da URL.

Repetir o mesmo PUT com os mesmos dados normalizados e metadata devolve a retificação já emitida durante as 24 horas seguintes à sua criação, sem gerar outra versão. Esta verificação ocorre antes de rejeitar um documento já retificado e também funciona se a nova tentativa identificar o mesmo documento por referência. Alterar dados de um documento já retificado devolve 409. Um resultado de nova tentativa expirado devolve 409 DOCUMENT_WINDOW_EXPIRED. Se a retificação devolvida estiver eliminada, a nova tentativa devolve 404. Para outra retificação, utilize o UUID ou a referência da última versão.

Eliminação lógica para corrigir erros detetados ao gerar um documento, exclusivamente antes de o entregar ao transportador ou ao condutor e antes de o utilizar num transporte. A integração deve confirmar ambas as condições; estar dentro do prazo não basta. Se o documento já foi entregue ou utilizado, deve ser retificado através de PUT.

Só é permitida enquanto a hora do servidor for anterior a created_at + 2 horas; às 2 horas exatas já não é permitida. Nem uma consulta nem uma nova tentativa reiniciam o prazo. Cada versão usa a sua própria data de criação. Só pode ser eliminada a última versão da credencial autenticada.

O PDF, os dados e a rastreabilidade são conservados, mas o documento deixa de aparecer na lista. As consultas por UUID ou referência, a descarga autenticada, o QR e as novas tentativas que devolveriam o conteúdo respondem 404. A consulta de estado responde apenas com status: deleted durante a janela de consulta de 24 horas. A referência continua reservada. Não existe endpoint de reativação; a eliminação conserva o ficheiro para permitir uma recuperação futura.

Repetir DELETE nas mesmas 2 horas devolve 204 sem alterar a data de eliminação. Após esse prazo devolve 409.

O primeiro acesso correto à ligação QR também bloqueia a eliminação com 409 DOCUMENT_ALREADY_ACCESSED. Este acesso não prova, por si só, que o transporte se realizou.

Devolve resumos, sem PDF, segredo QR nem metadata. O servidor aplica sempre a janela de 24 horas e o isolamento da credencial. Ordenação decrescente por data de criação e UUID para desempate, paginação por página e filtros inclusivos de data de transporte. A janela é avaliada em cada pedido; não constitui uma imagem estável entre páginas. Não permite consultar o histórico.

Os documentos eliminados não aparecem na lista.

Recupera o resultado original no prazo de 24 horas, apenas para a credencial que emitiu o documento. Inclui todos os campos aceites e normalizados e a metadata sem alteração semântica.

Um UUID ou uma referência inexistente, de outra credencial ou fora da janela devolve a mesma resposta 404, sem confirmar a existência nem o proprietário. Cada referência identifica a sua própria versão e não redireciona para uma retificação posterior.

Um documento eliminado devolve 404. Para saber se está eliminado, utilize a consulta de estado.

Devolve apenas o estado de um documento da credencial autenticada, durante as 24 horas seguintes à criação. Um documento eliminado responde 200 com {"status":"deleted"}; não devolve dados do transporte, PDF, ligação QR nem metadata. Um documento ativo responde com {"status":"active"}.

Um UUID inexistente, de outra credencial ou fora das 24 horas devolve o mesmo 404. A eliminação não alarga esta janela.

Devolve exatamente os bytes do PDF armazenado, sem o regenerar. Exige a credencial proprietária e uma antiguidade inferior a 24 horas. Esta limitação não altera a conservação legal nem a validade do QR.

Um documento eliminado devolve 404 sem entregar o PDF.