API Request & Response

The Philippines Social Security System verification service is the activity of checking the validity of inputted 10 digits Social Security System number compared to authoritative datasource.

Endpoint

MethodBase URLPath
POSThttps://api.verihubs.com/philippines/sss/verify

Request

Header

KeyTypeNotesDescription
App-IDstringRequiredApplication ID from Client Dashboard
Api-KeystringRequiredAPI-Key from Client Dashboard

Body

ParameterTypeMandatoryExampleDescription
card_nostringYes348339103210 digits of SSS number as stated on the card.
reference_idstringNocf0ae8c3-033b-4e7e-8e63-eb1352aa5607Optional ID for user to reference the transaction in reconciliation process.

Response

HTTP CodeDescriptionExample
200Successful Transaction with verified card number; Transaction that is considered successful and has been successfully verified by the data source.
{
    "message": "Transaction Success",
    "data": {
        "transaction_id": "cf0ae8c3-033b-4e7e-8e63-eb1352aa5607",
        "card_no": true
        "reference_id": "Docs-SSS-1"
    },
}
200Successful Transaction with rejected card number; Transaction that is considered successful and has been successfully verified by the data source
{
    "message": "Transaction Success",
    "data": {
        "transaction_id": "cf0ae8c3-033b-4e7e-8e63-eb1352aa5607",
        "card_no": fals
        "reference_id": "Docs-SSS-1"
    },
}
400Invalid Payload; Transaction that is considered failed due to validation errors, an error_field will appear explaining the error.
{
    "message": "Invalid payload",
    "error_code": "INVALID_PAYLOAD",
    "error_fields": [
        {
            "field": "card_no",
            "message": "card_no must 10 digits"
        }
    ]
}
401Authorization Failed (the transaction cannot proceed because it is unauthorized)
{
   "message": "Authorization Failed",
   "error_code":    "UNAUTHORIZED",
   "error_fields": []
}
403Quota Insufficient (the transaction failed due to insufficient quota, please contact CS Verihubs)
{
   "message": "Insufficient testing quota",
   "error_code": "FORBIDDEN",
   "error_fields": []
}
429Too Many Request; Spam Error as the transaction is read as spam, please wait 10 seconds before re-performing the hit process with the same identity.
{
   "message": "Too many request in the allowed time frame",
   "error_code":       "TOO_MANY_REQUEST",
   "error_fields": []
}
500Internal Server Error; The transaction failed due untraced server error that could be caused by data source constraints, timeout, internal error.
{
   "message": "Internal Server Error",
   "error_code":    "INTERNAL_SERVER_ERROR",
   "error_fields": []
}


Did this page help you?