GET
/
security
/
apiKeys
/
get
cURL
curl -X GET "https://api.onekhusa.com/sandbox/v1/security/apiKeys/get?merchantAccountNumber=35253486&clientKey=23" \
  --header "Authorization: Bearer your-jwt-token" \
  --header "accept: application/json" \
  --header "X-Organisation-Id: FYH0NTVW0DXK" \
  --header "X-Merchant-Account-Number: 35253486" \
  --header "Accept-Language: en"
{
  "organisationId": "FYH0NTVW0DXK",
  "merchantAccountNumber": 35253486,
  "clientKey": "abcdefghijklmnopqrstuvwxyz1234",
  "clientSecret": "abcdefghijklmnopqrstuvwxyz1234",
  "createdBy": "user@example.com",
  "statusCode": "A",
  "statusName": "Active",
  "dateCreated": "2025-11-13T06:08:37.217Z",
  "modifiedBy": "admin@example.com",
  "dateModified": "2025-11-13T06:08:37.217Z"
}

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 merchant account

Example:

35253486

ā€‹
clientId
integer
required

The unique identifier of the client API key to retrieve

Example:

23

Response

200 - application/json

Success - Client API key details retrieved

Detailed information about a client API key

ā€‹
clientId
integer
required

The unique identifier of the client API key

Example:

23

ā€‹
organisationId
string
required

The unique identifier of the organisation

Example:

"FYH0NTVW0DXK"

ā€‹
merchantAccountNumber
integer
required

The unique identifier of the merchant account

Example:

35253486

ā€‹
clientKey
string
required

The client API key (typically 30 characters)

Example:

"abcdefghijklmnopqrstuvwxyz1234"

ā€‹
capturedBy
string
required

The username or identifier of the user who created the API key

Example:

"Jdoe"

ā€‹
statusCode
string
required

The status code of the API key (e.g., "A" for Active, "I" for Inactive)

Example:

"A"

ā€‹
statusName
string
required

The human-readable status name of the API key

Example:

"Active"

ā€‹
dateCaptured
string<date-time>
required

The date and time when the API key was created in UTC format

Example:

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

ā€‹
clientSecret
string | null

The client API secret (typically 45 characters). Note: This field may be null or empty as secrets are not typically returned for security reasons

Example:

null

ā€‹
expiryDate
string<date-time> | null

The expiration date and time for the API key in UTC format (ISO 8601). Note: This field may be null if expiry is not set

Example:

null

ā€‹
modifiedBy
string | null

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

Example:

null

ā€‹
dateModified
string<date-time> | null

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

Example:

null