GET
/
users
/
me
Get a single user by their authorization token
curl --request GET \
  --url https://external.dev.onboardpay.co/users/me \
  --header 'x-auth-token: <api-key>'
{
  "userId": "<string>",
  "email": "<string>",
  "name": "<string>",
  "phoneNumber": "2348100000000",
  "phoneNumberVerified": true,
  "fullName": "<string>",
  "referralLink": "<string>",
  "referralCode": "<string>",
  "userType": "CUSTOMER",
  "roles": [
    "CUSTOMER"
  ],
  "isCustomer": true,
  "isMerchant": true,
  "isOpnMerchant": true,
  "isMerchantNetwork": true,
  "kycStatus": "VERIFIED",
  "kycRetryCount": 123,
  "kycRetryLimit": 123,
  "kycNameHistory": [
    {
      "reason": "<string>",
      "actor": "<string>",
      "previousName": "<string>",
      "currentName": "<string>",
      "evidenceUrl": "<string>",
      "timestamp": "2023-11-07T05:31:56Z"
    }
  ],
  "comments": [
    {
      "comment": "<string>",
      "addedBy": "<string>"
    }
  ],
  "includes": {},
  "supportedCurrencies": [
    "<string>"
  ],
  "language": "en, en-US, fr-FR, pt-BR",
  "availability": true,
  "active": true,
  "country": "<string>",
  "verifiedAddress": "0x15b8b00fb8d2bd7d76e90e70294e87fc6ba79e3b",
  "profile": {
    "status": "VERIFIED",
    "fullname": "<string>",
    "country": "NG",
    "dob": "2024-04-18T00:00:00.000Z",
    "displayName": "<string>",
    "proofOfAddress": "<string>",
    "hasBusinessBankAccount": true,
    "businessName": "<string>",
    "certificateOfIncorporation": "<string>",
    "hasShareHolderList": true,
    "userInShareHolderList": true,
    "noShareHolderListEvidence": "<string>",
    "useOfBusinessAccountApprovedByShareholders": true,
    "noOfLegalDirectors": 123,
    "regulatoryIdsOfDirectors": [
      "<string>"
    ],
    "depositTimeout": 1200,
    "approvalTimeout": 1200,
    "tradeHistoryDetails": {
      "hasPreviousTradeHistory": true,
      "proofOfTrade": [
        "<string>"
      ],
      "referee": "<string>"
    }
  },
  "transactionLimit": {
    "dailyTransactionLimit": 123,
    "maxSingleTransactionLimit": 123,
    "minSingleTransactionLimit": 123,
    "maxLifetimeLimit": 123
  },
  "authSource": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "lastActiveAt": "2023-11-07T05:31:56Z",
  "isTotpSetup": true,
  "totpSetupAt": "2023-11-07T05:31:56Z",
  "verifiedPhoneNumberLastUpdatedAt": "2023-11-07T05:31:56Z"
}
Fetches the profile of the currently authenticated user, including their account details and KYC status.

Authorizations

x-auth-token
string
header
required

Response

Success

userId
string
required

the user ID

email
string
required

User's email

name
string

Name of customer

phoneNumber
string

User phone number

Example:

"2348100000000"

phoneNumberVerified
boolean

flag indicating if user has verified their phone number

fullName
string

user's kyc fullname

referral link

referralCode
string

referral code generated for this user. Also known as onboard pass

userType
enum<string>

the type of the user

Available options:
CUSTOMER,
PARTNER
roles
enum<string>[]
isCustomer
boolean
isMerchant
boolean
isOpnMerchant
boolean

Indicates if the merchant has been provisioned for OPN

isMerchantNetwork
boolean
kycStatus
enum<string>
Available options:
VERIFIED,
UNVERIFIED,
IN_PROGRESS,
AWAITING_INPUT,
FAILED_VERIFICATION,
REVIEW_REQUIRED,
VERIFICATION_TIMEOUT
kycRetryCount
number

The number of kyc retries

kycRetryLimit
number

kyc retry limit

kycNameHistory
object[]

History of name change

comments
object[]
includes
object
supportedCurrencies
string[]
language
string

Language preference (preferred or detected). Can be just language (en) or locale (en-GB). See samples

Example:

"en, en-US, fr-FR, pt-BR"

availability
boolean
active
boolean
country
string
verifiedAddress
string

Wallet Address connected to user's account.

Example:

"0x15b8b00fb8d2bd7d76e90e70294e87fc6ba79e3b"

profile
object
transactionLimit
object
authSource
string

specifies the user's wallet source

createdAt
string<date-time>

Timestamp field.

lastActiveAt
string<date-time>

Timestamp field.

isTotpSetup
boolean
totpSetupAt
string<date-time>

Timestamp field.

verifiedPhoneNumberLastUpdatedAt
string<date-time>

Timestamp field.