Api DocumentationProfile

Client Operations API

This document explains how to complete the following tasks:

  • Retrieve the profile details of the authenticated client.
  • View client-specific configurations and verification status.
  • Access account metadata including creation and update timestamps.

Required Roles

To get the permissions that you need to access the client profile, ensure your account is in an active state and you have a valid access_token provided in the Authorization header.

Client Operations

This section provides details on how to retrieve and manage client profile information.

Get Client Profile

Retrieves the profile information for the authenticated client using a valid access token.

Request Body Payload

Property NameTypeMandatoryLength/LimitDescription
(None)N/ANo-This endpoint does not require a request body.

cURL Command

curl --request GET \
  --url https://api.swiftramp.in/v1/client/profile \
  --header 'Authorization: Bearer [ACCESS_TOKEN]'

Response Payload

Property NameTypeDescription
statusbooleanIndicates if the request was successful.
codeintegerHTTP status code.
messagestringHuman-readable response message.
dataobjectContains detailed profile information of the client.

Enums and Constants

Client Status

ValueDescription
activeAccount is fully functional and verified.
inactiveAccount is created but requires further action or verification.
suspendedAccount access has been temporarily revoked due to policy violations.
deletedAccount has been permanently removed from the system.

KYC Requirement

ValueDescription
trueKYC verification is mandatory for the client.
falseKYC verification is currently not required.

Success Response (200 OK)

{
  "status": true,
  "code": 200,
  "message": "Client fetched successfully!",
  "data": {
    "client_id": "b7d8f3a0-50cb-4a23-9b85-85962d56a3cc",
    "email": "example@swiftramp.in",
    "email_verified": true,
    "name": "test",
    "status": "active",
    "check_kyc": false,
    "created_at": "2025-05-17T06:11:16.683Z",
    "updated_at": "2025-05-17T06:11:16.683Z",
    "ClientConfigurations": []
  }
}

Error Responses (401 Unauthorized)

Invalid or Missing Token

{
  "status": false,
  "code": 401,
  "message": "Unauthorized access",
  "data": {}
}
  • 💡 In the cURL example above, ensure you replace [ACCESS_TOKEN] with the JWT access token obtained from the login endpoint.
  • 💡 The ClientConfigurations field provides insight into specific features or limits enabled for your account.
LoginUser