Response Codes and Verification Status

When using the Prembly API, you may encounter custom response codes that indicate the status of a particular request. These custom response codes are as follows:

Response CodeMeaningExplanation
00SuccessfulThis code indicates that the request was successful and that the expected data has been returned.
01Record not foundThis code indicates that the ID provided in the request was not found in the system.
02Service is not availableThis code indicates that the requested service is unavailable. This could be due to maintenance, downtime, or other issues.
03Insufficient wallet balanceThis code indicates that there is an insufficient balance in the wallet to complete the requested transaction. Please ensure that the wallet has enough funds before making the request.

It is important to note that custom response codes only compliments the standard HTTP response.

Verification Statuses

Verification Status is used to indicate the status of a verification request. There are three possible values for the Verification Status:

Verification StatusExplanation
PENDINGThis status indicates that the verification request has failed and will be retried at a later time.
NOT-VERIFIEDThis status indicates that the verification request was successfully performed, but the ID provided is not valid.
VERIFIEDThis status indicates that the verification request was successfully performed, and the ID provided is valid.

Response Structure

{
    "status": false,
    "response_code": "01",
    "message": "Record not found",
    "verification": {
        "reference": "254d1801-db5d-450a-954b-3682ddae7072"
    },
    "session": {}
}


{
    "status": false,
    "detail": "Verification failed",
    "response_code": "02",
    "message": "Verification can't be completed at this time. Kindly retry later",
    "verification": {
        "reference": ""
    },
    "session": {}
}


{
    "status": false,
    "response_code": "03",
    "detail": "Insufficient wallet balance",
    "verification": {
        "reference": "ca97b55e-880d-4e37-8e29-1529c3ffe9e6"
    },
    "session": {}
}