Check Grant Status via REST API

This document describes a simple REST API call to check the revocation status of a specific identity on Currently.io. This functionality is useful for organizations that implement the TyDIDS Trust Framework for GDPR compliance.

API Endpoint

• URL: https://api.corrently.io/v2.0/tydids/status?identity=<identity>

• Method: GET

• Path Parameter:

  • <identity>: Replace this with the identity you want to check the revocation status for. The identity is typically an SSI (Self-Sovereign Identity) identifier string.

Response

The API responds with a JSON object containing information about the revocation status and consensus value. The HTTP status code of the response indicates the overall status of the request.

• HTTP Status Code 200 (OK):

  • Body:

    JSON

    {
      "status": "granted",
      "consensus": 40856
    }
    

    Verwende den Code mit Vorsicht.

  • Description: The identity has not revoked data approval.

    • status: String indicating the approval status. In this case, the value is "granted".
    • consensus: Integer representing the number of the latest consensus reached at the time of the request.

• HTTP Status Code 403 (Forbidden):

  • Body:

    JSON

    {
      "status": "revoked",
      "consensus": 40850,
      "revoked": 1722722789
    }
    

    Verwende den Code mit Vorsicht.

  • Description: The identity has revoked data approval.

    • status: String indicating the approval status. In this case, the value is "revoked".
    • consensus: Integer representing the number of the latest consensus reached at the time of the request.
    • revoked: Integer representing the timestamp (in Unix time) at which the approval was revoked.

Example Usage

• Checking an identity that has not revoked data approval:

  • API Call: https://api.corrently.io/v2.0/tydids/status?identity=0x95Bee09c395c60883Fa8bb95F05404a71f7ee7F7

  • Response Body:

    JSON

    {
      "status": "granted",
      "consensus": 40856
    }
    

    Verwende den Code mit Vorsicht.

• Checking an identity that has revoked data approval:

  • API Call: https://api.corrently.io/v2.0/tydids/status?identity=0xa8CD7c57c144be63852Da3C44D97088A740D43Cd

  • Response Body:

    JSON

    {
      "status": "revoked",
      "consensus": 40850,
      "revoked": 1722722789
    }
    

    Verwende den Code mit Vorsicht.

GDPR Compliance

Organizations implementing the TyDIDS Trust Framework for GDPR can use this API to regularly check the revocation status of identities. If an identity revokes data approval, the organization can take appropriate actions, such as stopping data processing or informing the user.