v31

latestOpenAPI 3.0.1MITraw.githubusercontent.com2026-07-082421122.2 KB
User

Get user profile

Returns an exhaustive user profile detail

get/user

Response

User response

statusstring string

Example response

{
  "status": "ok",
  "data": {
    "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
    "name": "John Doe",
    "email": "johndoe@email.com",
    "phone": "+2348123456789",
    "businessName": "John Doe Enterprises",
    "emailVerified": true,
    "kycInfo": {
      "address": "3 Opebi Road, Ikeja, Lagos",
      "phone": "+2348123456789",
      "nationality": "Nigeria",
      "businessName": "John Doe Enterprises"
    },
    "account": {
      "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
      "walletDetails": {
        "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
        "bankAccount": {
          "bankName": "KUDA MICROFINANCE BANK",
          "bankCode": "090267",
          "bankAccountNumber": "0123456789",
          "bankAccountName": "Satoshi Nakamoto",
          "walletId": "d1614a76-9c7f-4111-98a7-43199f307e5b-123456789"
        },
        "transactions": [
          {
            "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
            "walletId": "d1614a76-9c7f-4111-98a7-43199f307e5b",
            "ref": "99eeff854ffd345fffs67890",
            "hash": "189727ef2e0f35921af7858b96e27cbad960b0ec2bb2a4ab73b6a231f9ce8727",
            "amount": 1000,
            "autopayout": true,
            "createdAt": "2021-07-01T12:00:00Z",
            "updatedAt": "2021-07-01T12:00:00Z",
            "metadata": {
              "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
              "orderId": "99854-2345",
              "bankCode": "090267",
              "bankAccountName": "Satoshi Nakamoto",
              "bankAccountNumber": "0123456789",
              "createdAt": "2021-07-01T12:00:00Z",
              "updatedAt": "2021-07-01T12:00:00Z"
            }
          }
        ]
      },
      "ownerId": "d1614a76-9c7f-4111-98a7-43199f307e5b",
      "apiKey": "d1614a76411198a743199f307e5b",
      "totalSatsExchanged": 1000,
      "webhook": {
        "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
        "url": "https://webhook.site/12345678-1234-1234-1234-123456789012",
        "secret": "secret",
        "isActive": true
      },
      "settings": {
        "id": "d1614a76-9c7f-4111-98a7-43199f307e5b",
        "autopayout": true,
        "notification": {
          "email": true,
          "sms": true
        }
      }
    }
  }
}