Verify OTP and fetch Address

Introduction

This API accepts sessionId generated in Generate OTP and OTP sent to phone number by Generate OTP API , After successful verification of OTP provides address details for the phone number associated with sessionId.

Sample cURL

curl --location 'https://api-preproduction.signzy.app/api/v3/phones/phone-address-submit-otp' \
--header 'Content-Type: application/json' \
--header 'Authorization: ********' \
--data '{
    "sessionId": "1ab00ef1-7c37-4304-bf79-77e24029f2bf",
    "otp":"0340"
}'

Input Parameters:

Parameter	Type	Description	Mandatory/Optional
sessionId	String	sessionId generated while generating otp	Mandatory
otp	String	OTP sent on phone number	Mandatory- if phone number is not verified. Optional- if phone number is already verified

Sample Response:

{
    "sessionId": "1ab00ef1-7c37-4304-bf79-77e24029f2bf",
    "result": {
        "user": {
            "firstName": null,
            "lastName": null,
            "phoneNumber": "+919691066329",
            "email": null
        },
        "addresses": [
            {
                "addressType": null,
                "zip": "560068",
                "country": "India",
                "countryCode": null,
                "city": "",
                "phone": "+919691066329",
                "address2": null,
                "address1": "BTM layout 1st stage",
                "name": "Prashant  Beck",
                "state": "Karnataka",
                "type": null,
                "stateCode": null,
                "email": "[email protected]"
            }
        ]
    },
    "status": "OTP is verified",
    "statusCode": 200
}

Output Parameters:

Key	Type	Description
sessionId	String	UUID for the session.
result	Object	Contains user and address information.
result.user	Object	User details of phone number
result.user.firstName	String	first name
result.user.lastName	String	last name
result.user.phoneNumber	String	phone number
result.user.email	String	email
result.addresses	Array	List of addresses associated with phone number
result.addresses[n].addressType	String	address type. example:- home,work etc.
result.addresses[n].zip	String	area pincode
result.addresses[n].country	String	country
result.addresses[n].countryCode	String	country code
result.addresses[n].city	String	city
result.addresses[n].phone	String	address phone number
result.addresses[n].address2	String	2nd address
result.addresses[n].address1	String	1st address
result.addresses[n].name	String	full name
result.addresses[n].state	String	state
result.addresses[n].type	String	type of address
result.addresses[n].stateCode	String	state code
result.addresses[n].email	String	email
status	String	status message
statusCode	Number	status code

Status Codes

{
    "sessionId": "1ab00ef1-7c37-4304-bf79-77e24029f2bf",
    "result": {
        "user": {
            "firstName": null,
            "lastName": null,
            "phoneNumber": "+919691066329",
            "email": null
        },
        "addresses": [
            {
                "addressType": null,
                "zip": "560068",
                "country": "India",
                "countryCode": null,
                "city": "",
                "phone": "+919691066329",
                "address2": null,
                "address1": "BTM layout 1st stage",
                "name": "Prashant  Beck",
                "state": "Karnataka",
                "type": null,
                "stateCode": null,
                "email": "[email protected]"
            }
        ]
    },
    "status": "OTP is verified",
    "statusCode": 200
}