Create Sub-Organization

Create a new Sub-Organization

POST

/

public

/

v1

/

submit

/

create_sub_organization

Authorizations

API Key

X-Stamp

string

header

required

X-Stamp

string

header

required

X-Stamp-Webauthn

string

header

required

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V7

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

parameters field

Show details

parameters.subOrganizationName

string

required

Name for this sub-organization

parameters.rootUsers · array · required

Root users to create within this sub-organization

Show item details

parameters.rootUsers.userName

string

required

Human-readable name for a User.

parameters.rootUsers.userEmail

string

The user’s email address.

parameters.rootUsers.userPhoneNumber

string

The user’s phone number in E.164 format e.g. [phone]

parameters.rootUsers.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.rootUsers.apiKeys.apiKeyName

string

required

Human-readable name for an API Key.

parameters.rootUsers.apiKeys.publicKey

string

required

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

parameters.rootUsers.apiKeys.curveType

enum<string>

required

Enum options: API_KEY_CURVE_P256, API_KEY_CURVE_SECP256K1, API_KEY_CURVE_ED25519

parameters.rootUsers.apiKeys.expirationSeconds

string

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

parameters.rootUsers.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.rootUsers.authenticators.authenticatorName

string

required

Human-readable name for an Authenticator.

parameters.rootUsers.authenticators.challenge

string

required

Challenge presented for authentication purposes.

parameters.rootUsers.authenticators.attestation · object · required

attestation field

Show details

parameters.rootUsers.authenticators.attestation.credentialId

string

required

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

parameters.rootUsers.authenticators.attestation.clientDataJson

string

required

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

parameters.rootUsers.authenticators.attestation.attestationObject

string

required

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

parameters.rootUsers.authenticators.attestation.transports

enum<string[]>

required

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

parameters.rootUsers.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.rootUsers.oauthProviders.providerName

string

required

Human-readable name to identify a Provider.

parameters.rootUsers.oauthProviders.oidcToken

string

required

Base64 encoded OIDC token

parameters.rootQuorumThreshold

number

required

The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users

parameters.wallet · object

wallet field

Show details

parameters.wallet.walletName

string

required

Human-readable name for a Wallet.

parameters.wallet.accounts · enum<string[]> · required

Enum options: CURVE_SECP256K1, CURVE_ED25519

Show item details

parameters.wallet.accounts.curve

enum<string>

required

Enum options: CURVE_SECP256K1, CURVE_ED25519

parameters.wallet.accounts.pathFormat

enum<string>

required

Enum options: PATH_FORMAT_BIP32

parameters.wallet.accounts.path

string

required

Path used to generate a wallet Account.

parameters.wallet.accounts.addressFormat

enum<string>

required

Enum options: ADDRESS_FORMAT_UNCOMPRESSED, ADDRESS_FORMAT_COMPRESSED, ADDRESS_FORMAT_ETHEREUM, ADDRESS_FORMAT_SOLANA, ADDRESS_FORMAT_COSMOS, ADDRESS_FORMAT_TRON, ADDRESS_FORMAT_SUI, ADDRESS_FORMAT_APTOS, ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH, ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH, ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH, ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH, ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR, ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH, ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH, ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH, ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH, ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR, ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH, ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH, ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH, ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH, ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR, ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH, ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH, ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH, ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH, ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR, ADDRESS_FORMAT_SEI, ADDRESS_FORMAT_XLM, ADDRESS_FORMAT_DOGE_MAINNET, ADDRESS_FORMAT_DOGE_TESTNET, ADDRESS_FORMAT_TON_V3R2, ADDRESS_FORMAT_TON_V4R2, ADDRESS_FORMAT_XRP

parameters.wallet.mnemonicLength

number

Length of mnemonic to generate the Wallet seed. Defaults to 12. Accepted values: 12, 15, 18, 21, 24.

parameters.disableEmailRecovery

boolean

Disable email recovery for the sub-organization

parameters.disableEmailAuth

boolean

Disable email auth for the sub-organization

parameters.disableSmsAuth

boolean

Disable OTP SMS auth for the sub-organization

parameters.disableOtpEmailAuth

boolean

Disable OTP email auth for the sub-organization

Response

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

activity.type

string

required

The activity type

activity.intent

object

required

The intent of the activity

Show intent details

activity.intent.createSubOrganizationIntentV7

object

required

The createSubOrganizationIntentV7 object

Show createSubOrganizationIntentV7 details

activity.intent.createSubOrganizationIntentV7.subOrganizationName

string

required

Name for this sub-organization

activity.intent.createSubOrganizationIntentV7.rootUsers

array

required

Root users to create within this sub-organization

Show rootUsers details

activity.intent.createSubOrganizationIntentV7.rootUsers.userName

string

required

Human-readable name for a User.

activity.intent.createSubOrganizationIntentV7.rootUsers.userEmail

string

The user’s email address.

activity.intent.createSubOrganizationIntentV7.rootUsers.userPhoneNumber

string

The user’s phone number in E.164 format e.g. [phone]

activity.intent.createSubOrganizationIntentV7.rootUsers.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.createSubOrganizationIntentV7.rootUsers.apiKeys.apiKeyName

string

required

Human-readable name for an API Key.

activity.intent.createSubOrganizationIntentV7.rootUsers.apiKeys.publicKey

string

required

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

activity.intent.createSubOrganizationIntentV7.rootUsers.apiKeys.curveType

enum

required

curveType field

Enum options: API_KEY_CURVE_P256, API_KEY_CURVE_SECP256K1, API_KEY_CURVE_ED25519

activity.intent.createSubOrganizationIntentV7.rootUsers.apiKeys.expirationSeconds

string

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

activity.intent.createSubOrganizationIntentV7.rootUsers.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.createSubOrganizationIntentV7.rootUsers.authenticators.authenticatorName

string

required

Human-readable name for an Authenticator.

activity.intent.createSubOrganizationIntentV7.rootUsers.authenticators.challenge

string

required

Challenge presented for authentication purposes.

activity.intent.createSubOrganizationIntentV7.rootUsers.authenticators.attestation

object

required

attestation field

Show attestation details

activity.intent.createSubOrganizationIntentV7.rootUsers.authenticators.attestation.credentialId

string

required

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

activity.intent.createSubOrganizationIntentV7.rootUsers.authenticators.attestation.clientDataJson

string

required

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

activity.intent.createSubOrganizationIntentV7.rootUsers.authenticators.attestation.attestationObject

string

required

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

activity.intent.createSubOrganizationIntentV7.rootUsers.authenticators.attestation.transports

array

required

The type of authenticator transports.

Show transports details

activity.intent.createSubOrganizationIntentV7.rootUsers.authenticators.attestation.transports.item

enum

required

item field

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

activity.intent.createSubOrganizationIntentV7.rootUsers.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.createSubOrganizationIntentV7.rootUsers.oauthProviders.providerName

string

required

Human-readable name to identify a Provider.

activity.intent.createSubOrganizationIntentV7.rootUsers.oauthProviders.oidcToken

string

required

Base64 encoded OIDC token

activity.intent.createSubOrganizationIntentV7.rootQuorumThreshold

number

required

The threshold of unique approvals to reach root quorum. This value must be less than or equal to the number of root users

activity.intent.createSubOrganizationIntentV7.wallet

object

wallet field

Show wallet details

activity.intent.createSubOrganizationIntentV7.wallet.walletName

string

required

Human-readable name for a Wallet.

activity.intent.createSubOrganizationIntentV7.wallet.accounts

array

required

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

Show accounts details

activity.intent.createSubOrganizationIntentV7.wallet.accounts.curve

enum

required

curve field

Enum options: CURVE_SECP256K1, CURVE_ED25519

activity.intent.createSubOrganizationIntentV7.wallet.accounts.pathFormat

enum

required

pathFormat field

Enum options: PATH_FORMAT_BIP32

activity.intent.createSubOrganizationIntentV7.wallet.accounts.path

string

required

Path used to generate a wallet Account.

activity.intent.createSubOrganizationIntentV7.wallet.accounts.addressFormat

enum

required

addressFormat field

Enum options: ADDRESS_FORMAT_UNCOMPRESSED, ADDRESS_FORMAT_COMPRESSED, ADDRESS_FORMAT_ETHEREUM, ADDRESS_FORMAT_SOLANA, ADDRESS_FORMAT_COSMOS, ADDRESS_FORMAT_TRON, ADDRESS_FORMAT_SUI, ADDRESS_FORMAT_APTOS, ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH, ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH, ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH, ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH, ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR, ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH, ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH, ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH, ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH, ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR, ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH, ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH, ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH, ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH, ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR, ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH, ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH, ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH, ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH, ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR, ADDRESS_FORMAT_SEI, ADDRESS_FORMAT_XLM, ADDRESS_FORMAT_DOGE_MAINNET, ADDRESS_FORMAT_DOGE_TESTNET, ADDRESS_FORMAT_TON_V3R2, ADDRESS_FORMAT_TON_V4R2, ADDRESS_FORMAT_XRP

activity.intent.createSubOrganizationIntentV7.wallet.mnemonicLength

number

Length of mnemonic to generate the Wallet seed. Defaults to 12. Accepted values: 12, 15, 18, 21, 24.

activity.intent.createSubOrganizationIntentV7.disableEmailRecovery

boolean

Disable email recovery for the sub-organization

activity.intent.createSubOrganizationIntentV7.disableEmailAuth

boolean

Disable email auth for the sub-organization

activity.intent.createSubOrganizationIntentV7.disableSmsAuth

boolean

Disable OTP SMS auth for the sub-organization

activity.intent.createSubOrganizationIntentV7.disableOtpEmailAuth

boolean

Disable OTP email auth for the sub-organization

activity.result

object

required

The result of the activity

Show result details

activity.result.createSubOrganizationResultV7

object

required

The createSubOrganizationResultV7 object

Show createSubOrganizationResultV7 details

activity.result.createSubOrganizationResultV7.subOrganizationId

string

required

subOrganizationId field

activity.result.createSubOrganizationResultV7.wallet

object

wallet field

Show wallet details

activity.result.createSubOrganizationResultV7.wallet.walletId

string

required

walletId field

activity.result.createSubOrganizationResultV7.wallet.addresses

array

required

A list of account addresses.

Show addresses details

activity.result.createSubOrganizationResultV7.wallet.addresses.item

string

required

item field

activity.result.createSubOrganizationResultV7.rootUserIds

array

rootUserIds field

Show rootUserIds details

activity.result.createSubOrganizationResultV7.rootUserIds.item

string

required

item field

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/create_sub_organization \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V7",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "subOrganizationName": "<string>",
        "rootUsers": [
            {
                "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>"
                    }
                ]
            }
        ],
        "rootQuorumThreshold": 123,
        "wallet": {
            "walletName": "<string>",
            "accounts": [
                {
                    "curve": "<CURVE_SECP256K1>",
                    "pathFormat": "<PATH_FORMAT_BIP32>",
                    "path": "<string>",
                    "addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>"
                }
            ],
            "mnemonicLength": 123
        },
        "disableEmailRecovery": true,
        "disableEmailAuth": true,
        "disableSmsAuth": true,
        "disableOtpEmailAuth": true
    }
}'

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V7",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "createSubOrganizationIntentV7": {
            "subOrganizationName": "<string>",
            "rootUsers": [
              {
                "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>"
                  }
                ]
              }
            ],
            "rootQuorumThreshold": 123,
            "wallet": {
              "walletName": "<string>",
              "accounts": [
                {
                  "curve": "<CURVE_SECP256K1>",
                  "pathFormat": "<PATH_FORMAT_BIP32>",
                  "path": "<string>",
                  "addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>"
                }
              ],
              "mnemonicLength": 123
            },
            "disableEmailRecovery": true,
            "disableEmailAuth": true,
            "disableSmsAuth": true,
            "disableOtpEmailAuth": true
          }
        },
        "result": {
          "createSubOrganizationResultV7": {
            "subOrganizationId": "<string>",
            "wallet": {
              "walletId": "<string>",
              "addresses": [
                "<string_element>"
              ]
            },
            "rootUserIds": [
              "<string_element>"
            ]
          }
        }
      }
    }
  }
}

Assistant

Responses are generated using AI and may contain mistakes.