Skip to main content
POST
Philippines Document Details Extraction
This endpoint classifies across 13 Philippine document types. data.fields.documentType names the card that was found; it is returned bare (no confidence wrapper) because it is a classification, not transcribed text. Card-specific fields are promoted to the top level of data.fields, so the field set returned depends on which document type was detected.

Recognised document types

The document names above match those used in the supported documents reference for the Philippines. If the uploaded image is not one of these, the response returns data.outcome: "rejected" with documentType: null and errorReason: "wrong_document_type".

Authorizations

Authorization
string
header
required

Use your API token as a Bearer token in the Authorization header.

Headers

Authorization
string
required
Example:

"Bearer {your_api_token}"

Body

multipart/form-data
documentImage
file
required

The Philippine ID document image. JPG, JPEG, PNG, or PDF, up to 2 MB. A base64 string (raw or data: URI) is also accepted.

metadata
object

Optional key-value pairs echoed back in the response.

Example:

Response

The document was processed. data.fields.documentType names the card type that was classified (one of: alien_id, driving_license, health_insurance, nbi_clearance, passport, philsys_id, postal_id, prc, sss, tax, umid, voter_id, work_permit), or is null when the document was not recognised. Check data.outcome and verificationStatus to determine the result.

data
object