OCR Rest Api

Here you will find the OCR Api Rest documentation.

Try it

POST https://api.idcapture.es

Simply make a HTTP1.1 POST Request to https://api.idcapture.es. with an appropriate json object.

{
  "front": "data:image/jpeg;base64,/9j/4Q/+RXhpZgAATU0AKgAAA.....", // Front Id Image - Base64 Encoded.
  "back": "data:image/jpeg;base64,/9j/4Q/+RXhpZgAATU0AKgAAAAgACgEPA......" // Back Id Image - Base64 Encoded.
}

Parameters

Name Description Required
front Front Id Image - Base64 Encoded. Yes
back Back Id Image - Base64 Encoded. Yes

The following is an example of the recognized data.

{
  "FRONT_FIELDS": {
    "BIRTHDATE": "",
    "DOC_NUMBER": "99999999R",
    "EXPIRY": "02122026",
    "ID_NUMBER": "",
    "NAME": "",
    "NATIONALITY": "ESP",
    "SEX": "M",
    "SURNAME": "MUESTRA MUESTRA"
  },
  "MRZ0": "IDESPBCR999999540962760J<<<<<<",
  "MRZ1": "6003162M2612029ESP<<<<<<<<<<<5",
  "MRZ2": "MUESTRA<MUESTRA<<TEST<<<<<<<<<<<<",
  "MRZ_FIELDS": {
    "BIRTHDATE": "16/03/1960",
    "DOC_NUMBER": "99999999R",
    "EXP": "02/12/2026",
    "EXPEDITOR": "ESP",
    "ID_NUMBER": "BCR999999",
    "NAME": "MUESTRA MUESTRA",
    "NATIONALITY": "ESP",
    "SEX": "M",
    "SURNAME": "TEST"
  },
  "RAW_FRONT_OCR": [
  ],
  "checks": {
    "EXPIRY_DATE_CHECK": "OK",
    "GLOBAL_AUTHENTICITY_RATIO": "1.0",
    "GLOBAL_AUTHENTICITY_VALUE": "CREDIBLE",
    "MRZ_FIELDS_INTEGRITY_CHECK BIRTHDATE": "OK",
    "MRZ_FIELDS_INTEGRITY_CHECK DOC_NUMBER": "OK",
    "MRZ_FIELDS_INTEGRITY_CHECK EXPIRY": "OK",
    "MRZ_GLOBAL_INTEGRITY_CHECK": "OK",
    "SIDE_CORRESPONDENCE_CHECK": "OK"
  },
  "morphology": {
    "MORPH_DOCUMENT_ASPECT_RATIO": "OK",
    "MORPH_DOC_CHIP_FOUND": "OK",
    "MORPH_DOC_HEADER_FOUND": "OK",
    "MORPH_DOC_LOGO_FOUND": "OK",
    "MORPH_FACE_IMAGE_COLOR": "GRAYSCALE",
    "MORPH_FACE_IMAGE_COLOR_VARIANCE_RATIO": 6,
    "MORPH_FACE_IMAGE_DETECTED": "OK"
  },
  "results": {
    "dateOfBirth": "16/03/1960",
    "dateOfExpiry": "02/12/2026",
    "docNumber": "BCR999999",
    "issuingCountry": "ESP",
    "model_id": "IDESP3",
    "nationality": "ESP",
    "personalNumber": "99999999R",
    "primaryIdentifier": "MUESTRA MUESTRA",
    "secondaryIdentifier": "TEST",
    "sex": "M",
    "sides": 2
  }
}