Mobile Revoke Status API

This document outlines the details of the Mobile Revoke Status API.

API Description

Objective

The Mobile Revoke Status API checks whether a given mobile number has been revoked.

Input	Output
The Mobile Number	The revocation status and date of the mobile number. The complete list of output fields is available in the Success Response Details section

did you know

Mobile number revocation, or more specifically, Mobile Number Revocation List (MNRL), refers to a database of permanently disconnected or deactivated mobile phone numbers. These numbers are flagged because they are no longer in use, are suspected of being involved in fraudulent activities, or have been disconnected due to various reasons.

API URL

https://ind-engine.thomas.hyperverge.co/v1/getMobileRevokeStatus

API Endpoint

getMobileRevokeStatus

Overview

The API is RESTful and uses standard HTTP verbs and status codes. The responses are in JSON format and you should send all data in JSON format through a POST request.

Authentication

You need a unique pair of application ID ( appId ) and application key (appKey) from HyperVerge to verify your identity for accessing the API.

API Request Details

Method - POST

Headers

Parameter	Mandatory or Optional	Description	Valid Values
content-type	Mandatory	This parameter defines the media type for the request payload.	application/json
appId	Mandatory	The application ID shared by HyperVerge	Not Applicable - this is a unique value
appKey	Mandatory	The application key shared by HyperVerge	Not Applicable - this is a unique value
transactionId	Mandatory	The unique ID for the customer journey.	Not Applicable - this is a unique value related to a transaction in your application

Input

The following table provides the details of the parameter required for the API's request body:

Parameter	Mandatory or Optional	Description	Allowed Values	Default Value
mobileNo	Mandatory	The 10-digit, valid mobile number	Not Applicable	Not Applicable

Request

The following code snippet demonstrates a standard curl request for the API:

curl --location --request POST 'https://ind-engine.thomas.hyperverge.co/v1/getMobileRevokeStatus' \
--header 'Content-Type: application/json' \
--header 'appId: <Enter_the_HyperVerge_appId>' \
--header 'appKey: <Enter_the_HyperVerge_appKey>' \
--header 'transactionId: <Enter_the_HyperVerge_transactionID>' \
--data '{
    "mobileNo": "<Enter_the_valid_Mobile_Number>"
}'

Success Response

The following code snippet demonstrates a success response from the API:

{
    "status": "success",
    "statusCode": 200,
    "result": {
        "revokeDate": "<Date_on_which_mobile_number_was_revoked>", // MM-YYYY format
        "revokeStatus": "Yes"
    },
    "metaData": {
        "requestId": "<Request_ID>",
        "transactionId": "<Transaction_ID>"
    }
}

Success Response Details

The following table outlines the details of the success response from the API:

Parameter	Type	Description
status	string	The status of the request
statusCode	integer	The HTTP status code returned for the request
revokeDate	string	Indicates the month and year when the mobile number was revoked
revokeStatus	string	The status of the revocation process ("Yes" if the number has been revoked)
requestId	string	The unique identifier for the API request
transactionId	string	The transaction ID associated with the request, if available

Error Responses

The following are some error responses from the API:

Invalid Mobile Number

{
    "status": "failure",
    "statusCode": 400,
    "error": "Mobile number is invalid",
    "metaData": {
        "requestId": "<Request_ID>",
        "transactionId": "<Transaction_ID>"
    }
}

Missing/Invalid Credentials

{
    "message": "Missing/Invalid credentials",
    "statusCode": 401,
    "status": "failure"
}

Mobile Number Not Revoked

{
    "status": "failure",
    "statusCode": 422,
    "error": "Mobile number is not revoked",
    "metaData": {
        "requestId": "<Request_ID>",
        "transactionId": "<Transaction_ID>"
    }
}

Internal Server Error

{
  "status": "failure",
  "statusCode": 500,
  "message": "Internal server error"
}

External Source Downtime

{
  "status": "failure",
  "statusCode": 503,
  "message": "External source downtime"
}

Error Response Details

A failure or error response from the module contains a failure status, with a relevant status code and error message.
The following table lists all error responses:

Status Code	Error Message	Error Description
400	Mobile number is invalid	This error occurs when mobileNo is invalid or empty
401	Missing/Invalid credentials	The request is either missing the mandatory appId and appKey combination or has invalid values
422	Mobile number is not revoked	This error occurs when we pass a 10-digit mobile number which is not revoked
500	Internal Server Error	Please check the request headers or contact the HyperVerge team for resolution
503	External source downtime	This error occurs when the external source is down