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

Get API keys

post

/partner/api/get-api-keys

Header parameters

x-api-public-keystring

Public API-key

x-api-signaturestring

Signing the request body with a private API-key

Content-typestring

Request content type

Example: application/json

Body

userIdstring

User ID

Example: 7376bfd8-2e53-4832-8445-50095093b5c2

limitinteger

Number of elements per page

offsetinteger

Number of items to skip

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://ocp.onchainpay.io/partner/api/get-api-keys' \
  --header 'Content-Type: application/json' \
  --data '{"userId":"7376bfd8-2e53-4832-8445-50095093b5c2"}'

200

200

{
  "success": true,
  "response": {
    "total": 1,
    "keys": [
      {
        "id": "8907ff05-5491-4eaa-9eb3-a8e5e111a1fd",
        "public": "QoK/3fZY8QK68z3DFvwcTgN4LSTDa8pi6rUNbGQfM4EgKCyt9whSFkbIQOFIAsGKlCZlCE1gyvi0Q6vf77KHKw==",
        "secret": "TLS9BLlNCOHTlAEhHGsl8P77gkaUleEnnJv3r4oL2n8owM8c33ALZCaVe3cBq4HEkGm+Tx1rNI6CPUXc8r7fBg==",
        "alias": "Integration key",
        "createdAt": "2024-12-26T08:21:33.130Z"
      }
    ]
  }
}