Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Enterprise Management

Create an enterprise for an organization

Create an enterprise in the specified organization. Also create a user if it doesn't already exist. This endpoint is intended for creating enterprises in Crypto-as-a-Service (CaaS) organizations. For non-CaaS organizations, set isCaaS to false to skip validation.

By default the new enterprise's initial kycState follows the environment: approved where KYC is not enforced (testnet-like environments) and pending where it is enforced (production, staging). Pass fullSandboxKyc: true to simulate the full KYC flow in a non-enforcing environment by starting with kycState = pending. Ignored in enforcing environments. KycExemption license takes precedence and overrides to approved even when this flag is set.

post/api/v2/organization/{organizationId}/enterprise

Path parameters

organizationIdstring required
Example:59cd72485007a239fb00282ed480da1f

Request body

emailstring required
idempotencyKeystring required

A unique identifier for the enterprise creation request. Multiple enterprises with the same organizationId and idempotencyKey will not be created.

additionalAdminsstring[] required
isCaaSboolean

Indicates if this is a Crypto-as-a-Service (CaaS) organization. If set to true, validates that the organization configuration is complete before creating child enterprises.

accountType'individual' | 'entity'

The account type for the enterprise. Defaults to 'individual' if not specified.

fullSandboxKycboolean

Enterprises are KYC approved at BitGo in our Test environment by default. If you want to replicate production and start the enterprise with pending KYC, pass this as true. Note: you will then need to complete KYC/KYB of the enterprise to move it to approved/rejected.

Example request

{
  "additionalAdmins": [
    "59cd72485007a239fb00282ed480da1f"
  ]
}

Response

OK

enterpriseIdstring required
userIdstring required

Example response

{
  "enterpriseId": "59cd72485007a239fb00282ed480da1f",
  "userId": "59cd72485007a239fb00282ed480da1f"
}