Create sub-organization

Create a new sub-organization.

type · enum<string> · required

Enum options: ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V8

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.rootUsers · array · required

Root users to create within this sub-organization

Show item details

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.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.attestation · object · required

attestation field

Show details

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.oidcClaims · object

oidcClaims field

Show details

parameters.wallet · object

wallet field

Show details

parameters.wallet.accounts · array · required

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

Show item details

parameters.clientSignature · object

clientSignature field

Show details

generateAppProofs · boolean

Enable to have your activity generate and return App Proofs, enabling verifiability.

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

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: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V8",
    "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>",
                        "oidcClaims": {
                            "iss": "<string>",
                            "sub": "<string>",
                            "aud": "<string>"
                        }
                    }
                ]
            }
        ],
        "rootQuorumThreshold": "<number>",
        "wallet": {
            "walletName": "<string>",
            "accounts": [
                {
                    "curve": "<CURVE_SECP256K1>",
                    "pathFormat": "<PATH_FORMAT_BIP32>",
                    "path": "<string>",
                    "addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>"
                }
            ],
            "mnemonicLength": "<number>"
        },
        "disableEmailRecovery": "<boolean>",
        "disableEmailAuth": "<boolean>",
        "disableSmsAuth": "<boolean>",
        "disableOtpEmailAuth": "<boolean>",
        "verificationToken": "<string>",
        "clientSignature": {
            "publicKey": "<string>",
            "scheme": "<CLIENT_SIGNATURE_SCHEME_API_P256>",
            "message": "<string>",
            "signature": "<string>"
        }
    }
}'

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V8",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "createSubOrganizationIntentV8": {
            "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>",
                    "oidcClaims": {
                      "iss": "<string>",
                      "sub": "<string>",
                      "aud": "<string>"
                    }
                  }
                ]
              }
            ],
            "rootQuorumThreshold": "<number>",
            "wallet": {
              "walletName": "<string>",
              "accounts": [
                {
                  "curve": "<CURVE_SECP256K1>",
                  "pathFormat": "<PATH_FORMAT_BIP32>",
                  "path": "<string>",
                  "addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>"
                }
              ],
              "mnemonicLength": "<number>"
            },
            "disableEmailRecovery": "<boolean>",
            "disableEmailAuth": "<boolean>",
            "disableSmsAuth": "<boolean>",
            "disableOtpEmailAuth": "<boolean>",
            "verificationToken": "<string>",
            "clientSignature": {
              "publicKey": "<string>",
              "scheme": "<CLIENT_SIGNATURE_SCHEME_API_P256>",
              "message": "<string>",
              "signature": "<string>"
            }
          }
        },
        "result": {
          "createSubOrganizationResultV8": {
            "subOrganizationId": "<string>",
            "wallet": {
              "walletId": "<string>",
              "addresses": [
                "<string>"
              ]
            },
            "rootUserIds": [
              "<string>"
            ]
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}