Generate OTP

Introduction

The API generates OTP to validate consent to fetch address of the registered phone number by accepting phone number as an input parameter and creates a session for user to further process the request against the sessionId generated.

Sample cURL

curl --location 'https://api.signzy.app/api/v3/phones/phone-address-generate-otp' \
--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:

{
    "sessionId": "44f7664b-2b83-46a4-91a2-81510917e463",
    "status": "OTP generated",
    "statusCode": 201
}

Output Parameters:

Key	Type	Description
sessionId	String	UUID generated to verify consent and fetch address details.
status	String	Status message
statusCode	Number	status code 201 on otp generation, 200 on otp bypass.

Status Codes

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