Create users

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/create_users \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_USERS_V3",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "users": [
            {
                "userName": "<string>",
                "userEmail": "<string>",
                "userPhoneNumber": "<string>",
                "apiKeys": [
                    {
                        "apiKeyName": "<string>",
                        "publicKey": "<string>",
                        "curveType": "<API_KEY_CURVE_P256>",
                        "expirationSeconds": "<string>"
                    }
                ],
                "authenticators": [
                    {
                        "authenticatorName": "<string>",
                        "challenge": "<string>",
                        "attestation": {
                            "credentialId": "<string>",
                            "clientDataJson": "<string>",
                            "attestationObject": "<string>",
                            "transports": [
                                "<AUTHENTICATOR_TRANSPORT_BLE>"
                            ]
                        }
                    }
                ],
                "oauthProviders": [
                    {
                        "providerName": "<string>",
                        "oidcToken": "<string>"
                    }
                ],
                "userTags": [
                    "<string>"
                ]
            }
        ]
    }
}'

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_CREATE_USERS_V3",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "createUsersIntentV3": {
            "users": [
              {
                "userName": "<string>",
                "userEmail": "<string>",
                "userPhoneNumber": "<string>",
                "apiKeys": [
                  {
                    "apiKeyName": "<string>",
                    "publicKey": "<string>",
                    "curveType": "<API_KEY_CURVE_P256>",
                    "expirationSeconds": "<string>"
                  }
                ],
                "authenticators": [
                  {
                    "authenticatorName": "<string>",
                    "challenge": "<string>",
                    "attestation": {
                      "credentialId": "<string>",
                      "clientDataJson": "<string>",
                      "attestationObject": "<string>",
                      "transports": [
                        "<AUTHENTICATOR_TRANSPORT_BLE>"
                      ]
                    }
                  }
                ],
                "oauthProviders": [
                  {
                    "providerName": "<string>",
                    "oidcToken": "<string>"
                  }
                ],
                "userTags": [
                  "<string>"
                ]
              }
            ]
          }
        },
        "result": {
          "createUsersResult": {
            "userIds": [
              "<string>"
            ]
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/create_users \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_USERS_V3",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "users": [
            {
                "userName": "<string>",
                "userEmail": "<string>",
                "userPhoneNumber": "<string>",
                "apiKeys": [
                    {
                        "apiKeyName": "<string>",
                        "publicKey": "<string>",
                        "curveType": "<API_KEY_CURVE_P256>",
                        "expirationSeconds": "<string>"
                    }
                ],
                "authenticators": [
                    {
                        "authenticatorName": "<string>",
                        "challenge": "<string>",
                        "attestation": {
                            "credentialId": "<string>",
                            "clientDataJson": "<string>",
                            "attestationObject": "<string>",
                            "transports": [
                                "<AUTHENTICATOR_TRANSPORT_BLE>"
                            ]
                        }
                    }
                ],
                "oauthProviders": [
                    {
                        "providerName": "<string>",
                        "oidcToken": "<string>"
                    }
                ],
                "userTags": [
                    "<string>"
                ]
            }
        ]
    }
}'

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_CREATE_USERS_V3",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "createUsersIntentV3": {
            "users": [
              {
                "userName": "<string>",
                "userEmail": "<string>",
                "userPhoneNumber": "<string>",
                "apiKeys": [
                  {
                    "apiKeyName": "<string>",
                    "publicKey": "<string>",
                    "curveType": "<API_KEY_CURVE_P256>",
                    "expirationSeconds": "<string>"
                  }
                ],
                "authenticators": [
                  {
                    "authenticatorName": "<string>",
                    "challenge": "<string>",
                    "attestation": {
                      "credentialId": "<string>",
                      "clientDataJson": "<string>",
                      "attestationObject": "<string>",
                      "transports": [
                        "<AUTHENTICATOR_TRANSPORT_BLE>"
                      ]
                    }
                  }
                ],
                "oauthProviders": [
                  {
                    "providerName": "<string>",
                    "oidcToken": "<string>"
                  }
                ],
                "userTags": [
                  "<string>"
                ]
              }
            ]
          }
        },
        "result": {
          "createUsersResult": {
            "userIds": [
              "<string>"
            ]
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}

POST

public

submit

create_users

Authorizations

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_USERS_V3

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.users

array

required

A list of Users.

Show item details

parameters.users.userName

string

required

Human-readable name for a User.

parameters.users.userEmail

string

The user’s email address.

parameters.users.userPhoneNumber

string

The user’s phone number in E.164 format e.g. +13214567890

parameters.users.apiKeys

array

required

A list of API Key parameters. This field, if not needed, should be an empty array in your request body.

Show item details

parameters.users.apiKeys.apiKeyName

string

required

Human-readable name for an API Key.

parameters.users.apiKeys.publicKey

string

required

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

parameters.users.apiKeys.curveType

enum<string>

required

Enum options: API_KEY_CURVE_P256, API_KEY_CURVE_SECP256K1, API_KEY_CURVE_ED25519

parameters.users.apiKeys.expirationSeconds

string

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

parameters.users.authenticators

array

required

A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.

Show item details

parameters.users.authenticators.authenticatorName

string

required

Human-readable name for an Authenticator.

parameters.users.authenticators.challenge

string

required

Challenge presented for authentication purposes.

parameters.users.authenticators.attestation

object

required

attestation field

Show details

parameters.users.authenticators.attestation.credentialId

string

required

The cbor encoded then base64 url encoded id of the credential.

parameters.users.authenticators.attestation.clientDataJson

string

required

A base64 url encoded payload containing metadata about the signing context and the challenge.

parameters.users.authenticators.attestation.attestationObject

string

required

A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses.

parameters.users.authenticators.attestation.transports

enum<string[]>

required

Enum options: AUTHENTICATOR_TRANSPORT_BLE, AUTHENTICATOR_TRANSPORT_INTERNAL, AUTHENTICATOR_TRANSPORT_NFC, AUTHENTICATOR_TRANSPORT_USB, AUTHENTICATOR_TRANSPORT_HYBRID

parameters.users.oauthProviders

array

required

A list of Oauth providers. This field, if not needed, should be an empty array in your request body.

Show item details

parameters.users.oauthProviders.providerName

string

required

Human-readable name to identify a Provider.

parameters.users.oauthProviders.oidcToken

string

required

Base64 encoded OIDC token

parameters.users.userTags

array

required

A list of User Tag IDs. This field, if not needed, should be an empty array in your request body.

Show item details

Array item type: string

item field

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.createUsersIntentV3

object

required

The createUsersIntentV3 object

Show createUsersIntentV3 details

activity.intent.createUsersIntentV3.users

array

required

A list of Users.

Show users details

activity.intent.createUsersIntentV3.users.userName

string

required

Human-readable name for a User.

activity.intent.createUsersIntentV3.users.userEmail

string

The user’s email address.

activity.intent.createUsersIntentV3.users.userPhoneNumber

string

The user’s phone number in E.164 format e.g. +13214567890

activity.intent.createUsersIntentV3.users.apiKeys

array

required

A list of API Key parameters. This field, if not needed, should be an empty array in your request body.

Show apiKeys details

activity.intent.createUsersIntentV3.users.apiKeys.apiKeyName

string

required

Human-readable name for an API Key.

activity.intent.createUsersIntentV3.users.apiKeys.publicKey

string

required

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

activity.intent.createUsersIntentV3.users.apiKeys.curveType

enum

required

curveType fieldEnum options: API_KEY_CURVE_P256, API_KEY_CURVE_SECP256K1, API_KEY_CURVE_ED25519

activity.intent.createUsersIntentV3.users.apiKeys.expirationSeconds

string

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

activity.intent.createUsersIntentV3.users.authenticators

array

required

A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.

Show authenticators details

activity.intent.createUsersIntentV3.users.authenticators.authenticatorName

string

required

Human-readable name for an Authenticator.

activity.intent.createUsersIntentV3.users.authenticators.challenge

string

required

Challenge presented for authentication purposes.

activity.intent.createUsersIntentV3.users.authenticators.attestation

object

required

attestation field

Show attestation details

activity.intent.createUsersIntentV3.users.authenticators.attestation.credentialId

string

required

The cbor encoded then base64 url encoded id of the credential.

activity.intent.createUsersIntentV3.users.authenticators.attestation.clientDataJson

string

required

A base64 url encoded payload containing metadata about the signing context and the challenge.

activity.intent.createUsersIntentV3.users.authenticators.attestation.attestationObject

string

required

A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses.

activity.intent.createUsersIntentV3.users.authenticators.attestation.transports

array

required

The type of authenticator transports.

Show transports details

activity.intent.createUsersIntentV3.users.authenticators.attestation.transports.item

enum

required

item fieldEnum options: AUTHENTICATOR_TRANSPORT_BLE, AUTHENTICATOR_TRANSPORT_INTERNAL, AUTHENTICATOR_TRANSPORT_NFC, AUTHENTICATOR_TRANSPORT_USB, AUTHENTICATOR_TRANSPORT_HYBRID

activity.intent.createUsersIntentV3.users.oauthProviders

array

required

A list of Oauth providers. This field, if not needed, should be an empty array in your request body.

Show oauthProviders details

activity.intent.createUsersIntentV3.users.oauthProviders.providerName

string

required

Human-readable name to identify a Provider.

activity.intent.createUsersIntentV3.users.oauthProviders.oidcToken

string

required

Base64 encoded OIDC token

activity.intent.createUsersIntentV3.users.userTags

array

required

A list of User Tag IDs. This field, if not needed, should be an empty array in your request body.

Show userTags details

activity.intent.createUsersIntentV3.users.userTags.item

string

required

item field

activity.result

object

required

The result of the activity

Show result details

activity.result.createUsersResult

object

required

The createUsersResult object

Show createUsersResult details

activity.result.createUsersResult.userIds

array

required

A list of User IDs.

Show userIds details

activity.result.createUsersResult.userIds.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 --request POST \
  --url https://api.turnkey.com/public/v1/submit/create_users \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_USERS_V3",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "users": [
            {
                "userName": "<string>",
                "userEmail": "<string>",
                "userPhoneNumber": "<string>",
                "apiKeys": [
                    {
                        "apiKeyName": "<string>",
                        "publicKey": "<string>",
                        "curveType": "<API_KEY_CURVE_P256>",
                        "expirationSeconds": "<string>"
                    }
                ],
                "authenticators": [
                    {
                        "authenticatorName": "<string>",
                        "challenge": "<string>",
                        "attestation": {
                            "credentialId": "<string>",
                            "clientDataJson": "<string>",
                            "attestationObject": "<string>",
                            "transports": [
                                "<AUTHENTICATOR_TRANSPORT_BLE>"
                            ]
                        }
                    }
                ],
                "oauthProviders": [
                    {
                        "providerName": "<string>",
                        "oidcToken": "<string>"
                    }
                ],
                "userTags": [
                    "<string>"
                ]
            }
        ]
    }
}'

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_CREATE_USERS_V3",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "createUsersIntentV3": {
            "users": [
              {
                "userName": "<string>",
                "userEmail": "<string>",
                "userPhoneNumber": "<string>",
                "apiKeys": [
                  {
                    "apiKeyName": "<string>",
                    "publicKey": "<string>",
                    "curveType": "<API_KEY_CURVE_P256>",
                    "expirationSeconds": "<string>"
                  }
                ],
                "authenticators": [
                  {
                    "authenticatorName": "<string>",
                    "challenge": "<string>",
                    "attestation": {
                      "credentialId": "<string>",
                      "clientDataJson": "<string>",
                      "attestationObject": "<string>",
                      "transports": [
                        "<AUTHENTICATOR_TRANSPORT_BLE>"
                      ]
                    }
                  }
                ],
                "oauthProviders": [
                  {
                    "providerName": "<string>",
                    "oidcToken": "<string>"
                  }
                ],
                "userTags": [
                  "<string>"
                ]
              }
            ]
          }
        },
        "result": {
          "createUsersResult": {
            "userIds": [
              "<string>"
            ]
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}

Create user tag Create wallet

Activities

Queries

Authorizations

Body

Response