EQTY LabDocs

Get DID key information

Retrieve information for one of the authenticated user's DID keys from the configured key provider

gethttps://localhost:8080/api/v1/auth/did-key/{keyId}
bash
curl --request GET \
  --url 'https://localhost:8080/api/v1/auth/did-key/{keyId}' \
  --header 'Authorization: Bearer <token>'
javascript
const response = await fetch("https://localhost:8080/api/v1/auth/did-key/{keyId}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

const data = await response.json();
typescript
interface DIDKeyInfo {
  createdAt?: string;
  didDocument?: Record<string, unknown>;
  keyId?: string;
  keyReference?: string;
  keyVaultUrl?: string;
  provider?: string;
  publicKey?: string;
}

const response = await fetch("https://localhost:8080/api/v1/auth/did-key/{keyId}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);

const data: DIDKeyInfo = await response.json();
python
import requests

response = requests.get(
    "https://localhost:8080/api/v1/auth/did-key/{keyId}",
    headers={
        "Authorization": "Bearer <token>",
    },
)
response.raise_for_status()
print(response.json())
go
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://localhost:8080/api/v1/auth/did-key/{keyId}", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer <token>")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(res.Status, string(data))
}
java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://localhost:8080/api/v1/auth/did-key/{keyId}"))
            .header("Authorization", "Bearer <token>")
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}
csharp
using System.Net.Http.Headers;

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:8080/api/v1/auth/did-key/{keyId}");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");

using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
php
<?php

$ch = curl_init('https://localhost:8080/api/v1/auth/did-key/{keyId}');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer <token>',
    ],
    CURLOPT_RETURNTRANSFER => true,
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status . " " . $response . PHP_EOL;
ruby
require "net/http"

uri = URI("https://localhost:8080/api/v1/auth/did-key/{keyId}")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <token>"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
puts "#{response.code} #{response.body}"
rust
// Cargo.toml dependencies: reqwest, tokio (features "full")

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let response = reqwest::Client::new()
        .get("https://localhost:8080/api/v1/auth/did-key/{keyId}")
        .header("Authorization", "Bearer <token>")
        .send()
        .await?;

    println!("{} {}", response.status(), response.text().await?);
    Ok(())
}

Authorizations

  • BearerAuth · API key in header "Authorization" — Type "Bearer" followed by a space and JWT token
  • ApiKeyAuth · API key in header "Authorization" — Type "Bearer" followed by a space and API key

Parameters

Path parameters

NameTypeDescription
keyId
required
string

Provider key ID (e.g., auth0-abc123) or the key's did:key

Responses

200DID key information

application/json
  • createdAtstring<date-time>
  • didDocumentcore.DIDDocument

    The W3C DID document for a key, in did:key form

    Show core.DIDDocument
    • @contextstring
    • assertionMethodstring[]
    • authenticationstring[]

      DID URLs into verificationMethod

    • idstring
    • verificationMethodcore.DIDVerificationMethod[]
      Show properties

      Array of core.DIDVerificationMethod

      • controllerstring
      • idstring
      • publicKeyJwkobject
      • typestring
  • keyIdstring
  • keyReferencestring
  • keyVaultUrlstring

    Deprecated: use keyReference

  • providerstring
  • publicKeystring
Examplejson
{
  "createdAt": "2025-01-01T00:00:00Z",
  "didDocument": {
    "@context": "https://www.w3.org/ns/did/v1",
    "assertionMethod": [
      "string"
    ],
    "authentication": [
      "string"
    ],
    "id": "did:key:zQ3shokFTS3brHcDQrn82RUDfCZESWL1ZdCEJwekUDPQiYBme",
    "verificationMethod": [
      {
        "controller": "did:key:zQ3shokFTS3brHcDQrn82RUDfCZESWL1ZdCEJwekUDPQiYBme",
        "id": "did:key:zQ3shokFTS3brHcDQrn82RUDfCZESWL1ZdCEJwekUDPQiYBme#zQ3shokFTS3brHcDQrn82RUDfCZESWL1ZdCEJwekUDPQiYBme",
        "publicKeyJwk": {},
        "type": "JsonWebSignature2020"
      }
    ]
  },
  "keyId": "string",
  "keyReference": "string",
  "keyVaultUrl": "string",
  "provider": "string",
  "publicKey": "string"
}

400Bad request - Key ID required

application/json
  • errorstring
  • error_descriptionstring
Examplejson
{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

401Unauthorized

application/json
  • errorstring
  • error_descriptionstring
Examplejson
{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

403Forbidden - May only access your own DID keys

application/json
  • errorstring
  • error_descriptionstring
Examplejson
{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

404DID key not found

application/json
  • errorstring
  • error_descriptionstring
Examplejson
{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

500Internal server error

application/json
  • errorstring
  • error_descriptionstring
Examplejson
{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}