NEnestechops
users-users
users-onboardapi

Get a single user by their authorization token

Changed on
get/users/me

Request

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

  • a3c4e2742615Revision changes
    • info

      the endpoint scheme security HMACAuth was added to the API

    • info

      the endpoint scheme security authToken was removed from the API

  • fc790ea4deb6Revision changes
    • warning

      added the new AWAITING_INPUT enum value to the response property for the response status

    • warning

      added the new FAILED_VERIFICATION enum value to the response property for the response status

    • warning

      added the new IN_PROGRESS enum value to the response property for the response status

    • warning

      added the new REVIEW_REQUIRED enum value to the response property for the response status

    • warning

      added the new UNVERIFIED enum value to the response property for the response status

    • warning

      added the new VERIFICATION_TIMEOUT enum value to the response property for the response status

    • warning

      added the new VERIFIED enum value to the response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status