Get a verifiable credential template by ID.

Get a verifiable credential template.

GET https://{tenantDomain}/api/v2/verifiable-credentials/verification/templates/{id}

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.VerifiableCredentials.Verification.Templates.GetAsync(
            "id"
        );
    }

}

package example

import (
    context "context"

    client "github.com/auth0/go-auth0/v2/management/client"
    option "github.com/auth0/go-auth0/v2/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    mgmt.VerifiableCredentials.Verification.Templates.Get(
        context.TODO(),
        "id",
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.verifiableCredentials().verification().templates().get("id");
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->verifiableCredentials->verification->templates->get(
    'id',
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.verifiable_credentials.verification.templates.get(
    id="id",
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.verifiable_credentials.verification.templates.get(id: "id")

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.verifiableCredentials.verification.templates.get("id");
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.verifiableCredentials.verification.templates.get("id");
}
main();

curl --request GET \
  --url https://{tenantDomain}/api/v2/verifiable-credentials/verification/templates/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "vct_0000000000000001",
  "name": "<string>",
  "type": "mdl",
  "dialect": "simplified/1.0",
  "presentation": {
    "org.iso.18013.5.1.mDL": {
      "org.iso.18013.5.1": {
        "family_name": true,
        "given_name": true,
        "birth_date": true,
        "issue_date": true,
        "expiry_date": true,
        "issuing_country": true,
        "issuing_authority": true,
        "portrait": true,
        "driving_privileges": true,
        "resident_address": true,
        "portrait_capture_date": true,
        "age_in_years": true,
        "age_birth_year": true,
        "issuing_jurisdiction": true,
        "nationality": true,
        "resident_city": true,
        "resident_state": true,
        "resident_postal_code": true,
        "resident_country": true,
        "family_name_national_character": true,
        "given_name_national_character": true
      }
    }
  },
  "custom_certificate_authority": "<string>",
  "well_known_trusted_issuers": "<string>",
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z"
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

ID of the template to retrieve.

Maximum string length: 26

Response

200

application/json

Template successfully retrieved.

id · string · default: vct_0000000000000001

The id of the template.

name · string

The name of the template.

type · string · default: mdl

The type of the template.

dialect · string · default: simplified/1.0

The dialect of the template.

Maximum string length: 255

presentation · object

A simplified presentation request

Show child attributes

custom_certificate_authority · string | null

The custom certificate authority.

Required string length: 1 - 4096

well_known_trusted_issuers · string | null

The well-known trusted issuers, comma separated.

Required string length: 1 - 255

created_at · string<date-time> · default: 2021-01-01T00:00:00Z

The date and time the template was created.

updated_at · string<date-time> · default: 2021-01-01T00:00:00Z

The date and time the template was created.