/verify/ibig

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

1.API Specification

This API is used to verify Philippine IBIG number.

Request Method

POST

Request URL

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

Debugging Tool

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 ibig_number string IBIG number

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
ibig_number string The valid IBIG number, or null if status = id_not_found
masked_name string Masked name, or null if status = id_not_found

Response Syntax

IBIG number is found

{
    "status": "OK",
    "result": {
        "status": "id_found",
        "ibig_number": "xxxxxx",
        "masked_name": "Taxxx Nxxx"
    },
    "request_id": "TID6f814b81bfb44c97a63b13e2750a3a2a"
}

IBIG number is not found

{
    "status": "OK",
    "result": {
        "status": "id_not_found",
        "ibig_number": null,
        "masked_name": 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 'ibig_number': not found",
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}

5.Sample

results matching ""

    No results matching ""