Skip to main content

Create sandbox organisation

POST 
/v2/config/sandbox-org

Creates a sandbox organisation for the organisation. A sandbox organisation is a separate wallet inside your organisation. It has its own credential definitions, presentation definitions, webhooks and keys, so you can test an issuance or a verification flow without a change to the main wallet.

The main wallet of the organisation must be deployed before you create a sandbox organisation. The name must be unique in the organisation.

The service deploys a new wallet for the sandbox organisation and copies the logo image and the cover image of the organisation to it. To use the new sandbox organisation in a later request, send its id in the X-SandboxOrgId header, or bind an API key to it with PUT /config/admin/apikey/{apiKeyId}/sandbox-org.

Request​

Body

required

The sandbox organisation to create.

    sandboxOrg objectrequired

    The sandbox organisation to create.

    name stringrequired

    Name of the sandbox organisation. This field is mandatory. The name must be unique in the organisation. If a sandbox organisation with the same name exists, the service gives HTTP 400.

    description string

    Description of the sandbox organisation. This field is optional, and the service stores an empty string when you leave it out.

Responses​

The service created the sandbox organisation.

Response Headers
    Schema
      sandboxOrg objectrequired

      The sandbox organisation that the service created. The service sets the id, the openIdDeploymentId, the status and the timestamps.

      id stringrequired

      Unique identifier of the sandbox organisation

      name stringrequired

      Display name of the sandbox organisation

      description stringrequired

      Human readable description of the sandbox organisation

      openIdDeploymentId stringrequired

      Identifier of the associated OpenID deployment

      status integerrequired

      Status code of the sandbox organisation

      ledgerId integerrequired

      Identifier of the associated ledger

      infrastructureProvider stringrequired

      Name of the infrastructure provider

      version stringrequired

      Version of the sandbox organisation configuration

      role stringrequired

      Role of the sandbox organisation in the ecosystem

      trustAnchor stringrequired

      Trust anchor identifier or DID

      isWalletProvider booleanrequired

      Indicates whether this sandbox organisation acts as a wallet provider

      secureVault integerrequired

      Identifier of the primary secure vault

      secureVaults integer[]nullable

      Identifiers of the secure vaults that the sandbox organisation uses. The field holds null when the sandbox organisation has no secure vault.

      logoImageId string

      Identifier of the logo image. The field is absent when the sandbox organisation has no logo image.

      coverImageId string

      Identifier of the cover image. The field is absent when the sandbox organisation has no cover image.

      logoImageUrl stringrequired

      Public URL for the logo image

      coverImageUrl stringrequired

      Public URL for the cover image

      createdAt integerrequired

      Timestamp when the sandbox organisation was created

      updatedAt integerrequired

      Timestamp when the sandbox organisation was last updated

      isMain booleanrequired

      Indicates whether this is the main organisation

    Loading...
    Last updated on