Skip to main content
POST
PhilSys Check requires faceLivenessSessionId plus exactly one of pcn, pcnFormData, or qrData. Supported QR formats are ePhilID, PhilID, and Digital ID. Unknown QR formats fail validation.

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}"

Accept
string
default:application/json
Content-Type
string
default:application/json

Body

application/json

Provide faceLivenessSessionId and exactly one of pcn, pcnFormData, or qrData.

faceLivenessSessionId
string
required

ID of a current face-liveness session.

Example:

"session-1001"

pcn
string
required

Sixteen-digit PhilSys Card Number, with or without groups of four hyphenated digits.

Pattern: ^(?:\d{16}|\d{4}(?:-\d{4}){3})$
Example:

"1234-5678-9012-3456"

pcnFormData
object
qrData
string

Raw QR value from a supported ePhilID, PhilID, or Digital ID.

Example:

"PH1:sample-qr-value"

metadata
object

Optional key-value pairs echoed back in completed and source-error responses.

Response

Request processed. Check data.isValid and verificationStatus to determine the outcome.

success
boolean
required
Example:

true

message
string
required
data
object
required

CamelCase result fields for this verification type. Additional source fields may be returned when available.

verificationStatus
enum<string>
required
Available options:
VERIFIED,
REJECTED
verificationStatusCode
enum<integer>
required

3 = Verified, 1 = Rejected.

Available options:
3,
1
transactionId
string<uuid>
required
verificationType
string
required
Example:

"scan_qr"

createdAt
string
required
Example:

"2026-09-01 08:00:00+0000"

metadata
object | null