POST
/
security
/
merchantUsers
/
getMerchantClaims
cURL
curl -X POST "https://api.onekhusa.com/sandbox/v1/security/merchantUsers/getMerchantClaims" \
  --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 '{
    "organisationId": "FYH0NTVW0DXK",
    "merchantAccountNumber": 35253486,
    "userId": "user-id-123"
  }'
[
  {
    "claimType": "MerchantAccountName",
    "claimValue": "Acme Corporation"
  },
  {
    "claimType": "MerchantStatusCode",
    "claimValue": "A"
  },
  {
    "claimType": "LevelNumber",
    "claimValue": "1"
  },
  {
    "claimType": "LevelName",
    "claimValue": "Level 1 Merchant"
  },
  {
    "claimType": "MerchantAccountNumber",
    "claimValue": "35253486"
  },
  {
    "claimType": "OrganisationId",
    "claimValue": "FYH0NTVW0DXK"
  },
  {
    "claimType": "OrganisationTypeCode",
    "claimValue": "MER"
  },
  {
    "claimType": "Role",
    "claimValue": "BO_OPR"
  }
]

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
ā€‹
organisationId
string
required

The unique identifier of the organisation

Example:

"FYH0NTVW0DXK"

ā€‹
merchantAccountNumber
integer
required

The unique identifier of the merchant account. Set to 0 to retrieve claims from login context (returns first active merchant association)

Required range: 0 <= x <= 99999999
Example:

35253486

ā€‹
userId
string
required

The unique identifier of the user

Example:

"user-id-123"

Response

200 - application/json

Success - Merchant user claims retrieved

An array of claim objects containing authorization information

ā€‹
claimType
string
required

The type/category of the claim (e.g., MerchantAccountName, MerchantStatusCode, LevelNumber, LevelName, MerchantAccountNumber, OrganisationId, OrganisationTypeCode, Role, UserRole)

Example:

"MerchantAccountName"

ā€‹
claimValue
string
required

The value of the claim

Example:

"Acme Corporation"