Delete Stamp

Endpoint Overview

POST /api/v1/stamper/delete-stamp

Description

This endpoint allows you to delete a stamp associated with a specific client in the Surepass system. Stamps are digital verification markers that indicate a client has completed certain verification processes. Deleting a stamp removes this verification marker from the client's profile, which may be necessary when verification data needs to be refreshed or when a client requests removal of their verification data.

Key Benefits

Maintain data hygiene by removing outdated verification stamps

Support compliance with data deletion requests from clients

Enable re-verification workflows when client information changes

Simplify user management by removing unnecessary verification markers

Use Cases

Financial Services

Healthcare

Digital Platforms

Remove verification stamps when a customer's KYC information needs to be re-verified

Delete stamps for accounts that have been dormant for an extended period

Support customer requests for data deletion as part of privacy compliance

Technical Implementation

Authentication

All API requests require authentication using a JWT Bearer token. Authentication follows these steps:

Obtain API Credentials: Register with Surepass to receive your API key.

Generate JWT Token: Use your API key to generate a JWT token.

Include in Requests: Add the token to the Authorization header as Bearer TOKEN.

Different authentication tokens are used for sandbox and production environments:

Sandbox: https://sandbox.surepass.io

Production: https://kyc-api.surepass.io

Request Parameters

Request Headers

Header	Required	Description
Authorization	Yes	Bearer token authentication using JWT token
Content-Type	Yes	Must be set to `application/json`

Request Body

Parameter	Type	Required	Description
client_id	String	Yes	The unique identifier of the client whose stamp needs to be deleted

Example Request

{
    "client_id": "stamp_ggkpcWhflwzxeqvOueyT"
}

Process Response

Response Parameters

Parameter	Type	Description
data	Object	Contains the details of the deleted stamp
data.client_id	String	The client ID associated with the deleted stamp
data.stamp_id	String	The unique identifier of the deleted stamp
data.deleted	Boolean	Indicates whether the stamp was successfully deleted
status_code	Integer	HTTP status code of the response
success	Boolean	Indicates whether the API call was successful
message	String	Human-readable description of the response
message_code	String	Machine-readable code representing the response message

Example Successful Response

{
    "data": {
        "client_id": "stamp_ggkpcWhflwzxeqvOueyT",
        "stamp_id": "stamp_ggkpcWhflwzxeqvOueyT",
        "deleted": true
    },
    "status_code": 200,
    "success": true,
    "message": "Success",
    "message_code": "success"
}

Possible Error Responses

Client Not Found

Authentication Error

{
    "data": null,
    "status_code": 404,
    "success": false,
    "message": "Client not found",
    "message_code": "client_not_found"
}

This error occurs when the provided client_id does not exist in the system.

Integration Best Practices

Security Recommendations

Store JWT tokens securely and never expose them in client-side code

Implement proper error handling to avoid exposing sensitive information

Maintain an audit log of all stamp deletion operations for compliance purposes

Implement confirmation steps before deleting stamps to prevent accidental deletions

User Experience Guidelines

Inform users when their verification stamp has been deleted

Provide clear instructions on how to re-verify if needed

Implement a confirmation step before initiating stamp deletion

Include appropriate status messages in your application when stamps are deleted

Code Samples

cURL

Python

Node.js

Related APIs

Create Stamp - Creates a new verification stamp for a client

Get Stamp - Retrieves details of an existing stamp

Update Stamp - Updates information associated with an existing stamp

List Stamps - Retrieves a list of all stamps associated with your account

Compliance and Legal Considerations

When deleting stamps, ensure you comply with relevant data protection regulations such as GDPR or CCPA. Maintain appropriate records of deletion requests and confirmations. Some industries may require you to maintain verification records for a minimum period before deletion is permitted. Consult your legal team to ensure compliance with industry-specific regulations.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

curl --location --request POST 'https://kyc-api.surepass.app/api/v1/stamper/delete-stamp' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "client_id": "{{stamp_client_id}}" }'

{ "data": { "client_id": "stamp_ggkpcWhflwzxeqvOueyT", "stamp_id": "stamp_ggkpcWhflwzxeqvOueyT", "deleted": true }, "status_code": 200, "success": true, "message": "Success", "message_code": "success" }

Delete Stamp

Delete Stamp#

Description#

Use Cases#

Technical Implementation#

Request Headers#

Request Body#

Example Request#

Response Parameters#

Example Successful Response#

Possible Error Responses#

Integration Best Practices#

Code Samples#

Request

Responses

Delete Stamp

Description

Use Cases

Technical Implementation

Request Headers

Request Body

Example Request

Response Parameters

Example Successful Response

Possible Error Responses

Integration Best Practices

Code Samples