Get API keys
The method allows you to get user's API keys
Request:
Parameter
Required
Type
Description
userId
Yes
String
User ID
limit
Yes
Number
Limit on the number of keys in the response
offset
Yes
Number
Offset (for pagination)
Response:
Parameter
Type
Description
keys
Array of objects
Массив объектов API ключей
total
Number
Общей количество API ключей пользователя
The keys
parameter is an array of the following objects:
Parameter
Type
Description
id
String
Api key ID
public
String
Public key
secret
String
Secret key
alias
String
Alias
createdAt
String
Creation date
Header parameters
x-api-public-keystringOptional
Public API-key
x-api-signaturestringOptional
Signing the request body with a private API-key
Content-typestringOptionalExample:
Request content type
application/json
Body
The body of the api key receipt request
userIdstringOptionalExample:
User ID
ed83d19f-30ef-4b3f-bca9-edd2c7714b16
limitintegerOptional
Number of elements per page
offsetintegerOptional
Number of items to skip
Responses
200Success
application/json
post
POST /partner/api/get-api-keys HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 70
{
"userId": "ed83d19f-30ef-4b3f-bca9-edd2c7714b16",
"limit": 1,
"offset": 1
}
200Success
{
"success": true,
"response": {
"keys": [
{
"id": "fdcedae3-b06a-4c9f-be0e-0933b476f98d",
"public": "QoK/3fZY8QK68z3DFvwcTgN4LSTDa8pi6rUNbGQfM4EgKCyt9whSFkbIQOFIAsGKlCZlCE1gyvi0Q6vf77KHKw==",
"secret": "TLS9BLlNCOHTlAEhHGsl8P77gkaUleEnnJv3r4oL2n8owM8c33ALZCaVe3cBq4HEkGm+Tx1rNI6CPUXc8r7fBg==",
"alias": "Integration key",
"createdAt": "2025-06-09T13:18:11.467Z"
}
],
"total": 1
}
}
Last updated