POST /v1/philippines/philsys/sandbox – Verihubs Sandbox

Sandbox - PhilSys

The sandbox for PhilSys Service that enables you to check the response of PhilSys verification without using real data. All validations applied in Live mode are also applied here.

Required inputs

philsys_session_id — required, a valid UUID. Determines which scenario the transaction returns.
pcn or pcn_form_data — required. You must send exactly one of the two: sending both, or neither, returns a validation error (only one of pcn or pcn_form_data must be provided / pcn or pcn_form_data is required).
reference_id — optional. When it is empty, a random UUID is generated and returned in the response.

Scenario Description

Scenario	pcn or pcn_form_data	philsys_session_id	Result
VERIFIED	pcn = 1234123412341234 <br> or pcn_form_data = John / Joseph / Doe / Jr / 01-01-2000	0e71f1ed-0000-4000-8000-000000000001	200, verification_status: VERIFIED, response contains the full identity data
REJECTED	pcn = 4567456745674567 <br> or pcn_form_data = Jonathan / Jovito / Deere / Jr / 10-10-2001	deac7ed0-0000-4000-8000-000000000002	200, verification_status: REJECTED, no identity data returned
Session ID Not Found	any of the payloads above	40440400-0000-4000-8000-000000000404	400, philsys_session_id not valid
Liveness Error	pcn = 1234123412341234 <br> or the VERIFIED pcn_form_data	f01ace00-0000-4000-8000-000000000004	400, verification_status: REJECTED with the liveness error inside verification_result
API Error	pcn = 1234123412341234 <br> or the VERIFIED pcn_form_data	500e7707-0000-4000-8000-000000000500	500, Internal server error from datasource
Validation Error	{invalid payload, e.g. 15-digit pcn or birth_date in YYYY-MM-DD}	{any valid UUID}	400, error message per validated field

Use the payload values above so your request matches the documented scenario. pcn and pcn_form_data are never sent together.

post/v1/philippines/philsys/sandbox

Request

Base URL
https://api.verihubs.com
URL
https://api.verihubs.com/v1/philippines/philsys/sandbox
Auth
none declared. Required headers: App-ID, API-Key

Headers

App-IDstring required

API-Keystring required

Request body

Example request

{
  "pcn": "1234123412341234",
  "pcn_form_data": {
    "first_name": "John",
    "middle_name": "Joseph",
    "last_name": "Doe",
    "suffix": "Jr",
    "birth_date": "01-01-2000"
  },
  "philsys_session_id": "0e71f1ed-0000-4000-8000-000000000001",
  "reference_id": "REF123456789"
}

Response

Successful Response

idstring required

Verihubs ID, generated string that is unique for every transaction.

reference_idstring required

Reference id of the transaction, the same value you sent (or a generated UUID if it was empty).

messagestring required

Shows message of the response.

verification_statusstring required

Verification status of the transaction. Returns VERIFIED or REJECTED.

Example response

{
  "id": "09d9c29b-0946-44aa-9944-afaf6c05c58a",
  "reference_id": "REF123456789",
  "message": "PhilSys Check processed successfully",
  "verification_status": "VERIFIED",
  "verification_result": {
    "meta": {
      "tier_level": "Tier II",
      "result_grade": 1
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.