MPC-TSS
Operations
PIN
Check Wallet's PIN Status

Check Wallet's PIN Status

API Documentation: Check Wallet's PIN Status

Overview

This API endpoint allows you to check if a wallet has a PIN set.

  • HTTP Method: GET
  • Endpoint: /api/v1/wallet/{walletId}/check-pin

Request Path Parameters

  • walletId (required): mandatory.

Request

Request Headers

  • X-CLIENT-ID: (required): Client ID which was generated when register in Xellar TSS API Service Dashboard.
  • X-SIGNATURE: (required): Calculated signature, please refer to Authorization section.
  • X-TIMESTAMP: (required): Request timestamp in RFC3339 format.

Example Request Syntax

curl -X GET -H "Content-Type: application/json" -H "x-client-id: $YOUR_CLIENT_ID" -H "x-client-secret: $YOUR_CLIENT_SECRET" <BASE_URL>/api/v1/wallet/{walletId}/check-pin

Response

The response will include a JSON object with the following properties:

  • status (number): The HTTP status code of the response (e.g., 200 for success).
  • message (string): A message providing additional information about the operation.
  • data (object): An object containing the account information.
  • data.isPinSet (boolean): Indicates whether the wallet has a PIN set.

Example Response

{
    "status": 200,
    "message": "Check PIN successfully",
    "data": {
        "isPinSet": false
    }
}