Phone API

7 min

Introduction

A one time password (OTP) application programming interface (API) is a RESTful web service. It enables developers to integrate into their projects the functionality to generate single-use, temporary passwords. An OTP API utilizes the POST request method to make API calls. Developers embed endpoints into their client applications or websites. Endpoints connect the requests to the data resources provided by the API. Responses are returned in standard JSON formatting.

How to call the API

The user can select the country code and enter their mobile phone number. Click on generate OTP to get one. After that, enter the otp to fetch the data.

API Input Guidelines

Select the country code
Enter your correct mobile phone number
Enter the valid OTP to fetch data

Sample cURL Request

curl --location --request POST 'https://preproduction.signzy.tech/api/v2/patrons/59536fbaec27fe12d4e9aa1d/phones' \
--data-raw '{
    "task": "mobile",
    "essentials": {
        "task": "submitOtp",
        "countryCode": "91",
        "mobileNumber": "9119225594",
        "otp": "3958",
        "referenceId": "telecom_NuQjnemrqWyiqaywKQuy",
        "extraFields": "false"
    }
}'

Input Parameters

Parameter Name	Description
task	to generate otp and fetch the data
essentials.task	submit the otp that was generated
essentials.mobileNumber	input as mobile number
essentials.otp	One time password as an input
essentials.referenceId	Reference ID that is provided when generating OTP

Sample API Response

{
    "essentials": {
        "task": "submitOtp",
        "countryCode": "91",
        "mobileNumber": "9119225594",
        "otp": "3958",
        "referenceId": "telecom_NuQjnemrqWyiqaywKQuy",
        "extraFields": "false"
    },
    "id": "6348d9b51cf4a73e5a368a51",
    "patronId": "59536fbaec27fe12d4e9aa1d",
    "task": "mobile",
    "result": {
        "name": "vaishali",
        "address": "Nb-135,Chack Ram Singh,Kathua,184102",
        "splitAddress": {
            "district": [
                "KATHUA"
            ],
            "state": [
                [
                    "JAMMU & KASHMIR",
                    "JK"
                ]
            ],
            "city": [
                "BIJJAT"
            ],
            "pincode": "184102",
            "country": [
                "IN",
                "IND",
                "INDIA"
            ],
            "addressLine": "NB-135,CHACK RAM SINGH"
        },
        "dob": "1999-11-23",
        "mobileNumber": "9119225594",
        "countryCode": "91",
        "email": "",
        "mobileNetworkOperator": "airtel",
        "billingType": "prepaid",
        "alternatePhone": "",
        "extraFields": null
    }
}

Output Parameters

Parameter Name	Description
id	The Id that is provided to the user
patronId	Patron Id of the user
task	the task here is to generate otp and fetch essential details
result	gives the result in terms of its parameters
result.name	name of the person
result.address	address of the person
result.split address	the address that the person used to get the mobile number
result.district	disctrict from where the mobile number is taken
result.state	state of the city
result.city	city name
result.pincode	pincode of the place
result.country	country name
result.address line	address of the person
dob	date of birth of the person
mobile number	mobile number that the user provided as an input
country code	country code for eg :(+91)
email	email address of the person
mobileNetworkOperator	the operator which helped provide the mobile number

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected].