This endpoint creates a DID. As input it takes the DID plus options, a DID document, and optionally secrets needed to create a DID. The output is a state object that represents the current state of the DID creation process.
See the DID Registration specification for additional details.
", "operationId": "create", "tags": [ "DID" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRequest" } } } }, "responses": { "200": { "description": "The request was successful, but the DID may not be fully created yet, as indicated by the \"didState.state\" and \"jobId\" output fields. Additional state information plus metadata are available in the response body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateState" } } } }, "201": { "description": "The DID has been successfully created, as indicated by the \"didState.state\" output field. Additional state information (including the created DID) plus metadata are available in the response body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateState" } } } }, "400": { "description": "A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "500": { "description": "An internal error has occurred. Additional state information plus metadata may be available in the response body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } } } } }, "/update": { "post": { "summary": "Update a DID.", "description": "This endpoint updates a DID. As input it takes the existing DID plus options, a DID document, and optionally secrets needed to update a DID. The output is a state object that represents the current state of the DID update process.
See the DID Registration specification for additional details.
", "operationId": "update", "tags": [ "DID" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRequest" } } } }, "responses": { "200": { "description": "The request was successful, and the DID may or may not be fully updated yet, as indicated by the \"didState.state\" and \"jobId\" output fields. Additional state information plus metadata are available in the response body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateState" } } } }, "400": { "description": "A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "500": { "description": "An internal error has occurred. Additional state information plus metadata may be available in the response body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } } } } }, "/deactivate": { "post": { "summary": "Deactivate a DID.", "description": "This endpoint deactivates a DID. As input it takes the existing DID plus options, and optionally secrets needed to deactivate a DID. The output is a state object that represents the current state of the DID deactivation process.
See the DID Registration specification for additional details.
", "operationId": "deactivate", "tags": [ "DID" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeactivateRequest" } } } }, "responses": { "200": { "description": "The request was successful, and the DID may or may not be fully deactivated yet, as indicated by the \"didState.state\" and \"jobId\" output fields. Additional state information plus metadata are available in the response body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeactivateState" } } } }, "400": { "description": "A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "500": { "description": "An internal error has occurred. Additional state information plus metadata may be available in the response body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } } } } }, "/{did}/create-resource": { "post": { "summary": "Create a Resource (Deprecated)", "description": "This endpoint is deprecated and will be removed in future versions. Please use `/createResource` instead.", "deprecated": true, "tags": [ "Resource" ], "parameters": [ { "in": "path", "name": "did", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateResourceRequestV1" } } } }, "responses": { "200": { "description": "The resource is created successfully" } } } }, "/createResource": { "post": { "summary": "Create a DID URL and associated resource", "description": "This endpoint creates a DID URL and associated resource. As input it takes an existing DID, a relative DID URL, a resource, plus optional DID registration options and secrets needed to create the DID URL. The output is a state object that represents the current state of the DID URL creation process.
See the DID Registration specification for additional details.
", "operationId": "createResource", "tags": [ "Resource" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateResourceRequest" } } } }, "responses": { "200": { "description": "The request was successful, but the DID URL may not be fully created yet, as indicated by the \"didState.state\" and \"jobId\" output fields. Additional state information plus metadata are available in the response body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateResourceState" } } } }, "201": { "description": "The DID URL has been successfully created, as indicated by the \"didState.state\" output field. Additional state information (including the created DID URL) plus metadata are available in the response body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateResourceState" } } } }, "400": { "description": "A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "500": { "description": "An internal error has occurred. Additional state information plus metadata may be available in the response body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } } } } }, "/updateResource": { "post": { "summary": "Update a DID URL and associated resource", "description": "This endpoint updates a DID URL and associated resource. As input it takes an existing DID, a relative DID URL, a resource, plus optional DID registration options and secrets needed to update the DID URL. The output is a state object that represents the current state of the DID URL update process.
See the DID Registration specification for additional details.
", "operationId": "updateResource", "tags": [ "Resource" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResourceRequest" } } } }, "responses": { "200": { "description": "The request was successful, and the DID URL may or may not be fully updated yet, as indicated by the \"didState.state\" and \"jobId\" output fields. Additional state information plus metadata are available in the response body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResourceState" } } } }, "400": { "description": "A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "500": { "description": "An internal error has occurred. Additional state information plus metadata may be available in the response body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } } } } }, "/key-pair": { "get": { "tags": [ "Cheqd Helpers" ], "parameters": [ { "in": "query", "name": "seed", "schema": { "type": "string" }, "description": "32bit string to generate key pair" } ], "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyPair" } } } } } } }, "/did-document": { "get": { "tags": [ "Cheqd Helpers" ], "parameters": [ { "in": "query", "name": "verificationMethod", "schema": { "type": "string", "enum": [ "Ed25519VerificationKey2020", "JsonWebKey2020", "Ed25519VerificationKey2018" ], "default": "Ed25519VerificationKey2020" } }, { "in": "query", "name": "methodSpecificIdAlgo", "schema": { "type": "string", "enum": [ "base58btc", "uuid" ], "default": "uuid" } }, { "in": "query", "name": "network", "schema": { "type": "string", "enum": [ "testnet", "mainnet" ], "default": "testnet" } }, { "in": "query", "name": "publicKeyHex", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Did document generated succesfully" } } } }, "/properties": { "get": { "summary": "Return a map of configuration properties", "description": "This endpoint returns a map of the configuration properties of the DID Registrar, including of its drivers.
", "operationId": "universalRegistrarGetProperties", "tags": [ "Properties" ], "responses": { "200": { "description": "Success.", "content": { "application/did+json": { "schema": { "type": "object", "description": "A map of properties.", "example": { "cheqd": { "someprop": "/lib", "poolConfigs": "..." } } } } } } } } }, "/methods": { "get": { "summary": "Return a list of supported DID methods", "description": "This endpoint returns a list of DID methods supported by the DID Registrar.
", "operationId": "universalRegistrarGetMethods", "tags": [ "Properties" ], "responses": { "200": { "description": "Success.", "content": { "application/did+json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "The list of supported DID methods.", "example": [ "cheqd" ] } } } } } } }, "/traits": { "get": { "summary": "Return a map of DID traits", "description": "This endpoint returns a map of the DID traits of the DID methods supported by the DID Registrar.
", "operationId": "universalRegistrarGetTraits", "tags": [ "Properties" ], "responses": { "200": { "description": "Success.", "content": { "application/did+json": { "schema": { "type": "object", "description": "A map of DID traits.", "example": { "$schema": "https://identity.foundation/did-traits/schemas/traits.json", "name": "cheqd", "updatable": true, "deactivatable": true, "enumerable": true, "historyAvailable": true, "humanReadable": false } } } } } } } } }, "components": { "schemas": { "RegistrarRequest": { "description": "Input fields for a DID operation.", "type": "object", "properties": { "jobId": { "description": "This input field is used to keep track of an ongoing DID operation process. See https://identity.foundation/did-registration/#jobid.", "type": "string", "example": "6d85bcd0-2ea3-4288-ab00-15afadd8a156" }, "options": { "$ref": "#/components/schemas/RequestOptions" }, "secret": { "$ref": "#/components/schemas/RequestSecret" } } }, "RegistrarResourceRequest": { "description": "Input fields for a Resource operation.", "type": "object", "properties": { "jobId": { "description": "This input field is used to keep track of an ongoing DID operation process. See https://identity.foundation/did-registration/#jobid.", "type": "string", "example": "6d85bcd0-2ea3-4288-ab00-15afadd8a156" }, "options": { "$ref": "#/components/schemas/ResourceRequestOptions" }, "secret": { "$ref": "#/components/schemas/RequestSecret" } } }, "RequestOptions": { "description": "This input field contains an object with various options for the DID operation, such as the network where the DID operation should be executed. See https://identity.foundation/did-registration/#options.", "type": "object", "properties": { "network": { "description": "This input field contains the network to operate the DID" }, "clientSecretMode": { "$ref": "#/components/schemas/Boolean" }, "storeSecrets": { "$ref": "#/components/schemas/Boolean" }, "returnSecrets": { "$ref": "#/components/schemas/Boolean" }, "requestVerificationMethod": { "$ref": "#/components/schemas/RequestOptionsRequestVerificationMethod" } }, "additionalProperties": {}, "example": { "network": "testnet" } }, "ResourceRequestOptions": { "description": "This input field contains an object with various options for the DID operation, such as the network where the DID operation should be executed. See https://identity.foundation/did-registration/#options.", "type": "object", "properties": { "name": { "description": "This input field contains the name of the linkedResource", "type": "string" }, "type": { "description": "This input field contains the type of the linkedResource", "type": "string" }, "clientSecretMode": { "$ref": "#/components/schemas/Boolean" }, "storeSecrets": { "$ref": "#/components/schemas/Boolean" }, "returnSecrets": { "$ref": "#/components/schemas/Boolean" }, "requestVerificationMethod": { "$ref": "#/components/schemas/RequestOptionsRequestVerificationMethod" } }, "additionalProperties": {}, "example": { "name": "Demo Resource", "type": "Year 2024" } }, "RequestOptionsRequestVerificationMethod": { "type": "array", "items": { "$ref": "#/components/schemas/VerificationMethodTemplate" } }, "CreateRequest": { "description": "Input fields for the DID create operation.", "allOf": [ { "$ref": "#/components/schemas/RegistrarRequest" }, { "type": "object", "properties": { "didDocument": { "$ref": "#/components/schemas/DidDocument" } } } ] }, "UpdateRequest": { "description": "Input fields for the DID update operation.", "allOf": [ { "$ref": "#/components/schemas/RegistrarRequest" }, { "type": "object", "required": [ "did" ], "properties": { "did": { "description": "This input field indicates the DID that is the target of the DID update operation.", "type": "string", "example": "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09" }, "didDocumentOperation": { "description": "This input field indicates which update operation(s) should be applied to a DID’s associated DID document. See https://identity.foundation/did-registration/#diddocumentoperation.", "type": "array", "items": { "type": "string" }, "default": [ "setDidDocument" ] }, "didDocument": { "description": "This input field contains either a complete DID document, or an incremental change (diff) to a DID document. See https://identity.foundation/did-registration/#diddocument.", "type": "array", "items": { "$ref": "#/components/schemas/DidDocument" } } } } ], "example": { "did": "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09", "didDocumentOperation": [ "setDidDocument" ], "didDocument": [ { "id": "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09", "controller": [ "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09" ], "verificationMethod": [ { "id": "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09#key-1", "type": "Ed25519VerificationKey2020", "controller": "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09", "publicKeyMultibase": "z6Mkt9Vg1a1Jbg5a1NkToUeWH23Z33TwGUua5MrqAYUz2AL3" } ], "authentication": [ "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09#key-1" ], "versionId": "978f4437-b498-4961-978f-116ffba7962c", "service": [ { "id": "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09#rand", "type": "rand", "serviceEndpoint": [ "https://rand.in" ] } ] } ] } }, "DeactivateRequest": { "description": "Input fields for the DID deactivate operation.", "allOf": [ { "$ref": "#/components/schemas/RegistrarRequest" }, { "type": "object", "required": [ "did" ], "properties": { "did": { "description": "This input field indicates the DID that is the target of the DID deactivation operation.", "type": "string", "example": "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09" } } } ] }, "CreateResourceRequestV1": { "description": "Input fields for a DID URL create operation.", "type": "object", "additionalProperties": false, "properties": { "jobId": { "description": "This input field is used to keep track of an ongoing DID deactivation process. See https://identity.foundation/did-registration/#jobid.", "type": "string" }, "secret": { "description": "This input field requires a keyPair.", "type": "object", "properties": { "keys": { "type": "array", "items": { "$ref": "#/components/schemas/KeyPair" } }, "signingResponse": { "type": "array", "items": { "$ref": "#/components/schemas/SigningResponse" } } } }, "data": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "alsoKnownAs": { "type": "array", "items": { "type": "object", "properties": { "uri": { "type": "string" }, "description": { "type": "string" } } } }, "version": { "type": "string" } }, "example": { "data": "SGVsbG8gV29ybGQ=", "name": "ResourceName", "type": "TextDocument" } }, "CreateResourceRequest": { "description": "Input fields for a DID URL create operation.", "allOf": [ { "$ref": "#/components/schemas/RegistrarResourceRequest" }, { "type": "object", "properties": { "did": { "description": "This input field indicates the DID that is the target of the DID URL create operation.", "type": "string", "example": "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09" }, "relativeDidUrl": { "description": "This input field indicates a relative DID URL for this resource after create operation.", "type": "string", "example": "/resources/0d033721-dfdc-46b4-85c2-68f35fced15a" }, "content": { "description": "This input field contains Base64-encoded data that is the content of the resource associated with the DID URL.", "type": "string", "example": "SGVsbG8gV29ybGQ=" } } } ] }, "UpdateResourceRequest": { "description": "Input fields for a DID URL update operation.", "allOf": [ { "$ref": "#/components/schemas/RegistrarResourceRequest" }, { "type": "object", "properties": { "did": { "description": "This input field indicates the DID that is the target of the DID URL update operation.", "type": "string", "example": "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09" }, "relativeDidUrl": { "description": "This input field indicates a relative DID URL for this resource after update operation.", "type": "string", "example": "/resources/e667fa68-c3cf-449e-89e1-482ef821abfe" }, "contentOperation": { "description": "This input field indicates which update operation(s) should be applied to the content of a DID URL’s associated resource. See https://identity.foundation/did-registration/#resourceoperation.", "type": "array", "items": { "type": "string" }, "example": [ "setContent" ] }, "content": { "description": "This input field contains Base64-encoded data that is the content of the resource associated with the DID URL.", "type": "array", "items": { "type": "string" }, "example": [ "SGVsbG8gV29ybGQ=" ] } } } ] }, "DidDocument": { "description": "This input field contains either a complete DID document, or an incremental change (diff) to a DID document. See https://identity.foundation/did-registration/#diddocument.", "type": "object", "properties": { "id": { "$ref": "#/components/schemas/String" }, "controller": { "$ref": "#/components/schemas/DidDocumentController" }, "authentication": { "type": "array", "items": { "type": "string" }, "example": [ "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09#key-0" ] }, "assertionMethod": { "type": "array", "items": { "type": "string" } }, "capabilityInvocation": { "type": "array", "items": { "type": "string" } }, "capabilityDelegation": { "type": "array", "items": { "type": "string" } }, "keyAgreement": { "type": "array", "items": { "type": "string" } }, "alsoKnownAs": { "type": "array", "items": { "type": "string" }, "example": [ "did:web:example.com" ] }, "verificationMethod": { "type": "array", "items": { "$ref": "#/components/schemas/VerificationMethodTemplate" } }, "service": { "type": "array", "items": { "$ref": "#/components/schemas/DidDocumentService" } } }, "additionalProperties": {}, "example": { "id": "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09", "controller": [ "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09" ], "verificationMethod": [ { "id": "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09#key-1", "type": "Ed25519VerificationKey2020", "controller": "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09", "publicKeyMultibase": "z6Mkt9Vg1a1Jbg5a1NkToUeWH23Z33TwGUua5MrqAYUz2AL3" } ], "authentication": [ "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09#key-1" ], "alsoKnownAs": [ "did:web:example.com" ] } }, "DidDocumentController": { "type": "array", "items": { "type": "string" }, "example": [ "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09" ] }, "DidDocumentService": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "RegistrarState": { "description": "The state after a DID operation.", "type": "object", "required": [ "didState" ], "properties": { "jobId": { "type": "string", "example": "6d85bcd0-2ea3-4288-ab00-15afadd8a156" }, "didState": { "$ref": "#/components/schemas/DidState" }, "didRegistrationMetadata": { "type": "object", "additionalProperties": {} }, "didDocumentMetadata": { "type": "object", "additionalProperties": {} } } }, "RegistrarResourceState": { "description": "The state after a DID URL operation.", "type": "object", "required": [ "didUrlState" ], "properties": { "jobId": { "type": "string", "example": "6d85bcd0-2ea3-4288-ab00-15afadd8a156" }, "didUrlState": { "$ref": "#/components/schemas/DidUrlState" }, "didRegistrationMetadata": { "type": "object", "additionalProperties": {} }, "contentMetadata": { "type": "object", "additionalProperties": {} } } }, "CreateState": { "description": "The state after a DID create operation.", "allOf": [ { "$ref": "#/components/schemas/RegistrarState" }, { "type": "object" } ] }, "UpdateState": { "description": "The state after a DID update operation.", "allOf": [ { "$ref": "#/components/schemas/RegistrarState" }, { "type": "object" } ] }, "DeactivateState": { "description": "The state after a DID deactivate operation.", "allOf": [ { "$ref": "#/components/schemas/RegistrarState" }, { "type": "object" } ] }, "CreateResourceState": { "description": "The state after a DID URL create operation.", "allOf": [ { "$ref": "#/components/schemas/RegistrarResourceState" }, { "type": "object" } ] }, "UpdateResourceState": { "description": "The state after a DID URL update operation.", "allOf": [ { "$ref": "#/components/schemas/RegistrarResourceState" }, { "type": "object" } ] }, "DeactivateResourceState": { "description": "The state after a DID URL deactivate operation.", "allOf": [ { "$ref": "#/components/schemas/RegistrarResourceState" }, { "type": "object" } ] }, "DidState": { "description": "The current state of a DID.", "type": "object", "required": [ "state" ], "discriminator": { "propertyName": "state", "mapping": { "finished": "#/components/schemas/DidStateFinished", "failed": "#/components/schemas/DidStateFailed", "action": "#/components/schemas/DidStateAction", "wait": "#/components/schemas/DidStateWait" } }, "properties": { "state": { "$ref": "#/components/schemas/String" }, "did": { "$ref": "#/components/schemas/String" }, "secret": { "$ref": "#/components/schemas/DidStateSecret" }, "didDocument": { "$ref": "#/components/schemas/DidDocument" } }, "additionalProperties": true }, "DidUrlState": { "description": "The current state of a DID URL and associated resource.", "type": "object", "required": [ "state" ], "discriminator": { "propertyName": "state", "mapping": { "finished": "#/components/schemas/DidUrlStateFinished", "failed": "#/components/schemas/DidUrlStateFailed", "action": "#/components/schemas/DidUrlStateAction", "wait": "#/components/schemas/DidUrlStateWait" } }, "properties": { "state": { "$ref": "#/components/schemas/String" }, "didUrl": { "$ref": "#/components/schemas/String" }, "secret": { "$ref": "#/components/schemas/DidStateSecret" }, "content": { "$ref": "#/components/schemas/String" } }, "additionalProperties": {} }, "DidStateFinished": { "allOf": [ { "$ref": "#/components/schemas/DidState" }, { "$ref": "#/components/schemas/StateFinished" } ] }, "DidStateFailed": { "allOf": [ { "$ref": "#/components/schemas/DidState" }, { "$ref": "#/components/schemas/StateFailed" } ] }, "DidStateAction": { "allOf": [ { "$ref": "#/components/schemas/DidState" }, { "$ref": "#/components/schemas/StateAction" } ] }, "DidStateWait": { "allOf": [ { "$ref": "#/components/schemas/DidState" }, { "$ref": "#/components/schemas/StateWait" } ] }, "DidUrlStateFinished": { "allOf": [ { "$ref": "#/components/schemas/DidUrlState" }, { "$ref": "#/components/schemas/StateFinished" } ] }, "DidUrlStateFailed": { "allOf": [ { "$ref": "#/components/schemas/DidUrlState" }, { "$ref": "#/components/schemas/StateFailed" } ] }, "DidUrlStateAction": { "allOf": [ { "$ref": "#/components/schemas/DidUrlState" }, { "$ref": "#/components/schemas/StateAction" } ] }, "DidUrlStateWait": { "allOf": [ { "$ref": "#/components/schemas/DidUrlState" }, { "$ref": "#/components/schemas/StateWait" } ] }, "StateFinished": { "description": "This state indicates that the DID operation has been completed. See https://identity.foundation/did-registration/#didstatestatefinished.", "allOf": [ { "type": "object" } ] }, "StateFailed": { "description": "This state indicates that the DID operation has failed. See https://identity.foundation/did-registration/#didstatestatefailed.", "allOf": [ { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/String" }, "reason": { "$ref": "#/components/schemas/String" } } } ] }, "StateAction": { "description": "This state indicates that the client needs to perform an action, before the DID operation can be continued. See https://identity.foundation/did-registration/#didstatestateaction.", "allOf": [ { "type": "object", "properties": { "action": { "$ref": "#/components/schemas/String" }, "verificationMethodTemplate": { "$ref": "#/components/schemas/StateActionVerificationMethodTemplate" }, "signingRequest": { "type": "array", "items": { "$ref": "#/components/schemas/SigningRequest" } }, "decryptionRequest": { "type": "array", "items": { "$ref": "#/components/schemas/DecryptionRequest" } } } } ] }, "StateActionVerificationMethodTemplate": { "type": "array", "items": { "$ref": "#/components/schemas/VerificationMethodTemplate" } }, "StateWait": { "description": "This state indicates that the client needs to wait, before the DID operation can be continued. See https://identity.foundation/did-registration/#didstatestatewait.", "allOf": [ { "type": "object", "properties": { "wait": { "$ref": "#/components/schemas/String" }, "waittime": { "$ref": "#/components/schemas/String" } } } ] }, "Secret": { "description": "Secrets in requests and states.", "type": "object", "properties": { "verificationMethod": { "$ref": "#/components/schemas/SecretVerificationMethod" } }, "additionalProperties": {} }, "SecretVerificationMethod": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/VerificationMethodPublicData" }, { "$ref": "#/components/schemas/VerificationMethodPrivateData" }, { "$ref": "#/components/schemas/SecretVerificationMethodVerificationMethodTemplate" } ] }, "example": [ { "id": "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09#key-1", "type": "JsonWebKey2020", "privateKeyJwk": { "kty": "OKP", "crv": "Ed25519", "d": "NzJXR3A3TmdGUjFPcWRpOHpsdDdqUVE0MzRYUjBjTlE", "x": "jpIKKU2b77lNXKTNW2NGvw1GUMjU6v_l_tLJAH5uYz0" } } ] }, "SecretVerificationMethodVerificationMethodTemplate": { "type": "array", "items": { "$ref": "#/components/schemas/VerificationMethodTemplate" } }, "RequestSecret": { "description": "This input field contains an object with DID controller keys and other secrets needed for performing the DID operation. See https://identity.foundation/did-registration/#secret.", "allOf": [ { "$ref": "#/components/schemas/Secret" }, { "type": "object", "properties": { "signingResponse": { "type": "array", "items": { "$ref": "#/components/schemas/SigningResponse" } }, "decryptionResponse": { "type": "array", "items": { "$ref": "#/components/schemas/DecryptionResponse" } } } } ] }, "DidStateSecret": { "description": "This output field contains an object with DID controller keys and other secrets. See https://identity.foundation/did-registration/#didstatesecret.", "allOf": [ { "$ref": "#/components/schemas/Secret" }, { "type": "object", "example": { "seed": "72WGp7NgFR1Oqdi8zlt7jQQ434XR0cNQ" } } ] }, "SigningRequest": { "description": "A signing request, see https://identity.foundation/did-registration/#signing-request-set.", "type": "object", "required": [ "serializedPayload", "alg" ], "properties": { "payload": { "type": "object" }, "serializedPayload": { "$ref": "#/components/schemas/String" }, "kid": { "$ref": "#/components/schemas/String" }, "alg": { "$ref": "#/components/schemas/String" }, "purpose": { "$ref": "#/components/schemas/String" } }, "additionalProperties": {} }, "SigningRequestSet": { "description": "A signing request set, see https://identity.foundation/did-registration/#signing-request-set.", "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SigningRequest" } }, "SigningResponse": { "description": "A signing response, see https://identity.foundation/did-registration/#signing-response-set.", "type": "object", "required": [ "signature" ], "properties": { "signature": { "$ref": "#/components/schemas/String" }, "kid": { "$ref": "#/components/schemas/String" }, "alg": { "$ref": "#/components/schemas/String" }, "purpose": { "$ref": "#/components/schemas/String" } }, "additionalProperties": {}, "example": { "kid": "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09#key-1", "signature": "keaiUef4jaPvupBpC2IK9/H/yd/OPsgxCADOgftuLQc" } }, "SigningResponseSet": { "description": "A signing response set, see https://identity.foundation/did-registration/#signing-response-set.", "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SigningResponse" } }, "DecryptionRequest": { "description": "A decryption request, see https://identity.foundation/did-registration/#decryption-request-set.", "type": "object", "required": [ "encryptedPayload", "enc" ], "properties": { "payload": { "$ref": "#/components/schemas/String" }, "encryptedPayload": { "$ref": "#/components/schemas/String" }, "kid": { "$ref": "#/components/schemas/String" }, "enc": { "$ref": "#/components/schemas/String" }, "purpose": { "$ref": "#/components/schemas/String" } }, "additionalProperties": {} }, "DecryptionRequestSet": { "description": "A decryption request set, see https://identity.foundation/did-registration/#decryption-request-set.", "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DecryptionRequest" } }, "DecryptionResponse": { "description": "A decryption response, see https://identity.foundation/did-registration/#decryption-response-set.", "type": "object", "required": [ "decryptedPayload" ], "properties": { "decryptedPayload": { "$ref": "#/components/schemas/String" }, "kid": { "$ref": "#/components/schemas/String" }, "enc": { "$ref": "#/components/schemas/String" }, "purpose": { "$ref": "#/components/schemas/String" } }, "additionalProperties": {}, "example": { "kid": "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09#key-1", "decryptedPayload": "keaiUef4jaPvupBpC2IK9/H/yd/OPsgxCADOgftuLQc" } }, "DecryptionResponseSet": { "description": "A decryption response set, see https://identity.foundation/did-registration/#decryption-response-set.", "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DecryptionResponse" } }, "VerificationMethodData": { "type": "object", "required": [ "type" ], "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "controller": { "type": "string" }, "purpose": { "type": "array", "items": { "type": "string" } } } }, "VerificationMethodPublicData": { "description": "A verification method public data object, see https://identity.foundation/did-registration/#verification-method-public-data", "allOf": [ { "$ref": "#/components/schemas/VerificationMethodData" }, { "type": "object", "properties": { "publicKeyJwk": { "type": "array", "items": { "type": "string" } }, "publicKeyMultibase": { "type": "string" } } } ] }, "VerificationMethodPrivateData": { "description": "A verification method private data object, see https://identity.foundation/did-registration/#verification-method-private-data", "allOf": [ { "$ref": "#/components/schemas/VerificationMethodData" }, { "type": "object", "properties": { "privateKeyJwk": { "type": "array", "items": { "type": "string" } }, "privateKeyMultibase": { "type": "string" } } } ] }, "VerificationMethodTemplate": { "description": "A verification method template, see https://identity.foundation/did-registration/#verification-method-template", "type": "object", "properties": { "id": { "type": "string", "example": "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09#key-0" }, "type": { "type": "string", "example": "Ed25519VerificationKey2020" }, "controller": { "type": "string", "example": "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09" }, "purpose": { "type": "array", "items": { "type": "string" } }, "publicKeyMultibase": { "type": "string", "example": "z6Mkt9Vg1a1Jbg5a1NkToUeWH23Z33TwGUua5MrqAYUz2AL3" }, "publicKeyJwk": { "type": "array", "items": { "type": "string" } } } }, "String": { "type": "string" }, "Boolean": { "type": "boolean" }, "Service": { "type": "object", "required": [ "id", "type", "serviceEndpoint" ], "properties": { "id": { "type": "string", "example": "did:cheqd:testnet:ca9ff47c-0286-4614-a4be-8ffa83911e09#rand" }, "type": { "type": "string", "example": "rand" }, "serviceEndpoint": { "type": "array", "items": { "type": "string" }, "example": [ "https://rand.in" ] }, "recipientKeys": { "type": "array", "items": { "type": "string" }, "example": [ "did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK" ] }, "routingKeys": { "type": "array", "items": { "type": "string" }, "example": [ "did:key:z6MkjchhfUsD6mmvni8mCdXHw216Xrm9bQe2mBH1P5RDjVJG" ] }, "accept": { "type": "array", "items": { "type": "string" }, "example": [ "application/didcomm-plain+json" ] }, "priority": { "type": "number", "example": 1 } } }, "Options": { "description": "This input field contains an object with various options for the DID create operation, such as the network where the DID should be created. See https://identity.foundation/did-registration/#options.", "type": "object", "properties": { "network": { "type": "string" } }, "example": { "network": "testnet" } }, "KeyPair": { "type": "object", "properties": { "kid": { "type": "string" }, "privateKeyHex": { "type": "string" }, "publicKeyHex": { "type": "string" } } }, "InvalidRequest": { "type": "object", "properties": { "jobId": { "type": "string" }, "didState": { "type": "object", "properties": { "state": { "type": "string", "example": "failed" }, "reason": { "type": "string" }, "description": { "type": "string" }, "secret": { "$ref": "#/components/schemas/Secret" }, "didDocument": { "$ref": "#/components/schemas/DidDocument" } } } } } } } }