C06 - Verification Only
Objective
The C06 - Verification Only module verifies a user's data against the national database.
| Input | Output |
|---|---|
| The user details from their National ID card. You can find the details of all the input fields under the Inputs section. | The user's verification status and the associated action for the identity verification process. |
Inputs
The following table provides the details of the input parameters required for the module.
| Parameter | Mandatory or Optional | Description | Data Type |
|---|---|---|---|
| idNumber | Mandatory | string | ID number on chip ID card - 12 digits NID |
| comData | Mandatory | string | COM data encoded base64, extracted from NFC chip |
| dg1Data | Mandatory | string | DG1 data encoded base64, extracted from NFC chip |
| dg2Data | Mandatory | string | DG2 data encoded base64, extracted from NFC chip |
| dg13Data | Mandatory | string | DG13 data encoded base64, extracted from NFC chip |
| dg14Data | Mandatory | string | DG14 data encoded base64, extracted from NFC chip |
| dg15Data | Mandatory | string | DG15 data encoded base64, extracted from NFC chip |
Success Response
The following is a success response from the module.
{
"status": "success",
"statusCode": "200",
"metaData": {
"requestId": "<Request_ID>",
"transactionId": "<Transaction_ID>"
},
"result": {
"details": {
"status": 200,
"verifyRequestId": "<Verify_Request_ID>",
"verifyC06": true,
"vendorVerifySignature": "<Base64_Encoded_Vendor_Verify_Signature>",
"c06VerifySignature": "<Base64_Encoded_C06_Verify_Signature>"
},
"summary": {
"action": "pass",
"details": []
}
}
}
Success Response Details
The following table provides the details of the fields in a success response.
| Parameter | Type | Description |
|---|---|---|
| status | string | The status of the request |
| statusCode | integer | The HTTP status code of the request |
| requestId | string | A unique identifier for the request |
| transactionId | string | A unique identifier for the transaction |
| verifyRequestId | string | A unique identifier for the verification request |
| verifyC06 | boolean | Indicates whether the C06 verification was successful |
| vendorVerifySignature | string | The signature for vendor verification in a Base64-encoded format |
| c06VerifySignature | string | The signature for C06 verification in a Base64-encoded format |
| action | string | The result of the verification process |
| details | array | Additional details related to the summary |
Action Samples
The following are code samples corresponding to each type of action value supported by the module.
- Pass
- Fail
- Manual Review
This is the response where the application is approved for further processing.
{
"summary": {
"action": "pass",
"details": []
}
}
This is the response where the application is rejected.
{
"summary": {
"action": "fail",
"details": [
{
"code": "001",
"message": "Missing input(s)"
}
]
}
}
This is the response where the application is sent to manual review.
{
"summary": {
"action": "manualReview",
"details": [
{
"code": "001",
"message": "Missing input(s)"
}
]
}
}
Error Responses
The following are some error responses.
- Missing Parameter(s)
- External Server Downtime
{
"status": "failure",
"statusCode": 400,
"metaData": {
"requestId": "<Request_Identifier>",
"transactionId": "<Transaction_Identifier>"
},
"result": {
"summary": {
"action": "manualReview",
"details": [
{
"code": "001",
"message": "Missing parameter(s)"
}
]
},
"error": "Missing parameter(s)"
}
}
{
"statusCode": 503,
"status": "failure",
"message": "External source downtime",
"error": "EXTERNAL_DOWNTIME"
}
Error Response Details
An error response from the module contains a failure status, with a relevant code and error message.
The following table lists all the error responses.
| Status Code | Error Code | Message | Description |
|---|---|---|---|
| 400 | 001 | Missing parameter(s) | The request has at least one missing input. Please contact the HyperVerge team for resolution |
| 503 | 002 | External source downtime | The external vendor system is temporarily unavailable. Please try again later |
| 503 | 003 | External source downtime | The external vendor system is temporarily unavailable. Please try again later |
| 503 | 004 | External source downtime | The external vendor system is temporarily unavailable. Please try again later |
| 503 | 005 | External source downtime | The external vendor system is temporarily unavailable. Please try again later |
| 503 | 006 | External source downtime | The external vendor system is temporarily unavailable. Please try again later |
| 503 | 007 | External source downtime | The external vendor system is temporarily unavailable. Please try again later |
| 503 | 008 | External source downtime | The external vendor system is temporarily unavailable. Please try again later |
| 503 | 009 | External source downtime | The external vendor system is temporarily unavailable. Please try again later |
| 400 | 010 | Duplicated data in unique field | Duplicate values were found in a field expected to be unique. Check the input and resubmit |
| 422 | 011 | Request ID mismatch for C06 validation - No data found | The provided Request ID does not match any existing records. Verify and resubmit the correct Request ID |
| 503 | 012 | External source downtime | The external vendor system is temporarily unavailable. Please try again later |
| 503 | 013 | External source downtime | The external vendor system is temporarily unavailable. Please try again later |
| 422 | 014 | Not found transaction (recheck) | The requested transaction was not found. Verify the transaction details and try again |
| 503 | 015 | External source downtime | The external vendor system is temporarily unavailable. Please try again later |
| 422 | 016 | Source API has no corresponding card data in the system | The API could not find any matching card data for the provided input |
| 503 | 017 | External source downtime | The external vendor system is temporarily unavailable. Please try again later |
| 503 | 018 | External source downtime | The external vendor system is temporarily unavailable. Please try again later |
| 500 | Internal Server Error | An unexpected error occurred on the server. Please contact the HyperVerge team for support | |
| 422 | 020 | Data integrity check failed | The NFC data failed integrity validation. Ensure the data is valid and conforms to expected formats |
| 429 | Rate limit error | Too many requests were made in a short period. The limit is 200 requests per minute |
Application View
The following section showcases a screen from a sample application featuring the C06 Verification module, accessible within the Applications tab of the HyperVerge dashboard.
The image only contains some of the output fields for representation. Please refer the success response details section for the complete list of supported fields.