Delete Token API

7 min

Introduction

This API from signzy is used to delete the token (requestId) generated using the Create URL API.

How to call the API

You will need to login before sending request. You are required to pass the access token received from the login call, as authorization header in the Delete Token API request.

API Input Guidelines

You need to provide the requestId recieved from the create URL API.

Sample Curl

Preproduction

Production

curl --location --request POST 'https://preproduction.signzy.tech/api/v2/patrons/..patronID../digilockers' \
--header 'Authorization: .....' \
--header 'Content-Type: application/json' \
--data-raw '{
       "task" : "deleteToken",
       "essentials" : {
            "requestId" : "...requestId..."
       }

curl --location --request POST 'https://signzy.tech/api/v2/patrons/..patronID../digilockers' \
--header 'Authorization: .....' \
--header 'Content-Type: application/json' \
--data-raw '{
       "task" : "deleteToken",
       "essentials" : {
            "requestId" : "...requestId..."
       }

Input Parameters

Parameter Name	Required/Optional	Description
Authorization	Required	Contains the id parameter returned from the login step
Content-Type	Required	application/json
task	Required	Type of Tasks to be performed in Signzy System, eg: URL , GetData
essentials	Required	This parameter contains the essential data for generating output
essentials.requestId	Required	This parameter contains the requestId generated from

Sample Response

{
"essentials": {
"requestId": "..< Request id>.."
},
"id": "..<token>..",
"patronId": "..<patron id>..",
"task": "deleteToken",
"result": {
"status": "SUCCESS"
}
}

Response Parameter

Parameter Name	Description
essentials	This parameter contains the essential data for generating output
essentials.requestId	This parameter contains the requestId generated from create URL API
id	Unique id of the response
patronId	Unique patron id generated from the login
task	Type of Tasks to be performed in Signzy System, eg: URL , GetData Required Type of Tasks to be performed in Signzy System, eg: URL , GetData
result	This parameter contains the actual response
result.status	This parameter contains the status of the result (i.e success/failed)

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