# 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=](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:**
        
        <div _ngcontent-ng-c347665101="" class="code-block ng-tns-c347665101-483 ng-trigger ng-trigger-codeBlockRevealAnimation" jslog="223238;track:impression;BardVeMetadataKey:[["r_1a2a4ab365d1ea79","c_873520ef584738e4",null,"rc_a503cb4a019b216b",null,null,"en",null,1,null,null,0,0]]"><div _ngcontent-ng-c347665101="" class="code-block ng-tns-c347665101-483 ng-trigger ng-trigger-codeBlockRevealAnimation" jslog="223238;track:impression;BardVeMetadataKey:[["r_1a2a4ab365d1ea79","c_873520ef584738e4",null,"rc_a503cb4a019b216b",null,null,"en",null,1,null,null,0,0]]"><div _ngcontent-ng-c347665101="" class="code-block-decoration header gmat-subtitle-1 ng-tns-c347665101-483 ng-star-inserted"><span class="ng-tns-c347665101-483">JSON</span></div><div _ngcontent-ng-c347665101="" class="code-block-internal-container ng-tns-c347665101-483"><div _ngcontent-ng-c347665101="" class="animated-opacity ng-tns-c347665101-483"></div></div></div></div>```
        {
          "status": "granted",
          "consensus": 40856
        }
        
        ```
        
        <div _ngcontent-ng-c347665101="" class="code-block ng-tns-c347665101-483 ng-trigger ng-trigger-codeBlockRevealAnimation" jslog="223238;track:impression;BardVeMetadataKey:[["r_1a2a4ab365d1ea79","c_873520ef584738e4",null,"rc_a503cb4a019b216b",null,null,"en",null,1,null,null,0,0]]"><div _ngcontent-ng-c347665101="" class="code-block-internal-container ng-tns-c347665101-483"><div _ngcontent-ng-c347665101="" class="animated-opacity ng-tns-c347665101-483"></div></div><div _ngcontent-ng-c347665101="" class="code-block-decoration footer gmat-overline ng-tns-c347665101-483 hide-from-message-actions ng-star-inserted" hide-from-message-actions=""><div _ngcontent-ng-c347665101="" class="ng-tns-c347665101-483"><span class="ng-tns-c347665101-483">Verwende den Code [mit Vorsicht](https://corrently.io/faq#coding).</span></div><div _ngcontent-ng-c347665101="" class="buttons ng-tns-c347665101-483"><button aria-label="Code kopieren" class="mat-mdc-tooltip-trigger copy-button ng-tns-c347665101-483 mdc-icon-button mat-mdc-icon-button gmat-mdc-button-with-prefix mat-unthemed mat-mdc-button-base gmat-mdc-button"></button></div></div></div>
    - **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:**
        
        <div _ngcontent-ng-c347665101="" class="code-block ng-tns-c347665101-484 ng-trigger ng-trigger-codeBlockRevealAnimation" jslog="223238;track:impression;BardVeMetadataKey:[["r_1a2a4ab365d1ea79","c_873520ef584738e4",null,"rc_a503cb4a019b216b",null,null,"en",null,1,null,null,0,0]]"><div _ngcontent-ng-c347665101="" class="code-block ng-tns-c347665101-484 ng-trigger ng-trigger-codeBlockRevealAnimation" jslog="223238;track:impression;BardVeMetadataKey:[["r_1a2a4ab365d1ea79","c_873520ef584738e4",null,"rc_a503cb4a019b216b",null,null,"en",null,1,null,null,0,0]]"><div _ngcontent-ng-c347665101="" class="code-block-decoration header gmat-subtitle-1 ng-tns-c347665101-484 ng-star-inserted"><span class="ng-tns-c347665101-484">JSON</span></div><div _ngcontent-ng-c347665101="" class="code-block-internal-container ng-tns-c347665101-484"><div _ngcontent-ng-c347665101="" class="animated-opacity ng-tns-c347665101-484"></div></div></div></div>```
        {
          "status": "revoked",
          "consensus": 40850,
          "revoked": 1722722789
        }
        
        ```
        
        <div _ngcontent-ng-c347665101="" class="code-block ng-tns-c347665101-484 ng-trigger ng-trigger-codeBlockRevealAnimation" jslog="223238;track:impression;BardVeMetadataKey:[["r_1a2a4ab365d1ea79","c_873520ef584738e4",null,"rc_a503cb4a019b216b",null,null,"en",null,1,null,null,0,0]]"><div _ngcontent-ng-c347665101="" class="code-block-internal-container ng-tns-c347665101-484"><div _ngcontent-ng-c347665101="" class="animated-opacity ng-tns-c347665101-484"></div></div><div _ngcontent-ng-c347665101="" class="code-block-decoration footer gmat-overline ng-tns-c347665101-484 hide-from-message-actions ng-star-inserted" hide-from-message-actions=""><div _ngcontent-ng-c347665101="" class="ng-tns-c347665101-484"><span class="ng-tns-c347665101-484">Verwende den Code [mit Vorsicht](https://corrently.io/faq#coding).</span></div><div _ngcontent-ng-c347665101="" class="buttons ng-tns-c347665101-484"><button aria-label="Code kopieren" class="mat-mdc-tooltip-trigger copy-button ng-tns-c347665101-484 mdc-icon-button mat-mdc-icon-button gmat-mdc-button-with-prefix mat-unthemed mat-mdc-button-base gmat-mdc-button"></button></div></div></div>
    - **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](https://api.corrently.io/v2.0/tydids/status?identity=0x95Bee09c395c60883Fa8bb95F05404a71f7ee7F7)
    - Response Body:
        
        <div _ngcontent-ng-c347665101="" class="code-block ng-tns-c347665101-485 ng-trigger ng-trigger-codeBlockRevealAnimation" jslog="223238;track:impression;BardVeMetadataKey:[["r_1a2a4ab365d1ea79","c_873520ef584738e4",null,"rc_a503cb4a019b216b",null,null,"en",null,1,null,null,0,0]]"><div _ngcontent-ng-c347665101="" class="code-block ng-tns-c347665101-485 ng-trigger ng-trigger-codeBlockRevealAnimation" jslog="223238;track:impression;BardVeMetadataKey:[["r_1a2a4ab365d1ea79","c_873520ef584738e4",null,"rc_a503cb4a019b216b",null,null,"en",null,1,null,null,0,0]]"><div _ngcontent-ng-c347665101="" class="code-block-decoration header gmat-subtitle-1 ng-tns-c347665101-485 ng-star-inserted"><span class="ng-tns-c347665101-485">JSON</span></div><div _ngcontent-ng-c347665101="" class="code-block-internal-container ng-tns-c347665101-485"><div _ngcontent-ng-c347665101="" class="animated-opacity ng-tns-c347665101-485"></div></div></div></div>```
        {
          "status": "granted",
          "consensus": 40856
        }
        
        ```
        
        <div _ngcontent-ng-c347665101="" class="code-block ng-tns-c347665101-485 ng-trigger ng-trigger-codeBlockRevealAnimation" jslog="223238;track:impression;BardVeMetadataKey:[["r_1a2a4ab365d1ea79","c_873520ef584738e4",null,"rc_a503cb4a019b216b",null,null,"en",null,1,null,null,0,0]]"><div _ngcontent-ng-c347665101="" class="code-block-internal-container ng-tns-c347665101-485"><div _ngcontent-ng-c347665101="" class="animated-opacity ng-tns-c347665101-485"></div></div><div _ngcontent-ng-c347665101="" class="code-block-decoration footer gmat-overline ng-tns-c347665101-485 hide-from-message-actions ng-star-inserted" hide-from-message-actions=""><div _ngcontent-ng-c347665101="" class="ng-tns-c347665101-485"><span class="ng-tns-c347665101-485">Verwende den Code [mit Vorsicht](https://corrently.io/faq#coding).</span></div><div _ngcontent-ng-c347665101="" class="buttons ng-tns-c347665101-485"><button aria-label="Code kopieren" class="mat-mdc-tooltip-trigger copy-button ng-tns-c347665101-485 mdc-icon-button mat-mdc-icon-button gmat-mdc-button-with-prefix mat-unthemed mat-mdc-button-base gmat-mdc-button"></button></div></div></div>
- **Checking an identity that has revoked data approval:**
    
    
    - API Call: [https://api.corrently.io/v2.0/tydids/status?identity=0xa8CD7c57c144be63852Da3C44D97088A740D43Cd](https://api.corrently.io/v2.0/tydids/status?identity=0xa8CD7c57c144be63852Da3C44D97088A740D43Cd)
    - Response Body:
        
        <div _ngcontent-ng-c347665101="" class="code-block ng-tns-c347665101-486 ng-trigger ng-trigger-codeBlockRevealAnimation" jslog="223238;track:impression;BardVeMetadataKey:[["r_1a2a4ab365d1ea79","c_873520ef584738e4",null,"rc_a503cb4a019b216b",null,null,"en",null,1,null,null,0,0]]"><div _ngcontent-ng-c347665101="" class="code-block ng-tns-c347665101-486 ng-trigger ng-trigger-codeBlockRevealAnimation" jslog="223238;track:impression;BardVeMetadataKey:[["r_1a2a4ab365d1ea79","c_873520ef584738e4",null,"rc_a503cb4a019b216b",null,null,"en",null,1,null,null,0,0]]"><div _ngcontent-ng-c347665101="" class="code-block-decoration header gmat-subtitle-1 ng-tns-c347665101-486 ng-star-inserted"><span class="ng-tns-c347665101-486">JSON</span></div><div _ngcontent-ng-c347665101="" class="code-block-internal-container ng-tns-c347665101-486"><div _ngcontent-ng-c347665101="" class="animated-opacity ng-tns-c347665101-486"></div></div></div></div>```
        {
          "status": "revoked",
          "consensus": 40850,
          "revoked": 1722722789
        }
        
        ```
        
        <div _ngcontent-ng-c347665101="" class="code-block ng-tns-c347665101-486 ng-trigger ng-trigger-codeBlockRevealAnimation" jslog="223238;track:impression;BardVeMetadataKey:[["r_1a2a4ab365d1ea79","c_873520ef584738e4",null,"rc_a503cb4a019b216b",null,null,"en",null,1,null,null,0,0]]"><div _ngcontent-ng-c347665101="" class="code-block-internal-container ng-tns-c347665101-486"><div _ngcontent-ng-c347665101="" class="animated-opacity ng-tns-c347665101-486"></div></div><div _ngcontent-ng-c347665101="" class="code-block-decoration footer gmat-overline ng-tns-c347665101-486 hide-from-message-actions ng-star-inserted" hide-from-message-actions=""><div _ngcontent-ng-c347665101="" class="ng-tns-c347665101-486"><span class="ng-tns-c347665101-486">Verwende den Code [mit Vorsicht](https://corrently.io/faq#coding).</span></div><div _ngcontent-ng-c347665101="" class="buttons ng-tns-c347665101-486"><button aria-label="Code kopieren" class="mat-mdc-tooltip-trigger copy-button ng-tns-c347665101-486 mdc-icon-button mat-mdc-icon-button gmat-mdc-button-with-prefix mat-unthemed mat-mdc-button-base gmat-mdc-button"></button></div></div></div>

### 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.