Create API key

The method allows you to create an API key for the user

Request:

Parameter

Required

Type

Description

userId

Yes

String

User ID

alias

Yes

String

Alias

Response:

Parameter

Type

Description

id

String

Api key ID

public

String

Public key

secret

String

Secret key

alias

String

Alias

createdAt

String

Creation date

Create API key

post
Header parameters
x-api-public-keystringOptional

Public API-key

x-api-signaturestringOptional

Signing the request body with a private API-key

Content-typestringOptional

Request content type

Example: application/json
Body

The body of the api key creation request

userIdstringRequired

User ID

Example: ed83d19f-30ef-4b3f-bca9-edd2c7714b16
organizationIdstringRequired

Organization ID

Example: a61799b2-cd0c-47fd-a7f0-216b2be184c7
aliasstringRequired

API key name

Example: Integration key
Responses
200Success
application/json
post
POST /partner/api/create-api-keys HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 131

{
  "userId": "ed83d19f-30ef-4b3f-bca9-edd2c7714b16",
  "organizationId": "a61799b2-cd0c-47fd-a7f0-216b2be184c7",
  "alias": "Integration key"
}
200Success
{
  "success": true,
  "response": {
    "id": "fdcedae3-b06a-4c9f-be0e-0933b476f98d",
    "public": "QoK/3fZY8QK68z3DFvwcTgN4LSTDa8pi6rUNbGQfM4EgKCyt9whSFkbIQOFIAsGKlCZlCE1gyvi0Q6vf77KHKw==",
    "secret": "TLS9BLlNCOHTlAEhHGsl8P77gkaUleEnnJv3r4oL2n8owM8c33ALZCaVe3cBq4HEkGm+Tx1rNI6CPUXc8r7fBg==",
    "alias": "Integration key",
    "createdAt": "2025-06-09T13:18:11.467Z"
  }
}

Last updated