Pular para o conteúdo principal

API — Processos CAR

Para quem é esta página

Engenheiros back-end e front-end. Para o modelo de domínio, veja Agregados.

Endpoints

MétodoPathDescriçãoAuth
GET/api/v1/processosListar processos (paginado)JWT
POST/api/v1/processosCriar processoJWT (prata+)
GET/api/v1/processos/{id}Buscar processo por IDJWT
PATCH/api/v1/processos/{id}Atualizar rascunhoJWT
POST/api/v1/processos/{id}/submeterSubmeter para análiseJWT (prata+)
POST/api/v1/processos/{id}/cancelarCancelar processoJWT
GET/api/v1/processos/{id}/historicoLinha do tempoJWT
GET/api/v1/processos/{id}/pendenciasListar pendênciasJWT
POST/api/v1/processos/{id}/pendencias/{pid}/responderResponder pendênciaJWT

Ciclo de Status

rascunho → em_preenchimento → submetido → em_analise
↓ ↓
pendente aprovado

em_correcao → em_analise

rejeitado → recurso

Submeter Processo — Pré-condições

Para que POST /api/v1/processos/{id}/submeter funcione:

  • Processo deve estar em rascunho ou em_preenchimento
  • Deve haver ao menos um documento matricula_imovel com status valido
  • Deve haver ao menos um documento ccir com status valido
  • Geometria do imóvel deve estar definida
Idempotência na submissão

Use o header Idempotency-Key para evitar submissões duplicadas em caso de timeout de rede.

Filtros na Listagem

GET /api/v1/processos?status=submetido,em_analise&municipio_ibge=2111300&page_size=20

Produtores só veem seus próprios processos. Analistas e acima veem todos.