Create API Keys

Add api keys to an existing User

POST

/

public

/

v1

/

submit

/

create_api_keys

Authorizations

API Key

X-Stamp · string · required

Cryptographically signed (stamped) request to be passed in as a header. For more info, see here.

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_CREATE_API_KEYS_V2

timestampMs · string · required

Timestamp (in milliseconds) of the request, used to verify liveness of user requests.

organizationId · string · required

Unique identifier for a given Organization.

parameters · object · required

The parameters object containing the specific intent data for this activity.

Show details

parameters.apiKeys · array · required

A list of API Keys.

Show item details

parameters.apiKeys.apiKeyName

string

required

Human-readable name for an API Key.

parameters.apiKeys.publicKey

string

required

The public component of a cryptographic key pair used to sign messages and transactions.

parameters.apiKeys.curveType

enum<string>

required

Enum options: API_KEY_CURVE_P256, API_KEY_CURVE_SECP256K1, API_KEY_CURVE_ED25519

parameters.apiKeys.expirationSeconds

string

Optional window (in seconds) indicating how long the API Key should last.

parameters.userId

string

required

Unique identifier for a given User.

Response

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

activity.id

string

required

Unique identifier for a given Activity object.

activity.organizationId

string

required

Unique identifier for a given Organization.

activity.status

string

required

The activity status

activity.type

string

required

The activity type

activity.intent

object

required

The intent of the activity

Show intent details

activity.intent.createApiKeysIntentV2

object

required

The createApiKeysIntentV2 object

Show createApiKeysIntentV2 details

activity.intent.createApiKeysIntentV2.apiKeys

array

required

A list of API Keys.

Show apiKeys details

activity.intent.createApiKeysIntentV2.apiKeys.apiKeyName

string

required

Human-readable name for an API Key.

activity.intent.createApiKeysIntentV2.apiKeys.publicKey

string

required

The public component of a cryptographic key pair used to sign messages and transactions.

activity.intent.createApiKeysIntentV2.apiKeys.curveType

enum

required

curveType field

Enum options: API_KEY_CURVE_P256, API_KEY_CURVE_SECP256K1, API_KEY_CURVE_ED25519

activity.intent.createApiKeysIntentV2.apiKeys.expirationSeconds

string

Optional window (in seconds) indicating how long the API Key should last.

activity.intent.createApiKeysIntentV2.userId

string

required

Unique identifier for a given User.

activity.result

object

required

The result of the activity

Show result details

activity.result.createApiKeysResult

object

required

The createApiKeysResult object

Show createApiKeysResult details

activity.result.createApiKeysResult.apiKeyIds

array

required

A list of API Key IDs.

Show apiKeyIds details

activity.result.createApiKeysResult.apiKeyIds.item

string

required

item field

activity.votes

array

required

A list of objects representing a particular User’s approval or rejection of a Consensus request, including all relevant metadata.

activity.fingerprint

string

required

An artifact verifying a User’s action.

activity.canApprove

boolean

required

Whether the activity can be approved.

activity.canReject

boolean

required

Whether the activity can be rejected.

activity.createdAt

string

required

The creation timestamp.

activity.updatedAt

string

required

The last update timestamp.

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/create_api_keys \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_API_KEYS_V2",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "apiKeys": [
            {
                "apiKeyName": "<string>",
                "publicKey": "<string>",
                "curveType": "<API_KEY_CURVE_P256>",
                "expirationSeconds": "<string>"
            }
        ],
        "userId": "<string>"
    }
}'

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_CREATE_API_KEYS_V2",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "createApiKeysIntentV2": {
            "apiKeys": [
              {
                "apiKeyName": "<string>",
                "publicKey": "<string>",
                "curveType": "<API_KEY_CURVE_P256>",
                "expirationSeconds": "<string>"
              }
            ],
            "userId": "<string>"
          }
        },
        "result": {
          "createApiKeysResult": {
            "apiKeyIds": [
              "<string>"
            ]
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}