Test Your Issuance Template

We recommend testing your templates in the sandbox before integrating it with your system.

You'll need to create an API Key before you can test the template. If you already have API Keys created, you can skip ahead to the Step 2.

Step 1: Create an API Key

An API Key is a unique identifier that allows your applications to access specific issuance and verification templates via the Gataca Studio APIs. To create an API Key:

  1. Go to the "API Keys" section in the left menu and click "Create API Key."

  2. Configure the API Key:

    • API Key Name: Choose a name for your API Key.

    • DID: Select the DID associated with the API Key. This determines which administrators can access it.

    • Templates associated : Select the credential issuance template you want to link to this API Key.

  1. Save the API Key information. You’ll receive the API Key ID and password.

Make sure to store the API key password in a secure place. Once you close this tab, you won’t be able to retrieve it later. If needed, you can regenerate a new password.

Step 2: Test it

2.1 Associate an API Key to your Issuance Template

  1. Go to "Issuance Templates" in the left menu, find the template you want to test, click the three dots, and select "Edit."

  2. Once the template opens, click "Generate test" in the top right corner.

  1. Select the API Key you created, enter the API Key password, and optionally provide a callback URL for POST notifications containing session data once the session has been successfully validated.

To test your issuance template, link your Wallet to the Sandbox environment. This allows you to securely test the credential issuance process.

You can skip to 2.3 Generate a Testing QR if you already linked your Wallet with your Sandbox.

  1. If you haven’t linked your Wallet yet with your Sandbox, click "Scan Now" to access the QR code.

  2. Scan the QR code with your Wallet. Once linked, you’ll see a confirmation in your Wallet.

2.3 Generate a testing QR code

  1. Click "Generating Test" to create a QR code for testing.

  2. Scan the QR code with your Wallet to start the test, simulating the user experience.

  3. Your Wallet will prompt you to share the requested credentials based on your issuance template configuration. Consent to the request as if you were the user.

  4. After consenting, you can proceed to manually issue the credentials for testing purposes. This manual issuance is intended to facilitate testing of your issuance templates without the need to execute internal integrations.

Step 3. Manually issue your credential

As an organization, you can issue credentials automatically through system integration. If you want to integrate your template with your system, go to SSI Issuance Integration.

To manually issue a credential, go to the "Pending" tab under "Credential Activity." Here you can review issuance requests.

  1. Click the green checkmark icon ✅.

  2. Manually fill out the form with the claims associated to this user. For examples of credential schemas in JSON format refer to Schemas (JSON Examples).

  3. Click the "Submit" button.

  4. The credential will now appear under "Issued Credentials" and will be issued to your Wallet, just as it would be seen by a user.

Once you've successfully tested the issuance template, it’s ready to be integrated into your website or application, allowing your users to request credentials that your institution can issue directly to their Wallets.

Last updated