Passport Front OCR

OCR the main data page of a passport from an image. Server-side multipart POST with Bearer auth.

Authorization

AuthorizationBearer <token>

JWT Bearer token authentication. Obtain a token from the KwikID dashboard.

In: header

Request Body

filestring

flags?string

Optional JSON string. Keys: CARD_ORIENT (0/1) corrects orientation; CARD_CROP (0/1) runs document crop before OCR.

unique_id?string

Optional correlation id for logs.

Response Body

curl -X POST "https://__mock__/ocr/passport/front" \
  -F file="string"

curl -X POST "https://__mock__/ocr/passport/front" \  -F file="string"

{
  "DOB": "string",
  "date_of_expiry": "string",
  "date_of_issue": "string",
  "name": "string",
  "nationality": "string",
  "passport_number": "string",
  "place_of_birth": "string",
  "sex": "string",
  "surname": "string"
}

{
  "detail": {
    "<location>": {
      "<field_name>": [
        "string"
      ]
    }
  },
  "message": "string"
}

{
  "detail": {},
  "message": "string"
}

Call POST /ocr/passport/front with Authorization: Bearer <token> and file. Optional flags and unique_id. Compare OCR output with Verify Passport when you need issuer-validated data.