Phone Intel - Submit OTP

Introduction

The "Submit OTP" API endpoint serves to retrieve comprehensive information about a mobile phone number in India by submitting a previously generated one-time password (OTP) that was sent to the respective number as part of the Generate OTP API call.

By utilizing this endpoint, users can access details including the name and address associated with the phone number, along with additional information such as the mobile network operator, billing type, and other relevant data. This wealth of information proves instrumental in verifying user identities, conducting background checks, and enhancing the accuracy of customer data.

Key Features

OTP Submission: Allows users to submit a previously generated OTP for authentication purposes.

Comprehensive Information Retrieval: Provides detailed information about the phone number, including name, address, mobile network operator, and billing type.

Identity Verification: Assists in verifying user identities and conducting background checks effectively.

Applications

Identity Verification: Enables businesses to verify the identity of users during registration or authentication processes.

Background Checks: Facilitates background checks to ensure the legitimacy of users and prevent fraudulent activities.

Data Accuracy Enhancement: Helps in improving the accuracy of customer data by providing detailed information associated with mobile phone numbers.

Conclusion

In conclusion, the "Submit OTP" API endpoint offers a valuable solution for retrieving detailed information about mobile phone numbers in India. By leveraging this endpoint, businesses can effectively verify user identities, conduct background checks, and enhance the accuracy of their customer data, thereby fostering trust and reliability in their services.

API Details

Endpoints

POST https://api.signzy.app/api/v3/phone/getNumberDetails

POST https://api-preproduction.signzy.app/api/v3/phone/getNumberDetails

Request Body Parameters

Parameter	Data Type	Description	Required
countryCode	String	The country code associated with the mobile number. The value to be passed is "91".	Mandatory
mobileNumber	String	The mobile number for which OTP is requested	Mandatory
referenceId	String	A unique identifier for tracking the request, generated in response to the Generate OTP API call.	Mandatory
otp	String	The One-Time Password (OTP) for verification, generated in response to the Generate OTP API call. The OTP has a validity of 10 mins. In case the time duration passes by, you would need to again consume the Generate OTP API.	Mandatory
extraFields	Boolean	If set as true, get additional information about billing history, device information, and other pertinent information in response. The default value for this flag is false.	Optional

{
   "countryCode": "91",
   "mobileNumber": "...mobile number...",
   "referenceId": "...refId...",
   "otp": "...otp...",
   "extraFields": true/false
}

Request Headers

Name	Value	Required	Description
Content-Type	application/json	Mandatory	The type of content that the request body contains.
Authorization	XXXXXXXXXXXXXXX	Mandatory	An authentication token to authorize the request. Reach out to the Signzy support team to get one created.

Code Samples

curl --location 'https://api-preproduction.signzy.app/api/v3/phone/getNumberDetails' \
--header 'Content-Type: application/json' \
--header 'Authorization: <your access token>' \
--data '{
    "countryCode": "91",
    "mobileNumber": "xxxxxxxxxx",
    "referenceId": "telecom_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "otp": "yyyyyy",
    "extraFields": false
}'

Response Body Parameters

Parameter	Data Type	Description
result	Object	The main container for all response information.
result.name	String	The name of the individual (e.g., "John Doe").
result.address	String	The complete address, including street, city, state, country, and pin code.
result.splitAddress	Object	Subdivided address details.
result.splitAddress.district	Array	Array containing district information.
result.splitAddress.state	Array	Array containing state information, with possible abbreviations.
result.splitAddress.city	Array	Array containing city information.
result.splitAddress.pincode	String	The postal code of the address.
result.splitAddress.country	Array	Array containing country information, with possible abbreviations.
result.splitAddress.addressLine	String	The street address line (e.g., "123, GENERIC STREET").
result.dob	String	Date of birth in the format "YYYY-MM-DD" (e.g., "1990-01-01").
result.mobileNumber	String	The primary mobile number.
result.countryCode	String	The country code associated with the mobile number (e.g., "91").
result.email	String	The email address
result.mobileNetworkOperator	String	The mobile network operator or carrier.
result.billingType	String	The type of billing ( "postpaid"/"prepaid").
result.alternatePhone	String	An alternate phone number.
result.extraFields	Object	Additional fields that may be included.
result.extraFields.loyalty_category	String	The loyalty category associated with the mobile number (e.g., "AIRTEL THANKS GOLD").
result.extraFields.device_name	String/Null	The device name associated with the mobile number. Null if not available.
result.extraFields.international_roaming	String/Null	The international roaming associated with the mobile number. Null if not available.
result.extraFields.auto_pay	Boolean	Indicates whether the mobile number is set to auto-pay (e.g. false).
result.extraFields.credit_limit	Number/Null	The credit limit associated with the mobile number. Null if not available.
result.extraFields.activation_date	String/Null	The activation date associated with the mobile number. Null if not available.
result.extraFields.current_pack.name	String	The name of the current pack associated with the mobile number (e.g., "Unlimited Pack").
result.extraFields.current_pack.price	Number/Null	The price of the current pack associated with the mobile number. Null if not available.
result.extraFields.current_pack.expiry	String/Null	The expiry date of the current pack associated with the mobile number. Null if not available.
result.extraFields.payment_mode	Array	The payment modes associated with the mobile number.
result.extraFields.billing_history[]	Array/Object	An array of billing history entries associated with the mobile number. Each entry contains date, amount, payment_mode, description, and type.
result.extraFields.billing_history[].date	String/Null	The date of the billing history entry associated with the mobile number. Null if not available.
result.extraFields.billing_history[].amount	Number/Null	The amount of the billing history entry associated with the mobile number. Null if not available.
result.extraFields.billing_history[].payment_mode	String/Null	The payment mode of the billing history entry associated with the mobile number. Null if not available.
result.extraFields.billing_history[].description	String/Null	The description of the billing history entry associated with the mobile number. Null if not available.
result.extraFields.billing_history[].type	String/Null	The type of the billing history entry associated with the mobile number. Null if not available.

{
    "result": {
        "name": "John Doe",
        "address": "123, Generic Street, Cityville, State, Country-123456",
        "splitAddress": {
            "district": [
                "DISTRICT"
            ],
            "state": [
                [
                    "STATE",
                    "ST"
                ]
            ],
            "city": [
                "CITY"
            ],
            "pincode": "123456",
            "country": [
                "COUNTRY",
                "CNTRY",
                "XYZ"
            ],
            "addressLine": "123, GENERIC STREET"
        },
        "dob": "1990-01-01",
        "mobileNumber": "xxxxxxxxxxx",
        "countryCode": "xx",
        "email": "[email protected]",
        "mobileNetworkOperator": "carrier",
        "billingType": "postpaid",
        "alternatePhone": "yyyyyyyyyyy",
        "extraFields": {}
        "extraFields": {
            "device_name": "XXXX",
            "current_pack": {
                "name": "xx",
                "expiry": "XX YY, XX XX:XX AM",
                "price": "xx"
            },
            "loyalty_category": "xx",
            "billing_history": [
                {
                    "amount": "xx",
                    "date": "xx, 2024 xx:xx xx",
                    "payment_mode": "xx",
                    "description": "xx xx xxxxxxxxxx"
                },
                {
                    "amount": "xx",
                    "date": "xx, 2024 xx:xx xx",
                    "payment_mode": "xx",
                    "description": "xx xx-xx-xxxxxx xxxxxxxxxx"
                }
            ]
        }
    }
}

Error Codes

{
    "error": {
        "name": "error",
        "message": "Internal Server Error",
        "status": 500,
        "reason": "ERROR",
        "type": "Internal Server Error",
        "statusCode": 500
    }
}

Contact Us for Any Assistance

If you have any questions or need assistance, please reach out to our customer support team. You can contact us via email at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.

We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!