Consultar ou Baixar Arquivo

Consulta os metadados ou faz download de um arquivo específico. Sem metadata=true, arquivos legados respondem com redirect e os novos documentos privados são transmitidos pela própria API. Use signed=true para baixar a assinatura destacada P7S quando disponível; PDF com PAdES já contém a assinatura. Requer arquivos:read.

Autenticação:

🔑 API Key

Parâmetros de Consulta

signedboolean

Se true, baixa versão assinada (.p7s)

metadataboolean

Se true, retorna metadados em JSON sem expor as URLs do Storage e não realiza redirect.

Respostas

{
  "ok": true,
  "data": {
    "arquivo_id": "550e8400-e29b-41d4-a716-446655440000",
    "empresa_id": 1,
    "colaborador_id": null,
    "periodo": "01/02/2026 - 28/02/2026",
    "tipo_arquivo": "AFD",
    "nome_arquivo": "AFD_20260204120000.txt",
    "gerado_em": "2026-02-04T12:00:00Z",
    "created_at": "2026-02-04T12:00:00Z",
    "nome_empresa": "Empresa Matriz",
    "possui_assinatura": true,
    "assinatura_formato": "CADES_DETACHED",
    "assinatura_status": "signed",
    "mime_type": "text/plain",
    "size_bytes": 12540,
    "registro_uuid": "550e8400-e29b-41d4-a716-446655440001",
    "geracao_id": "550e8400-e29b-41d4-a716-446655440002"
  }
}

Sandbox Mode

curl --request GET \
  'https://rep-gestor.youuponto.com/api/v1/arquivos/{id}?signed=true&metadata=true' \
  --header 'x-api-key: yk_sua_api_key'

Exemplos de Resposta

{
  "ok": true,
  "data": {
    "arquivo_id": "550e8400-e29b-41d4-a716-446655440000",
    "empresa_id": 1,
    "colaborador_id": null,
    "periodo": "01/02/2026 - 28/02/2026",
    "tipo_arquivo": "AFD",
    "nome_arquivo": "AFD_20260204120000.txt",
    "gerado_em": "2026-02-04T12:00:00Z",
    "created_at": "2026-02-04T12:00:00Z",
    "nome_empresa": "Empresa Matriz",
    "possui_assinatura": true,
    "assinatura_formato": "CADES_DETACHED",
    "assinatura_status": "signed",
    "mime_type": "text/plain",
    "size_bytes": 12540,
    "registro_uuid": "550e8400-e29b-41d4-a716-446655440001",
    "geracao_id": "550e8400-e29b-41d4-a716-446655440002"
  }
}