Generate OTP API

7 min

Introduction

An OTP is required to fetch the vaccination certificate from the server . This API is used to generate the OTP and the requestId which will be then used in Vaccination Details API to fetch the vaccination certificate along with other important details.

How to call the API

You will need to login before sending Vaccine Generate OTP API request. You are required to pass the access token received from the login call, as authorization header in the request for Vaccine Generate OTP API along with other parameters.

API Input Guidelines

An OTP will be sent to the registered mobile number.

Sample Curl

Preproduction

Production

curl --location --request POST 'https://preproduction.signzy.tech/api/v2/patrons/..patronId../vaccine' \
--header 'Accept: */*' \
--header 'Accept-Language: en-US,en;q=0.8' \
--header 'Authorization: <token>' \
--header 'content-type: application/json' \
--data-raw '{
    "task": "generateOTP",
    "essentials": {
        "mobileNumber": "<Mobile Number>"
    }
}'

curl --location --request POST 'https://signzy.tech/api/v2/patrons/..patronId../vaccine' \
--header 'Accept: */*' \
--header 'Accept-Language: en-US,en;q=0.8' \
--header 'Authorization: <token>' \
--header 'content-type: application/json' \
--data-raw '{
    "task": "generateOTP",
    "essentials": {
        "mobileNumber": "<Mobile Number>"
    }
}'

Input Parameters

Parameter Name	Required/Optional	Description
Authorization	Required	Authorization token
content-type	Required	application/json
task	Required	Type of task - generateOTP
essentials	Required	Contains the essential output data
essentials.mobileNumber	Required	Registered mobile number of the person

Sample API Response

{
    "essentials": {
        "mobileNumber": " "
    },
    "id": " ",
    "patronId": " ",
    "task": "generateOTP",
    "result": {
        "requestId": " "
    }
}

Response Parameters

Parameter Name	Description
essentials	Contains the essential output data
essentials.mobileNumber	Registered mobile number of the person
id	The unique identifier of the each API calls
patronId	This parameter is returned as userId parameter of login request.
task	Type of task - generateOTP
result	An object that contains result
result.requestId	This token will be used to fetch the certifcate using Vaccination Details API

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].