Sign in
users-users
users-onboardapi

Get a single user by their authorization token

get/users/me

Response

Success

userIdstring required

the user ID

emailstring required

User's email

namestring

Name of customer

phoneNumberstring

User phone number

phoneNumberVerifiedboolean

flag indicating if user has verified their phone number

fullNamestring

user's kyc fullname

referralLinkstring

referral link

referralCodestring

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

userType'CUSTOMER' | 'PARTNER'

the type of the user

rolesUserRoles[]
isCustomerboolean
isMerchantboolean
isOnboardWalletUserboolean

flag indicating if user is an Onboard wallet user or not. i.e user has made use of/sign in using Onboard wallet before.

isOpnMerchantboolean

Indicates if the merchant has been provisioned for OPN

isMerchantNetworkboolean
kycStatus'VERIFIED' | 'UNVERIFIED' | 'IN_PROGRESS' | 'AWAITING_INPUT' | 'FAILED_VERIFICATION' | 'REVIEW_REQUIRED' | 'VERIFICATION_TIMEOUT'
kycRetryCountnumber

The number of kyc retries

kycRetryLimitnumber

kyc retry limit

includesobject
supportedCurrenciesstring[]
languagestring

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

availabilityboolean
activeboolean
countrystring
verifiedAddressstring

Wallet Address connected to user's account.

authSourcestring

specifies the user's wallet source

createdAtstring date-time

Timestamp field.

lastActiveAtstring date-time

Timestamp field.

isTotpSetupboolean
totpSetupAtstring date-time

Timestamp field.

verifiedPhoneNumberLastUpdatedAtstring date-time

Timestamp field.

Example response

{
  "phoneNumber": "2348100000000",
  "language": "en, en-US, fr-FR, pt-BR",
  "verifiedAddress": "0x15b8b00fb8d2bd7d76e90e70294e87fc6ba79e3b",
  "profile": {
    "country": "NG",
    "dob": "2024-04-18T00:00:00.000Z",
    "depositTimeout": 1200,
    "approvalTimeout": 1200
  }
}

Changes

Changed in 1 of the 6 revisions of this API.2

  • a3c4e27426152See the full diff
    • ○

      the endpoint scheme security HMACAuth was added to the API

      api-security-added

    • ○

      the endpoint scheme security authToken was removed from the API

      api-security-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog