# Models
## The AlsoKnownAs object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"AlsoKnownAs":{"type":"object","properties":{"alsoKnownAs":{"type":"array","description":"Optional field to assign a set of alternative URIs where the DID-Linked Resource can be fetched from.","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri","description":"URI where the DID-Linked Resource can be fetched from. Can be any type of URI (e.g., DID, HTTPS, IPFS, etc.)"},"description":{"type":"string","description":"Optional description of the URI."}}}}}}}}}
```
## The CredentialRequest object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"CredentialRequest":{"description":"Input fields for the creating a Verifiable Credential.","type":"object","additionalProperties":false,"properties":{"issuerDid":{"description":"DID of the Verifiable Credential issuer. This needs to be a `did:cheqd` DID.","type":"string"},"subjectDid":{"description":"DID of the Verifiable Credential holder/subject. This needs to be a `did:key` DID.","type":"string"},"attributes":{"description":"JSON object containing the attributes to be included in the credential.","type":"object"},"@context":{"description":"Optional properties to be included in the `@context` property of the credential.","type":"array","items":{"type":"string"}},"type":{"description":"Optional properties to be included in the `type` property of the credential.","type":"array","items":{"type":"string"}},"expirationDate":{"description":"Optional expiration date according to the VC Data Model specification.","type":"string","format":"date-time"},"format":{"description":"Format of the Verifiable Credential. Defaults to VC-JWT.","type":"string","enum":["jwt","jsonld"]},"credentialStatus":{"description":"Optional `credentialStatus` properties for VC revocation or suspension. Takes `statusListName` and `statusListPurpose` as inputs.","type":"object","required":["statusPurpose","statusListName","statusListType"],"properties":{"statusPurpose":{"type":"string","enum":["revocation","suspension"]},"statusListName":{"type":"string"},"statusListType":{"type":"string","enum":["StatusList2021","BitstringStatusList"]},"statusListIndex":{"type":"number"},"statusListVersion":{"type":"string","format":"date-time"},"statusListRangeStart":{"type":"number"},"statusListRangeEnd":{"type":"number"},"indexNotIn":{"type":"number"}}},"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"}},"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"}},"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"}}},"connector":{"type":"string","enum":["verida","resource"]},"required":["issuerDid","subjectDid","attributes"]}}}}
```
## The Credential object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"Credential":{"description":"Input fields for revoking/suspending a Verifiable Credential.","type":"object","additionalProperties":false,"properties":{"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"expirationDate":{"type":"string","format":"date-time"},"issuer":{"type":"object","properties":{"id":{"type":"string","format":"DID"}}},"credentialSubject":{"type":"object","properties":{"id":{"type":"string","format":"DID"}}},"credentialStatus":{"type":"object","properties":{"id":{"type":"string"},"statusListIndex":{"type":"number"},"statusPurpose":{"type":"string","enum":["revocation","suspension"]},"type":{"type":"string","enum":["StatusList2021Entry","BitstringStatusListEntry"]}}},"issuanceDate":{"type":"string","format":"date-time"},"proof":{"type":"object","properties":{"type":{"type":"string"},"jwt":{"type":"string"}}}}}}}}
```
## The VerifiableCredential object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"VerifiableCredential":{"type":"object","required":["@context","type","issuer","issuanceDate","credentialSubject"],"properties":{"@context":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"JSON-LD context"},"id":{"type":"string","description":"Credential identifier"},"type":{"type":"array","items":{"type":"string"},"description":"Credential types"},"issuer":{"oneOf":[{"type":"string"},{"type":"object","properties":{"id":{"type":"string"}}}],"description":"Credential issuer"},"issuanceDate":{"type":"string","format":"date-time","description":"Issuance date"},"expirationDate":{"type":"string","format":"date-time","description":"Expiration date"},"credentialSubject":{"type":"object","additionalProperties":true,"description":"Credential subject claims"},"proof":{"type":"object","additionalProperties":true,"description":"Cryptographic proof"},"credentialStatus":{"type":"object","additionalProperties":true,"description":"Credential status information"}}}}}}
```
## The IssuedCredentialResponse object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"IssuedCredentialResponse":{"type":"object","required":["issuedCredentialId","providerId","format","type","status","issuedAt"],"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"},"issuerId":{"type":"string","description":"DID or identifier of the credential issuer"},"subjectId":{"type":"string","description":"DID or identifier of the credential subject"},"format":{"type":"string","description":"Credential format (e.g., jwt_vc, jsonld)"},"category":{"type":"string","description":"Credential category","enum":["credential","accreditation"]},"type":{"type":"array","items":{"type":"string"},"description":"Array of credential types"},"status":{"type":"string","description":"Current status of the credential","enum":["active","revoked","suspended","expired"]},"statusUpdatedAt":{"type":"string","format":"date-time","description":"Timestamp when status was last updated"},"issuedAt":{"type":"string","format":"date-time","description":"Timestamp when credential was issued"},"expiresAt":{"type":"string","format":"date-time","description":"Timestamp when credential expires"},"credentialStatus":{"type":"object","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,"description":"Provider-specific metadata"},"credential":{"$ref":"#/components/schemas/VerifiableCredential"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when record was created"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when record was last updated"}}},"VerifiableCredential":{"type":"object","required":["@context","type","issuer","issuanceDate","credentialSubject"],"properties":{"@context":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"JSON-LD context"},"id":{"type":"string","description":"Credential identifier"},"type":{"type":"array","items":{"type":"string"},"description":"Credential types"},"issuer":{"oneOf":[{"type":"string"},{"type":"object","properties":{"id":{"type":"string"}}}],"description":"Credential issuer"},"issuanceDate":{"type":"string","format":"date-time","description":"Issuance date"},"expirationDate":{"type":"string","format":"date-time","description":"Expiration date"},"credentialSubject":{"type":"object","additionalProperties":true,"description":"Credential subject claims"},"proof":{"type":"object","additionalProperties":true,"description":"Cryptographic proof"},"credentialStatus":{"type":"object","additionalProperties":true,"description":"Credential status information"}}}}}}
```
## The ListCredentialResult object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"ListCredentialResult":{"type":"object","properties":{"total":{"type":"number"},"credentials":{"type":"array","items":{"$ref":"#/components/schemas/IssuedCredentialResponse"}}}},"IssuedCredentialResponse":{"type":"object","required":["issuedCredentialId","providerId","format","type","status","issuedAt"],"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"},"issuerId":{"type":"string","description":"DID or identifier of the credential issuer"},"subjectId":{"type":"string","description":"DID or identifier of the credential subject"},"format":{"type":"string","description":"Credential format (e.g., jwt_vc, jsonld)"},"category":{"type":"string","description":"Credential category","enum":["credential","accreditation"]},"type":{"type":"array","items":{"type":"string"},"description":"Array of credential types"},"status":{"type":"string","description":"Current status of the credential","enum":["active","revoked","suspended","expired"]},"statusUpdatedAt":{"type":"string","format":"date-time","description":"Timestamp when status was last updated"},"issuedAt":{"type":"string","format":"date-time","description":"Timestamp when credential was issued"},"expiresAt":{"type":"string","format":"date-time","description":"Timestamp when credential expires"},"credentialStatus":{"type":"object","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,"description":"Provider-specific metadata"},"credential":{"$ref":"#/components/schemas/VerifiableCredential"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when record was created"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when record was last updated"}}},"VerifiableCredential":{"type":"object","required":["@context","type","issuer","issuanceDate","credentialSubject"],"properties":{"@context":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"JSON-LD context"},"id":{"type":"string","description":"Credential identifier"},"type":{"type":"array","items":{"type":"string"},"description":"Credential types"},"issuer":{"oneOf":[{"type":"string"},{"type":"object","properties":{"id":{"type":"string"}}}],"description":"Credential issuer"},"issuanceDate":{"type":"string","format":"date-time","description":"Issuance date"},"expirationDate":{"type":"string","format":"date-time","description":"Expiration date"},"credentialSubject":{"type":"object","additionalProperties":true,"description":"Credential subject claims"},"proof":{"type":"object","additionalProperties":true,"description":"Cryptographic proof"},"credentialStatus":{"type":"object","additionalProperties":true,"description":"Credential status information"}}}}}}
```
## The CredentialRevokeRequest object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"CredentialRevokeRequest":{"type":"object","properties":{"credential":{"description":"Verifiable Credential to be revoked as a VC-JWT string or a JSON object.","oneOf":[{"type":"object"},{"type":"string"}]},"symmetricKey":{"description":"The symmetric key used to encrypt the StatusList2021 DID-Linked Resource. Required if the StatusList2021 DID-Linked Resource is encrypted.","type":"string"}}}}}}
```
## The RevocationResult object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"RevocationResult":{"properties":{"revoked":{"type":"boolean"}}}}}}
```
## The SuspensionResult object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"SuspensionResult":{"properties":{"suspended":{"type":"boolean"}}}}}}
```
## The UnsuspensionResult object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"UnsuspensionResult":{"properties":{"unsuspended":{"type":"boolean"}}}}}}
```
## The CredentialVerifyRequest object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"CredentialVerifyRequest":{"type":"object","properties":{"credential":{"description":"Verifiable Credential to be verified as a VC-JWT string or a JSON object.","type":"object"},"policies":{"description":"Custom verification policies to execute when verifying credential.","type":"object","properties":{"issuanceDate":{"description":"Policy to skip the `issuanceDate` (`nbf`) timestamp check when set to `false`.","type":"boolean","default":true},"expirationDate":{"description":"Policy to skip the `expirationDate` (`exp`) timestamp check when set to `false`.","type":"boolean","default":true},"audience":{"description":"Policy to skip the audience check when set to `false`.","type":"boolean","default":false},"checkExternalProvider":{"description":"Policy to also check other providers when set to `true`.","type":"boolean","default":false}}}}}}}}
```
## The RetryCredentialRequest object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"RetryCredentialRequest":{"type":"object","properties":{"attributes":{"description":"JSON object containing the attributes to be included in the credential.","type":"object"},"@context":{"description":"Optional properties to be included in the `@context` property of the credential.","type":"array","items":{"type":"string"}},"type":{"description":"Optional properties to be included in the `type` property of the credential.","type":"array","items":{"type":"string"}},"expirationDate":{"description":"Optional expiration date according to the VC Data Model specification.","type":"string","format":"date-time"},"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"}},"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"}},"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"}}},"required":["attributes"]}}}}
```
## The VerifyPresentationResult object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"VerifyPresentationResult":{"type":"object","properties":{"verified":{"type":"boolean"},"issuer":{"type":"string"},"signer":{"type":"object"},"jwt":{"type":"string"},"verifiableCredential":{"type":"object"}}}}}}
```
## The VerifyCredentialResult object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"VerifyCredentialResult":{"type":"object","properties":{"verified":{"type":"boolean"},"issuer":{"type":"string"},"signer":{"type":"object"},"jwt":{"type":"string"},"verifiableCredential":{"type":"object"}}}}}}
```
## The AccreditationVerifyResponse object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"AccreditationVerifyResponse":{"type":"object","properties":{"verified":{"type":"boolean"},"issuer":{"type":"string"},"signer":{"type":"object"},"jwt":{"type":"string"},"verifiableCredential":{"type":"object"},"accreditorDids":{"type":"array","items":{"type":"string"}},"rootAuthorization":{"type":"object"},"termsOfUse":{"type":"object","properties":{"type":{"type":"string"},"trustFrameworkId":{"type":"string"},"trustFramework":{"type":"string"}}}}}}}}
```
## The AccreditationIssueRequest object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"AccreditationIssueRequest":{"description":"Input fields for the creating a Verifiable Accreditation.","type":"object","additionalProperties":false,"properties":{"issuerDid":{"description":"DID of the Verifiable Accreditation issuer. This needs to be a `did:cheqd` DID.","type":"string"},"subjectDid":{"description":"DID of the Verifiable Accreditation holder/subject. This needs to be a `did:cheqd` DID.","type":"string"},"schemas":{"description":"The list of schemas the subject DID is accredited for.","type":"array","items":{"$ref":"#/components/schemas/SchemaUrl"}},"accreditationName":{"description":"Unique name of the Verifiable Accreditation.","type":"string"},"attributes":{"description":"JSON object containing the attributes to be included in the Accreditation.","type":"object"},"@context":{"description":"Optional properties to be included in the `@context` property of the Accreditation.","type":"array","items":{"type":"string"}},"parentAccreditation":{"description":"DID URL of the parent Verifiable Accreditation, required for accredit/attest operation.","type":"string"},"rootAuthorization":{"description":"DID URL of the root Verifiable Accreditation, required for accredit/attest operation.","type":"string"},"trustFramework":{"description":"Name or Type of the Trust Framework, required for authorize operation.","type":"string"},"trustFrameworkId":{"description":"Url of the Trust Framework, required for authorize operation.","type":"string"},"type":{"description":"Optional properties to be included in the `type` property of the Accreditation.","type":"array","items":{"type":"string"}},"expirationDate":{"description":"Optional expiration date according to the VC Data Model specification.","type":"string","format":"date-time"},"format":{"description":"Format of the Verifiable Accreditation. Defaults to VC-JWT.","type":"string","enum":["jwt","jsonld"]},"credentialStatus":{"description":"Optional `credentialStatus` properties for VC revocation or suspension. Takes `statusListName` and `statusListPurpose` as inputs.","type":"object","required":["statusPurpose","statusListName"],"properties":{"statusPurpose":{"type":"string","enum":["revocation","suspension"]},"statusListName":{"type":"string"},"statusListIndex":{"type":"number"},"statusListVersion":{"type":"string","format":"date-time"},"statusListRangeStart":{"type":"number"},"statusListRangeEnd":{"type":"number"},"indexNotIn":{"type":"number"}}},"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"}},"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"}},"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"}}},"required":["issuerDid","subjectDid","schemas","accreditationName"]},"SchemaUrl":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string"}},"url":{"type":"string"}}}}}}
```
## The AccreditationVerifyRequest object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"AccreditationVerifyRequest":{"type":"object","properties":{"subjectDid":{"description":"DID of the Verifiable Accreditation holder/subject. This needs to be a `did:key` DID.","type":"string"},"didUrl":{"description":"DID URL of the Verifiable Accreditation to be verified as a VC-JWT string or a JSON object.","type":"string"},"did":{"description":"DID of the Verifiable Accreditation holder/subject","type":"string"},"resourceId":{"description":"Unique resource identifier of the Verifiable Accreditation","type":"string"},"resourceName":{"description":"Resource name of the Verifiable Accreditation","type":"string"},"resourceType":{"description":"Resource type of the Verifiable Accreditation","type":"string"},"schemas":{"description":"The list of schemas the subject DID is accredited for.","type":"array","items":{"$ref":"#/components/schemas/SchemaUrl"}},"policies":{"description":"Custom verification policies to execute when verifying Accreditation.","type":"object","properties":{"issuanceDate":{"description":"Policy to skip the `issuanceDate` (`nbf`) timestamp check when set to `false`.","type":"boolean","default":true},"expirationDate":{"description":"Policy to skip the `expirationDate` (`exp`) timestamp check when set to `false`.","type":"boolean","default":true},"audience":{"description":"Policy to skip the audience check when set to `false`.","type":"boolean","default":false}}}},"required":["subjectDid"]},"SchemaUrl":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string"}},"url":{"type":"string"}}}}}}
```
## The AccreditationRevokeRequest object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"AccreditationRevokeRequest":{"type":"object","properties":{"didUrl":{"description":"Verifiable Accreditation to be verified as a VC-JWT string or a JSON object.","type":"string"},"did":{"type":"string"},"resourceId":{"type":"string"},"resourceName":{"type":"string"},"resourceType":{"type":"string"},"symmetricKey":{"description":"The symmetric key used to encrypt the StatusList2021 DID-Linked Resource. Required if the StatusList2021 DID-Linked Resource is encrypted.","type":"string"}}}}}}
```
## The PresentationCreateRequest object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"PresentationCreateRequest":{"type":"object","required":["credentials"],"properties":{"credentials":{"description":"Verifiable Credentials to be used for VP-JWT creation as a VP-JWT strings or a JSON objectsf.","type":"array","items":{"type":"object"}},"holderDid":{"description":"DID of holder","type":"string"},"verifierDid":{"description":"DID of verifier","type":"string"}}}}}}
```
## The PresentationVerifyRequest object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"PresentationVerifyRequest":{"type":"object","required":["presentation"],"properties":{"presentation":{"description":"Verifiable Presentation to be verified as a VP-JWT string or a JSON object.","type":"object"},"verifierDid":{"description":"Provide an optional verifier DID (also known as 'domain' parameter), if the verifier DID in the presentation is not managed in the wallet.","type":"string"},"makeFeePayment":{"description":"Automatically make fee payment (if required) based on payment conditions to unlock encrypted StatusList2021 or BitstringStatusList DID-Linked Resource.","type":"boolean","default":false},"policies":{"description":"Custom verification policies to execute when verifying presentation.","type":"object","properties":{"issuanceDate":{"description":"Policy to skip the `issuanceDate` (`nbf`) timestamp check when set to `false`.","type":"boolean","default":true},"expirationDate":{"description":"Policy to skip the `expirationDate` (`exp`) timestamp check when set to `false`.","type":"boolean","default":true},"audience":{"description":"Policy to skip the audience check when set to `false`.","type":"boolean","default":false}}}}}}}}
```
## The CredentialStatusRecordResult object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"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"}}}}}}
```
## The ListCredentialStatusRecordsResult object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"ListCredentialStatusRecordsResult":{"type":"object","properties":{"total":{"type":"number"},"records":{"type":"array","items":{"$ref":"#/components/schemas/CredentialStatusRecordResult"}}}},"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"}}}}}}
```
## The CredentialStatusCreateBody object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"CredentialStatusCreateBody":{"allOf":[{"type":"object","required":["did","statusListName"],"properties":{"did":{"description":"DID of the StatusList2021 or BitstringStatusList publisher.","type":"string","format":"uri"},"statusListName":{"description":"The name of the StatusList2021 or BitstringStatusList DID-Linked Resource to be created.","type":"string"},"length":{"description":"The length of the status list to be created. The default and minimum length is 131072 which is 16kb.","type":"integer","minimum":0,"exclusiveMinimum":true,"default":131072},"encoding":{"description":"The encoding format of the StatusList2021 or BitstringStatusList (only base64url supported) DiD-Linked Resource to be created.","type":"string","default":"base64url","enum":["base64url","hex"]},"statusListVersion":{"description":"Optional field to assign a human-readable version in the StatusList2021 or BitstringStatusList DID-Linked Resource.","type":"string"},"statusSize":{"description":"Only for BitstringStatusList: bits per credential, used to support multiple status in same list.","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","items":{"type":"object","properties":{"status":{"type":"string"},"message":{"type":"string"}}}},"ttl":{"description":"Only for BitstringStatusList: Time to Live in Miliseconds (not expiry).","type":"integer","minimum":1000}}},{"$ref":"#/components/schemas/AlsoKnownAs"}]},"AlsoKnownAs":{"type":"object","properties":{"alsoKnownAs":{"type":"array","description":"Optional field to assign a set of alternative URIs where the DID-Linked Resource can be fetched from.","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri","description":"URI where the DID-Linked Resource can be fetched from. Can be any type of URI (e.g., DID, HTTPS, IPFS, etc.)"},"description":{"type":"string","description":"Optional description of the URI."}}}}}}}}}
```
## The CredentialStatusCreateUnencryptedRequest object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"CredentialStatusCreateUnencryptedRequest":{"allOf":[{"$ref":"#/components/schemas/CredentialStatusCreateBody"}]},"CredentialStatusCreateBody":{"allOf":[{"type":"object","required":["did","statusListName"],"properties":{"did":{"description":"DID of the StatusList2021 or BitstringStatusList publisher.","type":"string","format":"uri"},"statusListName":{"description":"The name of the StatusList2021 or BitstringStatusList DID-Linked Resource to be created.","type":"string"},"length":{"description":"The length of the status list to be created. The default and minimum length is 131072 which is 16kb.","type":"integer","minimum":0,"exclusiveMinimum":true,"default":131072},"encoding":{"description":"The encoding format of the StatusList2021 or BitstringStatusList (only base64url supported) DiD-Linked Resource to be created.","type":"string","default":"base64url","enum":["base64url","hex"]},"statusListVersion":{"description":"Optional field to assign a human-readable version in the StatusList2021 or BitstringStatusList DID-Linked Resource.","type":"string"},"statusSize":{"description":"Only for BitstringStatusList: bits per credential, used to support multiple status in same list.","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","items":{"type":"object","properties":{"status":{"type":"string"},"message":{"type":"string"}}}},"ttl":{"description":"Only for BitstringStatusList: Time to Live in Miliseconds (not expiry).","type":"integer","minimum":1000}}},{"$ref":"#/components/schemas/AlsoKnownAs"}]},"AlsoKnownAs":{"type":"object","properties":{"alsoKnownAs":{"type":"array","description":"Optional field to assign a set of alternative URIs where the DID-Linked Resource can be fetched from.","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri","description":"URI where the DID-Linked Resource can be fetched from. Can be any type of URI (e.g., DID, HTTPS, IPFS, etc.)"},"description":{"type":"string","description":"Optional description of the URI."}}}}}}}}}
```
## The CredentialStatusUnencryptedResult object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"CredentialStatusUnencryptedResult":{"type":"object","properties":{"resource":{"type":"object","properties":{"StatusList2021":{"type":"object","properties":{"encodedList":{"type":"string"},"type":{"type":"string"},"validFrom":{"type":"string","format":"date-time"}}},"metadata":{"type":"object","properties":{"type":{"type":"string"},"encoding":{"type":"string"},"encrypted":{"type":"boolean"}}}}},"resourceMetadata":{"type":"object"}}}}}}
```
## The CredentialStatusCreateUnencryptedResult object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"CredentialStatusCreateUnencryptedResult":{"allOf":[{"type":"object","properties":{"created":{"type":"boolean"}}},{"$ref":"#/components/schemas/CredentialStatusUnencryptedResult"}]},"CredentialStatusUnencryptedResult":{"type":"object","properties":{"resource":{"type":"object","properties":{"StatusList2021":{"type":"object","properties":{"encodedList":{"type":"string"},"type":{"type":"string"},"validFrom":{"type":"string","format":"date-time"}}},"metadata":{"type":"object","properties":{"type":{"type":"string"},"encoding":{"type":"string"},"encrypted":{"type":"boolean"}}}}},"resourceMetadata":{"type":"object"}}}}}}
```
## The CredentialStatusEncryptedPaymentConditionsBody object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"CredentialStatusEncryptedPaymentConditionsBody":{"type":"object","properties":{"feePaymentAddress":{"description":"The cheqd/Cosmos payment address where payments to unlock the encrypted StatusList2021 or BitstringStatusList DID-Linked Resource need to be sent.","type":"string"},"feePaymentAmount":{"description":"Amount in CHEQ tokens to unlock the encrypted StatusList2021 or BitstringStatusList DID-Linked Resource.","type":"number","minimum":0,"exclusiveMinimum":true,"default":20},"feePaymentWindow":{"description":"Time window (in minutes) within which the payment to unlock the encrypted StatusList2021 or BitstringStatusList DID-Linked Resource is considered valid.","type":"number","minimum":0,"exclusiveMinimum":true,"default":10}}}}}}
```
## The CredentialStatusEncryptedPaymentConditionsJson object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"CredentialStatusEncryptedPaymentConditionsJson":{"type":"object","properties":{"paymentConditions":{"allOf":[{"$ref":"#/components/schemas/CredentialStatusEncryptedPaymentConditionsBody"}]}}},"CredentialStatusEncryptedPaymentConditionsBody":{"type":"object","properties":{"feePaymentAddress":{"description":"The cheqd/Cosmos payment address where payments to unlock the encrypted StatusList2021 or BitstringStatusList DID-Linked Resource need to be sent.","type":"string"},"feePaymentAmount":{"description":"Amount in CHEQ tokens to unlock the encrypted StatusList2021 or BitstringStatusList DID-Linked Resource.","type":"number","minimum":0,"exclusiveMinimum":true,"default":20},"feePaymentWindow":{"description":"Time window (in minutes) within which the payment to unlock the encrypted StatusList2021 or BitstringStatusList DID-Linked Resource is considered valid.","type":"number","minimum":0,"exclusiveMinimum":true,"default":10}}}}}}
```
## The CredentialStatusCreateEncryptedFormRequest object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"CredentialStatusCreateEncryptedFormRequest":{"allOf":[{"$ref":"#/components/schemas/CredentialStatusCreateBody"},{"$ref":"#/components/schemas/CredentialStatusEncryptedPaymentConditionsBody"},{"type":"object","required":["feePaymentAddress","feePaymentAmount","feePaymentWindow"]}]},"CredentialStatusCreateBody":{"allOf":[{"type":"object","required":["did","statusListName"],"properties":{"did":{"description":"DID of the StatusList2021 or BitstringStatusList publisher.","type":"string","format":"uri"},"statusListName":{"description":"The name of the StatusList2021 or BitstringStatusList DID-Linked Resource to be created.","type":"string"},"length":{"description":"The length of the status list to be created. The default and minimum length is 131072 which is 16kb.","type":"integer","minimum":0,"exclusiveMinimum":true,"default":131072},"encoding":{"description":"The encoding format of the StatusList2021 or BitstringStatusList (only base64url supported) DiD-Linked Resource to be created.","type":"string","default":"base64url","enum":["base64url","hex"]},"statusListVersion":{"description":"Optional field to assign a human-readable version in the StatusList2021 or BitstringStatusList DID-Linked Resource.","type":"string"},"statusSize":{"description":"Only for BitstringStatusList: bits per credential, used to support multiple status in same list.","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","items":{"type":"object","properties":{"status":{"type":"string"},"message":{"type":"string"}}}},"ttl":{"description":"Only for BitstringStatusList: Time to Live in Miliseconds (not expiry).","type":"integer","minimum":1000}}},{"$ref":"#/components/schemas/AlsoKnownAs"}]},"AlsoKnownAs":{"type":"object","properties":{"alsoKnownAs":{"type":"array","description":"Optional field to assign a set of alternative URIs where the DID-Linked Resource can be fetched from.","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri","description":"URI where the DID-Linked Resource can be fetched from. Can be any type of URI (e.g., DID, HTTPS, IPFS, etc.)"},"description":{"type":"string","description":"Optional description of the URI."}}}}}},"CredentialStatusEncryptedPaymentConditionsBody":{"type":"object","properties":{"feePaymentAddress":{"description":"The cheqd/Cosmos payment address where payments to unlock the encrypted StatusList2021 or BitstringStatusList DID-Linked Resource need to be sent.","type":"string"},"feePaymentAmount":{"description":"Amount in CHEQ tokens to unlock the encrypted StatusList2021 or BitstringStatusList DID-Linked Resource.","type":"number","minimum":0,"exclusiveMinimum":true,"default":20},"feePaymentWindow":{"description":"Time window (in minutes) within which the payment to unlock the encrypted StatusList2021 or BitstringStatusList DID-Linked Resource is considered valid.","type":"number","minimum":0,"exclusiveMinimum":true,"default":10}}}}}}
```
## The CredentialStatusCreateEncryptedJsonRequest object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"CredentialStatusCreateEncryptedJsonRequest":{"allOf":[{"$ref":"#/components/schemas/CredentialStatusCreateBody"},{"$ref":"#/components/schemas/CredentialStatusEncryptedPaymentConditionsJson"},{"type":"object","required":["paymentConditions"]}]},"CredentialStatusCreateBody":{"allOf":[{"type":"object","required":["did","statusListName"],"properties":{"did":{"description":"DID of the StatusList2021 or BitstringStatusList publisher.","type":"string","format":"uri"},"statusListName":{"description":"The name of the StatusList2021 or BitstringStatusList DID-Linked Resource to be created.","type":"string"},"length":{"description":"The length of the status list to be created. The default and minimum length is 131072 which is 16kb.","type":"integer","minimum":0,"exclusiveMinimum":true,"default":131072},"encoding":{"description":"The encoding format of the StatusList2021 or BitstringStatusList (only base64url supported) DiD-Linked Resource to be created.","type":"string","default":"base64url","enum":["base64url","hex"]},"statusListVersion":{"description":"Optional field to assign a human-readable version in the StatusList2021 or BitstringStatusList DID-Linked Resource.","type":"string"},"statusSize":{"description":"Only for BitstringStatusList: bits per credential, used to support multiple status in same list.","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","items":{"type":"object","properties":{"status":{"type":"string"},"message":{"type":"string"}}}},"ttl":{"description":"Only for BitstringStatusList: Time to Live in Miliseconds (not expiry).","type":"integer","minimum":1000}}},{"$ref":"#/components/schemas/AlsoKnownAs"}]},"AlsoKnownAs":{"type":"object","properties":{"alsoKnownAs":{"type":"array","description":"Optional field to assign a set of alternative URIs where the DID-Linked Resource can be fetched from.","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri","description":"URI where the DID-Linked Resource can be fetched from. Can be any type of URI (e.g., DID, HTTPS, IPFS, etc.)"},"description":{"type":"string","description":"Optional description of the URI."}}}}}},"CredentialStatusEncryptedPaymentConditionsJson":{"type":"object","properties":{"paymentConditions":{"allOf":[{"$ref":"#/components/schemas/CredentialStatusEncryptedPaymentConditionsBody"}]}}},"CredentialStatusEncryptedPaymentConditionsBody":{"type":"object","properties":{"feePaymentAddress":{"description":"The cheqd/Cosmos payment address where payments to unlock the encrypted StatusList2021 or BitstringStatusList DID-Linked Resource need to be sent.","type":"string"},"feePaymentAmount":{"description":"Amount in CHEQ tokens to unlock the encrypted StatusList2021 or BitstringStatusList DID-Linked Resource.","type":"number","minimum":0,"exclusiveMinimum":true,"default":20},"feePaymentWindow":{"description":"Time window (in minutes) within which the payment to unlock the encrypted StatusList2021 or BitstringStatusList DID-Linked Resource is considered valid.","type":"number","minimum":0,"exclusiveMinimum":true,"default":10}}}}}}
```
## The CredentialStatusEncryptedResult object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"CredentialStatusEncryptedResult":{"type":"object","properties":{"resource":{"type":"object","properties":{"StatusList2021":{"type":"object","properties":{"encodedList":{"type":"string"},"type":{"type":"string"},"validFrom":{"type":"string","format":"date-time"}}},"metadata":{"type":"object","properties":{"type":{"type":"string"},"encoding":{"type":"string"},"encrypted":{"type":"boolean"},"encryptedSymmetricKey":{"type":"string"},"paymentConditions":{"type":"array","items":{"type":"object","properties":{"feePaymentAddress":{"type":"string"},"feePaymentAmount":{"type":"string"},"intervalInSeconds":{"type":"number"},"type":{"type":"string"}}}}}},"resourceMetadata":{"type":"object"},"symmetricKey":{"type":"string"}}}}}}}}
```
## The CredentialStatusCreateEncryptedResult object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"CredentialStatusCreateEncryptedResult":{"allOf":[{"type":"object","properties":{"created":{"type":"boolean"}}},{"$ref":"#/components/schemas/CredentialStatusEncryptedResult"}]},"CredentialStatusEncryptedResult":{"type":"object","properties":{"resource":{"type":"object","properties":{"StatusList2021":{"type":"object","properties":{"encodedList":{"type":"string"},"type":{"type":"string"},"validFrom":{"type":"string","format":"date-time"}}},"metadata":{"type":"object","properties":{"type":{"type":"string"},"encoding":{"type":"string"},"encrypted":{"type":"boolean"},"encryptedSymmetricKey":{"type":"string"},"paymentConditions":{"type":"array","items":{"type":"object","properties":{"feePaymentAddress":{"type":"string"},"feePaymentAmount":{"type":"string"},"intervalInSeconds":{"type":"number"},"type":{"type":"string"}}}}}},"resourceMetadata":{"type":"object"},"symmetricKey":{"type":"string"}}}}}}}}
```
## The CredentialStatusUpdateBody object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"CredentialStatusUpdateBody":{"type":"object","required":["did","statusListName","indices"],"properties":{"did":{"description":"DID of the StatusList2021 publisher.","type":"string","format":"uri"},"statusListName":{"description":"The name of the StatusList2021 DID-Linked Resource to be updated.","type":"string"},"indices":{"description":"List of credential status indices to be updated. The indices must be in the range of the status list.","type":"array","items":{"type":"integer","minimum":0,"exclusiveMinimum":false}},"statusListVersion":{"description":"Optional field to assign a human-readable version in the StatusList2021 DID-Linked Resource.","type":"string"}}}}}}
```
## The CredentialStatusUpdateUnencryptedRequest object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"CredentialStatusUpdateUnencryptedRequest":{"allOf":[{"$ref":"#/components/schemas/CredentialStatusUpdateBody"}]},"CredentialStatusUpdateBody":{"type":"object","required":["did","statusListName","indices"],"properties":{"did":{"description":"DID of the StatusList2021 publisher.","type":"string","format":"uri"},"statusListName":{"description":"The name of the StatusList2021 DID-Linked Resource to be updated.","type":"string"},"indices":{"description":"List of credential status indices to be updated. The indices must be in the range of the status list.","type":"array","items":{"type":"integer","minimum":0,"exclusiveMinimum":false}},"statusListVersion":{"description":"Optional field to assign a human-readable version in the StatusList2021 DID-Linked Resource.","type":"string"}}}}}}
```
## The CredentialStatusUpdateUnencryptedResult object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"CredentialStatusUpdateUnencryptedResult":{"allOf":[{"type":"object","properties":{"updated":{"type":"boolean"}}},{"oneOf":[{"$ref":"#/components/schemas/RevocationResult"},{"$ref":"#/components/schemas/SuspensionResult"},{"$ref":"#/components/schemas/UnsuspensionResult"}]},{"$ref":"#/components/schemas/CredentialStatusUnencryptedResult"}]},"RevocationResult":{"properties":{"revoked":{"type":"boolean"}}},"SuspensionResult":{"properties":{"suspended":{"type":"boolean"}}},"UnsuspensionResult":{"properties":{"unsuspended":{"type":"boolean"}}},"CredentialStatusUnencryptedResult":{"type":"object","properties":{"resource":{"type":"object","properties":{"StatusList2021":{"type":"object","properties":{"encodedList":{"type":"string"},"type":{"type":"string"},"validFrom":{"type":"string","format":"date-time"}}},"metadata":{"type":"object","properties":{"type":{"type":"string"},"encoding":{"type":"string"},"encrypted":{"type":"boolean"}}}}},"resourceMetadata":{"type":"object"}}}}}}
```
## The CredentialStatusUpdateEncryptedFormRequest object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"CredentialStatusUpdateEncryptedFormRequest":{"allOf":[{"$ref":"#/components/schemas/CredentialStatusUpdateBody"},{"type":"object","required":["symmetricKey"],"properties":{"symmetricKey":{"description":"The symmetric key used to encrypt the StatusList2021 DID-Linked Resource.","type":"string"}}},{"$ref":"#/components/schemas/CredentialStatusEncryptedPaymentConditionsBody"}]},"CredentialStatusUpdateBody":{"type":"object","required":["did","statusListName","indices"],"properties":{"did":{"description":"DID of the StatusList2021 publisher.","type":"string","format":"uri"},"statusListName":{"description":"The name of the StatusList2021 DID-Linked Resource to be updated.","type":"string"},"indices":{"description":"List of credential status indices to be updated. The indices must be in the range of the status list.","type":"array","items":{"type":"integer","minimum":0,"exclusiveMinimum":false}},"statusListVersion":{"description":"Optional field to assign a human-readable version in the StatusList2021 DID-Linked Resource.","type":"string"}}},"CredentialStatusEncryptedPaymentConditionsBody":{"type":"object","properties":{"feePaymentAddress":{"description":"The cheqd/Cosmos payment address where payments to unlock the encrypted StatusList2021 or BitstringStatusList DID-Linked Resource need to be sent.","type":"string"},"feePaymentAmount":{"description":"Amount in CHEQ tokens to unlock the encrypted StatusList2021 or BitstringStatusList DID-Linked Resource.","type":"number","minimum":0,"exclusiveMinimum":true,"default":20},"feePaymentWindow":{"description":"Time window (in minutes) within which the payment to unlock the encrypted StatusList2021 or BitstringStatusList DID-Linked Resource is considered valid.","type":"number","minimum":0,"exclusiveMinimum":true,"default":10}}}}}}
```
## The CredentialStatusUpdateEncryptedJsonRequest object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"CredentialStatusUpdateEncryptedJsonRequest":{"allOf":[{"$ref":"#/components/schemas/CredentialStatusUpdateBody"},{"type":"object","required":["symmetricKey"],"properties":{"symmetricKey":{"description":"The symmetric key used to encrypt the StatusList2021 DID-Linked Resource.","type":"string"}}},{"$ref":"#/components/schemas/CredentialStatusEncryptedPaymentConditionsJson"}]},"CredentialStatusUpdateBody":{"type":"object","required":["did","statusListName","indices"],"properties":{"did":{"description":"DID of the StatusList2021 publisher.","type":"string","format":"uri"},"statusListName":{"description":"The name of the StatusList2021 DID-Linked Resource to be updated.","type":"string"},"indices":{"description":"List of credential status indices to be updated. The indices must be in the range of the status list.","type":"array","items":{"type":"integer","minimum":0,"exclusiveMinimum":false}},"statusListVersion":{"description":"Optional field to assign a human-readable version in the StatusList2021 DID-Linked Resource.","type":"string"}}},"CredentialStatusEncryptedPaymentConditionsJson":{"type":"object","properties":{"paymentConditions":{"allOf":[{"$ref":"#/components/schemas/CredentialStatusEncryptedPaymentConditionsBody"}]}}},"CredentialStatusEncryptedPaymentConditionsBody":{"type":"object","properties":{"feePaymentAddress":{"description":"The cheqd/Cosmos payment address where payments to unlock the encrypted StatusList2021 or BitstringStatusList DID-Linked Resource need to be sent.","type":"string"},"feePaymentAmount":{"description":"Amount in CHEQ tokens to unlock the encrypted StatusList2021 or BitstringStatusList DID-Linked Resource.","type":"number","minimum":0,"exclusiveMinimum":true,"default":20},"feePaymentWindow":{"description":"Time window (in minutes) within which the payment to unlock the encrypted StatusList2021 or BitstringStatusList DID-Linked Resource is considered valid.","type":"number","minimum":0,"exclusiveMinimum":true,"default":10}}}}}}
```
## The CredentialStatusUpdateEncryptedResult object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"CredentialStatusUpdateEncryptedResult":{"allOf":[{"type":"object","properties":{"updated":{"type":"boolean"}}},{"oneOf":[{"$ref":"#/components/schemas/RevocationResult"},{"$ref":"#/components/schemas/SuspensionResult"},{"$ref":"#/components/schemas/UnsuspensionResult"}]},{"$ref":"#/components/schemas/CredentialStatusEncryptedResult"}]},"RevocationResult":{"properties":{"revoked":{"type":"boolean"}}},"SuspensionResult":{"properties":{"suspended":{"type":"boolean"}}},"UnsuspensionResult":{"properties":{"unsuspended":{"type":"boolean"}}},"CredentialStatusEncryptedResult":{"type":"object","properties":{"resource":{"type":"object","properties":{"StatusList2021":{"type":"object","properties":{"encodedList":{"type":"string"},"type":{"type":"string"},"validFrom":{"type":"string","format":"date-time"}}},"metadata":{"type":"object","properties":{"type":{"type":"string"},"encoding":{"type":"string"},"encrypted":{"type":"boolean"},"encryptedSymmetricKey":{"type":"string"},"paymentConditions":{"type":"array","items":{"type":"object","properties":{"feePaymentAddress":{"type":"string"},"feePaymentAmount":{"type":"string"},"intervalInSeconds":{"type":"number"},"type":{"type":"string"}}}}}},"resourceMetadata":{"type":"object"},"symmetricKey":{"type":"string"}}}}}}}}
```
## The CredentialStatusCheckRequest object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"CredentialStatusCheckRequest":{"type":"object","required":["did","statusListName"],"properties":{"did":{"description":"DID of the StatusList2021 publisher.","type":"string","format":"uri"},"statusListName":{"description":"The name of the StatusList2021 DID-Linked Resource to be checked.","type":"string"},"index":{"description":"Credential status index to be checked for revocation or suspension.","type":"integer","minimum":0,"exclusiveMinimum":false},"indices":{"description":"List of credential status indices to be checked for revocation or suspension.","type":"array","items":{"type":"integer"}},"indexRangeStart":{"description":"Start of the credential status index range to be checked for revocation or suspension.","type":"integer"},"indexRangeEnd":{"description":"End of the credential status index range to be checked for revocation or suspension.","type":"integer"},"statusListCredential":{"description":"Optional Resolvable DID URL of the BitstringStatusList credential to be checked.","type":"string"},"statusSize":{"description":"Optional size of the BitstringStatusList.","type":"number","default":2},"statusMessage":{"description":"Array of status messages for each bit in the BitstringStatusList.","type":"array"},"makeFeePayment":{"description":"Automatically make fee payment (if required) based on payment conditions to unlock encrypted StatusList2021 or BitstringStatusList DID-Linked Resource.","type":"boolean","default":true}}}}}}
```
## The CredentialStatusCheckResult object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"CredentialStatusCheckResult":{"oneOf":[{"$ref":"#/components/schemas/CredentialStatusCheckRevocationResult"},{"$ref":"#/components/schemas/CredentialStatusCheckSuspensionResult"}]},"CredentialStatusCheckRevocationResult":{"type":"object","properties":{"checked":{"type":"boolean"},"revoked":{"type":"boolean"}}},"CredentialStatusCheckSuspensionResult":{"type":"object","properties":{"checked":{"type":"boolean"},"suspended":{"type":"boolean"}}}}}}
```
## The CredentialStatusCheckRevocationResult object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"CredentialStatusCheckRevocationResult":{"type":"object","properties":{"checked":{"type":"boolean"},"revoked":{"type":"boolean"}}}}}}
```
## The CredentialStatusCheckSuspensionResult object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"CredentialStatusCheckSuspensionResult":{"type":"object","properties":{"checked":{"type":"boolean"},"suspended":{"type":"boolean"}}}}}}
```
## The CredentialStatusListSearchResult object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"CredentialStatusListSearchResult":{"allOf":[{"type":"object","properties":{"found":{"type":"boolean"}}},{"oneOf":[{"$ref":"#/components/schemas/CredentialStatusUnencryptedResult"},{"$ref":"#/components/schemas/CredentialStatusEncryptedResult"}]}]},"CredentialStatusUnencryptedResult":{"type":"object","properties":{"resource":{"type":"object","properties":{"StatusList2021":{"type":"object","properties":{"encodedList":{"type":"string"},"type":{"type":"string"},"validFrom":{"type":"string","format":"date-time"}}},"metadata":{"type":"object","properties":{"type":{"type":"string"},"encoding":{"type":"string"},"encrypted":{"type":"boolean"}}}}},"resourceMetadata":{"type":"object"}}},"CredentialStatusEncryptedResult":{"type":"object","properties":{"resource":{"type":"object","properties":{"StatusList2021":{"type":"object","properties":{"encodedList":{"type":"string"},"type":{"type":"string"},"validFrom":{"type":"string","format":"date-time"}}},"metadata":{"type":"object","properties":{"type":{"type":"string"},"encoding":{"type":"string"},"encrypted":{"type":"boolean"},"encryptedSymmetricKey":{"type":"string"},"paymentConditions":{"type":"array","items":{"type":"object","properties":{"feePaymentAddress":{"type":"string"},"feePaymentAmount":{"type":"string"},"intervalInSeconds":{"type":"number"},"type":{"type":"string"}}}}}},"resourceMetadata":{"type":"object"},"symmetricKey":{"type":"string"}}}}}}}}
```
## The KeyImportRequest object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"KeyImportRequest":{"type":"object","properties":{"alias":{"type":"string"},"type":{"type":"string","enum":["Ed25519","Secp256k1"]},"privateKeyHex":{"type":"string"}}}}}}
```
## The KeyResult object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"KeyResult":{"type":"object","properties":{"kid":{"type":"string"},"type":{"type":"string","enum":["Ed25519","Secp256k1"]},"publicKeyHex":{"type":"string"}}}}}}
```
## The DidDocument object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"DidDocument":{"description":"This input field contains either a complete DID document, or an incremental change (diff) to a DID document. See Universal DID Registrar specification.","type":"object","properties":{"@context":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"controllers":{"type":"array","items":{"type":"string"}},"verificationMethod":{"type":"array","items":{"$ref":"#/components/schemas/VerificationMethod"}},"service":{"type":"array","items":{"$ref":"#/components/schemas/Service"}},"authentication":{"type":"array","items":{"type":"string"}},"assertionMethod":{"type":"array","items":{"type":"string"}},"capabilityInvocation":{"type":"array","items":{"type":"string"}},"capabilityDelegation":{"type":"array","items":{"type":"string"}},"keyAgreement":{"type":"array","items":{"type":"string"}}}},"VerificationMethod":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"controller":{"type":"string"},"publicKeyMultibase":{"type":"string"},"publicKeyJwk":{"type":"array","items":{"type":"string"}}}},"Service":{"description":"Communicating or interacting with the DID subject or associated entities via one or more service endpoints. See DID Core specification for more details.","type":"object","properties":{"id":{"description":"DID appended with Service fragment ID (e.g., `#service-1` in `did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1`)","type":"string"},"type":{"description":"Service type as defined in DID Specification Registries.","type":"string"},"serviceEndpoint":{"description":"Service endpoint as defined in DID Core Specification.","type":"array","items":{"type":"string"}},"priority":{"description":"(Optional) Priority of the service endpoint, used for distinction when multiple did-communication service endpoints are present in a single DID document.","type":"integer"},"recipientKeys":{"description":"(Optional) List of recipient keys used to denote the default recipients of an endpoint.","type":"array","items":{"type":"string"}},"routingKeys":{"description":"(Optional) List of routing keys used to used to denote the individual routing hops in between the sender and recipients.","type":"array","items":{"type":"string"}},"accept":{"description":"(Optional) List of media types that the service endpoint accepts.","type":"array","items":{"type":"string"}}}}}}}
```
## The DidDocumentWithoutVerificationMethod object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"DidDocumentWithoutVerificationMethod":{"type":"object","properties":{"@context":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"controllers":{"type":"array","items":{"type":"string"}},"service":{"type":"array","items":{"$ref":"#/components/schemas/Service"}},"authentication":{"type":"array","items":{"type":"string"}},"assertionMethod":{"type":"array","items":{"type":"string"}},"capabilityInvocation":{"type":"array","items":{"type":"string"}},"capabilityDelegation":{"type":"array","items":{"type":"string"}},"keyAgreement":{"type":"array","items":{"type":"string"}}}},"Service":{"description":"Communicating or interacting with the DID subject or associated entities via one or more service endpoints. See DID Core specification for more details.","type":"object","properties":{"id":{"description":"DID appended with Service fragment ID (e.g., `#service-1` in `did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1`)","type":"string"},"type":{"description":"Service type as defined in DID Specification Registries.","type":"string"},"serviceEndpoint":{"description":"Service endpoint as defined in DID Core Specification.","type":"array","items":{"type":"string"}},"priority":{"description":"(Optional) Priority of the service endpoint, used for distinction when multiple did-communication service endpoints are present in a single DID document.","type":"integer"},"recipientKeys":{"description":"(Optional) List of recipient keys used to denote the default recipients of an endpoint.","type":"array","items":{"type":"string"}},"routingKeys":{"description":"(Optional) List of routing keys used to used to denote the individual routing hops in between the sender and recipients.","type":"array","items":{"type":"string"}},"accept":{"description":"(Optional) List of media types that the service endpoint accepts.","type":"array","items":{"type":"string"}}}}}}}
```
## The DidCreateRequestFormBased object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"DidCreateRequestFormBased":{"type":"object","properties":{"network":{"description":"Network to create the DID on (testnet or mainnet)","type":"string","enum":["testnet","mainnet"]},"providerId":{"description":"Identity Provider to create the DID","type":"string","required":false},"identifierFormatType":{"description":"Algorithm to use for generating the method-specific ID. The two styles supported are UUIDs and Indy-style Base58. See cheqd DID method documentation for more details.","type":"string","enum":["uuid","base58btc"]},"verificationMethodType":{"description":"Type of verification method to use for the DID. See DID Core specification for more details. Only the types listed below are supported.","type":"string","enum":["Ed25519VerificationKey2018","JsonWebKey2020","Ed25519VerificationKey2020"]},"service":{"description":"It's a list of special objects which are designed to build the actual service. It's almost the same as in DID Core specification, but instead of `id` it utilises `idFragment` field for making the right `id` for each service. !!! WARN. Cause swagger-ui does not handle x-ww-form based arrays correctly, please frame all your services in brackets while using swagger UI. !!!","type":"array","items":{"type":"object","properties":{"idFragment":{"type":"string"},"type":{"type":"string"},"serviceEndpoint":{"type":"array","items":{"type":"string"}}}}},"key":{"description":"The unique identifier in hexadecimal public key format used in the verification method to create the DID.","type":"string"},"@context":{"type":"array","items":{"type":"string"}}}}}}}
```
## The DidCreateRequestJson object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"DidCreateRequestJson":{"type":"object","properties":{"network":{"description":"Network to create the DID on (testnet or mainnet)","type":"string","enum":["testnet","mainnet"]},"providerId":{"description":"Identity Provider to create the DID","type":"string","required":false},"identifierFormatType":{"description":"Algorithm to use for generating the method-specific ID. The two styles supported are UUIDs and Indy-style Base58. See cheqd DID method documentation for more details.","type":"string","enum":["uuid","base58btc"]},"options":{"type":"object","properties":{"key":{"type":"string"},"verificationMethodType":{"description":"Type of verification method to use for the DID. See DID Core specification for more details. Only the types listed below are supported.","type":"string","enum":["Ed25519VerificationKey2018","JsonWebKey2020","Ed25519VerificationKey2020"]}}},"didDocument":{"$ref":"#/components/schemas/DidDocumentWithoutVerificationMethod"}}},"DidDocumentWithoutVerificationMethod":{"type":"object","properties":{"@context":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"controllers":{"type":"array","items":{"type":"string"}},"service":{"type":"array","items":{"$ref":"#/components/schemas/Service"}},"authentication":{"type":"array","items":{"type":"string"}},"assertionMethod":{"type":"array","items":{"type":"string"}},"capabilityInvocation":{"type":"array","items":{"type":"string"}},"capabilityDelegation":{"type":"array","items":{"type":"string"}},"keyAgreement":{"type":"array","items":{"type":"string"}}}},"Service":{"description":"Communicating or interacting with the DID subject or associated entities via one or more service endpoints. See DID Core specification for more details.","type":"object","properties":{"id":{"description":"DID appended with Service fragment ID (e.g., `#service-1` in `did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1`)","type":"string"},"type":{"description":"Service type as defined in DID Specification Registries.","type":"string"},"serviceEndpoint":{"description":"Service endpoint as defined in DID Core Specification.","type":"array","items":{"type":"string"}},"priority":{"description":"(Optional) Priority of the service endpoint, used for distinction when multiple did-communication service endpoints are present in a single DID document.","type":"integer"},"recipientKeys":{"description":"(Optional) List of recipient keys used to denote the default recipients of an endpoint.","type":"array","items":{"type":"string"}},"routingKeys":{"description":"(Optional) List of routing keys used to used to denote the individual routing hops in between the sender and recipients.","type":"array","items":{"type":"string"}},"accept":{"description":"(Optional) List of media types that the service endpoint accepts.","type":"array","items":{"type":"string"}}}}}}}
```
## The DidImportRequest object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"DidImportRequest":{"type":"object","properties":{"did":{"type":"string","description":"DID to be imported","format":"uri"},"keys":{"type":"array","description":"List of keys required to import the DID","items":{"$ref":"#/components/schemas/KeyImportRequest"}}},"required":["did","keys"]},"KeyImportRequest":{"type":"object","properties":{"alias":{"type":"string"},"type":{"type":"string","enum":["Ed25519","Secp256k1"]},"privateKeyHex":{"type":"string"}}}}}}
```
## The PresentationCreateResult object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"PresentationCreateResult":{"type":"object","properties":{"vp":{"type":"object","description":"Verifiable Presentation which could be provided to the verifier."},"nbf":{"type":"integer","description":"Unix timestamp of the earliest time that the Verifiable Presentation is valid."},"iss":{"type":"string","description":"DID of the issuer of the Verifiable Presentation. (Here it's supposed to be a holder DID)"},"aud":{"type":"array","items":{"type":"string"},"description":"DID of the verifier of the Verifiable Presentation."}}}}}}
```
## The DidResult object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"DidResult":{"type":"object","properties":{"did":{"type":"string"},"controllerKeyId":{"type":"string"},"keys":{"type":"array","items":{"type":"object"}},"services":{"type":"array","items":{"$ref":"#/components/schemas/Service"}}}},"Service":{"description":"Communicating or interacting with the DID subject or associated entities via one or more service endpoints. See DID Core specification for more details.","type":"object","properties":{"id":{"description":"DID appended with Service fragment ID (e.g., `#service-1` in `did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1`)","type":"string"},"type":{"description":"Service type as defined in DID Specification Registries.","type":"string"},"serviceEndpoint":{"description":"Service endpoint as defined in DID Core Specification.","type":"array","items":{"type":"string"}},"priority":{"description":"(Optional) Priority of the service endpoint, used for distinction when multiple did-communication service endpoints are present in a single DID document.","type":"integer"},"recipientKeys":{"description":"(Optional) List of recipient keys used to denote the default recipients of an endpoint.","type":"array","items":{"type":"string"}},"routingKeys":{"description":"(Optional) List of routing keys used to used to denote the individual routing hops in between the sender and recipients.","type":"array","items":{"type":"string"}},"accept":{"description":"(Optional) List of media types that the service endpoint accepts.","type":"array","items":{"type":"string"}}}}}}}
```
## The ListDidResult object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"ListDidResult":{"type":"object","properties":{"total":{"type":"number"},"dids":{"type":"array","items":{"type":"string"}}}}}}}
```
## The ExportDidResult object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"ExportDidResult":{"type":"object","properties":{"@context":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"type":{"type":"array","items":{"type":"string"}},"didDidResolutionMetadata":{"$ref":"#/components/schemas/DidResolutionMetadata"},"didDocument":{"$ref":"#/components/schemas/DidDocument"},"didDocumentMetadata":{"$ref":"#/components/schemas/DeactivatedDidDocumentMetadata"},"keys":{"type":"array","items":{"type":"object","properties":{"@context":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"type":{"type":"array","items":{"type":"string"}},"controller":{"type":"string"},"name":{"type":"string"},"correlation":{"type":"array","items":{"type":"string"}},"created":{"type":"string"},"publicKeyMultibase":{"type":"string"},"privateKeyMultibase":{"type":"string"},"publicKeyBase58":{"type":"string"},"privateKeyBase58":{"type":"string"}}}}}},"DidResolutionMetadata":{"type":"object","properties":{"contentType":{"allOf":[{"$ref":"#/components/schemas/ContentType"}]},"retrieved":{"type":"string"},"did":{"$ref":"#/components/schemas/DidProperties"}}},"ContentType":{"type":"string","enum":["application/did+json","application/did+ld+json","application/ld+json","application/json"]},"DidProperties":{"type":"object","properties":{"didString":{"type":"string"},"method":{"type":"string"},"methodSpecificId":{"type":"string"}}},"DidDocument":{"description":"This input field contains either a complete DID document, or an incremental change (diff) to a DID document. See Universal DID Registrar specification.","type":"object","properties":{"@context":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"controllers":{"type":"array","items":{"type":"string"}},"verificationMethod":{"type":"array","items":{"$ref":"#/components/schemas/VerificationMethod"}},"service":{"type":"array","items":{"$ref":"#/components/schemas/Service"}},"authentication":{"type":"array","items":{"type":"string"}},"assertionMethod":{"type":"array","items":{"type":"string"}},"capabilityInvocation":{"type":"array","items":{"type":"string"}},"capabilityDelegation":{"type":"array","items":{"type":"string"}},"keyAgreement":{"type":"array","items":{"type":"string"}}}},"VerificationMethod":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"controller":{"type":"string"},"publicKeyMultibase":{"type":"string"},"publicKeyJwk":{"type":"array","items":{"type":"string"}}}},"Service":{"description":"Communicating or interacting with the DID subject or associated entities via one or more service endpoints. See DID Core specification for more details.","type":"object","properties":{"id":{"description":"DID appended with Service fragment ID (e.g., `#service-1` in `did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1`)","type":"string"},"type":{"description":"Service type as defined in DID Specification Registries.","type":"string"},"serviceEndpoint":{"description":"Service endpoint as defined in DID Core Specification.","type":"array","items":{"type":"string"}},"priority":{"description":"(Optional) Priority of the service endpoint, used for distinction when multiple did-communication service endpoints are present in a single DID document.","type":"integer"},"recipientKeys":{"description":"(Optional) List of recipient keys used to denote the default recipients of an endpoint.","type":"array","items":{"type":"string"}},"routingKeys":{"description":"(Optional) List of routing keys used to used to denote the individual routing hops in between the sender and recipients.","type":"array","items":{"type":"string"}},"accept":{"description":"(Optional) List of media types that the service endpoint accepts.","type":"array","items":{"type":"string"}}}},"DeactivatedDidDocumentMetadata":{"type":"object","properties":{"created":{"type":"string"},"deactivated":{"type":"boolean"},"updated":{"type":"string"},"versionId":{"type":"string"},"linkedResourceMetadata":{"type":"array","items":{"$ref":"#/components/schemas/ResourceMetadata"}}}},"ResourceMetadata":{"type":"object","properties":{"resourceURI":{"type":"string"},"resourceCollectionId":{"type":"string"},"resourceId":{"type":"string"},"resourceName":{"type":"string"},"resourceType":{"type":"string"},"mediaType":{"type":"string"},"resourceVersion":{"type":"string"},"checksum":{"type":"string"},"created":{"type":"string"},"nextVersionId":{"type":"string"},"previousVersionId":{"type":"string"}}}}}}
```
## The DidUpdateResponse object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"DidUpdateResponse":{"type":"object","properties":{"did":{"type":"string"},"controllerKeyId":{"type":"string","description":"The default key id of which is the key associated with the first verificationMethod"},"keys":{"type":"array","description":"The list of keys associated with the list of verificationMethod's of DIDDocument","items":{"type":"object"}},"services":{"type":"array","items":{"$ref":"#/components/schemas/Service"}},"controllerKeyRefs":{"type":"array","description":"The list of keyRefs which were used for signing the transaction","items":{"type":"string"}},"controllerKeys":{"type":"array","description":"The list of all possible keys, inlcuding all controller's keys","items":{"type":"string"}}}},"Service":{"description":"Communicating or interacting with the DID subject or associated entities via one or more service endpoints. See DID Core specification for more details.","type":"object","properties":{"id":{"description":"DID appended with Service fragment ID (e.g., `#service-1` in `did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1`)","type":"string"},"type":{"description":"Service type as defined in DID Specification Registries.","type":"string"},"serviceEndpoint":{"description":"Service endpoint as defined in DID Core Specification.","type":"array","items":{"type":"string"}},"priority":{"description":"(Optional) Priority of the service endpoint, used for distinction when multiple did-communication service endpoints are present in a single DID document.","type":"integer"},"recipientKeys":{"description":"(Optional) List of recipient keys used to denote the default recipients of an endpoint.","type":"array","items":{"type":"string"}},"routingKeys":{"description":"(Optional) List of routing keys used to used to denote the individual routing hops in between the sender and recipients.","type":"array","items":{"type":"string"}},"accept":{"description":"(Optional) List of media types that the service endpoint accepts.","type":"array","items":{"type":"string"}}}}}}}
```
## The VerificationMethod object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"VerificationMethod":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"controller":{"type":"string"},"publicKeyMultibase":{"type":"string"},"publicKeyJwk":{"type":"array","items":{"type":"string"}}}}}}}
```
## The Service object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"Service":{"description":"Communicating or interacting with the DID subject or associated entities via one or more service endpoints. See DID Core specification for more details.","type":"object","properties":{"id":{"description":"DID appended with Service fragment ID (e.g., `#service-1` in `did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1`)","type":"string"},"type":{"description":"Service type as defined in DID Specification Registries.","type":"string"},"serviceEndpoint":{"description":"Service endpoint as defined in DID Core Specification.","type":"array","items":{"type":"string"}},"priority":{"description":"(Optional) Priority of the service endpoint, used for distinction when multiple did-communication service endpoints are present in a single DID document.","type":"integer"},"recipientKeys":{"description":"(Optional) List of recipient keys used to denote the default recipients of an endpoint.","type":"array","items":{"type":"string"}},"routingKeys":{"description":"(Optional) List of routing keys used to used to denote the individual routing hops in between the sender and recipients.","type":"array","items":{"type":"string"}},"accept":{"description":"(Optional) List of media types that the service endpoint accepts.","type":"array","items":{"type":"string"}}}}}}}
```
## The DidUpdateRequest object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"DidUpdateRequest":{"type":"object","properties":{"did":{"description":"DID identifier to be updated.","type":"string"},"service":{"type":"array","description":"Service section of the DID Document.","items":{"$ref":"#/components/schemas/Service"}},"verificationMethod":{"type":"array","description":"Verification Method section of the DID Document.","items":{"$ref":"#/components/schemas/VerificationMethod"}},"authentication":{"description":"Authentication section of the DID Document.","type":"array","items":{"type":"string"}},"publicKeyHexs":{"description":"List of key references (publicKeys) which will be used for signing the message. The should be in hexadecimal format and placed in the wallet of current user.","type":"array","items":{"type":"string"}},"didDocument":{"$ref":"#/components/schemas/DidDocument"}}},"Service":{"description":"Communicating or interacting with the DID subject or associated entities via one or more service endpoints. See DID Core specification for more details.","type":"object","properties":{"id":{"description":"DID appended with Service fragment ID (e.g., `#service-1` in `did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1`)","type":"string"},"type":{"description":"Service type as defined in DID Specification Registries.","type":"string"},"serviceEndpoint":{"description":"Service endpoint as defined in DID Core Specification.","type":"array","items":{"type":"string"}},"priority":{"description":"(Optional) Priority of the service endpoint, used for distinction when multiple did-communication service endpoints are present in a single DID document.","type":"integer"},"recipientKeys":{"description":"(Optional) List of recipient keys used to denote the default recipients of an endpoint.","type":"array","items":{"type":"string"}},"routingKeys":{"description":"(Optional) List of routing keys used to used to denote the individual routing hops in between the sender and recipients.","type":"array","items":{"type":"string"}},"accept":{"description":"(Optional) List of media types that the service endpoint accepts.","type":"array","items":{"type":"string"}}}},"VerificationMethod":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"controller":{"type":"string"},"publicKeyMultibase":{"type":"string"},"publicKeyJwk":{"type":"array","items":{"type":"string"}}}},"DidDocument":{"description":"This input field contains either a complete DID document, or an incremental change (diff) to a DID document. See Universal DID Registrar specification.","type":"object","properties":{"@context":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"controllers":{"type":"array","items":{"type":"string"}},"verificationMethod":{"type":"array","items":{"$ref":"#/components/schemas/VerificationMethod"}},"service":{"type":"array","items":{"$ref":"#/components/schemas/Service"}},"authentication":{"type":"array","items":{"type":"string"}},"assertionMethod":{"type":"array","items":{"type":"string"}},"capabilityInvocation":{"type":"array","items":{"type":"string"}},"capabilityDelegation":{"type":"array","items":{"type":"string"}},"keyAgreement":{"type":"array","items":{"type":"string"}}}}}}}
```
## The DidDeactivateRequest object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"DidDeactivateRequest":{"type":"object","properties":{"publicKeyHexs":{"description":"List of key references (publicKeys) which will be used for signing the message. The should be in hexadecimal format and placed in the wallet of current user.","type":"array","items":{"type":"string"}}}}}}}
```
## The CreateResourceRequest object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"CreateResourceRequest":{"description":"Input fields for DID-Linked Resource creation.","type":"object","additionalProperties":false,"required":["name","type","data","encoding"],"properties":{"data":{"description":"Encoded string containing the data to be stored in the DID-Linked Resource.","type":"string"},"encoding":{"description":"Encoding format used to encode the data.","type":"string","enum":["base64url","base64","hex"]},"name":{"description":"Name of DID-Linked Resource.","type":"string"},"type":{"description":"Type of DID-Linked Resource. This is NOT the same as the media type, which is calculated automatically ledger-side.","type":"string"},"alsoKnownAs":{"description":"Optional field to assign a set of alternative URIs where the DID-Linked Resource can be fetched from.","type":"array","items":{"type":"object","properties":{"uri":{"type":"string"},"description":{"type":"string"}}}},"version":{"description":"Optional field to assign a human-readable version in the DID-Linked Resource.","type":"string"},"publicKeyHexs":{"description":"List of key references (publicKeys) which will be used for signing the message. The should be in hexadecimal format and placed in the wallet of current user.","type":"array","items":{"type":"string"}}}}}}}
```
## The ResourceList object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"ResourceList":{"type":"object","properties":{"@context":{"type":"string"},"contentMetadata":{"type":"object"},"contentStream":{"type":"object"},"dereferencingMetadata":{"$ref":"#/components/schemas/DereferencingMetadata"}}},"DereferencingMetadata":{"type":"object","properties":{"contentType":{"type":"string"},"did":{"$ref":"#/components/schemas/DidProperties"},"retrieved":{"type":"string"}}},"DidProperties":{"type":"object","properties":{"didString":{"type":"string"},"method":{"type":"string"},"methodSpecificId":{"type":"string"}}}}}}
```
## The ListResourceResult object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"ListResourceResult":{"type":"object","properties":{"total":{"type":"number"},"resources":{"type":"array","items":{"$ref":"#/components/schemas/ResourceMetadata"}}}},"ResourceMetadata":{"type":"object","properties":{"resourceURI":{"type":"string"},"resourceCollectionId":{"type":"string"},"resourceId":{"type":"string"},"resourceName":{"type":"string"},"resourceType":{"type":"string"},"mediaType":{"type":"string"},"resourceVersion":{"type":"string"},"checksum":{"type":"string"},"created":{"type":"string"},"nextVersionId":{"type":"string"},"previousVersionId":{"type":"string"}}}}}}
```
## The DereferencingMetadata object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"DereferencingMetadata":{"type":"object","properties":{"contentType":{"type":"string"},"did":{"$ref":"#/components/schemas/DidProperties"},"retrieved":{"type":"string"}}},"DidProperties":{"type":"object","properties":{"didString":{"type":"string"},"method":{"type":"string"},"methodSpecificId":{"type":"string"}}}}}}
```
## The DidResolution object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"DidResolution":{"type":"object","properties":{"@context":{"type":"string"},"didDidResolutionMetadata":{"$ref":"#/components/schemas/DidResolutionMetadata"},"didDocument":{"$ref":"#/components/schemas/DidDocument"},"didDocumentMetadata":{"$ref":"#/components/schemas/DidDocumentMetadata"}}},"DidResolutionMetadata":{"type":"object","properties":{"contentType":{"allOf":[{"$ref":"#/components/schemas/ContentType"}]},"retrieved":{"type":"string"},"did":{"$ref":"#/components/schemas/DidProperties"}}},"ContentType":{"type":"string","enum":["application/did+json","application/did+ld+json","application/ld+json","application/json"]},"DidProperties":{"type":"object","properties":{"didString":{"type":"string"},"method":{"type":"string"},"methodSpecificId":{"type":"string"}}},"DidDocument":{"description":"This input field contains either a complete DID document, or an incremental change (diff) to a DID document. See Universal DID Registrar specification.","type":"object","properties":{"@context":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"controllers":{"type":"array","items":{"type":"string"}},"verificationMethod":{"type":"array","items":{"$ref":"#/components/schemas/VerificationMethod"}},"service":{"type":"array","items":{"$ref":"#/components/schemas/Service"}},"authentication":{"type":"array","items":{"type":"string"}},"assertionMethod":{"type":"array","items":{"type":"string"}},"capabilityInvocation":{"type":"array","items":{"type":"string"}},"capabilityDelegation":{"type":"array","items":{"type":"string"}},"keyAgreement":{"type":"array","items":{"type":"string"}}}},"VerificationMethod":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"controller":{"type":"string"},"publicKeyMultibase":{"type":"string"},"publicKeyJwk":{"type":"array","items":{"type":"string"}}}},"Service":{"description":"Communicating or interacting with the DID subject or associated entities via one or more service endpoints. See DID Core specification for more details.","type":"object","properties":{"id":{"description":"DID appended with Service fragment ID (e.g., `#service-1` in `did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1`)","type":"string"},"type":{"description":"Service type as defined in DID Specification Registries.","type":"string"},"serviceEndpoint":{"description":"Service endpoint as defined in DID Core Specification.","type":"array","items":{"type":"string"}},"priority":{"description":"(Optional) Priority of the service endpoint, used for distinction when multiple did-communication service endpoints are present in a single DID document.","type":"integer"},"recipientKeys":{"description":"(Optional) List of recipient keys used to denote the default recipients of an endpoint.","type":"array","items":{"type":"string"}},"routingKeys":{"description":"(Optional) List of routing keys used to used to denote the individual routing hops in between the sender and recipients.","type":"array","items":{"type":"string"}},"accept":{"description":"(Optional) List of media types that the service endpoint accepts.","type":"array","items":{"type":"string"}}}},"DidDocumentMetadata":{"type":"object","properties":{"created":{"type":"string"},"deactivated":{"type":"boolean"},"updated":{"type":"string"},"versionId":{"type":"string"},"linkedResourceMetadata":{"type":"array","items":{"$ref":"#/components/schemas/ResourceMetadata"}}}},"ResourceMetadata":{"type":"object","properties":{"resourceURI":{"type":"string"},"resourceCollectionId":{"type":"string"},"resourceId":{"type":"string"},"resourceName":{"type":"string"},"resourceType":{"type":"string"},"mediaType":{"type":"string"},"resourceVersion":{"type":"string"},"checksum":{"type":"string"},"created":{"type":"string"},"nextVersionId":{"type":"string"},"previousVersionId":{"type":"string"}}}}}}
```
## The DeactivatedDidResolution object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"DeactivatedDidResolution":{"type":"object","properties":{"@context":{"type":"string"},"didDidResolutionMetadata":{"$ref":"#/components/schemas/DidResolutionMetadata"},"didDocument":{"$ref":"#/components/schemas/DidDocument"},"didDocumentMetadata":{"$ref":"#/components/schemas/DeactivatedDidDocumentMetadata"}}},"DidResolutionMetadata":{"type":"object","properties":{"contentType":{"allOf":[{"$ref":"#/components/schemas/ContentType"}]},"retrieved":{"type":"string"},"did":{"$ref":"#/components/schemas/DidProperties"}}},"ContentType":{"type":"string","enum":["application/did+json","application/did+ld+json","application/ld+json","application/json"]},"DidProperties":{"type":"object","properties":{"didString":{"type":"string"},"method":{"type":"string"},"methodSpecificId":{"type":"string"}}},"DidDocument":{"description":"This input field contains either a complete DID document, or an incremental change (diff) to a DID document. See Universal DID Registrar specification.","type":"object","properties":{"@context":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"controllers":{"type":"array","items":{"type":"string"}},"verificationMethod":{"type":"array","items":{"$ref":"#/components/schemas/VerificationMethod"}},"service":{"type":"array","items":{"$ref":"#/components/schemas/Service"}},"authentication":{"type":"array","items":{"type":"string"}},"assertionMethod":{"type":"array","items":{"type":"string"}},"capabilityInvocation":{"type":"array","items":{"type":"string"}},"capabilityDelegation":{"type":"array","items":{"type":"string"}},"keyAgreement":{"type":"array","items":{"type":"string"}}}},"VerificationMethod":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"controller":{"type":"string"},"publicKeyMultibase":{"type":"string"},"publicKeyJwk":{"type":"array","items":{"type":"string"}}}},"Service":{"description":"Communicating or interacting with the DID subject or associated entities via one or more service endpoints. See DID Core specification for more details.","type":"object","properties":{"id":{"description":"DID appended with Service fragment ID (e.g., `#service-1` in `did:cheqd:mainnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0#service-1`)","type":"string"},"type":{"description":"Service type as defined in DID Specification Registries.","type":"string"},"serviceEndpoint":{"description":"Service endpoint as defined in DID Core Specification.","type":"array","items":{"type":"string"}},"priority":{"description":"(Optional) Priority of the service endpoint, used for distinction when multiple did-communication service endpoints are present in a single DID document.","type":"integer"},"recipientKeys":{"description":"(Optional) List of recipient keys used to denote the default recipients of an endpoint.","type":"array","items":{"type":"string"}},"routingKeys":{"description":"(Optional) List of routing keys used to used to denote the individual routing hops in between the sender and recipients.","type":"array","items":{"type":"string"}},"accept":{"description":"(Optional) List of media types that the service endpoint accepts.","type":"array","items":{"type":"string"}}}},"DeactivatedDidDocumentMetadata":{"type":"object","properties":{"created":{"type":"string"},"deactivated":{"type":"boolean"},"updated":{"type":"string"},"versionId":{"type":"string"},"linkedResourceMetadata":{"type":"array","items":{"$ref":"#/components/schemas/ResourceMetadata"}}}},"ResourceMetadata":{"type":"object","properties":{"resourceURI":{"type":"string"},"resourceCollectionId":{"type":"string"},"resourceId":{"type":"string"},"resourceName":{"type":"string"},"resourceType":{"type":"string"},"mediaType":{"type":"string"},"resourceVersion":{"type":"string"},"checksum":{"type":"string"},"created":{"type":"string"},"nextVersionId":{"type":"string"},"previousVersionId":{"type":"string"}}}}}}
```
## The DidDocumentMetadata object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"DidDocumentMetadata":{"type":"object","properties":{"created":{"type":"string"},"deactivated":{"type":"boolean"},"updated":{"type":"string"},"versionId":{"type":"string"},"linkedResourceMetadata":{"type":"array","items":{"$ref":"#/components/schemas/ResourceMetadata"}}}},"ResourceMetadata":{"type":"object","properties":{"resourceURI":{"type":"string"},"resourceCollectionId":{"type":"string"},"resourceId":{"type":"string"},"resourceName":{"type":"string"},"resourceType":{"type":"string"},"mediaType":{"type":"string"},"resourceVersion":{"type":"string"},"checksum":{"type":"string"},"created":{"type":"string"},"nextVersionId":{"type":"string"},"previousVersionId":{"type":"string"}}}}}}
```
## The DeactivatedDidDocumentMetadata object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"DeactivatedDidDocumentMetadata":{"type":"object","properties":{"created":{"type":"string"},"deactivated":{"type":"boolean"},"updated":{"type":"string"},"versionId":{"type":"string"},"linkedResourceMetadata":{"type":"array","items":{"$ref":"#/components/schemas/ResourceMetadata"}}}},"ResourceMetadata":{"type":"object","properties":{"resourceURI":{"type":"string"},"resourceCollectionId":{"type":"string"},"resourceId":{"type":"string"},"resourceName":{"type":"string"},"resourceType":{"type":"string"},"mediaType":{"type":"string"},"resourceVersion":{"type":"string"},"checksum":{"type":"string"},"created":{"type":"string"},"nextVersionId":{"type":"string"},"previousVersionId":{"type":"string"}}}}}}
```
## The ResourceMetadata object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"ResourceMetadata":{"type":"object","properties":{"resourceURI":{"type":"string"},"resourceCollectionId":{"type":"string"},"resourceId":{"type":"string"},"resourceName":{"type":"string"},"resourceType":{"type":"string"},"mediaType":{"type":"string"},"resourceVersion":{"type":"string"},"checksum":{"type":"string"},"created":{"type":"string"},"nextVersionId":{"type":"string"},"previousVersionId":{"type":"string"}}}}}}
```
## The DidResolutionMetadata object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"DidResolutionMetadata":{"type":"object","properties":{"contentType":{"allOf":[{"$ref":"#/components/schemas/ContentType"}]},"retrieved":{"type":"string"},"did":{"$ref":"#/components/schemas/DidProperties"}}},"ContentType":{"type":"string","enum":["application/did+json","application/did+ld+json","application/ld+json","application/json"]},"DidProperties":{"type":"object","properties":{"didString":{"type":"string"},"method":{"type":"string"},"methodSpecificId":{"type":"string"}}}}}}
```
## The ContentType object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"ContentType":{"type":"string","enum":["application/did+json","application/did+ld+json","application/ld+json","application/json"]}}}}
```
## The DidProperties object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"DidProperties":{"type":"object","properties":{"didString":{"type":"string"},"method":{"type":"string"},"methodSpecificId":{"type":"string"}}}}}}
```
## The Customer object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"Customer":{"type":"object","properties":{"customer":{"type":"object","properties":{"customerId":{"type":"string"},"name":{"type":"string"}}},"paymentAccount":{"type":"object","properties":{"mainnet":{"type":"string"},"testnet":{"type":"string"}}}}}}}}
```
## The QueryIdTokenResponseBody object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"QueryIdTokenResponseBody":{"type":"object","properties":{"idToken":{"type":"string"}}}}}}
```
## The AccountCreateRequest object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"AccountCreateRequest":{"type":"object","required":["primaryEmail"],"properties":{"name":{"type":"string"},"primaryEmail":{"type":"string"}}}}}}
```
## The AccountCreateResponse object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"AccountCreateResponse":{"type":"object","properties":{"customerId":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"description":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"paymentProviderId":{"type":"string"}}}}}}
```
## The AccountAnalyticsResponse object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"AccountAnalyticsResponse":{"type":"object","properties":{"dids":{"type":"integer"},"credentials":{"type":"integer"},"accreditations":{"type":"integer"},"resources":{"type":"integer"}}}}}}
```
## The SchemaUrl object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"SchemaUrl":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string"}},"url":{"type":"string"}}}}}}
```
## The InvalidRequest object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"InvalidRequest":{"description":"A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.","type":"object","properties":{"error":{"type":"string"}}}}}}
```
## The InternalError object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"InternalError":{"description":"An internal error has occurred. Additional state information plus metadata may be available in the response body.","type":"object","properties":{"error":{"type":"string"}}}}}}
```
## The UnauthorizedError object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"UnauthorizedError":{"description":"Access token is missing or invalid","type":"object","properties":{"error":{"type":"string"}}}}}}
```
## The ListAccreditationResult object
```json
{"openapi":"3.0.0","info":{"title":"cheqd Studio API for cheqd network","version":"2.0.0"},"components":{"schemas":{"ListAccreditationResult":{"type":"object","properties":{"total":{"type":"number","description":"Total number of accreditations."},"accreditations":{"type":"array","description":"List of accreditations with credential data and tracking metadata.","items":{"allOf":[{"$ref":"#/components/schemas/VerifiableCredential"},{"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"}}}}}]}}}},"VerifiableCredential":{"type":"object","required":["@context","type","issuer","issuanceDate","credentialSubject"],"properties":{"@context":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"JSON-LD context"},"id":{"type":"string","description":"Credential identifier"},"type":{"type":"array","items":{"type":"string"},"description":"Credential types"},"issuer":{"oneOf":[{"type":"string"},{"type":"object","properties":{"id":{"type":"string"}}}],"description":"Credential issuer"},"issuanceDate":{"type":"string","format":"date-time","description":"Issuance date"},"expirationDate":{"type":"string","format":"date-time","description":"Expiration date"},"credentialSubject":{"type":"object","additionalProperties":true,"description":"Credential subject claims"},"proof":{"type":"object","additionalProperties":true,"description":"Cryptographic proof"},"credentialStatus":{"type":"object","additionalProperties":true,"description":"Credential status information"}}}}}}
```
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.cheqd.io/product/api-reference/combined/models.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.