Check Address Availability

Introduction

This API checks the availability of address for a phone number. This API is particularly useful to check the address availability before requesting to fetch address.

Sample cURL

curl --location 'https://api-preproduction.signzy.app/api/v3/phones/phone-address-check' \
--header 'Content-Type: application/json' \
--header 'Authorization: ******' \
--data '{
    "phoneNumber":"9691066329"
}'

Input Parameters:

Parameter	Type	Description	Mandatory/Optional
phoneNumber	String	Phone Number of the Individual	Mandatory

Sample Response:

{
    "success": true,
    "data": {
        "addressAvailable": true
    },
    "status": "Address available",
    "statusCode": 200
}

Output Parameters:

Key	Type	Description
success	Boolean	Indicates the success status of request
data	Object	Contains address availability information
data.addressAvailable	Boolean	True if Address is available for a phone number
status	String	Status message
statusCode	Number	status code

Status Codes:

{
    "success": true,
    "data": {
        "addressAvailable": true
    },
    "status": "Address available",
    "statusCode": 200
}