GET
/
security
/
merchantUsers
/
get
cURL
curl -X POST "https://api.onekhusa.com/sandbox/v1/security/merchantUsers/get" \
  --header "Authorization: Bearer your-jwt-token" \
  --header "Content-Type: application/json" \
  --header "X-Organisation-Id: FYH0NTVW0DXK" \
  --header "X-Merchant-Account-Number: 35253486" \
  --header "Accept-Language: en" \
  -d '{
    "userId": 8,
    "merchantAccountNumber": 35253486
  }'
{
  "userId": "user-id-123",
  "firstName": "John",
  "lastName": "Phiri",
  "emailAddress": "john.phiri@example.com",
  "phoneNumber": "0881234567",
  "isEmailConfirmed": true,
  "roleName": "Merchant Administrator",
  "statusCode": "A",
  "statusName": "Active",
  "capturedBy": "admin@example.com",
  "dateCaptured": "2025-11-13T07:11:09.746Z",
  "modifiedBy": "admin@example.com",
  "dateModified": "2025-11-13T07:11:09.746Z"
}

Authorizations

ā€‹
Authorization
string
header
required

Bearer authentication header of the form Bearer <Token>, where <Token> is your access token.

Headers

ā€‹
X-Organisation-Id
string
required

The organization identifier

ā€‹
X-Merchant-Account-Number
string
required

The merchant account number

ā€‹
Accept-Language
string
default:en

Preferred language for the response

Body

application/json
ā€‹
merchantAccountNumber
integer
required

The unique identifier of the merchant account

Example:

35253486

ā€‹
userId
string
required

The unique identifier of the user to retrieve

Example:

"8"

Response

200 - application/json

Success - Merchant user details retrieved

ā€‹
userId
string

The unique identifier of the user

Example:

"user-id-123"

ā€‹
firstName
string

The first name of the user

Example:

"John"

ā€‹
lastName
string

The last name of the user

Example:

"Phiri"

ā€‹
emailAddress
string<email>

The email address of the user

Example:

"john.phiri@example.com"

ā€‹
phoneNumber
string

The phone number of the user. May be an empty string if not set

Example:

"1234567890"

ā€‹
isEmailConfirmed
boolean

Indicates whether the user's email address has been confirmed

Example:

true

ā€‹
roleName
string

The human-readable description of the user's role

Example:

"Merchant Administrator"

ā€‹
statusCode
string

The status code of the merchant user account (e.g., "A" for Active, "I" for Inactive, "C" for Closed)

Example:

"A"

ā€‹
statusName
string

The human-readable status name of the merchant user account

Example:

"Active"

ā€‹
capturedBy
string

The username or identifier of the user who created this merchant user association

Example:

"JohnDoe"

ā€‹
dateCaptured
string<date-time>

The date and time when the merchant user association was created in UTC format

Example:

"2025-11-01T10:30:00.000Z"

ā€‹
modifiedBy
string

The username or identifier of the user who last modified the merchant user. May be null or empty if never modified

Example:

"JohnDoe"

ā€‹
dateModified
string<date-time>

The date and time when the merchant user was last modified in UTC format. May be null if never modified

Example:

"2025-11-03T09:15:00.000Z"