Philippines UMID OCR

crn + name recognition

Code example:

curl --location --request POST 'https://api.ekycpro.com/v1/ph_ocr_umid/general' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'X-API-Key: AbcdEfgh' \
--data-urlencode 'img=BASE64_ENCODE_VALUE'

Response for recognition success

{
  "status": "OK",
  "message": {
    "crn": "CRN-0028-1215160-9",
    "surname": "SANTOS",
    "givenName": "JOSE",
    "MiddleName": "CRUZ",
    "birthday": "1960/01/28",
    "sex": "M",
    "address": "28 PAYAPA ST BAGONG DIWA STO CRISTOBAL CAL OOCAN CITY METRO MANILA PHILIPPINES 1800"
  }
}

Response for recognition fail

{
  "status": "FAIL",
  "message": "check input image and retry"
}

Response for invalid request parameters

{
  "status": "INVALID_REQUEST",
  "message": "check request params"
}

Response for invalid image format

{
  "status": "IMAGE_INVALID_FORMAT",
  "message": "image format not support"
}

Response for image size larger than 2M

{
  "status": "IMAGE_INVALID_SIZE",
  "message": "image larger than 2M"
}

Response for server error

{
  "status": "INNER_ERROR",
  "message": "Inner error, please retry later"
}

HTTP request

POST https://api.ekycpro.com/v1/ph_ocr_umid/general

Request parameters

parameter	description
`img`	`string`, base64 encoded image. It is recommended that the image be less than 200KB, so it will be returned within 2 seconds, otherwise the return time will be longer.

Response format

fields	description
`status`	status code
`message`	`crn`: the crn number
`surname`: surname
`givenName`: given name
`middleName`: middle name
`birthday`: date of birth
`sex`: gender
`address`: address

Status code

status	description
`OK`	`charge`, success
`FAIL`	`charge`, image recognition error, please check input image
`INVALID_REQUEST`	`free`, invalid request parameters
`IMAGE_INVALID_FORMAT`	`free`, invalid image format, image format should be one of jpeg/jpg/png/bmp
`IMAGE_INVALID_SIZE`	`free`, invalid image size, should be less than 2M
`INNER_ERROR`	`free`, server error