Clients - Protected

Ler Carta de Condução e devolver campos para autofill do cliente

OCR a Portuguese Carta de Condução via Claude Vision and return the storable client fields (nome, nº da carta, data de emissão) plus the card's validade, which only stamps DataExpira on the attached document. Data-minimized: no DOB, no nº de identificação civil, no categorias.

RGPD: reads the images in-memory and never persists them; the frontend attaches them as Documentos do cliente (módulo 12, tipo "Carta de Condução") after the client is saved. Unreadable/unsupported input returns success=False (never a 5xx); billing only fires on success, and success requires the document to actually be a licence. Heavy sync work runs in the threadpool.

post/api/clients/ocr-driving-license

Request

  • Base URL
    https://api.multigest.pt (the document declares no server; this is the origin it was published from)
  • URL
    https://api.multigest.pt/api/clients/ocr-driving-license
  • Auth
    API key in header x-api-token and API key in header x-origin-verify

Headers

x-api-tokenstring nullable

Request body multipart/form-data

filesstring[] required

Carta de Condução (frente e, opcionalmente, verso ou PDF)

Response

Successful Response

successboolean
error_messagestring nullable
billedboolean
doc_typestring nullable
confiancastring nullable
warningsstring[]
nomestring nullable
numero_cartastring nullable
data_emissaostring nullable
validadestring nullable

Changes

No recorded changes to this operation across all 21 revisions of this API.