Delete Verification Data

4 min

Introduction

The Signzy Patron API provides a simple and secure way to onboard customers and manage their digital identities. This API endpoint allows patrons to delete a previously created individual onboarding request.

Sample cURL

curl --request POST \
  --url https://signzy.tech/api/v2/patrons/....patronid.../individualonboardings \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'Authorization: <Access-Token>' \
  --header 'content-type: application/json' \
  --data '{"task":"deleteRequest","essentials":{"requestId":"...requestId.."}}'

Parameter	Type	Required?	Description
task	String	Yes	The task to be performed by the API. Set to "deleteRequest" to delete an individual onboarding request.
requestId	String	Yes	The ID of the individual onboarding request to be deleted.
essentials	JSON object	Yes	An object that contains the essential data required to perform the task. The object must include the requestId parameter.

Sample API REsponse

{
    "result": {
        "message" : "User with that RequestId is deleted",
        "statusCode" : 200
    }
}

Parameter	Type	Description
message	String	A message that describes the status of the operation. If the operation was successful, the message will be "User with that RequestId is deleted".
statusCode	Integer	The HTTP status code returned by the API. A status code of 200 indicates that the operation was successful.