User Operations API Documentation

This document explains how to complete the following tasks:

• Register new users within the Swiftramp ecosystem.
• Retrieve detailed information for specific users or paginated lists.
• Manage user KYC verification and bank account linking.
• Understand the lifecycle of a user from creation to transaction readiness.

Required Roles

To manage users, ensure your client account is in an active state and you use a valid access_token in the Authorization header for all requests.

User Management

Once a merchant is registered with Swiftramp, every user belonging to the merchant must also be registered to process transactions. This forms the foundation of all Swiftramp operations, including on-ramp and off-ramp services.

Create User

Description: Establishes a new user profile within the Swiftramp system. A user wallet is automatically created upon registration for off-ramp purposes.

Request Body Payload

cURL Command

curl --request POST \
  --url https://api.swiftramp.in/v1/user \
  --header 'Authorization: Bearer [ACCESS_TOKEN]' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "new_user@swiftramp.in",
  "mobile": "9876543210"
}'

Response Payload

Get User by ID

Description: Retrieves specific information for a single user using their unique user_id.

cURL Command

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

Success Response (200 OK)

{
  "status": true,
  "code": 200,
  "message": "User found",
  "data": {
    "user_id": "e6ee0af8-c1e2-471f-9a51-fb26bd7621c8",
    "client_id": "e513739a-5231-4538-a818-ea2b8a1a2bc0",
    "user_type": "individual",
    "email": "sachin@swiftramp.in",
    "mobile": "9876543211",
    "created_at": "2025-07-07T07:14:27.683Z",
    "updated_at": "2025-07-07T07:19:45.151Z"
  }
}

List All Users

Description: Retrieves a paginated list of all users associated with the merchant.

Query Parameters

cURL Command

curl --request GET \
  --url https://api.swiftramp.in/v1/users?page=1 \
  --header 'Authorization: Bearer [ACCESS_TOKEN]'

Add Bank Account (Indian Banks Only)

Description: For off-ramp services, Indian users must link a bank account. This is mandatory post-KYC for processing payouts.

Request Body Payload

cURL Command

curl --request POST \
  --url https://api.swiftramp.in/v1/bank \
  --header 'Authorization: Bearer [ACCESS_TOKEN]' \
  --header 'Content-Type: application/json' \
  --data '{
    "user_id": "78e4b4b8-0cf6-40a0-9444-4f2ecf8571d3",
    "account_number": "23423423234223",
    "ifsc_code": "SBIN0001234"
}'

Enums and Constants

User Type

Compliance Requirements

• 💡 KYC Approval: Only KYC-approved users can perform on-ramp and off-ramp operations.
• 💡 Bank Linking: For Indian users, adding a valid bank account is mandatory for off-ramp transactions.
• 💡 Wallet Creation: A user wallet is automatically provisioned upon successful registration.

Summary of Operations

• 💡 Always ensure the Authorization header contains a fresh Bearer token.
• 💡 For detailed error codes, refer to the global Error Handling guide.