> ## Documentation Index > Fetch the complete documentation index at: https://docs.jusfy.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Dispara o rastreamento de um veículo (assíncrona) > Inicia a busca por capturas do veículo em câmeras de monitoramento nos últimos 12 meses. **A consulta não responde na hora**: o fornecedor processa por lote e pode levar minutos, então esta rota devolve `202` com um protocolo. Há duas formas de obter o resultado, que podem ser combinadas: informar um `url_retorno` e receber o webhook assim que terminar, ou consultar `GET /api/consultas/rastreamento-veicular/{id}`. **A consulta é cobrada neste disparo**, não na entrega — inclusive se o lote depois expirar. Não há deduplicação: dois disparos para a mesma placa são duas consultas cobráveis. Em caso de erro de rede sem resposta, prefira consultar antes de repetir. ## OpenAPI ````yaml /openapi/legado.json post /api/consultas/rastreamento-veicular openapi: 3.0.0 info: title: Calculadoras Jusfy API description: >- Rotas sem versão (`/api/...`). Continuam funcionando, mas a versão atual da API é a v1 (`/api/v1`): para integrações novas, use a v1 e siga o [guia de migração](https://api.jusfy.dev/calculators/api/reference/fundamentos/migracao-do-legado). A política de versionamento e depreciação está na [política de versionamento](https://api.jusfy.dev/calculators/api/reference/fundamentos/migracao-do-legado#pol%C3%ADtica-de-versionamento). version: legacy contact: {} servers: - url: https://api.jusfy.dev/calculators security: [] tags: - name: Calculadoras description: >- Execução das calculadoras jurídicas e consulta dos índices de correção. Cada cálculo recebe um payload, retorna o resultado processado e exige API key no header `x-api-key`. - name: Consultas description: >- Consultas de dados (veículos, condutores e documentos). Cada consulta recebe o documento, retorna os dados encontrados e exige API key no header `x-api-key`. A maioria responde na mesma requisição; o **rastreamento veicular** e o **buscador processual** são assíncronos — devolvem `202` com um protocolo e entregam o resultado por webhook e/ou pelo `GET` do protocolo. - name: JusScore description: >- Consulta de processos judiciais por CPF/CNPJ, com score de risco consolidado e a lista detalhada dos processos. É assíncrona: o POST inicia a consulta e o GET devolve o resultado quando pronto. Exige API key no header `x-api-key`. - name: Consumo description: >- Consumo da própria API key: quantas chamadas cada produto recebeu num período, separando as cobradas das não cobradas. Não exige escopo; exige API key no header `x-api-key`. - name: Health description: >- Verificações de disponibilidade do serviço (liveness e readiness). Rotas abertas, sem autenticação. paths: /api/consultas/rastreamento-veicular: post: tags: - Consultas summary: Dispara o rastreamento de um veículo (assíncrona) description: >- Inicia a busca por capturas do veículo em câmeras de monitoramento nos últimos 12 meses. **A consulta não responde na hora**: o fornecedor processa por lote e pode levar minutos, então esta rota devolve `202` com um protocolo. Há duas formas de obter o resultado, que podem ser combinadas: informar um `url_retorno` e receber o webhook assim que terminar, ou consultar `GET /api/consultas/rastreamento-veicular/{id}`. **A consulta é cobrada neste disparo**, não na entrega — inclusive se o lote depois expirar. Não há deduplicação: dois disparos para a mesma placa são duas consultas cobráveis. Em caso de erro de rede sem resposta, prefira consultar antes de repetir. operationId: AsyncQueriesController_rastreamentoVeicular[0] parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/VehicleTrackingQueryDto' responses: '202': description: >- Consulta aceita e em processamento. Guarde o `id` — e o `signingSecret`, que **não é exibido novamente**. content: application/json: schema: type: object example: statusCode: 202 message: Consulta assíncrona aceita timestamp: '2026-09-02T18:00:00.000Z' path: /api/consultas/rastreamento-veicular result: id: aqry_1f0b2c3d-4e5f-6071-8293-a4b5c6d7e8f9 consulta: rastreamento-veicular status: pending createdAt: '2026-09-02T18:00:00.000Z' expiresAt: '2026-09-02T18:10:00.000Z' statusUrl: >- /api/consultas/rastreamento-veicular/aqry_1f0b2c3d-4e5f-6071-8293-a4b5c6d7e8f9 url_retorno: https://cliente.exemplo.com/webhooks/jusfy signingSecret: whsec_kQ8yq2Vx1pN7mJ4rT6sW9zL0aB3cD5eF7gH1iK2lM4o '400': description: >- Placa ou `url_retorno` inválidos. `message` é a **lista** de erros de validação desta API, diferente dos demais erros, em que é uma string. Nada é cobrado. content: application/json: schema: example: statusCode: 400 code: invalid_request message: - 'document deve ser uma placa válida (ex.: ABC1D23)' requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65 timestamp: '2026-09-02T18:00:00.000Z' path: /api/consultas/rastreamento-veicular '401': description: >- API key ausente ou que não pertence a nenhum cliente (`code: invalid_api_key`). A `message` diz qual dos dois. content: application/json: examples: missing: summary: Key ausente value: statusCode: 401 message: Missing API key code: invalid_api_key requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65 timestamp: '2026-10-14T18:00:00.000Z' path: /api/consultas/{consulta} invalid: summary: Key inválida value: statusCode: 401 message: Invalid API key code: invalid_api_key requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65 timestamp: '2026-10-14T18:00:00.000Z' path: /api/consultas/{consulta} '403': description: >- Acesso negado. Dois motivos, distinguidos pelo `code`: o cliente não está ativo (`inactive_client`), ou a API key não tem o escopo deste produto (`insufficient_scope`, com o escopo na `message`). A liberação de produtos é feita pela equipe Jusfy. content: application/json: examples: inactive_client: summary: Cliente não ativo value: statusCode: 403 message: Client is not active code: inactive_client requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65 timestamp: '2026-10-14T18:00:00.000Z' path: /api/consultas/{consulta} insufficient_scope: summary: Sem o escopo do produto value: statusCode: 403 message: 'Missing scope: ' code: insufficient_scope requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65 timestamp: '2026-10-14T18:00:00.000Z' path: /api/consultas/{consulta} '422': description: Payload recusado pelo provedor da consulta. content: application/json: schema: example: statusCode: 422 code: payload_rejected message: Invalid query payload requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65 timestamp: '2026-09-02T18:00:00.000Z' path: /api/consultas/rastreamento-veicular '429': description: >- Consultas simultâneas demais em processamento para este cliente. Aguarde as atuais terminarem; `Retry-After` sugere quando tentar de novo (estimativa, não garantia). Nada é cobrado (`code: too_many_pending_queries`). Também sai quando o limite de requisições por minuto do cliente é excedido (`code: rate_limit_exceeded`), com `Retry-After` exato. content: application/json: schema: example: statusCode: 429 code: too_many_pending_queries message: Too many pending queries requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65 timestamp: '2026-09-02T18:00:00.000Z' path: /api/consultas/rastreamento-veicular '502': description: Erro no provedor ao criar a consulta. Ela **não** foi iniciada. content: application/json: schema: example: statusCode: 502 code: upstream_error message: Erro ao consultar o fornecedor de rastreamento de veículos. requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65 timestamp: '2026-09-02T18:00:00.000Z' path: /api/consultas/rastreamento-veicular '503': description: >- Provedor temporariamente indisponível. A consulta **não** foi iniciada — pode ser repetida. content: application/json: schema: example: statusCode: 503 code: upstream_unavailable message: >- A consulta de rastreamento de veículos está temporariamente indisponível, tente novamente mais tarde. requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65 timestamp: '2026-09-02T18:00:00.000Z' path: /api/consultas/rastreamento-veicular '504': description: Tempo limite ao iniciar a consulta no provedor. content: application/json: schema: example: statusCode: 504 code: upstream_timeout message: Query provider timed out requestId: 9f1c2b7e-4d3a-4f8b-a6e2-1c0d9e8f7a65 timestamp: '2026-09-02T18:00:00.000Z' path: /api/consultas/rastreamento-veicular security: - api-key: [] components: schemas: VehicleTrackingQueryDto: type: object properties: document: type: string description: >- Placa do veículo, no formato antigo (`ABC1234`) ou Mercosul (`ABC1D23`). Pode ser enviada com máscara — separadores são ignorados. example: ABC1D23 url_retorno: type: string description: >- URL `https` que receberá o resultado quando a consulta terminar. Opcional: sem ela, o resultado é obtido apenas pelo `GET` do protocolo. Deve apontar para um domínio público na porta 443 — endereços IP, hosts internos e `http` são recusados. A entrega é assinada; o segredo vem no campo `signingSecret` desta resposta e **não** é exibido novamente. example: https://cliente.exemplo.com/webhooks/jusfy required: - document securitySchemes: api-key: type: apiKey in: header name: x-api-key ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.