Acceptable header values

This page will explain what values are acceptable for each header.

CountryCode

Describes the country of the document you wish to scan for.

Acceptable Value

'PHL' or 'PHILIPPINES'

'ZAF' or 'SOUTHAFRICA'

DocumentType

Describes the document you wish to scan for.

Acceptable Value

Description

'DRIVERSLICENSE'

'FIREARMSLICENSE'

The Philippines Firearms License card.

'GREENBOOK'

The South African Green Book ID (Bilingual or English).

'HEALTHINSURANCECARD' or 'PHILHEALTH'

The Philippines Phil Health Insurance card, also known as the Philippines Phil Health ID.

'IBP' or 'INTEGRATEDBAR'

'IDCARD'

The identity card for the indicated country code.

'PASSPORT'

The passport for the indicated country code.

'PIC' or 'PRC' or 'PROFESSIONALREGULATIONS'

The Philippines Professional Regulation Commission card, also known as the Philippines Professional ID card (or PIC for short).

'PID' or 'POSTALID'

'SID'

The Philippines Seafarer's Identification Document.

'SIRB' or 'SEAMANSBOOK'

The Philippines Seafarer's Identification and Record Book (commonly known as the Seaman's Book).

'SSS' or 'SOCIALSECURITY'

'UMID' or 'UNIFIEDMULTIPURPOSE'

The Philippines Unified Multi-purpose ID card (commonly known as the UMID card).

'BIRTHCERTIFICATE'

The birth certificate for the indicated country code.

ReturnType

Describes the format in which the model will be returned.

Acceptable Value

Description

'STRING'

The model will be returned in a single JSON string.

'JSONOBJECT'

The model will be returned as a JSON object.

Last updated