Skip to main content

Delete User Details API

Overview​

Remove a user account from the system. This action permanently deletes the user and all associated data.

API Details​

Endpoint​

DELETE https://api.gafapay.com:8443/gafapay/v3/user/user_detail/{user_id}

Path Parameters​

  • user_id (String, required): The unique identifier of the user to delete
    • Format: User ID string
    • Example: 6f1b82443e524459831de59d430a0c41

Headers​

authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJlNDk0Njg3N2YxODk0NmIyOTlmZGRmMGYyMTMzZGNiYSIsInJvbGVzIjpbIlJPTEVfQURNSU4iXSwiZXhwIjoxNzU3MDA3NDEyfQ.ph7qKBEzuHxgljV3141L9iOrWmHI4TnyoknBSNoVYYU
companyid: 59388167894b4d10a04fe5da3b8a2104
requestid: be08f79e-7eac-40e1-acbe-00f6ae7b8f7b

Request Body​

No request body is required for DELETE operations.

Response​

{
    "success": 1,
    "error": [],
    "data": {
        "message": "USER_REMOVE_USER_DETAIL_SUCCESSFULLY"
    }
}

Response Fields​

  • success (integer): Response status indicator
    • 1 = Success
    • 0 = Failure
  • error (array): Array of error messages (empty on success)
  • data (object): Response data object
    • message (string): Success message indicating user was successfully removed

Example Usage​

curl --location --request DELETE 'https://api.gafapay.com:8443/gafapay/v3/user/user_detail/6f1b82443e524459831de59d430a0c41' \
--header 'authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJlNDk0Njg3N2YxODk0NmIyOTlmZGRmMGYyMTMzZGNiYSIsInJvbGVzIjpbIlJPTEVfQURNSU4iXSwiZXhwIjoxNzU3MDA3NDEyfQ.ph7qKBEzuHxgljV3141L9iOrWmHI4TnyoknBSNoVYYU' \
--header 'companyid: 59388167894b4d10a04fe5da3b8a2104' \
--header 'requestid: be08f79e-7eac-40e1-acbe-00f6ae7b8f7b'

Notes​

  • This action is irreversible - deleted users cannot be recovered
  • All user data including profile information, PINs, and account details will be permanently removed
  • The user's account number and user code will no longer be valid
  • Associated transactions and KYC data may be affected
  • Only users with appropriate permissions can delete user accounts
  • Consider using status updates (e.g., USER_STATUS_SUSPENDED or USER_STATUS_BLOCKED) instead of deletion for temporary deactivation
  • All deletion actions are logged for audit and compliance purposes
  • Verify the user ID carefully before executing the delete operation