Skip to main content

Resolve a Digital Twin

A digital twin is represented as a Decentralized Identifier (DID) Document, enabling secure, verifiable, and self-sovereign identity for each twin. Accessing a digital twin’s details retrieves the DID Document, which contains metadata and verification methods that authenticate the digital twin’s identity.

Access the details of a digital twin​

Using the gemini service, you can access the details of a digital twin by sending a GET request to the digital twin endpoint. A detailed description of the endpoint can be found in the API Reference.

For authorized access, you need to include the access token in the Authorization header. Also make sure that the App has the necessary permission Resolve Digital Twin to fetch details of a digital twin. Learn more about Apps and permissions in Create App & API Token guide.

Request​

GET /api/gemini/v1/digital-twin/<YOUR_DID>

Headers:
Authorization: Bearer <YOUR_ACCESS_TOKEN>
  • <YOUR_DID> - The DID of the digital twin you want to access.

Response​

If the request is successful, you get a response with the the DID Document for your digital twin.

[
    {
        "didDocumentMetadata": {},
        "didResolutionMetadata": {
            "contentType": "application/did+ld+json"
        },
        "didDocument": {
            "id": string,
            "verificationMethod": [...],
            "authentication": [...],
            "assertionMethod": [...]
        }
    }
]
  • didDocumentMetadata - Contains metadata about the DID Document.
  • didResolutionMetadata - Provides information on how the DID Document was resolved, such as contentType, indicating the format.
  • didDocument - The core DID Document object, which includes:
    • id - The identifier of the digital twin.
    • verificationMethod - Lists the cryptographic methods for verifying the twin’s identity.
    • authentication - Contains methods that confirm the identity for authentication purposes.
    • assertionMethod - Methods for verifying claims made by the digital twin.

The DID Document is a verifiable data structure, essential for managing identity attributes and ensuring the authenticity and integrity of the digital twin’s details.