/verify/prc
1.API Specification
2.Request Params
3.Response Params
4.Error Codes
5.Sample
1.API Specification
This API is used to verify Philippine PRC details with a government database.
Request Method
POST
Request URL
https://cloudapi.philippine.accuauth.com/verify/prc
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
2.2.1 Verify by name
| Required | Fields | Type | Description | 
|---|---|---|---|
| required | prc_verification_mode | string | Verification mode, must be verify_using_name | 
| required | profession | string | Profession on ID card | 
| required | first_name | string | First name on ID card | 
| required | last_name | string | Last name on ID card | 
2.2.2 Verify by license Number
| Required | Fields | Type | Description | 
|---|---|---|---|
| required | prc_verification_mode | string | Verification mode, must be verify_using_license | 
| required | profession | string | Profession on ID card | 
| required | license_number | string | The PRC license number for verification, e.g., "1085496". | 
| required | dob | string | The date of birth of the individual, e.g., "1991-01-05". | 
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 | 
| full_name | string | The full name of the individual | 
| initial_registration_date | string | The initial registration date of the PRC license, e.g., "2011-02-16". | 
| license_expiration_date | string | The full name of the individual | 
| prc_status | string | The status of the PRC verification, e.g., "Valid" (can be null). You can ignore this key. | 
| prc_verification_mode | string | The mode used for PRC verification, e.g., "verify_using_license". | 
| profession | string | The profession of the individual, e.g., "PROFESSIONAL TEACHER". | 
Response Syntax
PRC is found
{
    "status": "OK",
    "result": {
        "status": "id_found",
        "full_name": "VICENTE, JOBELLE MAE VILLAR",
        "initial_registration_date": null,
        "license_expiration_date": null,
        "prc_status": "Valid",
        "prc_verification_mode": "verify_using_name",
        "profession": "PROFESSIONAL TEACHER"
    },
    "request_id": "TID6f814b81bfb44c97a63b13e2750a3a2a"
}
PRC is not found
{
    "status": "OK",
    "result": {
        "status": "id_not_found",
        "full_name": null,
        "initial_registration_date": null,
        "license_expiration_date": null,
        "prc_status": null,
        "prc_verification_mode": null,
        "profession": 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 'first_name': not found",
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}