Skip to main content

Read sandbox organisation

GET 
/v2/config/sandbox-org/:sandboxOrgId

Reads one sandbox organisation of the organisation. Give the sandbox organisation ID in the path.

The response also gives the OpenID endpoints of the wallet of the sandbox organisation. Use these endpoints to point a holder wallet or an external IT system to this sandbox organisation. If the sandbox organisation has no OpenID deployment, all the endpoint fields hold an empty string.

Request​

Path Parameters

    sandboxOrgId stringrequired

    Unique identifier of the sandbox organisation.

Responses​

The service returns the sandbox organisation.

Response Headers
    Schema
      sandboxOrg object
      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

      agentServiceEndpoint stringrequired

      Base URL of the wallet of the sandbox organisation.

      credentialIssuerMetadata stringrequired

      URL of the credential issuer metadata of the sandbox organisation. A wallet reads this document to start an OID4VCI flow.

      authorizationServerMetadata stringrequired

      URL of the authorization server metadata of the sandbox organisation. A wallet reads this document to find the token endpoint and the supported grant types.

      notificationEndpoint stringrequired

      URL of the OID4VCI notification endpoint of the sandbox organisation. A wallet sends the result of a credential issuance to this endpoint.

      jwksEndpoint stringrequired

      URL of the JSON Web Key Set of the sandbox organisation. A wallet reads the public keys from this endpoint to validate the signature of a credential.

    Loading...
    Last updated on