/verify/philsys

1.API Specification
2.Request Params
3.Response Params
4.Error Codes
5.Sample

1.API Specification

This API is used to verify Philippine PhilSys Number(PSN).

Request Method

POST

Request URL

https://cloudapi.philippine.accuauth.com/verify/philsys

Debugging Tool

2.Request Params

2.1 Request Header

Parameter	Type	Required	Description
X-DF-API-ID	string	Yes	For API credentials，Please visit API Request
X-DF-API-SECRET	string	Yes	For API credentials，Please visit API Request

2.2 Request Body

Required	Fields	Type	Description
required	document1	string	image in base64 format OR URL of image of voter ID. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms.

3.Response Params

Fields	Type	Description
request_id	string	Unique id of each request
status	string	Response status, `OK` for success request, Error Codes for failed request
result	object	The verification result

3.2 Elements in `result`

Fields	Type	Description
status	string	`id_found` or `id_not_found`
card_status	string	`activated`
philsys_card_number	string	The PhilSys Card Number
philsys_qr_code_status	string	Status of PhilSys QR Code, `valid` or `invalid`
first_name	string	The first name
middle_name	string	The middle name
last_name	string	The last name
full_name	string	The full name
dob	string	Date of birth, formatted as YYYY-mm-dd
place_of_birth	string	Place of birth
sex	string	Gender
suffix	string	Suffix
date_of_insurance	string	Date of insurance, formatted as YYYY-mm-dd

Response Syntax

Philsys is found

{
    "status": "OK",
    "result": {
        "best_capture_finger": [
        "LEFT THUMB",
        "LEFT MIDDLE FINGER"
      ],
      "card_status": "activated",
      "date_of_insurance": "2021-12-12",
      "dob": "1997-03-06",
      "fist_name": "MARK CHRISTIAN",
      "last_name": "MATA",
      "middle_name": "DELOS SANTOS",
      "philsys_card_number": "2570431529769165",
      "philsys_qr_code_status": "valid",
      "place_of_birth": "City of Cebu,Cebu",
      "sex": "Male",
      "status": "id_found",
      "suffix": ""
    },
    "request_id": "TID6f814b81bfb44c97a63b13e2750a3a2a"
}

Philsys is not found

{
    "status": "OK",
    "result": {
      "best_capture_finger": null,
      "card_status": null,
      "date_of_insurance": null,
      "dob": null,
      "first_name": null,
      "full_name": null,
      "last_name": null,
      "middle_name": null,
      "philsys_card_number": null,
      "philsys_qr_code_status": null,
      "place_of_birth": null,
      "sex": null,
      "status": "id_not_found",
      "suffix": null
    },
    "request_id": "TID6f814b81bfb44c97a63b13e2750a3a2a"
}

4.Error Codes

Common error codes of this API:

Http Status Code	`Status` Field	Description
`400`	PENDING	Operation is in progress, please try again
`400`	INVALID_ARGUMENT	Request parameter is invalid
`400`	QUERY_FAILED	Query failed
`400`	ABNORMAL_BEHAVIOURS_DETECTED	Request with same parameters repeated more than amount of times
`401`	UNAUTHORIZED	Unauthorized or access is denied
`401`	KEY_EXPIRED	Your API ID has expired
`403`	NO_PERMISSION	You are not authorized to use this API
`403`	OUT_OF_QUOTA	API calls quota exceeded
`403`	RATE_LIMIT_EXCEEDED	API request frequency exceeds the limit
`404`	NOT_FOUND	Requested API cannot be found
`500`	INTERNAL_ERROR	Internal server error
`512`	SOURCE_SERVICE_UNAVAILABLE	Source service is unavailable
`513`	SOURCE_SERVICE_TIMEOUT	Source service is timeout

Comment: Please see the reason field for details when the above 40X / 51X error occurred

Response Syntax

{
  "status": "INVALID_ARGUMENT",
  "reason": "argument 'tin_number': not found",
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}

5.Sample

results matching ""

No results matching ""