@cheqd/studio 3.15.0-develop.1 → 3.15.0-develop.2

package/dist/static/swagger-api.json

@@ -577,6 +577,22 @@
                         "additionalProperties": true,
                         "description": "Credential status configuration"
                     },
+                    "statusRegistryId": {
+                        "type": "string",
+                        "description": "UUID of the Status Registry"
+                    },
+                    "statusIndex": {
+                        "type": "number",
+                        "description": "Allocated Index of the Status Registry"
+                    },
+                    "retryCount": {
+                        "type": "number",
+                        "description": "Retry Count in case of failures"
+                    },
+                    "lastError": {
+                        "type": "string",
+                        "description": "Last error message in case of failure"
+                    },
                     "providerMetadata": {
                         "type": "object",
                         "additionalProperties": true,
@@ -685,6 +701,100 @@
                     }
                 }
             },
+            "RetryCredentialRequest": {
+                "type": "object",
+                "properties": {
+                    "attributes": {
+                        "description": "JSON object containing the attributes to be included in the credential.",
+                        "type": "object",
+                        "example": {
+                            "name": "Bob",
+                            "gender": "male"
+                        }
+                    },
+                    "@context": {
+                        "description": "Optional properties to be included in the `@context` property of the credential.",
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        },
+                        "example": [
+                            "https://schema.org/schema.jsonld",
+                            "https://veramo.io/contexts/profile/v1"
+                        ]
+                    },
+                    "type": {
+                        "description": "Optional properties to be included in the `type` property of the credential.",
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        },
+                        "example": [
+                            "Person"
+                        ]
+                    },
+                    "expirationDate": {
+                        "description": "Optional expiration date according to the <a href=https://www.w3.org/TR/vc-data-model/#expiration> VC Data Model specification</a>.",
+                        "type": "string",
+                        "format": "date-time",
+                        "example": "2023-06-08T13:49:28.000Z"
+                    },
+                    "termsOfUse": {
+                        "description": "Terms of use can be utilized by an issuer or a holder to communicate the terms under which a verifiable credential was issued.",
+                        "type": "array",
+                        "items": {
+                            "type": "object",
+                            "example": {
+                                "type": "IssuerPolicy",
+                                "id": "http://example.com/policies/credential/4",
+                                "profile": "http://example.com/profiles/credential",
+                                "prohibition": [
+                                    {
+                                        "assigner": "https://example.edu/issuers/14",
+                                        "assignee": "AllVerifiers",
+                                        "target": "http://example.edu/credentials/3732",
+                                        "action": [
+                                            "Archival"
+                                        ]
+                                    }
+                                ]
+                            }
+                        }
+                    },
+                    "refreshService": {
+                        "description": "RefreshService property MUST be one or more refresh services that provides enough information to the recipient's software such that the recipient can refresh the verifiable credential.",
+                        "type": "array",
+                        "items": {
+                            "type": "object",
+                            "example": {
+                                "type": "ManualRefreshService2018",
+                                "id": "https://example.edu/refresh/3732"
+                            }
+                        }
+                    },
+                    "evidence": {
+                        "description": "Evidence property MUST be one or more evidence schemes providing enough information for a verifier to determine whether the evidence gathered by the issuer meets its confidence requirements for relying on the credential.",
+                        "type": "array",
+                        "items": {
+                            "type": "object",
+                            "example": {
+                                "type": [
+                                    "DocumentVerification"
+                                ],
+                                "id": "https://example.edu/evidence/f2aeec97-fc0d-42bf-8ca7-0548192d4231",
+                                "verifier": "https://example.edu/issuers/14",
+                                "evidenceDocument": "DriversLicense",
+                                "subjectPresence": "Physical",
+                                "documentPresence": "Physical",
+                                "licenseNumber": "123AB4567"
+                            }
+                        }
+                    }
+                },
+                "required": [
+                    "attributes"
+                ]
+            },
             "VerifyPresentationResult": {
                 "type": "object",
                 "properties": {
@@ -1099,6 +1209,175 @@
                     }
                 }
             },
+            "CredentialStatusRecordResult": {
+                "type": "object",
+                "properties": {
+                    "statusListId": {
+                        "type": "string",
+                        "description": "Unique identifier for the status registry"
+                    },
+                    "statusListName": {
+                        "type": "string",
+                        "description": "Name of the status list resource"
+                    },
+                    "uri": {
+                        "type": "string",
+                        "description": "DID URL of the status list resource"
+                    },
+                    "issuerId": {
+                        "type": "string",
+                        "format": "uri",
+                        "description": "DID of the issuer"
+                    },
+                    "previousUri": {
+                        "type": "string",
+                        "nullable": true,
+                        "description": "Link to previous registry in the chain (for FULL registries)"
+                    },
+                    "nextUri": {
+                        "type": "string",
+                        "nullable": true,
+                        "description": "Link to next registry in the chain (STANDBY registry)"
+                    },
+                    "listType": {
+                        "type": "string",
+                        "description": "Type of status list (StatusList2021Revocation, StatusList2021Suspension, BitstringStatusListCredential)"
+                    },
+                    "storageType": {
+                        "type": "string",
+                        "enum": [
+                            "cheqd",
+                            "ipfs",
+                            "dock",
+                            "paradym"
+                        ],
+                        "description": "Storage provider for the status list"
+                    },
+                    "encrypted": {
+                        "type": "boolean",
+                        "description": "Whether the status list is encrypted"
+                    },
+                    "credentialCategory": {
+                        "type": "string",
+                        "enum": [
+                            "credential",
+                            "accreditation"
+                        ],
+                        "description": "Category of credentials this status list is for"
+                    },
+                    "size": {
+                        "type": "integer",
+                        "description": "Maximum capacity of the status list (total number of indices)"
+                    },
+                    "writeCursor": {
+                        "type": "integer",
+                        "description": "Current write cursor position (last assigned index)"
+                    },
+                    "state": {
+                        "type": "string",
+                        "enum": [
+                            "ACTIVE",
+                            "STANDBY",
+                            "FULL"
+                        ],
+                        "description": "Current state of the registry"
+                    },
+                    "createdAt": {
+                        "type": "string",
+                        "format": "date-time",
+                        "description": "Timestamp when the registry was created"
+                    },
+                    "updatedAt": {
+                        "type": "string",
+                        "format": "date-time",
+                        "description": "Timestamp when the registry was last updated"
+                    },
+                    "sealedAt": {
+                        "type": "string",
+                        "format": "date-time",
+                        "nullable": true,
+                        "description": "Timestamp when the registry was sealed (marked as FULL)"
+                    },
+                    "statusPurpose": {
+                        "oneOf": [
+                            {
+                                "type": "string"
+                            },
+                            {
+                                "type": "array",
+                                "items": {
+                                    "type": "string"
+                                }
+                            }
+                        ],
+                        "description": "Status purpose or list of status purposes"
+                    },
+                    "deprecated": {
+                        "type": "boolean",
+                        "description": "Whether the registry is deprecated"
+                    }
+                },
+                "example": {
+                    "statusListId": "5945233a-a4b5-422b-b893-eaed5cedd2dc",
+                    "statusListName": "cheqd-employee-credentials",
+                    "uri": "did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e?resourceName=cheqd-employee-credentials&resourceType=StatusList2021Revocation",
+                    "issuerId": "did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e",
+                    "previousUri": null,
+                    "nextUri": "did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e?resourceName=cheqd-employee-credentials-ext1&resourceType=StatusList2021Revocation",
+                    "listType": "StatusList2021Revocation",
+                    "storageType": "cheqd",
+                    "encrypted": false,
+                    "credentialCategory": "credential",
+                    "size": 131072,
+                    "writeCursor": 105432,
+                    "state": "ACTIVE",
+                    "createdAt": "2023-06-26T11:45:19.349Z",
+                    "updatedAt": "2023-06-26T11:45:20.000Z",
+                    "statusPurpose": [
+                        "revocation"
+                    ],
+                    "sealedAt": null,
+                    "deprecated": false
+                }
+            },
+            "ListCredentialStatusRecordsResult": {
+                "type": "object",
+                "properties": {
+                    "total": {
+                        "type": "number"
+                    },
+                    "records": {
+                        "type": "array",
+                        "items": {
+                            "$ref": "#/components/schemas/CredentialStatusRecordResult"
+                        }
+                    }
+                },
+                "example": {
+                    "total": 1,
+                    "records": [
+                        {
+                            "statusListId": "5945233a-a4b5-422b-b893-eaed5cedd2dc",
+                            "statusListName": "cheqd-employee-credentials",
+                            "uri": "did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e?resourceName=cheqd-employee-credentials&resourceType=StatusList2021Revocation",
+                            "issuerId": "did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e",
+                            "previousUri": null,
+                            "nextUri": "did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e?resourceName=cheqd-employee-credentials-ext1&resourceType=StatusList2021Revocation",
+                            "listType": "StatusList2021Revocation",
+                            "storageType": "cheqd",
+                            "encrypted": false,
+                            "credentialCategory": "credential",
+                            "size": 131072,
+                            "writeCursor": 105432,
+                            "state": "ACTIVE",
+                            "createdAt": "2023-06-26T11:45:19.349Z",
+                            "updatedAt": "2023-06-26T11:45:20.000Z",
+                            "sealedAt": null,
+                            "deprecated": false
+                        }
+                    ]
+                }
+            },
             "CredentialStatusCreateBody": {
                 "allOf": [
                     {
@@ -1142,6 +1421,14 @@
                                 "type": "integer",
                                 "minimum": 1
                             },
+                            "credentialCategory": {
+                                "description": "Category of credentials this status list is for.",
+                                "type": "string",
+                                "enum": [
+                                    "credential",
+                                    "accreditation"
+                                ]
+                            },
                             "statusMessages": {
                                 "description": "Only for BitstringStatusList (Mandatory if statusSize > 1): Message explaining each bit",
                                 "type": "array",
@@ -1637,11 +1924,11 @@
                         "exclusiveMinimum": false
                     },
                     "statusListCredential": {
-                        "description": "Optional Resolvable DID URL of the BistringStatusList credential to be checked.",
+                        "description": "Optional Resolvable DID URL of the BitstringStatusList credential to be checked.",
                         "type": "string"
                     },
                     "statusSize": {
-                        "description": "Optional size of the BistringStatusList.",
+                        "description": "Optional size of the BitstringStatusList.",
                         "type": "number",
                         "default": 2
                     },
@@ -2834,54 +3121,50 @@
                     },
                     "accreditations": {
                         "type": "array",
-                        "description": "List of accreditations.",
+                        "description": "List of accreditations with credential data and tracking metadata.",
                         "items": {
-                            "type": "object",
-                            "properties": {
-                                "id": {
-                                    "type": "string",
-                                    "description": "Unique identifier of the accreditation.",
-                                    "example": "did:cheqd:testnet:12345678-90ab-cdef-1234-567890abcdef"
-                                },
-                                "name": {
-                                    "type": "string",
-                                    "description": "Name of the accreditation.",
-                                    "example": "MuseumPassAccreditation"
-                                },
-                                "issuerDid": {
-                                    "type": "string",
-                                    "description": "DID of the accreditation issuer.",
-                                    "example": "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0"
-                                },
-                                "subjectDid": {
-                                    "type": "string",
-                                    "description": "DID of the accreditation holder/subject.",
-                                    "example": "did:cheqd:testnet:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK"
+                            "allOf": [
+                                {
+                                    "$ref": "#/components/schemas/VerifiableCredential"
                                 },
-                                "schemas": {
-                                    "type": "array",
-                                    "description": "List of schemas associated with the accreditation.",
-                                    "items": {
-                                        "$ref": "#/components/schemas/SchemaUrl"
+                                {
+                                    "type": "object",
+                                    "properties": {
+                                        "metadata": {
+                                            "type": "object",
+                                            "description": "Tracking metadata from the issued credential database record",
+                                            "properties": {
+                                                "issuedCredentialId": {
+                                                    "type": "string",
+                                                    "description": "Unique identifier for the issued credential"
+                                                },
+                                                "providerId": {
+                                                    "type": "string",
+                                                    "description": "Provider identifier"
+                                                },
+                                                "providerCredentialId": {
+                                                    "type": "string",
+                                                    "description": "Provider-specific credential ID (resourceId)"
+                                                },
+                                                "status": {
+                                                    "type": "string",
+                                                    "description": "Current status of the credential",
+                                                    "enum": [
+                                                        "issued",
+                                                        "suspended",
+                                                        "revoked"
+                                                    ]
+                                                },
+                                                "statusUpdatedAt": {
+                                                    "type": "string",
+                                                    "format": "date-time",
+                                                    "description": "Timestamp when status was last updated"
+                                                }
+                                            }
+                                        }
                                     }
-                                },
-                                "expirationDate": {
-                                    "type": "string",
-                                    "format": "date-time",
-                                    "description": "Expiration date of the accreditation.",
-                                    "example": "2025-12-31T23:59:59Z"
-                                },
-                                "status": {
-                                    "type": "string",
-                                    "description": "Current status of the accreditation.",
-                                    "enum": [
-                                        "active",
-                                        "revoked",
-                                        "expired"
-                                    ],
-                                    "example": "active"
                                 }
-                            }
+                            ]
                         }
                     }
                 }
@@ -3874,6 +4157,138 @@
                 }
             }
         },
+        "/credential-status/list": {
+            "get": {
+                "tags": [
+                    "Status Lists"
+                ],
+                "summary": "List StatusList2021 or BitstringStatusList DID-Linked Resources created by the customer.",
+                "parameters": [
+                    {
+                        "in": "query",
+                        "name": "did",
+                        "description": "The DID of the issuer of the status list.",
+                        "schema": {
+                            "type": "string"
+                        }
+                    },
+                    {
+                        "in": "query",
+                        "name": "listType",
+                        "description": "The type of Status List.",
+                        "schema": {
+                            "type": "string",
+                            "enum": [
+                                "StatusList2021",
+                                "BitstringStatusList"
+                            ]
+                        }
+                    },
+                    {
+                        "in": "query",
+                        "name": "statusListName",
+                        "description": "The name of the Status List DID-Linked Resource.",
+                        "schema": {
+                            "type": "string"
+                        }
+                    },
+                    {
+                        "in": "query",
+                        "name": "state",
+                        "description": "The state of the Status List DID-Linked Resource.",
+                        "schema": {
+                            "type": "string",
+                            "enum": [
+                                "ACTIVE",
+                                "STANDBY",
+                                "FULL"
+                            ]
+                        }
+                    },
+                    {
+                        "in": "query",
+                        "name": "credentialCategory",
+                        "description": "Filter status lists by credential category assigned for.",
+                        "schema": {
+                            "type": "string",
+                            "enum": [
+                                "credential",
+                                "accreditation"
+                            ]
+                        }
+                    },
+                    {
+                        "in": "query",
+                        "name": "deprecated",
+                        "description": "Filter status lists by deprecated status.",
+                        "schema": {
+                            "type": "boolean"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "The request was successful.",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/ListCredentialStatusRecordsResult"
+                                }
+                            }
+                        }
+                    },
+                    "400": {
+                        "$ref": "#/components/schemas/InvalidRequest"
+                    },
+                    "401": {
+                        "$ref": "#/components/schemas/UnauthorizedError"
+                    },
+                    "500": {
+                        "$ref": "#/components/schemas/InternalError"
+                    }
+                }
+            }
+        },
+        "/credential-status/list/{statusListId}": {
+            "get": {
+                "tags": [
+                    "Status Lists"
+                ],
+                "summary": "Fetch StatusList2021 or BitstringStatusList DID-Linked Resource based on search criteria.",
+                "parameters": [
+                    {
+                        "in": "path",
+                        "name": "statusListId",
+                        "description": "The statusListId of the status list.",
+                        "required": true,
+                        "schema": {
+                            "type": "string"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "The request was successful.",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/CredentialStatusRecordResult"
+                                }
+                            }
+                        }
+                    },
+                    "400": {
+                        "$ref": "#/components/schemas/InvalidRequest"
+                    },
+                    "401": {
+                        "$ref": "#/components/schemas/UnauthorizedError"
+                    },
+                    "500": {
+                        "$ref": "#/components/schemas/InternalError"
+                    }
+                }
+            }
+        },
         "/credential/issue": {
             "post": {
                 "tags": [
@@ -4304,6 +4719,24 @@
                             "format": "date-time"
                         },
                         "required": false
+                    },
+                    {
+                        "in": "query",
+                        "name": "credentialType",
+                        "description": "Filter credentials by type (e.g., 'VerifiableCredential', 'UniversityDegreeCredential').",
+                        "schema": {
+                            "type": "string"
+                        },
+                        "required": false
+                    },
+                    {
+                        "in": "query",
+                        "name": "statusRegistryId",
+                        "description": "Filter issued credentials using status registry ID.",
+                        "schema": {
+                            "type": "string"
+                        },
+                        "required": false
                     }
                 ],
                 "responses": {
@@ -4507,6 +4940,87 @@
                 }
             }
         },
+        "/credentials/issued/{id}/re-issue": {
+            "post": {
+                "tags": [
+                    "Verifiable Credentials"
+                ],
+                "summary": "Reissue an issued credential with failed state.",
+                "description": "This endpoint re-issues the issued credential record in failed state.",
+                "parameters": [
+                    {
+                        "in": "path",
+                        "name": "id",
+                        "description": "Credential identifier (issuedCredentialId).",
+                        "required": true,
+                        "schema": {
+                            "type": "string"
+                        }
+                    }
+                ],
+                "requestBody": {
+                    "content": {
+                        "application/x-www-form-urlencoded": {
+                            "schema": {
+                                "$ref": "#/components/schemas/RetryCredentialRequest"
+                            }
+                        },
+                        "application/json": {
+                            "schema": {
+                                "$ref": "#/components/schemas/RetryCredentialRequest"
+                            }
+                        }
+                    }
+                },
+                "responses": {
+                    "200": {
+                        "description": "The request was successful.",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "type": "object",
+                                    "properties": {
+                                        "success": {
+                                            "type": "boolean"
+                                        },
+                                        "data": {
+                                            "$ref": "#/components/schemas/IssuedCredentialResponse"
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    },
+                    "400": {
+                        "$ref": "#/components/schemas/InvalidRequest"
+                    },
+                    "401": {
+                        "$ref": "#/components/schemas/UnauthorizedError"
+                    },
+                    "404": {
+                        "description": "Credential not found.",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "type": "object",
+                                    "properties": {
+                                        "success": {
+                                            "type": "boolean"
+                                        },
+                                        "error": {
+                                            "type": "string"
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    },
+                    "500": {
+                        "$ref": "#/components/schemas/InternalError"
+                    }
+                }
+            }
+        },
         "/did/create": {
             "post": {
                 "tags": [