api-docs.json

{"paths": {"/plugins": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminModules"}, "description": null}}, "parameters": [], "tags": ["server"], "summary": "Fetch the list of loaded plugins", "produces": ["application/json"]}}, "/status": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminStatus"}, "description": null}}, "parameters": [], "tags": ["server"], "summary": "Fetch the server status", "produces": ["application/json"]}}, "/status/reset": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminStatus"}, "description": null}}, "parameters": [], "tags": ["server"], "summary": "Reset statistics", "produces": ["application/json"]}}, "/present-proof/records": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchangeList"}, "description": null}}, "parameters": [], "tags": ["present-proof"], "summary": "Fetch all present-proof exchange records", "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": null}}, "parameters": [{"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof"], "summary": "Fetch a single presentation exchange record", "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}/credentials": {"get": {"responses": {}, "parameters": [{"in": "query", "name": "count", "required": false, "type": "integer", "format": "int32", "minimum": 1, "description": "Maximum number to retrieve", "example": 10}, {"in": "query", "name": "start", "required": false, "type": "integer", "format": "int32", "minimum": 0, "description": "Start index", "example": 0}, {"in": "query", "name": "extra_query", "required": false, "type": "string", "pattern": "^{.*}$", "description": "(JSON) WQL extra query", "example": "{\"name\": \"Alex\"}"}, {"in": "query", "name": "referent", "required": false, "type": "string", "description": "Proof request referents of interest, comma-separated", "example": "1_name_uuid,2_score_uuid"}, {"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof"], "summary": "Fetch credentials for a presentation request from wallet", "produces": ["application/json"]}}, "/present-proof/send-proposal": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": null}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10PresentationProposalRequest"}}], "tags": ["present-proof"], "summary": "Sends a presentation proposal", "produces": ["application/json"]}}, "/present-proof/create-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": null}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10PresentationCreateRequestRequest"}}], "tags": ["present-proof"], "summary": "\n    Creates a presentation request not bound to any proposal or existing connection\n    ", "produces": ["application/json"]}}, "/present-proof/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": null}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10PresentationSendRequestRequest"}}], "tags": ["present-proof"], "summary": "Sends a free presentation request not bound to any proposal", "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": null}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10PresentationSendRequestRequest"}}, {"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof"], "summary": "Sends a presentation request in reference to a proposal", "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}/send-presentation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": null}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10PresentationRequest"}}, {"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof"], "summary": "Sends a proof presentation", "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}/verify-presentation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": null}}, "parameters": [{"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof"], "summary": "Verify a received presentation", "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}/remove": {"post": {"responses": {}, "parameters": [{"in": "path", "name": "pres_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["present-proof"], "summary": "Remove an existing presentation exchange record", "produces": ["application/json"]}}, "/connections/{conn_id}/send-message": {"post": {"responses": {}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/SendMessage"}}, {"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["basicmessage"], "summary": "Send a basic message to a connection", "produces": ["application/json"]}}, "/connections/{conn_id}/start-introduction": {"post": {"responses": {}, "parameters": [{"in": "query", "name": "target_connection_id", "required": true, "type": "string", "description": "Target connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "query", "name": "message", "required": false, "type": "string", "description": "Message", "example": "Allow me to introduce ..."}, {"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["introduction"], "summary": "Start an introduction between two connections", "produces": ["application/json"]}}, "/issue-credential/mime-types/{credential_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10AttributeMimeTypesResult"}, "description": null}}, "parameters": [{"in": "path", "name": "credential_id", "required": true, "type": "string", "description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential"], "summary": "Get attribute MIME types from wallet", "produces": ["application/json"]}}, "/issue-credential/records": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchangeListResult"}, "description": null}}, "parameters": [], "tags": ["issue-credential"], "summary": "Fetch all credential exchange records", "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": null}}, "parameters": [{"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential"], "summary": "Fetch a single credential exchange record", "produces": ["application/json"]}}, "/issue-credential/send": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": null}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialProposalRequestMand"}}], "tags": ["issue-credential"], "summary": "Send holder a credential, automating entire flow", "produces": ["application/json"]}}, "/issue-credential/send-proposal": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": null}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialProposalRequestOpt"}}], "tags": ["issue-credential"], "summary": "Send issuer a credential proposal", "produces": ["application/json"]}}, "/issue-credential/send-offer": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": null}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialOfferRequest"}}], "tags": ["issue-credential"], "summary": "Send holder a credential offer, independent of any proposal", "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}/send-offer": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": null}}, "parameters": [{"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential"], "summary": "Send holder a credential offer in reference to a proposal with preview", "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": null}}, "parameters": [{"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential"], "summary": "Send issuer a credential request", "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}/issue": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": null}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialIssueRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential"], "summary": "Send holder a credential", "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}/store": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": null}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialStoreRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential"], "summary": "Store a received credential", "produces": ["application/json"]}}, "/issue-credential/revoke": {"post": {"responses": {}, "parameters": [{"in": "query", "name": "cred_rev_id", "required": true, "type": "integer", "format": "int32", "minimum": 1, "description": "Credential revocation identifier", "example": 10}, {"in": "query", "name": "publish", "required": false, "type": "boolean", "description": "(True) publish revocation to ledger immediately, or (False) mark it pending (default value)"}, {"in": "query", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}], "tags": ["issue-credential"], "summary": "Revoke an issued credential", "produces": ["application/json"]}}, "/issue-credential/publish-revocations": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PublishRevocationsResult"}, "description": null}}, "parameters": [], "tags": ["issue-credential"], "summary": "Publish pending revocations to ledger", "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}/remove": {"post": {"responses": {}, "parameters": [{"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential"], "summary": "Remove an existing credential exchange record", "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}/problem-report": {"post": {"responses": {}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialProblemReportRequest"}}, {"in": "path", "name": "cred_ex_id", "required": true, "type": "string", "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["issue-credential"], "summary": "Send a problem report for credential exchange", "produces": ["application/json"]}}, "/features": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/QueryResult"}, "description": null}}, "parameters": [{"in": "query", "name": "query", "required": false, "type": "string", "description": "Query", "example": "did:sov:*"}], "tags": ["server"], "summary": "Query supported features", "produces": ["application/json"]}}, "/connections/{conn_id}/send-ping": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/PingRequestResponse"}, "description": null}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/PingRequest"}}, {"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["trustping"], "summary": "Send a trust ping to a connection", "produces": ["application/json"]}}, "/connections": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnectionList"}, "description": null}}, "parameters": [{"in": "query", "name": "their_role", "required": false, "type": "string", "description": "Their assigned connection role", "example": "Interlocutor"}, {"in": "query", "name": "invitation_key", "required": false, "type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "description": "invitation key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"}, {"in": "query", "name": "alias", "required": false, "type": "string", "description": "Alias", "example": "Barry"}, {"in": "query", "name": "their_did", "required": false, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Their DID", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "my_did", "required": false, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "My DID", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "state", "required": false, "type": "string", "enum": ["init", "invitation", "request", "response", "active", "error", "inactive"], "description": "Connection state"}, {"in": "query", "name": "initiator", "required": false, "type": "string", "enum": ["self", "external"], "description": "Connection initiator"}], "tags": ["connection"], "summary": "Query agent-to-agent connections", "produces": ["application/json"]}}, "/connections/{conn_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnectionRecord"}, "description": null}}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["connection"], "summary": "Fetch a single connection record", "produces": ["application/json"]}}, "/connections/create-static": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnectionStaticResult"}, "description": null}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/ConnectionStaticRequest"}}], "tags": ["connection"], "summary": "Create a new static connection", "produces": ["application/json"]}}, "/connections/create-invitation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/InvitationResult"}, "description": null}}, "parameters": [{"in": "query", "name": "alias", "required": false, "type": "string", "description": "Alias", "example": "Barry"}, {"in": "query", "name": "public", "required": false, "type": "boolean", "description": "Create invitation from public DID (default false)"}, {"in": "query", "name": "multi_use", "required": false, "type": "boolean", "description": "Create invitation for multiple use (default false)"}, {"in": "query", "name": "auto_accept", "required": false, "type": "boolean", "description": "Auto-accept connection (default as per configuration)"}], "tags": ["connection"], "summary": "Create a new connection invitation", "produces": ["application/json"]}}, "/connections/receive-invitation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnectionRecord"}, "description": null}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/ReceiveInvitationRequest"}}, {"in": "query", "name": "alias", "required": false, "type": "string", "description": "Alias", "example": "Barry"}, {"in": "query", "name": "auto_accept", "required": false, "type": "boolean", "description": "Auto-accept connection (defaults to configuration)"}], "tags": ["connection"], "summary": "Receive a new connection invitation", "produces": ["application/json"]}}, "/connections/{conn_id}/accept-invitation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnectionRecord"}, "description": null}}, "parameters": [{"in": "query", "name": "my_label", "required": false, "type": "string", "description": "Label for connection", "example": "Broker"}, {"in": "query", "name": "my_endpoint", "required": false, "type": "string", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "description": "My URL endpoint", "example": "https://myhost:8021"}, {"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["connection"], "summary": "Accept a stored connection invitation", "produces": ["application/json"]}}, "/connections/{conn_id}/accept-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnectionRecord"}, "description": null}}, "parameters": [{"in": "query", "name": "my_endpoint", "required": false, "type": "string", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "description": "My URL endpoint", "example": "https://myhost:8021"}, {"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["connection"], "summary": "Accept a stored connection request", "produces": ["application/json"]}}, "/connections/{conn_id}/establish-inbound/{ref_id}": {"post": {"responses": {}, "parameters": [{"in": "path", "name": "ref_id", "required": true, "type": "string", "description": "Inbound connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, {"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["connection"], "summary": "Assign another connection as the inbound connection", "produces": ["application/json"]}}, "/connections/{conn_id}/remove": {"post": {"responses": {}, "parameters": [{"in": "path", "name": "conn_id", "required": true, "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["connection"], "summary": "Remove an existing connection record", "produces": ["application/json"]}}, "/credential/{credential_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/Credential"}, "description": null}}, "parameters": [{"in": "path", "name": "credential_id", "required": true, "type": "string", "description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["credentials"], "summary": "Fetch a credential from wallet by id", "produces": ["application/json"]}}, "/credential/{credential_id}/remove": {"post": {"responses": {}, "parameters": [{"in": "path", "name": "credential_id", "required": true, "type": "string", "description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "tags": ["credentials"], "summary": "Remove a credential from the wallet by id", "produces": ["application/json"]}}, "/credentials": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredentialsList"}, "description": null}}, "parameters": [{"in": "query", "name": "count", "required": false, "type": "integer", "format": "int32", "minimum": 1, "description": "Maximum number to retrieve", "example": 10}, {"in": "query", "name": "wql", "required": false, "type": "string", "pattern": "^{.*}$", "description": "(JSON) WQL query", "example": "{\"name\": \"Alex\"}"}, {"in": "query", "name": "start", "required": false, "type": "integer", "format": "int32", "minimum": 0, "description": "Start index", "example": 0}], "tags": ["credentials"], "summary": "Fetch credentials from wallet", "produces": ["application/json"]}}, "/ledger/register-nym": {"post": {"responses": {}, "parameters": [{"in": "query", "name": "alias", "required": false, "type": "string", "description": "Alias", "example": "Barry"}, {"in": "query", "name": "verkey", "required": true, "type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "description": "Verification key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"}, {"in": "query", "name": "role", "required": false, "type": "string", "enum": ["STEWARD", "TRUSTEE", "ENDORSER", "NETWORK_MONITOR", "reset"], "description": "Role"}, {"in": "query", "name": "did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID to register", "example": "WgWxqztrNooG92RXvxSTWv"}], "tags": ["ledger"], "summary": "Send a NYM registration to the ledger.", "produces": ["application/json"]}}, "/ledger/rotate-public-did-keypair": {"patch": {"responses": {}, "parameters": [], "tags": ["ledger"], "summary": "Rotate key pair for public DID.", "produces": ["application/json"]}}, "/ledger/did-verkey": {"get": {"responses": {}, "parameters": [{"in": "query", "name": "did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv"}], "tags": ["ledger"], "summary": "Get the verkey for a DID from the ledger.", "produces": ["application/json"]}}, "/ledger/did-endpoint": {"get": {"responses": {}, "parameters": [{"in": "query", "name": "did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv"}], "tags": ["ledger"], "summary": "Get the endpoint for a DID from the ledger.", "produces": ["application/json"]}}, "/ledger/taa": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/TAAResult"}, "description": null}}, "parameters": [], "tags": ["ledger"], "summary": "Fetch the current transaction author agreement, if any", "produces": ["application/json"]}}, "/ledger/taa/accept": {"post": {"responses": {}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/TAAAccept"}}], "tags": ["ledger"], "summary": "Accept the transaction author agreement", "produces": ["application/json"]}}, "/credential-definitions": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredentialDefinitionSendResults"}, "description": null}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/CredentialDefinitionSendRequest"}}], "tags": ["credential-definition"], "summary": "Sends a credential definition to the ledger", "produces": ["application/json"]}}, "/credential-definitions/created": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredentialDefinitionsCreatedResults"}, "description": null}}, "parameters": [{"in": "query", "name": "schema_version", "required": false, "type": "string", "pattern": "^[0-9.]+$", "description": "Schema version", "example": "1.0"}, {"in": "query", "name": "schema_name", "required": false, "type": "string", "description": "Schema name", "example": "membership"}, {"in": "query", "name": "schema_id", "required": false, "type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0"}, {"in": "query", "name": "issuer_did", "required": false, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Issuer DID", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "cred_def_id", "required": false, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition id", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}, {"in": "query", "name": "schema_issuer_did", "required": false, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Schema issuer DID", "example": "WgWxqztrNooG92RXvxSTWv"}], "tags": ["credential-definition"], "summary": "Search for matching credential definitions that agent originated", "produces": ["application/json"]}}, "/credential-definitions/{cred_def_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredentialDefinitionGetResults"}, "description": null}}, "parameters": [{"in": "path", "name": "cred_def_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}], "tags": ["credential-definition"], "summary": "Gets a credential definition from the ledger", "produces": ["application/json"]}}, "/schemas": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/SchemaSendResults"}, "description": null}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/SchemaSendRequest"}}], "tags": ["schema"], "summary": "Sends a schema to the ledger", "produces": ["application/json"]}}, "/schemas/created": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/SchemasCreatedResults"}, "description": null}}, "parameters": [{"in": "query", "name": "schema_name", "required": false, "type": "string", "description": "Schema name", "example": "membership"}, {"in": "query", "name": "schema_issuer_did", "required": false, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Schema issuer DID", "example": "WgWxqztrNooG92RXvxSTWv"}, {"in": "query", "name": "schema_id", "required": false, "type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0"}, {"in": "query", "name": "schema_version", "required": false, "type": "string", "pattern": "^[0-9.]+$", "description": "Schema version", "example": "1.0"}], "tags": ["schema"], "summary": "Search for matching schema that agent originated", "produces": ["application/json"]}}, "/schemas/{schema_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/SchemaGetResults"}, "description": null}}, "parameters": [{"in": "path", "name": "schema_id", "required": true, "type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0"}], "tags": ["schema"], "summary": "Gets a schema from the ledger", "produces": ["application/json"]}}, "/revocation/create-registry": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegCreateResult"}, "description": null}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/RevRegCreateRequest"}}], "tags": ["revocation"], "summary": "Creates a new revocation registry", "produces": ["application/json"]}}, "/revocation/registries/created": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegsCreated"}, "description": null}}, "parameters": [{"in": "query", "name": "state", "required": false, "type": "string", "enum": ["init", "generated", "published", "active", "full"], "description": "Revocation registry state"}, {"in": "query", "name": "cred_def_id", "required": false, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}], "tags": ["revocation"], "summary": "Search for matching revocation registries that current agent created", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegCreateResult"}, "description": null}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}], "tags": ["revocation"], "summary": "Get revocation registry by revocation registry id", "produces": ["application/json"]}, "patch": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegCreateResult"}, "description": null}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/RevRegUpdateTailsFileUri"}}, {"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}], "tags": ["revocation"], "summary": "Update revocation registry with new public URI to the tails file.", "produces": ["application/json"]}}, "/revocation/active-registry/{cred_def_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegCreateResult"}, "description": null}}, "parameters": [{"in": "path", "name": "cred_def_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}], "tags": ["revocation"], "summary": "Get an active revocation registry by credential definition id", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/tails-file": {"get": {"responses": {"200": {"description": "tails file", "schema": {"type": "string", "format": "binary"}}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}], "tags": ["revocation"], "summary": "Download the tails file of revocation registry", "produces": "application/octet-stream"}}, "/revocation/registry/{rev_reg_id}/publish": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegCreateResult"}, "description": null}}, "parameters": [{"in": "path", "name": "rev_reg_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}], "tags": ["revocation"], "summary": "Publish a given revocation registry", "produces": ["application/json"]}}, "/wallet/did": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/DIDList"}, "description": null}}, "parameters": [{"in": "query", "name": "public", "required": false, "type": "boolean", "description": "Whether DID is on the ledger"}, {"in": "query", "name": "verkey", "required": false, "type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "description": "Verification key of interest", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"}, {"in": "query", "name": "did", "required": false, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv"}], "tags": ["wallet"], "summary": "List wallet DIDs", "produces": ["application/json"]}}, "/wallet/did/create": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/DIDResult"}, "description": null}}, "parameters": [], "tags": ["wallet"], "summary": "Create a local DID", "produces": ["application/json"]}}, "/wallet/did/public": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/DIDResult"}, "description": null}}, "parameters": [], "tags": ["wallet"], "summary": "Fetch the current public DID", "produces": ["application/json"]}, "post": {"responses": {"200": {"schema": {"$ref": "#/definitions/DIDResult"}, "description": null}}, "parameters": [{"in": "query", "name": "did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv"}], "tags": ["wallet"], "summary": "Assign the current public DID", "produces": ["application/json"]}}, "/wallet/did/local/rotate-keypair": {"patch": {"responses": {}, "parameters": [{"in": "query", "name": "did", "required": true, "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv"}], "tags": ["wallet"], "summary": "Rotate keypair for a local non-public DID", "produces": ["application/json"]}}, "/wallet/tag-policy/{cred_def_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/GetTagPolicyResult"}, "description": null}}, "parameters": [{"in": "path", "name": "cred_def_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}], "tags": ["wallet"], "summary": "Get the tagging policy for a credential definition", "produces": ["application/json"]}, "post": {"responses": {}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/SetTagPolicyRequest"}}, {"in": "path", "name": "cred_def_id", "required": true, "type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}], "tags": ["wallet"], "summary": "Set the tagging policy for a credential definition", "produces": ["application/json"]}}}, "info": {"title": "Cloud.Agent", "version": "v0.5.1"}, "swagger": "2.0", "definitions": {"AdminModules": {"type": "object", "properties": {"result": {"type": "array", "description": "List of admin modules", "items": {"type": "string", "description": "admin module"}}}}, "AdminStatus": {"type": "object", "properties": {}}, "V10PresentationExchange": {"type": "object", "properties": {"presentation_proposal_dict": {"type": "object", "description": "Serialized presentation proposal message"}, "presentation_request": {"type": "object", "description": "(Indy) presentation request (also known as proof request)"}, "presentation": {"type": "object", "description": "(Indy) presentation (also known as proof)"}, "thread_id": {"type": "string", "description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "role": {"type": "string", "enum": ["prover", "verifier"], "description": "Present-proof exchange role: prover or verifier", "example": "prover"}, "verified": {"type": "string", "enum": ["true", "false"], "description": "Whether presentation is verified: true or false", "example": "true"}, "error_msg": {"type": "string", "description": "Error message", "example": "Invalid structure"}, "created_at": {"type": "string", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "description": "Time of record creation", "example": "2020-06-10 06:16:04Z"}, "auto_present": {"type": "boolean", "description": "Prover choice to auto-present proof as verifier requests", "example": false}, "updated_at": {"type": "string", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "description": "Time of last record update", "example": "2020-06-10 06:16:04Z"}, "trace": {"type": "boolean", "description": "Record trace information, based on agent configuration"}, "state": {"type": "string", "description": "Present-proof exchange state", "example": "verified"}, "connection_id": {"type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "presentation_exchange_id": {"type": "string", "description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "initiator": {"type": "string", "enum": ["self", "external"], "description": "Present-proof exchange initiator: self or external", "example": "self"}}}, "V10PresentationExchangeList": {"type": "object", "properties": {"results": {"type": "array", "description": "Aries#0037 v1.0 presentation exchange records", "items": {"$ref": "#/definitions/V10PresentationExchange"}}}}, "PresAttrSpec": {"type": "object", "properties": {"name": {"type": "string", "description": "Attribute name", "example": "favourite_drink"}, "cred_def_id": {"type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}, "mime-type": {"type": "string", "description": "MIME type (default null)", "example": "image/jpeg"}, "value": {"type": "string", "description": "Attribute value", "example": "martini"}, "referent": {"type": "string", "description": "Credential referent", "example": "0"}}, "required": ["name"]}, "PresPredSpec": {"type": "object", "properties": {"name": {"type": "string", "description": "Attribute name", "example": "high_score"}, "cred_def_id": {"type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}, "predicate": {"type": "string", "enum": ["<", "<=", ">=", ">"], "description": "Predicate type ('<', '<=', '>=', or '>')", "example": ">="}, "threshold": {"type": "integer", "format": "int32", "description": "Threshold value"}}, "required": ["cred_def_id", "name", "predicate", "threshold"]}, "PresentationPreview": {"type": "object", "properties": {"@type": {"type": "string", "description": "Message type identifier", "example": "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/present-proof/1.0/presentation-preview"}, "attributes": {"type": "array", "items": {"$ref": "#/definitions/PresAttrSpec"}}, "predicates": {"type": "array", "items": {"$ref": "#/definitions/PresPredSpec"}}}, "required": ["attributes", "predicates"]}, "V10PresentationProposalRequest": {"type": "object", "properties": {"presentation_proposal": {"$ref": "#/definitions/PresentationPreview"}, "comment": {"type": "string", "description": "Human-readable comment"}, "auto_present": {"type": "boolean", "description": "Whether to respond automatically to presentation requests, building and presenting requested proof"}, "trace": {"type": "boolean", "description": "Whether to trace event (default false)", "example": false}, "connection_id": {"type": "string", "format": "uuid", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}}, "required": ["connection_id", "presentation_proposal"]}, "IndyProofReqSpecRestrictions": {"type": "object", "properties": {"schema_version": {"type": "string", "pattern": "^[0-9.]+$", "description": "Schema version", "example": "1.0"}, "schema_name": {"type": "string", "example": "transcript", "description": "Schema name"}, "schema_id": {"type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0"}, "issuer_did": {"type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Credential issuer DID", "example": "WgWxqztrNooG92RXvxSTWv"}, "cred_def_id": {"type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}, "schema_issuer_did": {"type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Schema issuer (origin) DID", "example": "WgWxqztrNooG92RXvxSTWv"}}}, "IndyProofReqNonRevoked": {"type": "object", "properties": {"from": {"type": "integer", "format": "int32", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "description": "Earliest epoch of interest for non-revocation proof", "example": 1591769764}, "to": {"type": "integer", "format": "int32", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "description": "Latest epoch of interest for non-revocation proof", "example": 1591769764}}}, "IndyProofReqPredSpec": {"type": "object", "properties": {"p_value": {"type": "integer", "format": "int32", "description": "Threshold value"}, "name": {"type": "string", "example": "index", "description": "Attribute name"}, "restrictions": {"type": "array", "description": "If present, credential must satisfy one of given restrictions", "items": {"$ref": "#/definitions/IndyProofReqSpecRestrictions"}}, "non_revoked": {"$ref": "#/definitions/IndyProofReqNonRevoked"}, "p_type": {"type": "string", "enum": ["<", "<=", ">=", ">"], "description": "Predicate type ('<', '<=', '>=', or '>')", "example": ">="}}, "required": ["name", "p_type", "p_value"]}, "IndyProofReqAttrSpec": {"type": "object", "properties": {"name": {"type": "string", "example": "favouriteDrink", "description": "Attribute name"}, "restrictions": {"type": "array", "description": "If present, credential must satisfy one of given restrictions", "items": {"$ref": "#/definitions/IndyProofReqSpecRestrictions"}}, "non_revoked": {"$ref": "#/definitions/IndyProofReqNonRevoked"}}, "required": ["name"]}, "IndyProofRequest": {"type": "object", "properties": {"name": {"type": "string", "description": "Proof request name", "example": "Proof request"}, "requested_predicates": {"type": "object", "description": "Requested predicate specifications of proof request", "additionalProperties": {"$ref": "#/definitions/IndyProofReqPredSpec"}}, "nonce": {"type": "string", "description": "Nonce", "example": "1234567890"}, "requested_attributes": {"type": "object", "description": "Requested attribute specifications of proof request", "additionalProperties": {"$ref": "#/definitions/IndyProofReqAttrSpec"}}, "non_revoked": {"$ref": "#/definitions/IndyProofReqNonRevoked"}, "version": {"type": "string", "pattern": "^[0-9.]+$", "description": "Proof request version", "example": "1.0"}}, "required": ["requested_attributes", "requested_predicates"]}, "V10PresentationCreateRequestRequest": {"type": "object", "properties": {"trace": {"type": "boolean", "description": "Whether to trace event (default false)", "example": false}, "proof_request": {"$ref": "#/definitions/IndyProofRequest"}, "comment": {"type": "string"}}, "required": ["proof_request"]}, "V10PresentationSendRequestRequest": {"type": "object", "properties": {"trace": {"type": "boolean", "description": "Whether to trace event (default false)", "example": false}, "connection_id": {"type": "string", "format": "uuid", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "proof_request": {"$ref": "#/definitions/IndyProofRequest"}, "comment": {"type": "string"}}, "required": ["connection_id", "proof_request"]}, "IndyRequestedCredsRequestedAttr": {"type": "object", "properties": {"timestamp": {"type": "integer", "format": "int32", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "description": "Epoch timestamp of interest for non-revocation proof", "example": 1591769764}, "revealed": {"type": "boolean", "description": "Whether to reveal attribute in proof"}, "cred_id": {"type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "description": "Wallet credential identifier (typically but not necessarily a UUID)"}}, "required": ["cred_id", "revealed"]}, "IndyRequestedCredsRequestedPred": {"type": "object", "properties": {"timestamp": {"type": "integer", "format": "int32", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "description": "Epoch timestamp of interest for non-revocation proof", "example": 1591769764}, "cred_id": {"type": "string", "description": "Wallet credential identifier (typically but not necessarily a UUID)", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}}, "required": ["cred_id"]}, "V10PresentationRequest": {"type": "object", "properties": {"trace": {"type": "boolean", "description": "Whether to trace event (default false)", "example": false}, "self_attested_attributes": {"type": "object", "description": "Self-attested attributes to build into proof", "additionalProperties": {"type": "string", "example": "self_attested_value", "description": "Self-attested attribute values to use in requested-credentials structure for proof construction"}}, "requested_attributes": {"type": "object", "description": "Nested object mapping proof request attribute referents to requested-attribute specifiers", "additionalProperties": {"$ref": "#/definitions/IndyRequestedCredsRequestedAttr"}}, "requested_predicates": {"type": "object", "description": "Nested object mapping proof request predicate referents to requested-predicate specifiers", "additionalProperties": {"$ref": "#/definitions/IndyRequestedCredsRequestedPred"}}}, "required": ["requested_attributes", "requested_predicates", "self_attested_attributes"]}, "SendMessage": {"type": "object", "properties": {"content": {"type": "string", "description": "Message content", "example": "Hello"}}}, "V10AttributeMimeTypesResult": {"type": "object", "properties": {}}, "V10CredentialExchange": {"type": "object", "properties": {"credential": {"type": "object", "description": "Credential as stored"}, "error_msg": {"type": "string", "description": "Error message", "example": "credential definition identifier is not set in proposal"}, "schema_id": {"type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0"}, "created_at": {"type": "string", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "description": "Time of record creation", "example": "2020-06-10 06:16:04Z"}, "updated_at": {"type": "string", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "description": "Time of last record update", "example": "2020-06-10 06:16:04Z"}, "credential_definition_id": {"type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}, "trace": {"type": "boolean", "description": "Record trace information, based on agent configuration"}, "state": {"type": "string", "description": "Issue-credential exchange state", "example": "credential_acked"}, "connection_id": {"type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "revocation_id": {"type": "string", "description": "Credential identifier within revocation registry"}, "role": {"type": "string", "enum": ["holder", "issuer"], "description": "Issue-credential exchange role: holder or issuer", "example": "issuer"}, "credential_request": {"type": "object", "description": "(Indy) credential request"}, "revoc_reg_id": {"type": "string", "description": "Revocation registry identifier"}, "raw_credential": {"type": "object", "description": "Credential as received, prior to storage in holder wallet"}, "credential_offer": {"type": "object", "description": "(Indy) credential offer"}, "auto_remove": {"type": "boolean", "description": "Issuer choice to remove this credential exchange record when complete", "example": false}, "initiator": {"type": "string", "enum": ["self", "external"], "description": "Issue-credential exchange initiator: self or external", "example": "self"}, "credential_request_metadata": {"type": "object", "description": "(Indy) credential request metadata"}, "credential_proposal_dict": {"type": "object", "description": "Serialized credential proposal message"}, "auto_offer": {"type": "boolean", "description": "Holder choice to accept offer in this credential exchange", "example": false}, "thread_id": {"type": "string", "description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "credential_exchange_id": {"type": "string", "description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "credential_id": {"type": "string", "description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "auto_issue": {"type": "boolean", "description": "Issuer choice to issue to request in this credential exchange", "example": false}, "parent_thread_id": {"type": "string", "description": "Parent thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}}}, "V10CredentialExchangeListResult": {"type": "object", "properties": {"results": {"type": "array", "description": "Aries#0036 v1.0 credential exchange records", "items": {"$ref": "#/definitions/V10CredentialExchange"}}}}, "CredAttrSpec": {"type": "object", "properties": {"name": {"type": "string", "description": "Attribute name", "example": "favourite_drink"}, "mime-type": {"type": "string", "x-nullable": true, "description": "MIME type: omit for (null) default", "example": "image/jpeg"}, "value": {"type": "string", "description": "Attribute value: base64-encode if MIME type is present", "example": "martini"}}, "required": ["name", "value"]}, "CredentialPreview": {"type": "object", "properties": {"@type": {"type": "string", "description": "Message type identifier", "example": "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/issue-credential/1.0/credential-preview"}, "attributes": {"type": "array", "items": {"$ref": "#/definitions/CredAttrSpec"}}}, "required": ["attributes"]}, "V10CredentialProposalRequestMand": {"type": "object", "properties": {"schema_version": {"type": "string", "pattern": "^[0-9.]+$", "description": "Schema version", "example": "1.0"}, "comment": {"type": "string", "description": "Human-readable comment"}, "credential_proposal": {"$ref": "#/definitions/CredentialPreview"}, "schema_name": {"type": "string", "description": "Schema name", "example": "preferences"}, "schema_id": {"type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0"}, "cred_def_id": {"type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}, "issuer_did": {"type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Credential issuer DID", "example": "WgWxqztrNooG92RXvxSTWv"}, "trace": {"type": "boolean", "description": "Whether to trace event (default false)", "example": false}, "schema_issuer_did": {"type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Schema issuer DID", "example": "WgWxqztrNooG92RXvxSTWv"}, "auto_remove": {"type": "boolean", "description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)"}, "connection_id": {"type": "string", "format": "uuid", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}}, "required": ["connection_id", "credential_proposal"]}, "V10CredentialProposalRequestOpt": {"type": "object", "properties": {"schema_version": {"type": "string", "pattern": "^[0-9.]+$", "description": "Schema version", "example": "1.0"}, "comment": {"type": "string", "description": "Human-readable comment"}, "credential_proposal": {"$ref": "#/definitions/CredentialPreview"}, "schema_name": {"type": "string", "description": "Schema name", "example": "preferences"}, "schema_id": {"type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0"}, "cred_def_id": {"type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}, "issuer_did": {"type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Credential issuer DID", "example": "WgWxqztrNooG92RXvxSTWv"}, "trace": {"type": "boolean", "description": "Whether to trace event (default false)", "example": false}, "schema_issuer_did": {"type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Schema issuer DID", "example": "WgWxqztrNooG92RXvxSTWv"}, "auto_remove": {"type": "boolean", "description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)"}, "connection_id": {"type": "string", "format": "uuid", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}}, "required": ["connection_id"]}, "V10CredentialOfferRequest": {"type": "object", "properties": {"auto_issue": {"type": "boolean", "description": "Whether to respond automatically to credential requests, creating and issuing requested credentials"}, "comment": {"type": "string", "description": "Human-readable comment"}, "credential_preview": {"$ref": "#/definitions/CredentialPreview"}, "cred_def_id": {"type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}, "trace": {"type": "boolean", "description": "Whether to trace event (default false)", "example": false}, "auto_remove": {"type": "boolean", "description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)"}, "connection_id": {"type": "string", "format": "uuid", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}}, "required": ["connection_id", "cred_def_id", "credential_preview"]}, "V10CredentialIssueRequest": {"type": "object", "properties": {"credential_preview": {"$ref": "#/definitions/CredentialPreview"}, "comment": {"type": "string", "description": "Human-readable comment"}}, "required": ["credential_preview"]}, "V10CredentialStoreRequest": {"type": "object", "properties": {"credential_id": {"type": "string"}}}, "V10PublishRevocationsResult": {"type": "object", "properties": {"results": {"type": "object", "description": "Credential revocation ids published by revocation registry id", "additionalProperties": {"type": "array", "items": {"type": "string", "description": "Credential revocation identifier", "example": "23"}}}}}, "V10CredentialProblemReportRequest": {"type": "object", "properties": {"explain_ltxt": {"type": "string"}}, "required": ["explain_ltxt"]}, "QueryResult": {"type": "object", "properties": {"results": {"type": "object", "description": "Query results keyed by protocol", "additionalProperties": {"type": "object", "description": "Protocol descriptor"}}}}, "PerformRequest": {"type": "object", "properties": {"name": {"type": "string", "description": "Menu option name", "example": "Query"}, "params": {"type": "object", "description": "Input parameter values", "additionalProperties": {"type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}}}}, "MenuFormParam": {"type": "object", "properties": {"name": {"type": "string", "description": "Menu parameter name", "example": "delay"}, "title": {"type": "string", "description": "Menu parameter title", "example": "Delay in seconds"}, "default": {"type": "string", "description": "Default parameter value", "example": "0"}, "description": {"type": "string", "description": "Additional descriptive text for menu form parameter", "example": "Delay in seconds before starting"}, "type": {"type": "string", "description": "Menu form parameter input type", "example": "int"}, "required": {"type": "boolean", "description": "Whether parameter is required", "example": "False"}}, "required": ["name", "title"]}, "MenuForm": {"type": "object", "properties": {"title": {"type": "string", "description": "Menu form title", "example": "Preferences"}, "description": {"type": "string", "description": "Additional descriptive text for menu form", "example": "Window preference settings"}, "params": {"type": "array", "description": "List of form parameters", "items": {"$ref": "#/definitions/MenuFormParam"}}, "submit-label": {"type": "string", "description": "Alternative label for form submit button", "example": "Send"}}}, "MenuOption": {"type": "object", "properties": {"name": {"type": "string", "description": "Menu option name (unique identifier)", "example": "window_prefs"}, "title": {"type": "string", "description": "Menu option title", "example": "Window Preferences"}, "description": {"type": "string", "description": "Additional descriptive text for menu option", "example": "Window display preferences"}, "disabled": {"type": "boolean", "description": "Whether to show option as disabled", "example": "False"}, "form": {"$ref": "#/definitions/MenuForm"}}, "required": ["name", "title"]}, "MenuJson": {"type": "object", "properties": {"title": {"type": "string", "description": "Menu title", "example": "My Menu"}, "options": {"type": "array", "description": "List of menu options", "items": {"$ref": "#/definitions/MenuOption"}}, "errormsg": {"type": "string", "description": "Optional error message to display in menu header", "example": "Error: item not present"}, "description": {"type": "string", "description": "Introductory text for the menu", "example": "User preferences for window settings"}}, "required": ["options"]}, "SendMenu": {"type": "object", "properties": {"menu": {"description": "Menu to send to connection", "allOf": [{"$ref": "#/definitions/MenuJson"}]}}, "required": ["menu"]}, "PingRequest": {"type": "object", "properties": {"comment": {"type": "string", "description": "Comment for the ping message"}}}, "PingRequestResponse": {"type": "object", "properties": {"thread_id": {"type": "string", "description": "Thread ID of the ping message"}}}, "ConnectionRecord": {"type": "object", "properties": {"accept": {"type": "string", "enum": ["manual", "auto"], "description": "Connection acceptance: manual or auto", "example": "auto"}, "their_role": {"type": "string", "description": "Their assigned role for connection", "example": "Point of contact"}, "their_label": {"type": "string", "description": "Their label for connection", "example": "Bob"}, "invitation_key": {"type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "description": "Public key for connection", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"}, "invitation_mode": {"type": "string", "enum": ["once", "multi", "static"], "description": "Invitation mode: once, multi, or static", "example": "once"}, "their_did": {"type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Their DID for connection", "example": "WgWxqztrNooG92RXvxSTWv"}, "inbound_connection_id": {"type": "string", "description": "Inbound routing connection id to use", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "alias": {"type": "string", "description": "Optional alias to apply to connection for later use", "example": "Bob, providing quotes"}, "error_msg": {"type": "string", "description": "Error message", "example": "No DIDDoc provided; cannot connect to public DID"}, "my_did": {"type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Our DID for connection", "example": "WgWxqztrNooG92RXvxSTWv"}, "routing_state": {"type": "string", "description": "Routing state of connection", "example": "active"}, "created_at": {"type": "string", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "description": "Time of record creation", "example": "2020-06-10 06:16:04Z"}, "updated_at": {"type": "string", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "description": "Time of last record update", "example": "2020-06-10 06:16:04Z"}, "state": {"type": "string", "description": "Current record state", "example": "active"}, "connection_id": {"type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "request_id": {"type": "string", "description": "Connection request identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "initiator": {"type": "string", "enum": ["self", "external", "multiuse"], "description": "Connection initiator: self, external, or multiuse", "example": "self"}}}, "ConnectionList": {"type": "object", "properties": {"results": {"type": "array", "description": "List of connection records", "items": {"$ref": "#/definitions/ConnectionRecord"}}}}, "ConnectionStaticRequest": {"type": "object", "properties": {"their_role": {"type": "string", "description": "Role to assign to this connection"}, "my_seed": {"type": "string", "description": "Seed to use for the local DID"}, "their_label": {"type": "string", "description": "Label to assign to this connection"}, "their_endpoint": {"type": "string", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "description": "URL endpoint for the other party", "example": "https://myhost:8021"}, "their_did": {"type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Remote DID", "example": "WgWxqztrNooG92RXvxSTWv"}, "alias": {"type": "string", "description": "Alias to assign to this connection"}, "my_did": {"type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Local DID", "example": "WgWxqztrNooG92RXvxSTWv"}, "their_verkey": {"type": "string", "description": "Remote verification key"}, "their_seed": {"type": "string", "description": "Seed to use for the remote DID"}}}, "ConnectionStaticResult": {"type": "object", "properties": {"my_endpoint": {"type": "string", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "description": "My URL endpoint", "example": "https://myhost:8021"}, "record": {"$ref": "#/definitions/ConnectionRecord"}, "mv_verkey": {"type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "description": "My verification key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"}, "their_did": {"type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Remote DID", "example": "WgWxqztrNooG92RXvxSTWv"}, "my_did": {"type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Local DID", "example": "WgWxqztrNooG92RXvxSTWv"}, "their_verkey": {"type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "description": "Remote verification key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"}}, "required": ["mv_verkey", "my_did", "my_endpoint", "record", "their_did", "their_verkey"]}, "ConnectionInvitation": {"type": "object", "properties": {"@type": {"type": "string", "readOnly": true, "description": "Message type", "example": "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/my-family/1.0/my-message-type"}, "routingKeys": {"type": "array", "description": "List of routing keys", "items": {"type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "description": "Routing key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"}}, "imageUrl": {"type": "string", "format": "url", "x-nullable": true, "description": "Optional image URL for connection invitation", "example": "http://192.168.56.101/img/logo.jpg"}, "serviceEndpoint": {"type": "string", "description": "Service endpoint at which to reach this agent", "example": "http://192.168.56.101:8020"}, "recipientKeys": {"type": "array", "description": "List of recipient keys", "items": {"type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "description": "Recipient public key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"}}, "@id": {"type": "string", "description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "label": {"type": "string", "description": "Optional label for connection", "example": "Bob"}, "did": {"type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID for connection invitation", "example": "WgWxqztrNooG92RXvxSTWv"}}}, "InvitationResult": {"type": "object", "properties": {"invitation": {"$ref": "#/definitions/ConnectionInvitation"}, "connection_id": {"type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "invitation_url": {"type": "string", "description": "Invitation URL", "example": "http://192.168.56.101:8020/invite?c_i=eyJAdHlwZSI6Li4ufQ=="}}}, "ReceiveInvitationRequest": {"type": "object", "properties": {"@type": {"type": "string", "readOnly": true, "description": "Message type", "example": "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/my-family/1.0/my-message-type"}, "routingKeys": {"type": "array", "description": "List of routing keys", "items": {"type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "description": "Routing key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"}}, "imageUrl": {"type": "string", "format": "url", "x-nullable": true, "description": "Optional image URL for connection invitation", "example": "http://192.168.56.101/img/logo.jpg"}, "serviceEndpoint": {"type": "string", "description": "Service endpoint at which to reach this agent", "example": "http://192.168.56.101:8020"}, "recipientKeys": {"type": "array", "description": "List of recipient keys", "items": {"type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "description": "Recipient public key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"}}, "@id": {"type": "string", "description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}, "label": {"type": "string", "description": "Optional label for connection", "example": "Bob"}, "did": {"type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID for connection invitation", "example": "WgWxqztrNooG92RXvxSTWv"}}}, "Witness": {"type": "object", "properties": {"omega": {"type": "string", "description": "Revocation registry witness omega state", "example": "21 129EA8716C921058BB91826FD 21 8F19B91313862FE916C0 ..."}}}, "RawEncCredAttr": {"type": "object", "properties": {"encoded": {"type": "string", "description": "(Numeric string) encoded value", "example": "412821674062189604125602903860586582569826459817431467861859655321"}, "raw": {"type": "string", "description": "Raw value", "example": "Alex"}}}, "RevReg": {"type": "object", "properties": {"accum": {"type": "string", "description": "Revocation registry accumulator state", "example": "21 136D54EA439FC26F03DB4b812 21 123DE9F624B86823A00D ..."}}}, "Credential": {"type": "object", "properties": {"witness": {"$ref": "#/definitions/Witness"}, "signature_correctness_proof": {"type": "object", "description": "Signature correctness proof"}, "rev_reg_id": {"type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}, "signature": {"type": "object", "description": "Digital signature"}, "schema_id": {"type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0"}, "cred_def_id": {"type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}, "values": {"type": "object", "description": "Attribute names mapped to their raw and encoded values", "additionalProperties": {"$ref": "#/definitions/RawEncCredAttr"}}, "rev_reg": {"$ref": "#/definitions/RevReg"}}}, "CredentialsList": {"type": "object", "properties": {"results": {"type": "array", "items": {"$ref": "#/definitions/Credential"}}}}, "TAAAcceptance": {"type": "object", "properties": {"time": {"type": "integer", "format": "int32"}, "mechanism": {"type": "string"}}}, "TAARecord": {"type": "object", "properties": {"version": {"type": "string"}, "text": {"type": "string"}, "digest": {"type": "string"}}}, "AMLRecord": {"type": "object", "properties": {"version": {"type": "string"}, "aml": {"type": "object", "additionalProperties": {"type": "string"}}, "amlContext": {"type": "string"}}}, "TAAInfo": {"type": "object", "properties": {"taa_accepted": {"$ref": "#/definitions/TAAAcceptance"}, "taa_required": {"type": "boolean"}, "taa_record": {"$ref": "#/definitions/TAARecord"}, "aml_record": {"$ref": "#/definitions/AMLRecord"}}}, "TAAResult": {"type": "object", "properties": {"result": {"$ref": "#/definitions/TAAInfo"}}}, "TAAAccept": {"type": "object", "properties": {"version": {"type": "string"}, "mechanism": {"type": "string"}, "text": {"type": "string"}}}, "CredentialDefinitionSendRequest": {"type": "object", "properties": {"support_revocation": {"type": "boolean", "description": "Revocation supported flag"}, "schema_id": {"type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0"}, "tag": {"type": "string", "description": "Credential definition identifier tag", "example": "default"}}}, "CredentialDefinitionSendResults": {"type": "object", "properties": {"credential_definition_id": {"type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}}}, "CredentialDefinitionsCreatedResults": {"type": "object", "properties": {"credential_definition_ids": {"type": "array", "items": {"type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition identifiers", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}}}}, "CredentialDefinition": {"type": "object", "properties": {"type": {"default": "CL", "description": "Signature type: CL for Camenisch-Lysyanskaya", "example": "CL"}, "ver": {"type": "string", "pattern": "^[0-9.]+$", "description": "Node protocol version", "example": "1.0"}, "schemaId": {"type": "string", "description": "Schema identifier within credential definition identifier", "example": "20"}, "id": {"type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}, "value": {"type": "object", "description": "Credential definition primary and revocation values"}, "tag": {"type": "string", "description": "Tag within credential definition identifier", "example": "tag"}}}, "CredentialDefinitionGetResults": {"type": "object", "properties": {"credential_definition": {"$ref": "#/definitions/CredentialDefinition"}}}, "SchemaSendRequest": {"type": "object", "properties": {"schema_name": {"type": "string", "description": "Schema name", "example": "prefs"}, "attributes": {"type": "array", "description": "List of schema attributes", "items": {"type": "string", "description": "attribute name", "example": "score"}}, "schema_version": {"type": "string", "pattern": "^[0-9.]+$", "description": "Schema version", "example": "1.0"}}, "required": ["attributes", "schema_name", "schema_version"]}, "SchemaSendResults": {"type": "object", "properties": {"schema_id": {"type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0"}, "schema": {"type": "object", "description": "Schema result"}}}, "SchemasCreatedResults": {"type": "object", "properties": {"schema_ids": {"type": "array", "items": {"type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "description": "Schema identifiers", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0"}}}}, "Schema": {"type": "object", "properties": {"name": {"type": "string", "description": "Schema name", "example": "schema_name"}, "version": {"type": "string", "pattern": "^[0-9.]+$", "description": "Schema version", "example": "1.0"}, "seqNo": {"type": "integer", "format": "int32", "minimum": 1, "description": "Schema sequence number", "example": 10}, "ver": {"type": "string", "pattern": "^[0-9.]+$", "description": "Node protocol version", "example": "1.0"}, "attrNames": {"type": "array", "description": "Schema attribute names", "items": {"type": "string", "description": "Attribute name", "example": "score"}}, "id": {"type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0"}}}, "SchemaGetResults": {"type": "object", "properties": {"schema_json": {"$ref": "#/definitions/Schema"}}}, "RevRegCreateRequest": {"type": "object", "properties": {"credential_definition_id": {"type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag"}, "issuance_by_default": {"type": "boolean", "description": "Create registry with all indexes issued"}, "max_cred_num": {"type": "integer", "format": "int32", "description": "Maximum credential numbers", "example": 100}}}, "RevRegCreateResult": {"type": "object", "properties": {}}, "RevRegsCreated": {"type": "object", "properties": {"rev_reg_ids": {"type": "array", "items": {"type": "string", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "description": "Revocation Registry identifiers", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0"}}}}, "RevRegUpdateTailsFileUri": {"type": "object", "properties": {"tails_public_uri": {"type": "string", "format": "url", "description": "Public URI to the tails file", "example": "http://192.168.56.133:5000/revocation/registry/WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0/tails-file"}}, "required": ["tails_public_uri"]}, "DID": {"type": "object", "properties": {"public": {"type": "boolean", "description": "Whether DID is public", "example": false}, "verkey": {"type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "description": "Public verification key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"}, "did": {"type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv"}}}, "DIDList": {"type": "object", "properties": {"results": {"type": "array", "description": "DID list", "items": {"$ref": "#/definitions/DID"}}}}, "DIDResult": {"type": "object", "properties": {"result": {"$ref": "#/definitions/DID"}}}, "GetTagPolicyResult": {"type": "object", "properties": {"taggables": {"type": "array", "description": "List of attributes taggable for credential search under current policy", "items": {"type": "string", "description": "Taggable attribute", "example": "score"}}}}, "SetTagPolicyRequest": {"type": "object", "properties": {"taggables": {"type": "array", "description": "List of attributes to set taggable for credential search", "items": {"type": "string", "description": "Taggable attribute", "example": "score"}}}}}, "tags": [{"name": "present-proof", "description": "Proof presentation", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/4fae574c03f9f1013db30bf2c0c676b1122f7149/features/0037-present-proof"}}, {"name": "basicmessage", "description": "Simple messaging", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/527849ec3aa2a8fd47a7bb6c57f918ff8bcb5e8c/features/0095-basic-message"}}, {"name": "introduction", "description": "Introduction of known parties"}, {"name": "issue-credential", "description": "Credential issue, revocation", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/bb42a6c35e0d5543718fb36dd099551ab192f7b0/features/0036-issue-credential"}}, {"name": "server", "description": "Feature discovery", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/9b7ab9814f2e7d1108f74aca6f3d2e5d62899473/features/0031-discover-features"}}, {"name": "trustping", "description": "Trust-ping over connection", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/527849ec3aa2a8fd47a7bb6c57f918ff8bcb5e8c/features/0048-trust-ping"}}, {"name": "connection", "description": "Connection management", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/9b0aaa39df7e8bd434126c4b33c097aae78d65bf/features/0160-connection-protocol"}}, {"name": "credentials", "description": "Holder credential management", "externalDocs": {"description": "Overview", "url": "https://w3c.github.io/vc-data-model/#credentials"}}, {"name": "ledger", "description": "Interaction with ledger", "externalDocs": {"description": "Overview", "url": "https://hyperledger-indy.readthedocs.io/projects/plenum/en/latest/storage.html#ledger"}}, {"name": "credential-definition", "description": "Credential definition operations", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/indy-node/blob/master/design/anoncreds.md#cred_def"}}, {"name": "schema", "description": "Schema operations", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/indy-node/blob/master/design/anoncreds.md#schema"}}, {"name": "revocation", "description": "Revocation registry management", "externalDocs": {"description": "Overview", "url": "https://github.com/hyperledger/indy-hipe/tree/master/text/0011-cred-revocation"}}, {"name": "wallet", "description": "DID and tag policy management", "externalDocs": {"description": "Design", "url": "https://github.com/hyperledger/indy-sdk/tree/master/docs/design/003-wallet-storage"}}]}