From 6d0f322784c55fd3018618aeda7cbb8c60889ec7 Mon Sep 17 00:00:00 2001 From: ff137 Date: Fri, 25 Oct 2024 16:10:35 +0200 Subject: [PATCH] :memo: Updated specs --- generator/data/openapi.yml | 288 + generator/data/swagger.json | 15896 +--------------------------------- 2 files changed, 289 insertions(+), 15895 deletions(-) diff --git a/generator/data/openapi.yml b/generator/data/openapi.yml index 6543c9aa..eeeaeb19 100644 --- a/generator/data/openapi.yml +++ b/generator/data/openapi.yml @@ -5311,6 +5311,44 @@ paths: schema: $ref: '#/components/schemas/FetchCredentialResponse' operationId: get_credential + /vc/di/add-proof: + post: + tags: + - vc + summary: Add a DataIntegrityProof to a document. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddProof' + required: false + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/AddProofResponse' + x-codegen-request-body-name: body + /vc/di/verify: + post: + tags: + - vc + summary: Verify a document secured with a data integrity proof. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VerifyDiRequest' + required: false + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/VerifyDiResponse' + x-codegen-request-body-name: body /vc/presentations/prove: post: tags: @@ -5555,6 +5593,61 @@ paths: $ref: '#/components/schemas/JWSVerifyResponse' x-codegen-request-body-name: body operationId: verify_jwt + /wallet/keys: + put: + tags: + - wallet + summary: Update a key pair's kid + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateKeyRequest' + required: false + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateKeyResponse' + x-codegen-request-body-name: body + post: + tags: + - wallet + summary: Create a key pair + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateKeyRequest' + required: false + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/CreateKeyResponse' + x-codegen-request-body-name: body + /wallet/keys/{multikey}: + get: + tags: + - wallet + summary: Fetch key info. + parameters: + - name: multikey + in: path + required: true + schema: + type: string + responses: + '200': + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/FetchKeyResponse' /wallet/sd-jwt/sign: post: tags: @@ -5656,6 +5749,35 @@ components: - $ref: '#/components/schemas/Menu' ActionMenuModulesResult: type: object + AddProof: + required: + - document + type: object + properties: + document: + type: object + properties: {} + example: + hello: world + options: + type: object + example: + cryptosuite: eddsa-jcs-2022 + proofPurpose: assertionMethod + type: DataIntegrityProof + verificationMethod: did:web:example.com#key-01 + allOf: + - $ref: '#/components/schemas/DataIntegrityProofOptions' + AddProofResponse: + required: + - secured_document + type: object + properties: + secured_document: + type: object + properties: {} + example: + hello: world AdminConfig: required: - config @@ -6236,6 +6358,34 @@ components: type: string description: Connection endpoint example: http://192.168.56.102:8020 + CreateKeyRequest: + type: object + properties: + alg: + type: string + description: Which key algorithm to use. + example: ed25519 + kid: + type: string + description: Optional kid to bind to the keypair, such as + a verificationMethod. + example: did:web:example.com#key-01 + seed: + type: string + description: Optional seed to generate the key pair. Must + enable insecure wallet mode. + example: '00000000000000000000000000000000' + CreateKeyResponse: + type: object + properties: + kid: + type: string + description: The associated kid + example: did:web:example.com#key-01 + multikey: + type: string + description: The Public Key Multibase format (multikey) + example: z6MkgKA7yrw5kYSiDuQFcye4bMaJpcfHFry3Bx45pdWh3s8i CreateWalletRequest: type: object properties: @@ -6993,6 +7143,11 @@ components: - Endpoint - Profile - LinkedDomains + mediation_id: + 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}' + type: string + description: Mediation ID to use for endpoint information. + example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 DIDList: type: object properties: @@ -7172,6 +7327,79 @@ components: presentation_definition: $ref: '#/components/schemas/PresentationDefinition' additionalProperties: true + DataIntegrityProofOptions: + required: + - cryptosuite + - proofPurpose + - type + - verificationMethod + type: object + properties: + challenge: + type: string + description: The value is used once for a particular domain and window of + time. This value is used to mitigate replay attacks. + example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + created: + type: string + description: The date and time the proof was created is OPTIONAL and, if included, + MUST be specified as an [XMLSCHEMA11-2] dateTimeStamp + string + example: 2010-01-01 19:23:24+00:00 + cryptosuite: + type: string + description: An identifier for the cryptographic suite that can be used + to verify the proof. + example: eddsa-jcs-2022 + domain: + type: string + description: It conveys one or more security domains in which the proof + is meant to be used. + example: example.com + expires: + type: string + description: The expires property is OPTIONAL and, if present, specifies + when the proof expires. If present, it MUST be an + [XMLSCHEMA11-2] dateTimeStamp string + example: 2010-01-01 19:23:24+00:00 + id: + type: string + description: An optional identifier for the proof, which MUST be a URL [URL], such + as a UUID as a URN + example: urn:uuid:6a1676b8-b51f-11ed-937b-d76685a20ff5 + nonce: + type: string + description: One use of this field is to increase privacy by decreasing linkability + that is the result of deterministically generated + signatures. + example: CF69iO3nfvqRsRBNElE8b4wO39SyJHPM7Gg1nExltW5vSfQA1lvDCR/zXX1To0/4NLo== + previousProof: + type: string + description: Each value identifies another data integrity proof that MUST + verify before the current proof is processed. + example: urn:uuid:6a1676b8-b51f-11ed-937b-d76685a20ff5 + proofPurpose: + type: string + description: The proof purpose acts as a safeguard to prevent the proof + from being misused by being applied to a purpose other than the + one that was intended. + example: assertionMethod + proofValue: + type: string + description: The value of the proof signature. + example: zsy1AahqbzJQ63n9RtekmwzqZeVj494VppdAVJBnMYrTwft6cLJJGeTSSxCCJ6HKnRtwE7jjDh6sB2z2AAiZY9BBnCD8wUVgwqH3qchGRCuC2RugA4eQ9fUrR4Yuycac3caiaaay + type: + type: string + description: The specific type of proof MUST be specified as a string that + maps to a URL [URL]. + example: DataIntegrityProof + verificationMethod: + pattern: \w+:(\/?\/?)[^\s]+ + type: string + description: 'A verification method is the means and information needed + to verify the proof. ' + example: did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL + additionalProperties: true Date: required: - expires_time @@ -7280,6 +7508,17 @@ components: properties: results: $ref: '#/components/schemas/VerifiableCredential' + FetchKeyResponse: + type: object + properties: + kid: + type: string + description: The associated kid + example: did:web:example.com#key-01 + multikey: + type: string + description: The Public Key Multibase format (multikey) + example: z6MkgKA7yrw5kYSiDuQFcye4bMaJpcfHFry3Bx45pdWh3s8i Filter: type: object properties: @@ -10720,6 +10959,32 @@ components: description: Schema transaction to endorse allOf: - $ref: '#/components/schemas/TransactionRecord' + UpdateKeyRequest: + required: + - kid + - multikey + type: object + properties: + kid: + type: string + description: New kid to bind to the key pair, such as a + verificationMethod. + example: did:web:example.com#key-02 + multikey: + type: string + description: Multikey of the key pair to update + example: z6MkgKA7yrw5kYSiDuQFcye4bMaJpcfHFry3Bx45pdWh3s8i + UpdateKeyResponse: + type: object + properties: + kid: + type: string + description: The associated kid + example: did:web:example.com#key-02 + multikey: + type: string + description: The Public Key Multibase format (multikey) + example: z6MkgKA7yrw5kYSiDuQFcye4bMaJpcfHFry3Bx45pdWh3s8i UpdateProfileSettings: type: object properties: @@ -12743,6 +13008,29 @@ components: properties: results: $ref: '#/components/schemas/PresentationVerificationResult' + VerifyDiRequest: + required: + - securedDocument + type: object + properties: + securedDocument: + type: object + properties: {} + example: + hello: world + proof: + - cryptosuite: eddsa-jcs-2022 + proofPurpose: assertionMethod + type: DataIntegrityProof + verificationMethod: 'did:key: z6MksxraKwH8GR7NKeQ4HVZAeRKvD76kfd6G7jm8MscbDmy8# z6MksxraKwH8GR7NKeQ4HVZAeRKvD76kfd6G7jm8MscbDmy8' + proofValue: zHtda8vV7kJQUPfSKiTGSQDhZfhkgtpnVziT7cdEzhu fjPjbeRmysHvizMJEox1eHR7xUGzNUj1V4yaKiLw7UA6E + VerifyDiResponse: + type: object + properties: + verified: + type: boolean + description: Verified + example: true VerifyPresentationRequest: type: object properties: diff --git a/generator/data/swagger.json b/generator/data/swagger.json index 27a5b794..3f1c073e 100644 --- a/generator/data/swagger.json +++ b/generator/data/swagger.json @@ -1,15895 +1 @@ -{ - "swagger": "2.0", - "info": { - "version": "v1.1.1b1", - "title": "Aries Cloud Agent" - }, - "tags": [ - { - "name": "action-menu", - "description": "Menu interaction over connection" - }, - { - "name": "anoncreds - credential definitions", - "description": "Anoncreds credential definition management", - "externalDocs": { - "description": "Specification", - "url": "https://hyperledger.github.io/anoncreds-spec" - } - }, - { - "name": "anoncreds - revocation", - "description": "Revocation registry management", - "externalDocs": { - "description": "Overview", - "url": "https://github.com/hyperledger/indy-hipe/tree/master/text/0011-cred-revocation" - } - }, - { - "name": "anoncreds - schemas", - "description": "Anoncreds schema management", - "externalDocs": { - "description": "Specification", - "url": "https://hyperledger.github.io/anoncreds-spec" - } - }, - { - "name": "anoncreds - wallet upgrade", - "description": "Anoncreds wallet upgrade", - "externalDocs": { - "description": "Specification", - "url": "https://hyperledger.github.io/anoncreds-spec" - } - }, - { - "name": "basicmessage", - "description": "Simple messaging", - "externalDocs": { - "description": "Specification", - "url": "https://github.com/hyperledger/aries-rfcs/tree/527849ec3aa2a8fd47a7bb6c57f918ff8bcb5e8c/features/0095-basic-message" - } - }, - { - "name": "connection", - "description": "Connection management", - "externalDocs": { - "description": "Specification", - "url": "https://github.com/hyperledger/aries-rfcs/tree/9b0aaa39df7e8bd434126c4b33c097aae78d65bf/features/0160-connection-protocol" - } - }, - { - "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": "credentials", - "description": "Holder credential management", - "externalDocs": { - "description": "Overview", - "url": "https://w3c.github.io/vc-data-model/#credentials" - } - }, - { - "name": "did-exchange", - "description": "Connection management via DID exchange", - "externalDocs": { - "description": "Specification", - "url": "https://github.com/hyperledger/aries-rfcs/tree/25464a5c8f8a17b14edaa4310393df6094ace7b0/features/0023-did-exchange" - } - }, - { - "name": "did-rotate", - "description": "Rotate a DID", - "externalDocs": { - "description": "Specification", - "url": "https://github.com/hyperledger/aries-rfcs/tree/main/features/0794-did-rotate" - } - }, - { - "name": "discover-features", - "description": "Feature discovery", - "externalDocs": { - "description": "Specification", - "url": "https://github.com/hyperledger/aries-rfcs/tree/b3a3942ef052039e73cd23d847f42947f8287da2/features/0031-discover-features" - } - }, - { - "name": "discover-features v2.0", - "description": "Feature discovery v2", - "externalDocs": { - "description": "Specification", - "url": "https://github.com/hyperledger/aries-rfcs/tree/b3a3942ef052039e73cd23d847f42947f8287da2/features/0557-discover-features-v2" - } - }, - { - "name": "endorse-transaction", - "description": "Endorse a Transaction" - }, - { - "name": "introduction", - "description": "Introduction of known parties" - }, - { - "name": "issue-credential v1.0", - "description": "Credential issue v1.0", - "externalDocs": { - "description": "Specification", - "url": "https://github.com/hyperledger/aries-rfcs/tree/bb42a6c35e0d5543718fb36dd099551ab192f7b0/features/0036-issue-credential" - } - }, - { - "name": "issue-credential v2.0", - "description": "Credential issue v2.0", - "externalDocs": { - "description": "Specification", - "url": "https://github.com/hyperledger/aries-rfcs/tree/cd27fc64aa2805f756a118043d7c880354353047/features/0453-issue-credential-v2" - } - }, - { - "name": "jsonld", - "description": "Sign and verify json-ld data", - "externalDocs": { - "description": "Specification", - "url": "https://tools.ietf.org/html/rfc7515" - } - }, - { - "name": "ledger", - "description": "Interaction with ledger", - "externalDocs": { - "description": "Overview", - "url": "https://hyperledger-indy.readthedocs.io/projects/plenum/en/latest/storage.html#ledger" - } - }, - { - "name": "mediation", - "description": "Mediation management", - "externalDocs": { - "description": "Specification", - "url": "https://github.com/hyperledger/aries-rfcs/tree/fa8dc4ea1e667eb07db8f9ffeaf074a4455697c0/features/0211-route-coordination" - } - }, - { - "name": "multitenancy", - "description": "Multitenant wallet management" - }, - { - "name": "out-of-band", - "description": "Out-of-band connections", - "externalDocs": { - "description": "Design", - "url": "https://github.com/hyperledger/aries-rfcs/tree/2da7fc4ee043effa3a9960150e7ba8c9a4628b68/features/0434-outofband" - } - }, - { - "name": "present-proof v1.0", - "description": "Proof presentation v1.0", - "externalDocs": { - "description": "Specification", - "url": "https://github.com/hyperledger/aries-rfcs/tree/4fae574c03f9f1013db30bf2c0c676b1122f7149/features/0037-present-proof" - } - }, - { - "name": "present-proof v2.0", - "description": "Proof presentation v2.0", - "externalDocs": { - "description": "Specification", - "url": "https://github.com/hyperledger/aries-rfcs/tree/eace815c3e8598d4a8dd7881d8c731fdb2bcc0aa/features/0454-present-proof-v2" - } - }, - { - "name": "resolver", - "description": "did resolver interface.", - "externalDocs": { - "description": "DID Resolution Specification", - "url": "https://www.w3.org/TR/did-core/#resolution" - } - }, - { - "name": "revocation", - "description": "Revocation registry management", - "externalDocs": { - "description": "Overview", - "url": "https://github.com/hyperledger/indy-hipe/tree/master/text/0011-cred-revocation" - } - }, - { - "name": "schema", - "description": "Schema operations", - "externalDocs": { - "description": "Specification", - "url": "https://github.com/hyperledger/indy-node/blob/master/design/anoncreds.md#schema" - } - }, - { - "name": "settings", - "description": "Agent settings interface." - }, - { - "name": "trustping", - "description": "Trust-ping over connection", - "externalDocs": { - "description": "Specification", - "url": "https://github.com/hyperledger/aries-rfcs/tree/527849ec3aa2a8fd47a7bb6c57f918ff8bcb5e8c/features/0048-trust-ping" - } - }, - { - "name": "vc-api", - "description": "Endpoints for managing w3c credentials and presentations", - "externalDocs": { - "description": "Specification", - "url": "https://w3c-ccg.github.io/vc-api/" - } - }, - { - "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" - } - } - ], - "security": [ - { - "AuthorizationHeader": [] - } - ], - "paths": { - "/action-menu/{conn_id}/close": { - "post": { - "tags": ["action-menu"], - "summary": "Close the active menu associated with a connection", - "produces": ["application/json"], - "parameters": [ - { - "name": "conn_id", - "in": "path", - "description": "Connection identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ActionMenuModulesResult" - } - } - } - } - }, - "/action-menu/{conn_id}/fetch": { - "post": { - "tags": ["action-menu"], - "summary": "Fetch the active menu", - "produces": ["application/json"], - "parameters": [ - { - "name": "conn_id", - "in": "path", - "description": "Connection identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ActionMenuFetchResult" - } - } - } - } - }, - "/action-menu/{conn_id}/perform": { - "post": { - "tags": ["action-menu"], - "summary": "Perform an action associated with the active menu", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/PerformRequest" - } - }, - { - "name": "conn_id", - "in": "path", - "description": "Connection identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ActionMenuModulesResult" - } - } - } - } - }, - "/action-menu/{conn_id}/request": { - "post": { - "tags": ["action-menu"], - "summary": "Request the active menu", - "produces": ["application/json"], - "parameters": [ - { - "name": "conn_id", - "in": "path", - "description": "Connection identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ActionMenuModulesResult" - } - } - } - } - }, - "/action-menu/{conn_id}/send-menu": { - "post": { - "tags": ["action-menu"], - "summary": "Send an action menu to a connection", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/SendMenu" - } - }, - { - "name": "conn_id", - "in": "path", - "description": "Connection identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ActionMenuModulesResult" - } - } - } - } - }, - "/anoncreds/credential-definition": { - "post": { - "tags": ["anoncreds - credential definitions"], - "summary": "Create a credential definition on the connected ledger", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/CredDefPostRequest" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/CredDefResult" - } - } - } - } - }, - "/anoncreds/credential-definition/{cred_def_id}": { - "get": { - "tags": ["anoncreds - credential definitions"], - "summary": "Retrieve an individual credential definition details", - "produces": ["application/json"], - "parameters": [ - { - "name": "cred_def_id", - "in": "path", - "description": "Credential definition identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/GetCredDefResult" - } - } - } - } - }, - "/anoncreds/credential-definitions": { - "get": { - "tags": ["anoncreds - credential definitions"], - "summary": "Retrieve all credential definition ids", - "produces": ["application/json"], - "parameters": [ - { - "name": "issuer_id", - "in": "query", - "description": "Issuer Identifier of the credential definition", - "required": false, - "type": "string" - }, - { - "name": "schema_id", - "in": "query", - "description": "Schema identifier", - "required": false, - "type": "string" - }, - { - "name": "schema_name", - "in": "query", - "description": "Schema name", - "required": false, - "type": "string" - }, - { - "name": "schema_version", - "in": "query", - "description": "Schema version", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/GetCredDefsResponse" - } - } - } - } - }, - "/anoncreds/registry/{rev_reg_id}/active": { - "put": { - "tags": ["anoncreds - revocation"], - "summary": "Update the active registry", - "produces": ["application/json"], - "parameters": [ - { - "name": "rev_reg_id", - "in": "path", - "description": "Revocation Registry identifier", - "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:(.+$)" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/RevocationModuleResponse" - } - } - } - } - }, - "/anoncreds/registry/{rev_reg_id}/tails-file": { - "put": { - "tags": ["anoncreds - revocation"], - "summary": "Upload local tails file to server", - "produces": ["application/json"], - "parameters": [ - { - "name": "rev_reg_id", - "in": "path", - "description": "Revocation Registry identifier", - "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:(.+$)" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/RevocationModuleResponse" - } - } - } - } - }, - "/anoncreds/revocation-list": { - "post": { - "tags": ["anoncreds - revocation"], - "summary": "Create and publish a revocation status list on the connected ledger", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/RevListCreateRequest" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/RevListResult" - } - } - } - } - }, - "/anoncreds/revocation-registry-definition": { - "post": { - "tags": ["anoncreds - revocation"], - "summary": "Create and publish a registration revocation on the connected ledger", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/RevRegCreateRequestSchemaAnoncreds" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/RevRegDefResult" - } - } - } - } - }, - "/anoncreds/revocation/active-registry/{cred_def_id}": { - "get": { - "tags": ["anoncreds - revocation"], - "summary": "Get current active revocation registry by credential definition id", - "produces": ["application/json"], - "parameters": [ - { - "name": "cred_def_id", - "in": "path", - "description": "Credential definition identifier", - "required": true, - "type": "string", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/RevRegResultSchemaAnoncreds" - } - } - } - } - }, - "/anoncreds/revocation/active-registry/{cred_def_id}/rotate": { - "post": { - "tags": ["anoncreds - revocation"], - "summary": "Rotate revocation registry", - "produces": ["application/json"], - "parameters": [ - { - "name": "cred_def_id", - "in": "path", - "description": "Credential definition identifier", - "required": true, - "type": "string", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/RevRegsCreatedSchemaAnoncreds" - } - } - } - } - }, - "/anoncreds/revocation/credential-record": { - "get": { - "tags": ["anoncreds - revocation"], - "summary": "Get credential revocation status", - "produces": ["application/json"], - "parameters": [ - { - "name": "cred_ex_id", - "in": "query", - "description": "Credential exchange identifier", - "required": false, - "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}" - }, - { - "name": "cred_rev_id", - "in": "query", - "description": "Credential revocation identifier", - "required": false, - "type": "string", - "pattern": "^[1-9][0-9]*$" - }, - { - "name": "rev_reg_id", - "in": "query", - "description": "Revocation registry identifier", - "required": false, - "type": "string", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/CredRevRecordResultSchemaAnoncreds" - } - } - } - } - }, - "/anoncreds/revocation/publish-revocations": { - "post": { - "tags": ["anoncreds - revocation"], - "summary": "Publish pending revocations to ledger", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/PublishRevocationsSchemaAnoncreds" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PublishRevocationsResultSchemaAnoncreds" - } - } - } - } - }, - "/anoncreds/revocation/registries": { - "get": { - "tags": ["anoncreds - revocation"], - "summary": "Search for matching revocation registries that current agent created", - "produces": ["application/json"], - "parameters": [ - { - "name": "cred_def_id", - "in": "query", - "description": "Credential definition identifier", - "required": false, - "type": "string", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - { - "name": "state", - "in": "query", - "description": "Revocation registry state", - "required": false, - "type": "string", - "enum": [ - "finished", - "failed", - "action", - "wait", - "decommissioned", - "full" - ] - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/RevRegsCreatedSchemaAnoncreds" - } - } - } - } - }, - "/anoncreds/revocation/registry/{rev_reg_id}": { - "get": { - "tags": ["anoncreds - revocation"], - "summary": "Get revocation registry by revocation registry id", - "produces": ["application/json"], - "parameters": [ - { - "name": "rev_reg_id", - "in": "path", - "description": "Revocation Registry identifier", - "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:(.+$)" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/RevRegResultSchemaAnoncreds" - } - } - } - } - }, - "/anoncreds/revocation/registry/{rev_reg_id}/fix-revocation-entry-state": { - "put": { - "tags": ["anoncreds - revocation"], - "summary": "Fix revocation state in wallet and return number of updated entries", - "produces": ["application/json"], - "parameters": [ - { - "name": "rev_reg_id", - "in": "path", - "description": "Revocation Registry identifier", - "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:(.+$)" - }, - { - "name": "apply_ledger_update", - "in": "query", - "description": "Apply updated accumulator transaction to ledger", - "required": true, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/RevRegWalletUpdatedResultSchemaAnoncreds" - } - } - } - } - }, - "/anoncreds/revocation/registry/{rev_reg_id}/issued": { - "get": { - "tags": ["anoncreds - revocation"], - "summary": "Get number of credentials issued against revocation registry", - "produces": ["application/json"], - "parameters": [ - { - "name": "rev_reg_id", - "in": "path", - "description": "Revocation Registry identifier", - "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:(.+$)" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/RevRegIssuedResultSchemaAnoncreds" - } - } - } - } - }, - "/anoncreds/revocation/registry/{rev_reg_id}/issued/details": { - "get": { - "tags": ["anoncreds - revocation"], - "summary": "Get details of credentials issued against revocation registry", - "produces": ["application/json"], - "parameters": [ - { - "name": "rev_reg_id", - "in": "path", - "description": "Revocation Registry identifier", - "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:(.+$)" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/CredRevRecordDetailsResultSchemaAnoncreds" - } - } - } - } - }, - "/anoncreds/revocation/registry/{rev_reg_id}/issued/indy_recs": { - "get": { - "tags": ["anoncreds - revocation"], - "summary": "Get details of revoked credentials from ledger", - "produces": ["application/json"], - "parameters": [ - { - "name": "rev_reg_id", - "in": "path", - "description": "Revocation Registry identifier", - "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:(.+$)" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/CredRevIndyRecordsResultSchemaAnoncreds" - } - } - } - } - }, - "/anoncreds/revocation/registry/{rev_reg_id}/set-state": { - "patch": { - "tags": ["anoncreds - revocation"], - "summary": "Set revocation registry state manually", - "produces": ["application/json"], - "parameters": [ - { - "name": "rev_reg_id", - "in": "path", - "description": "Revocation Registry identifier", - "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:(.+$)" - }, - { - "name": "state", - "in": "query", - "description": "Revocation registry state to set", - "required": true, - "type": "string", - "enum": [ - "finished", - "failed", - "action", - "wait", - "decommissioned", - "full" - ] - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/RevRegResultSchemaAnoncreds" - } - } - } - } - }, - "/anoncreds/revocation/registry/{rev_reg_id}/tails-file": { - "get": { - "tags": ["anoncreds - revocation"], - "summary": "Download tails file", - "produces": ["application/octet-stream"], - "parameters": [ - { - "name": "rev_reg_id", - "in": "path", - "description": "Revocation Registry identifier", - "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:(.+$)" - } - ], - "responses": { - "200": { - "description": "tails file", - "schema": { - "$ref": "#/definitions/RevocationAnoncredsModuleResponse" - } - } - } - } - }, - "/anoncreds/revocation/revoke": { - "post": { - "tags": ["anoncreds - revocation"], - "summary": "Revoke an issued credential", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/RevokeRequestSchemaAnoncreds" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/RevocationAnoncredsModuleResponse" - } - } - } - } - }, - "/anoncreds/schema": { - "post": { - "tags": ["anoncreds - schemas"], - "summary": "Create a schema on the connected ledger", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/SchemaPostRequest" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/SchemaResult" - } - } - } - } - }, - "/anoncreds/schema/{schema_id}": { - "get": { - "tags": ["anoncreds - schemas"], - "summary": "Retrieve an individual schemas details", - "produces": ["application/json"], - "parameters": [ - { - "name": "schema_id", - "in": "path", - "description": "Schema identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/GetSchemaResult" - } - } - } - } - }, - "/anoncreds/schemas": { - "get": { - "tags": ["anoncreds - schemas"], - "summary": "Retrieve all schema ids", - "produces": ["application/json"], - "parameters": [ - { - "name": "schema_issuer_id", - "in": "query", - "description": "Schema issuer identifier", - "required": false, - "type": "string" - }, - { - "name": "schema_name", - "in": "query", - "description": "Schema name", - "required": false, - "type": "string" - }, - { - "name": "schema_version", - "in": "query", - "description": "Schema version", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/GetSchemasResponse" - } - } - } - } - }, - "/anoncreds/wallet/upgrade": { - "post": { - "tags": ["anoncreds - wallet upgrade"], - "summary": "\n Upgrade the wallet from askar to anoncreds - Be very careful with this! You \n cannot go back! See migration guide for more information.\n ", - "produces": ["application/json"], - "parameters": [ - { - "name": "wallet_name", - "in": "query", - "description": "Name of wallet to upgrade to anoncreds", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/UpgradeResult" - } - } - } - } - }, - "/connections": { - "get": { - "tags": ["connection"], - "summary": "Query agent-to-agent connections", - "produces": ["application/json"], - "parameters": [ - { - "name": "alias", - "in": "query", - "description": "Alias", - "required": false, - "type": "string" - }, - { - "name": "connection_protocol", - "in": "query", - "description": "Connection protocol used", - "required": false, - "type": "string", - "enum": ["connections/1.0", "didexchange/1.0", "didexchange/1.1"] - }, - { - "name": "descending", - "in": "query", - "description": "Order results in descending order if true", - "required": false, - "type": "boolean", - "default": false - }, - { - "name": "invitation_key", - "in": "query", - "description": "invitation key", - "required": false, - "type": "string", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - }, - { - "name": "invitation_msg_id", - "in": "query", - "description": "Identifier of the associated Invitation Message", - "required": false, - "type": "string" - }, - { - "name": "limit", - "in": "query", - "description": "Number of results to return", - "required": false, - "type": "integer", - "default": 100 - }, - { - "name": "my_did", - "in": "query", - "description": "My DID", - "required": false, - "type": "string", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$" - }, - { - "name": "offset", - "in": "query", - "description": "Offset for pagination", - "required": false, - "type": "integer", - "default": 0 - }, - { - "name": "order_by", - "in": "query", - "description": "The column to order results by. Only \"id\" is currently supported.", - "required": false, - "type": "string", - "default": "id", - "enum": ["id"] - }, - { - "name": "state", - "in": "query", - "description": "Connection state", - "required": false, - "type": "string", - "enum": [ - "abandoned", - "active", - "completed", - "error", - "init", - "invitation", - "request", - "response", - "start" - ] - }, - { - "name": "their_did", - "in": "query", - "description": "Their DID", - "required": false, - "type": "string", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$" - }, - { - "name": "their_public_did", - "in": "query", - "description": "Their Public DID", - "required": false, - "type": "string", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$" - }, - { - "name": "their_role", - "in": "query", - "description": "Their role in the connection protocol", - "required": false, - "type": "string", - "enum": ["invitee", "requester", "inviter", "responder"] - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ConnectionList" - } - } - } - } - }, - "/connections/create-invitation": { - "post": { - "tags": ["connection"], - "summary": "Create a new connection invitation", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/CreateInvitationRequest" - } - }, - { - "name": "alias", - "in": "query", - "description": "Alias", - "required": false, - "type": "string" - }, - { - "name": "auto_accept", - "in": "query", - "description": "Auto-accept connection (defaults to configuration)", - "required": false, - "type": "boolean" - }, - { - "name": "multi_use", - "in": "query", - "description": "Create invitation for multiple use (default false)", - "required": false, - "type": "boolean" - }, - { - "name": "public", - "in": "query", - "description": "Create invitation from public DID (default false)", - "required": false, - "type": "boolean" - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/InvitationResult" - } - } - } - } - }, - "/connections/create-static": { - "post": { - "tags": ["connection"], - "summary": "Create a new static connection", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/ConnectionStaticRequest" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ConnectionStaticResult" - } - } - } - } - }, - "/connections/receive-invitation": { - "post": { - "tags": ["connection"], - "summary": "Receive a new connection invitation", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/ReceiveInvitationRequest" - } - }, - { - "name": "alias", - "in": "query", - "description": "Alias", - "required": false, - "type": "string" - }, - { - "name": "auto_accept", - "in": "query", - "description": "Auto-accept connection (defaults to configuration)", - "required": false, - "type": "boolean" - }, - { - "name": "mediation_id", - "in": "query", - "description": "Identifier for active mediation record to be used", - "required": false, - "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}" - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ConnRecord" - } - } - } - } - }, - "/connections/{conn_id}": { - "get": { - "tags": ["connection"], - "summary": "Fetch a single connection record", - "produces": ["application/json"], - "parameters": [ - { - "name": "conn_id", - "in": "path", - "description": "Connection identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ConnRecord" - } - } - } - }, - "delete": { - "tags": ["connection"], - "summary": "Remove an existing connection record", - "produces": ["application/json"], - "parameters": [ - { - "name": "conn_id", - "in": "path", - "description": "Connection identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ConnectionModuleResponse" - } - } - } - } - }, - "/connections/{conn_id}/accept-invitation": { - "post": { - "tags": ["connection"], - "summary": "Accept a stored connection invitation", - "produces": ["application/json"], - "parameters": [ - { - "name": "conn_id", - "in": "path", - "description": "Connection identifier", - "required": true, - "type": "string" - }, - { - "name": "mediation_id", - "in": "query", - "description": "Identifier for active mediation record to be used", - "required": false, - "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}" - }, - { - "name": "my_endpoint", - "in": "query", - "description": "My URL 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]*)?(/[^?&#]+)?$" - }, - { - "name": "my_label", - "in": "query", - "description": "Label for connection", - "required": false, - "type": "string" - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ConnRecord" - } - } - } - } - }, - "/connections/{conn_id}/accept-request": { - "post": { - "tags": ["connection"], - "summary": "Accept a stored connection request", - "produces": ["application/json"], - "parameters": [ - { - "name": "conn_id", - "in": "path", - "description": "Connection identifier", - "required": true, - "type": "string" - }, - { - "name": "my_endpoint", - "in": "query", - "description": "My URL 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]*)?(/[^?&#]+)?$" - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ConnRecord" - } - } - } - } - }, - "/connections/{conn_id}/endpoints": { - "get": { - "tags": ["connection"], - "summary": "Fetch connection remote endpoint", - "produces": ["application/json"], - "parameters": [ - { - "name": "conn_id", - "in": "path", - "description": "Connection identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/EndpointsResult" - } - } - } - } - }, - "/connections/{conn_id}/metadata": { - "get": { - "tags": ["connection"], - "summary": "Fetch connection metadata", - "produces": ["application/json"], - "parameters": [ - { - "name": "conn_id", - "in": "path", - "description": "Connection identifier", - "required": true, - "type": "string" - }, - { - "name": "key", - "in": "query", - "description": "Key to retrieve.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ConnectionMetadata" - } - } - } - }, - "post": { - "tags": ["connection"], - "summary": "Set connection metadata", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/ConnectionMetadataSetRequest" - } - }, - { - "name": "conn_id", - "in": "path", - "description": "Connection identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ConnectionMetadata" - } - } - } - } - }, - "/connections/{conn_id}/send-message": { - "post": { - "tags": ["basicmessage"], - "summary": "Send a basic message to a connection", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/SendMessage" - } - }, - { - "name": "conn_id", - "in": "path", - "description": "Connection identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/BasicMessageModuleResponse" - } - } - } - } - }, - "/connections/{conn_id}/send-ping": { - "post": { - "tags": ["trustping"], - "summary": "Send a trust ping to a connection", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/PingRequest" - } - }, - { - "name": "conn_id", - "in": "path", - "description": "Connection identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PingRequestResponse" - } - } - } - } - }, - "/connections/{conn_id}/start-introduction": { - "post": { - "tags": ["introduction"], - "summary": "Start an introduction between two connections", - "produces": ["application/json"], - "parameters": [ - { - "name": "conn_id", - "in": "path", - "description": "Connection identifier", - "required": true, - "type": "string" - }, - { - "name": "target_connection_id", - "in": "query", - "description": "Target connection identifier", - "required": true, - "type": "string" - }, - { - "name": "message", - "in": "query", - "description": "Message", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/IntroModuleResponse" - } - } - } - } - }, - "/credential-definitions": { - "post": { - "tags": ["credential-definition"], - "summary": "Sends a credential definition to the ledger", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/CredentialDefinitionSendRequest" - } - }, - { - "name": "conn_id", - "in": "query", - "description": "Connection identifier", - "required": false, - "type": "string" - }, - { - "name": "create_transaction_for_endorser", - "in": "query", - "description": "Create Transaction For Endorser's signature", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TxnOrCredentialDefinitionSendResult" - } - } - } - } - }, - "/credential-definitions/created": { - "get": { - "tags": ["credential-definition"], - "summary": "Search for matching credential definitions that agent originated", - "produces": ["application/json"], - "parameters": [ - { - "name": "cred_def_id", - "in": "query", - "description": "Credential definition id", - "required": false, - "type": "string", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - { - "name": "issuer_did", - "in": "query", - "description": "Issuer DID", - "required": false, - "type": "string", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - { - "name": "schema_id", - "in": "query", - "description": "Schema identifier", - "required": false, - "type": "string", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - }, - { - "name": "schema_issuer_did", - "in": "query", - "description": "Schema issuer DID", - "required": false, - "type": "string", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - { - "name": "schema_name", - "in": "query", - "description": "Schema name", - "required": false, - "type": "string" - }, - { - "name": "schema_version", - "in": "query", - "description": "Schema version", - "required": false, - "type": "string", - "pattern": "^[0-9.]+$" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/CredentialDefinitionsCreatedResult" - } - } - } - } - }, - "/credential-definitions/{cred_def_id}": { - "get": { - "tags": ["credential-definition"], - "summary": "Gets a credential definition from the ledger", - "produces": ["application/json"], - "parameters": [ - { - "name": "cred_def_id", - "in": "path", - "description": "Credential definition identifier", - "required": true, - "type": "string", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/CredentialDefinitionGetResult" - } - } - } - } - }, - "/credential-definitions/{cred_def_id}/write_record": { - "post": { - "tags": ["credential-definition"], - "summary": "Writes a credential definition non-secret record to the wallet", - "produces": ["application/json"], - "parameters": [ - { - "name": "cred_def_id", - "in": "path", - "description": "Credential definition identifier", - "required": true, - "type": "string", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/CredentialDefinitionGetResult" - } - } - } - } - }, - "/credential/mime-types/{credential_id}": { - "get": { - "tags": ["credentials"], - "summary": "Get attribute MIME types from wallet", - "produces": ["application/json"], - "parameters": [ - { - "name": "credential_id", - "in": "path", - "description": "Credential identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/AttributeMimeTypesResult" - } - } - } - } - }, - "/credential/revoked/{credential_id}": { - "get": { - "tags": ["credentials"], - "summary": "Query credential revocation status by id", - "produces": ["application/json"], - "parameters": [ - { - "name": "credential_id", - "in": "path", - "description": "Credential identifier", - "required": true, - "type": "string" - }, - { - "name": "from", - "in": "query", - "description": "Earliest epoch of revocation status interval of interest", - "required": false, - "type": "string", - "pattern": "^[0-9]*$" - }, - { - "name": "to", - "in": "query", - "description": "Latest epoch of revocation status interval of interest", - "required": false, - "type": "string", - "pattern": "^[0-9]*$" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/CredRevokedResult" - } - } - } - } - }, - "/credential/w3c/{credential_id}": { - "get": { - "tags": ["credentials"], - "summary": "Fetch W3C credential from wallet by id", - "produces": ["application/json"], - "parameters": [ - { - "name": "credential_id", - "in": "path", - "description": "Credential identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/VCRecord" - } - } - } - }, - "delete": { - "tags": ["credentials"], - "summary": "Remove W3C credential from wallet by id", - "produces": ["application/json"], - "parameters": [ - { - "name": "credential_id", - "in": "path", - "description": "Credential identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/HolderModuleResponse" - } - } - } - } - }, - "/credential/{credential_id}": { - "get": { - "tags": ["credentials"], - "summary": "Fetch credential from wallet by id", - "produces": ["application/json"], - "parameters": [ - { - "name": "credential_id", - "in": "path", - "description": "Credential identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/IndyCredInfo" - } - } - } - }, - "delete": { - "tags": ["credentials"], - "summary": "Remove credential from wallet by id", - "produces": ["application/json"], - "parameters": [ - { - "name": "credential_id", - "in": "path", - "description": "Credential identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/HolderModuleResponse" - } - } - } - } - }, - "/credentials": { - "get": { - "tags": ["credentials"], - "summary": "Fetch credentials from wallet", - "produces": ["application/json"], - "parameters": [ - { - "name": "count", - "in": "query", - "description": "Maximum number to retrieve", - "required": false, - "type": "string", - "pattern": "^[1-9][0-9]*$" - }, - { - "name": "start", - "in": "query", - "description": "Start index", - "required": false, - "type": "string", - "pattern": "^[0-9]*$" - }, - { - "name": "wql", - "in": "query", - "description": "(JSON) WQL query", - "required": false, - "type": "string", - "pattern": "^{.*}$" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/CredInfoList" - } - } - } - } - }, - "/credentials/w3c": { - "post": { - "tags": ["credentials"], - "summary": "Fetch W3C credentials from wallet", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/W3CCredentialsListRequest" - } - }, - { - "name": "count", - "in": "query", - "description": "Maximum number to retrieve", - "required": false, - "type": "string", - "pattern": "^[1-9][0-9]*$" - }, - { - "name": "start", - "in": "query", - "description": "Start index", - "required": false, - "type": "string", - "pattern": "^[0-9]*$" - }, - { - "name": "wql", - "in": "query", - "description": "(JSON) WQL query", - "required": false, - "type": "string", - "pattern": "^{.*}$" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/VCRecordList" - } - } - } - } - }, - "/did-rotate/{conn_id}/hangup": { - "post": { - "tags": ["did-rotate"], - "summary": "Send hangup of DID rotation as a rotator", - "produces": ["application/json"], - "parameters": [ - { - "name": "conn_id", - "in": "path", - "description": "Connection identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Hangup agent message for observer", - "schema": { - "$ref": "#/definitions/Hangup" - } - } - } - } - }, - "/did-rotate/{conn_id}/rotate": { - "post": { - "tags": ["did-rotate"], - "summary": "Begin rotation of a DID as a rotator", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/DIDRotateRequestJSON" - } - }, - { - "name": "conn_id", - "in": "path", - "description": "Connection identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Rotate agent message for observer", - "schema": { - "$ref": "#/definitions/Rotate" - } - } - } - } - }, - "/didexchange/create-request": { - "post": { - "tags": ["did-exchange"], - "summary": "Create and send a request against public DID's implicit invitation", - "produces": ["application/json"], - "parameters": [ - { - "name": "their_public_did", - "in": "query", - "description": "Qualified public DID to which to request connection", - "required": true, - "type": "string", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$" - }, - { - "name": "alias", - "in": "query", - "description": "Alias for connection", - "required": false, - "type": "string" - }, - { - "name": "auto_accept", - "in": "query", - "description": "Auto-accept connection (defaults to configuration)", - "required": false, - "type": "boolean" - }, - { - "name": "goal", - "in": "query", - "description": "A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message", - "required": false, - "type": "string" - }, - { - "name": "goal_code", - "in": "query", - "description": "A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message", - "required": false, - "type": "string" - }, - { - "name": "mediation_id", - "in": "query", - "description": "Identifier for active mediation record to be used", - "required": false, - "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}" - }, - { - "name": "my_endpoint", - "in": "query", - "description": "My URL 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]*)?(/[^?&#]+)?$" - }, - { - "name": "my_label", - "in": "query", - "description": "Label for connection request", - "required": false, - "type": "string" - }, - { - "name": "protocol", - "in": "query", - "description": "Which DID Exchange Protocol version to use", - "required": false, - "type": "string", - "enum": ["didexchange/1.0", "didexchange/1.1"] - }, - { - "name": "use_did", - "in": "query", - "description": "The DID to use to for this connection", - "required": false, - "type": "string" - }, - { - "name": "use_did_method", - "in": "query", - "description": "The DID method to use to generate a DID for this connection", - "required": false, - "type": "string", - "enum": ["did:peer:2", "did:peer:4"] - }, - { - "name": "use_public_did", - "in": "query", - "description": "Use public DID for this connection", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ConnRecord" - } - } - } - } - }, - "/didexchange/receive-request": { - "post": { - "tags": ["did-exchange"], - "summary": "Receive request against public DID's implicit invitation", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/DIDXRequest" - } - }, - { - "name": "alias", - "in": "query", - "description": "Alias for connection", - "required": false, - "type": "string" - }, - { - "name": "auto_accept", - "in": "query", - "description": "Auto-accept connection (defaults to configuration)", - "required": false, - "type": "boolean" - }, - { - "name": "mediation_id", - "in": "query", - "description": "Identifier for active mediation record to be used", - "required": false, - "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}" - }, - { - "name": "my_endpoint", - "in": "query", - "description": "My URL 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]*)?(/[^?&#]+)?$" - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ConnRecord" - } - } - } - } - }, - "/didexchange/{conn_id}/accept-invitation": { - "post": { - "tags": ["did-exchange"], - "summary": "Accept a stored connection invitation", - "produces": ["application/json"], - "parameters": [ - { - "name": "conn_id", - "in": "path", - "description": "Connection identifier", - "required": true, - "type": "string" - }, - { - "name": "my_endpoint", - "in": "query", - "description": "My URL 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]*)?(/[^?&#]+)?$" - }, - { - "name": "my_label", - "in": "query", - "description": "Label for connection request", - "required": false, - "type": "string" - }, - { - "name": "use_did", - "in": "query", - "description": "The DID to use to for this connection", - "required": false, - "type": "string" - }, - { - "name": "use_did_method", - "in": "query", - "description": "The DID method to use to generate a DID for this connection", - "required": false, - "type": "string", - "enum": ["did:peer:2", "did:peer:4"] - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ConnRecord" - } - } - } - } - }, - "/didexchange/{conn_id}/accept-request": { - "post": { - "tags": ["did-exchange"], - "summary": "Accept a stored connection request", - "produces": ["application/json"], - "parameters": [ - { - "name": "conn_id", - "in": "path", - "description": "Connection identifier", - "required": true, - "type": "string" - }, - { - "name": "mediation_id", - "in": "query", - "description": "Identifier for active mediation record to be used", - "required": false, - "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}" - }, - { - "name": "my_endpoint", - "in": "query", - "description": "My URL 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]*)?(/[^?&#]+)?$" - }, - { - "name": "use_public_did", - "in": "query", - "description": "Use public DID for this connection", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ConnRecord" - } - } - } - } - }, - "/didexchange/{conn_id}/reject": { - "post": { - "tags": ["did-exchange"], - "summary": "Abandon or reject a DID Exchange", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/DIDXRejectRequest" - } - }, - { - "name": "conn_id", - "in": "path", - "description": "Connection identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ConnRecord" - } - } - } - } - }, - "/discover-features-2.0/queries": { - "get": { - "tags": ["discover-features v2.0"], - "summary": "Query supported features", - "produces": ["application/json"], - "parameters": [ - { - "name": "connection_id", - "in": "query", - "description": "Connection identifier, if none specified, then the query will provide features for this agent.", - "required": false, - "type": "string" - }, - { - "name": "query_goal_code", - "in": "query", - "description": "Goal-code feature-type query", - "required": false, - "type": "string" - }, - { - "name": "query_protocol", - "in": "query", - "description": "Protocol feature-type query", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V20DiscoveryExchangeResult" - } - } - } - } - }, - "/discover-features-2.0/records": { - "get": { - "tags": ["discover-features v2.0"], - "summary": "Discover Features v2.0 records", - "produces": ["application/json"], - "parameters": [ - { - "name": "connection_id", - "in": "query", - "description": "Connection identifier", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V20DiscoveryExchangeListResult" - } - } - } - } - }, - "/discover-features/query": { - "get": { - "tags": ["discover-features"], - "summary": "Query supported features", - "produces": ["application/json"], - "parameters": [ - { - "name": "comment", - "in": "query", - "description": "Comment", - "required": false, - "type": "string" - }, - { - "name": "connection_id", - "in": "query", - "description": "Connection identifier, if none specified, then the query will provide features for this agent.", - "required": false, - "type": "string" - }, - { - "name": "query", - "in": "query", - "description": "Protocol feature query", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V10DiscoveryRecord" - } - } - } - } - }, - "/discover-features/records": { - "get": { - "tags": ["discover-features"], - "summary": "Discover Features records", - "produces": ["application/json"], - "parameters": [ - { - "name": "connection_id", - "in": "query", - "description": "Connection identifier", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V10DiscoveryExchangeListResult" - } - } - } - } - }, - "/issue-credential-2.0/create": { - "post": { - "tags": ["issue-credential v2.0"], - "summary": "Create a credential record without sending (generally for use with Out-Of-Band)", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V20IssueCredSchemaCore" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V20CredExRecord" - } - } - } - } - }, - "/issue-credential-2.0/create-offer": { - "post": { - "tags": ["issue-credential v2.0"], - "summary": "Create a credential offer, independent of any proposal or connection", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V20CredOfferConnFreeRequest" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V20CredExRecord" - } - } - } - } - }, - "/issue-credential-2.0/records": { - "get": { - "tags": ["issue-credential v2.0"], - "summary": "Fetch all credential exchange records", - "produces": ["application/json"], - "parameters": [ - { - "name": "connection_id", - "in": "query", - "description": "Connection identifier", - "required": false, - "type": "string" - }, - { - "name": "descending", - "in": "query", - "description": "Order results in descending order if true", - "required": false, - "type": "boolean", - "default": false - }, - { - "name": "limit", - "in": "query", - "description": "Number of results to return", - "required": false, - "type": "integer", - "default": 100 - }, - { - "name": "offset", - "in": "query", - "description": "Offset for pagination", - "required": false, - "type": "integer", - "default": 0 - }, - { - "name": "order_by", - "in": "query", - "description": "The column to order results by. Only \"id\" is currently supported.", - "required": false, - "type": "string", - "default": "id", - "enum": ["id"] - }, - { - "name": "role", - "in": "query", - "description": "Role assigned in credential exchange", - "required": false, - "type": "string", - "enum": ["issuer", "holder"] - }, - { - "name": "state", - "in": "query", - "description": "Credential exchange state", - "required": false, - "type": "string", - "enum": [ - "proposal-sent", - "proposal-received", - "offer-sent", - "offer-received", - "request-sent", - "request-received", - "credential-issued", - "credential-received", - "done", - "credential-revoked", - "abandoned" - ] - }, - { - "name": "thread_id", - "in": "query", - "description": "Thread identifier", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V20CredExRecordListResult" - } - } - } - } - }, - "/issue-credential-2.0/records/{cred_ex_id}": { - "get": { - "tags": ["issue-credential v2.0"], - "summary": "Fetch a single credential exchange record", - "produces": ["application/json"], - "parameters": [ - { - "name": "cred_ex_id", - "in": "path", - "description": "Credential exchange identifier", - "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}" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V20CredExRecordDetail" - } - } - } - }, - "delete": { - "tags": ["issue-credential v2.0"], - "summary": "Remove an existing credential exchange record", - "produces": ["application/json"], - "parameters": [ - { - "name": "cred_ex_id", - "in": "path", - "description": "Credential exchange identifier", - "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}" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V20IssueCredentialModuleResponse" - } - } - } - } - }, - "/issue-credential-2.0/records/{cred_ex_id}/issue": { - "post": { - "tags": ["issue-credential v2.0"], - "summary": "Send holder a credential", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V20CredIssueRequest" - } - }, - { - "name": "cred_ex_id", - "in": "path", - "description": "Credential exchange identifier", - "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}" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V20CredExRecordDetail" - } - } - } - } - }, - "/issue-credential-2.0/records/{cred_ex_id}/problem-report": { - "post": { - "tags": ["issue-credential v2.0"], - "summary": "Send a problem report for credential exchange", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V20CredIssueProblemReportRequest" - } - }, - { - "name": "cred_ex_id", - "in": "path", - "description": "Credential exchange identifier", - "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}" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V20IssueCredentialModuleResponse" - } - } - } - } - }, - "/issue-credential-2.0/records/{cred_ex_id}/send-offer": { - "post": { - "tags": ["issue-credential v2.0"], - "summary": "Send holder a credential offer in reference to a proposal with preview", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V20CredBoundOfferRequest" - } - }, - { - "name": "cred_ex_id", - "in": "path", - "description": "Credential exchange identifier", - "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}" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V20CredExRecord" - } - } - } - } - }, - "/issue-credential-2.0/records/{cred_ex_id}/send-request": { - "post": { - "tags": ["issue-credential v2.0"], - "summary": "Send issuer a credential request", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V20CredRequestRequest" - } - }, - { - "name": "cred_ex_id", - "in": "path", - "description": "Credential exchange identifier", - "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}" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V20CredExRecord" - } - } - } - } - }, - "/issue-credential-2.0/records/{cred_ex_id}/store": { - "post": { - "tags": ["issue-credential v2.0"], - "summary": "Store a received credential", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V20CredStoreRequest" - } - }, - { - "name": "cred_ex_id", - "in": "path", - "description": "Credential exchange identifier", - "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}" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V20CredExRecordDetail" - } - } - } - } - }, - "/issue-credential-2.0/send": { - "post": { - "tags": ["issue-credential v2.0"], - "summary": "Send holder a credential, automating entire flow", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V20CredExFree" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V20CredExRecord" - } - } - } - } - }, - "/issue-credential-2.0/send-offer": { - "post": { - "tags": ["issue-credential v2.0"], - "summary": "Send holder a credential offer, independent of any proposal", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V20CredOfferRequest" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V20CredExRecord" - } - } - } - } - }, - "/issue-credential-2.0/send-proposal": { - "post": { - "tags": ["issue-credential v2.0"], - "summary": "Send issuer a credential proposal", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V20CredExFree" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V20CredExRecord" - } - } - } - } - }, - "/issue-credential-2.0/send-request": { - "post": { - "tags": ["issue-credential v2.0"], - "summary": "Send issuer a credential request not bound to an existing thread. Indy credentials cannot start at a request", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V20CredRequestFree" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V20CredExRecord" - } - } - } - } - }, - "/issue-credential/create": { - "post": { - "tags": ["issue-credential v1.0"], - "summary": "Create a credential record without sending (generally for use with Out-Of-Band)", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V10CredentialCreate" - } - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V10CredentialExchange" - } - } - } - } - }, - "/issue-credential/create-offer": { - "post": { - "tags": ["issue-credential v1.0"], - "summary": "Create a credential offer, independent of any proposal or connection", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V10CredentialConnFreeOfferRequest" - } - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V10CredentialExchange" - } - } - } - } - }, - "/issue-credential/records": { - "get": { - "tags": ["issue-credential v1.0"], - "summary": "Fetch all credential exchange records", - "produces": ["application/json"], - "parameters": [ - { - "name": "connection_id", - "in": "query", - "description": "Connection identifier", - "required": false, - "type": "string" - }, - { - "name": "descending", - "in": "query", - "description": "Order results in descending order if true", - "required": false, - "type": "boolean", - "default": false - }, - { - "name": "limit", - "in": "query", - "description": "Number of results to return", - "required": false, - "type": "integer", - "default": 100 - }, - { - "name": "offset", - "in": "query", - "description": "Offset for pagination", - "required": false, - "type": "integer", - "default": 0 - }, - { - "name": "order_by", - "in": "query", - "description": "The column to order results by. Only \"id\" is currently supported.", - "required": false, - "type": "string", - "default": "id", - "enum": ["id"] - }, - { - "name": "role", - "in": "query", - "description": "Role assigned in credential exchange", - "required": false, - "type": "string", - "enum": ["issuer", "holder"] - }, - { - "name": "state", - "in": "query", - "description": "Credential exchange state", - "required": false, - "type": "string", - "enum": [ - "proposal_sent", - "proposal_received", - "offer_sent", - "offer_received", - "request_sent", - "request_received", - "credential_issued", - "credential_received", - "credential_acked", - "credential_revoked", - "abandoned" - ] - }, - { - "name": "thread_id", - "in": "query", - "description": "Thread identifier", - "required": false, - "type": "string" - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V10CredentialExchangeListResult" - } - } - } - } - }, - "/issue-credential/records/{cred_ex_id}": { - "get": { - "tags": ["issue-credential v1.0"], - "summary": "Fetch a single credential exchange record", - "produces": ["application/json"], - "parameters": [ - { - "name": "cred_ex_id", - "in": "path", - "description": "Credential exchange identifier", - "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}" - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V10CredentialExchange" - } - } - } - }, - "delete": { - "tags": ["issue-credential v1.0"], - "summary": "Remove an existing credential exchange record", - "produces": ["application/json"], - "parameters": [ - { - "name": "cred_ex_id", - "in": "path", - "description": "Credential exchange identifier", - "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}" - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/IssueCredentialModuleResponse" - } - } - } - } - }, - "/issue-credential/records/{cred_ex_id}/issue": { - "post": { - "tags": ["issue-credential v1.0"], - "summary": "Send holder a credential", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V10CredentialIssueRequest" - } - }, - { - "name": "cred_ex_id", - "in": "path", - "description": "Credential exchange identifier", - "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}" - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V10CredentialExchange" - } - } - } - } - }, - "/issue-credential/records/{cred_ex_id}/problem-report": { - "post": { - "tags": ["issue-credential v1.0"], - "summary": "Send a problem report for credential exchange", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V10CredentialProblemReportRequest" - } - }, - { - "name": "cred_ex_id", - "in": "path", - "description": "Credential exchange identifier", - "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}" - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/IssueCredentialModuleResponse" - } - } - } - } - }, - "/issue-credential/records/{cred_ex_id}/send-offer": { - "post": { - "tags": ["issue-credential v1.0"], - "summary": "Send holder a credential offer in reference to a proposal with preview", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V10CredentialBoundOfferRequest" - } - }, - { - "name": "cred_ex_id", - "in": "path", - "description": "Credential exchange identifier", - "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}" - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V10CredentialExchange" - } - } - } - } - }, - "/issue-credential/records/{cred_ex_id}/send-request": { - "post": { - "tags": ["issue-credential v1.0"], - "summary": "Send issuer a credential request", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V10CredentialExchangeAutoRemoveRequest" - } - }, - { - "name": "cred_ex_id", - "in": "path", - "description": "Credential exchange identifier", - "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}" - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V10CredentialExchange" - } - } - } - } - }, - "/issue-credential/records/{cred_ex_id}/store": { - "post": { - "tags": ["issue-credential v1.0"], - "summary": "Store a received credential", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V10CredentialStoreRequest" - } - }, - { - "name": "cred_ex_id", - "in": "path", - "description": "Credential exchange identifier", - "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}" - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V10CredentialExchange" - } - } - } - } - }, - "/issue-credential/send": { - "post": { - "tags": ["issue-credential v1.0"], - "summary": "Send holder a credential, automating entire flow", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V10CredentialProposalRequestMand" - } - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V10CredentialExchange" - } - } - } - } - }, - "/issue-credential/send-offer": { - "post": { - "tags": ["issue-credential v1.0"], - "summary": "Send holder a credential offer, independent of any proposal", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V10CredentialFreeOfferRequest" - } - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V10CredentialExchange" - } - } - } - } - }, - "/issue-credential/send-proposal": { - "post": { - "tags": ["issue-credential v1.0"], - "summary": "Send issuer a credential proposal", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V10CredentialProposalRequestOpt" - } - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V10CredentialExchange" - } - } - } - } - }, - "/jsonld/sign": { - "post": { - "tags": ["jsonld"], - "summary": "Sign a JSON-LD structure and return it", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/SignRequest" - } - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/SignResponse" - } - } - } - } - }, - "/jsonld/verify": { - "post": { - "tags": ["jsonld"], - "summary": "Verify a JSON-LD structure.", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/VerifyRequest" - } - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/VerifyResponse" - } - } - } - } - }, - "/ledger/config": { - "get": { - "tags": ["ledger"], - "summary": "Fetch the multiple ledger configuration currently in use", - "produces": ["application/json"], - "parameters": [], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/LedgerConfigList" - } - } - } - } - }, - "/ledger/did-endpoint": { - "get": { - "tags": ["ledger"], - "summary": "Get the endpoint for a DID from the ledger.", - "produces": ["application/json"], - "parameters": [ - { - "name": "did", - "in": "query", - "description": "DID of interest", - "required": true, - "type": "string", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - { - "name": "endpoint_type", - "in": "query", - "description": "Endpoint type of interest (default 'Endpoint')", - "required": false, - "type": "string", - "enum": ["Endpoint", "Profile", "LinkedDomains"] - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/GetDIDEndpointResponse" - } - } - } - } - }, - "/ledger/did-verkey": { - "get": { - "tags": ["ledger"], - "summary": "Get the verkey for a DID from the ledger.", - "produces": ["application/json"], - "parameters": [ - { - "name": "did", - "in": "query", - "description": "DID of interest", - "required": true, - "type": "string", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/GetDIDVerkeyResponse" - } - } - } - } - }, - "/ledger/get-nym-role": { - "get": { - "tags": ["ledger"], - "summary": "Get the role from the NYM registration of a public DID.", - "produces": ["application/json"], - "parameters": [ - { - "name": "did", - "in": "query", - "description": "DID of interest", - "required": true, - "type": "string", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/GetNymRoleResponse" - } - } - } - } - }, - "/ledger/get-write-ledger": { - "get": { - "tags": ["ledger"], - "summary": "Fetch the current write ledger", - "produces": ["application/json"], - "parameters": [], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/WriteLedger" - } - } - } - } - }, - "/ledger/get-write-ledgers": { - "get": { - "tags": ["ledger"], - "summary": "Fetch list of available write ledgers", - "produces": ["application/json"], - "parameters": [], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ConfigurableWriteLedgers" - } - } - } - } - }, - "/ledger/register-nym": { - "post": { - "tags": ["ledger"], - "summary": "Send a NYM registration to the ledger.", - "produces": ["application/json"], - "parameters": [ - { - "name": "did", - "in": "query", - "description": "DID to register", - "required": true, - "type": "string", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - { - "name": "verkey", - "in": "query", - "description": "Verification key", - "required": true, - "type": "string", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - }, - { - "name": "alias", - "in": "query", - "description": "Alias", - "required": false, - "type": "string" - }, - { - "name": "conn_id", - "in": "query", - "description": "Connection identifier", - "required": false, - "type": "string" - }, - { - "name": "create_transaction_for_endorser", - "in": "query", - "description": "Create Transaction For Endorser's signature", - "required": false, - "type": "boolean" - }, - { - "name": "role", - "in": "query", - "description": "Role", - "required": false, - "type": "string", - "enum": [ - "STEWARD", - "TRUSTEE", - "ENDORSER", - "NETWORK_MONITOR", - "reset" - ] - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TxnOrRegisterLedgerNymResponse" - } - } - } - } - }, - "/ledger/rotate-public-did-keypair": { - "patch": { - "tags": ["ledger"], - "summary": "Rotate key pair for public DID.", - "produces": ["application/json"], - "parameters": [], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/LedgerModulesResult" - } - } - } - } - }, - "/ledger/taa": { - "get": { - "tags": ["ledger"], - "summary": "Fetch the current transaction author agreement, if any", - "produces": ["application/json"], - "parameters": [], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TAAResult" - } - } - } - } - }, - "/ledger/taa/accept": { - "post": { - "tags": ["ledger"], - "summary": "Accept the transaction author agreement", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/TAAAccept" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/LedgerModulesResult" - } - } - } - } - }, - "/ledger/{ledger_id}/set-write-ledger": { - "put": { - "tags": ["ledger"], - "summary": "Set write ledger", - "produces": ["application/json"], - "parameters": [ - { - "name": "ledger_id", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/WriteLedger" - } - } - } - } - }, - "/mediation/default-mediator": { - "get": { - "tags": ["mediation"], - "summary": "Get default mediator", - "produces": ["application/json"], - "parameters": [], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/MediationRecord" - } - } - } - }, - "delete": { - "tags": ["mediation"], - "summary": "Clear default mediator", - "produces": ["application/json"], - "parameters": [], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/MediationRecord" - } - } - } - } - }, - "/mediation/keylists": { - "get": { - "tags": ["mediation"], - "summary": "Retrieve keylists by connection or role", - "produces": ["application/json"], - "parameters": [ - { - "name": "conn_id", - "in": "query", - "description": "Connection identifier (optional)", - "required": false, - "type": "string" - }, - { - "name": "role", - "in": "query", - "description": "Filer on role, 'client' for keys mediated by other agents, 'server' for keys mediated by this agent", - "required": false, - "type": "string", - "default": "server", - "enum": ["client", "server"] - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/Keylist" - } - } - } - } - }, - "/mediation/keylists/{mediation_id}/send-keylist-query": { - "post": { - "tags": ["mediation"], - "summary": "Send keylist query to mediator", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/KeylistQueryFilterRequest" - } - }, - { - "name": "mediation_id", - "in": "path", - "description": "Mediation record identifier", - "required": true, - "type": "string" - }, - { - "name": "paginate_limit", - "in": "query", - "description": "limit number of results", - "required": false, - "type": "integer", - "default": -1 - }, - { - "name": "paginate_offset", - "in": "query", - "description": "offset to use in pagination", - "required": false, - "type": "integer", - "default": 0 - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/KeylistQuery" - } - } - } - } - }, - "/mediation/keylists/{mediation_id}/send-keylist-update": { - "post": { - "tags": ["mediation"], - "summary": "Send keylist update to mediator", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/KeylistUpdateRequest" - } - }, - { - "name": "mediation_id", - "in": "path", - "description": "Mediation record identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/KeylistUpdate" - } - } - } - } - }, - "/mediation/request/{conn_id}": { - "post": { - "tags": ["mediation"], - "summary": "Request mediation from connection", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/MediationCreateRequest" - } - }, - { - "name": "conn_id", - "in": "path", - "description": "Connection identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/MediationRecord" - } - } - } - } - }, - "/mediation/requests": { - "get": { - "tags": ["mediation"], - "summary": "Query mediation requests, returns list of all mediation records", - "produces": ["application/json"], - "parameters": [ - { - "name": "conn_id", - "in": "query", - "description": "Connection identifier (optional)", - "required": false, - "type": "string" - }, - { - "name": "state", - "in": "query", - "description": "Mediation state (optional)", - "required": false, - "type": "string", - "enum": ["request", "granted", "denied"] - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/MediationList" - } - } - } - } - }, - "/mediation/requests/{mediation_id}": { - "get": { - "tags": ["mediation"], - "summary": "Retrieve mediation request record", - "produces": ["application/json"], - "parameters": [ - { - "name": "mediation_id", - "in": "path", - "description": "Mediation record identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/MediationRecord" - } - } - } - }, - "delete": { - "tags": ["mediation"], - "summary": "Delete mediation request by ID", - "produces": ["application/json"], - "parameters": [ - { - "name": "mediation_id", - "in": "path", - "description": "Mediation record identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/MediationRecord" - } - } - } - } - }, - "/mediation/requests/{mediation_id}/deny": { - "post": { - "tags": ["mediation"], - "summary": "Deny a stored mediation request", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/AdminMediationDeny" - } - }, - { - "name": "mediation_id", - "in": "path", - "description": "Mediation record identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/MediationDeny" - } - } - } - } - }, - "/mediation/requests/{mediation_id}/grant": { - "post": { - "tags": ["mediation"], - "summary": "Grant received mediation", - "produces": ["application/json"], - "parameters": [ - { - "name": "mediation_id", - "in": "path", - "description": "Mediation record identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/MediationGrant" - } - } - } - } - }, - "/mediation/update-keylist/{conn_id}": { - "post": { - "tags": ["mediation"], - "summary": "Update keylist for a connection", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/MediationIdMatchInfo" - } - }, - { - "name": "conn_id", - "in": "path", - "description": "Connection identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/KeylistUpdate" - } - } - } - } - }, - "/mediation/{mediation_id}/default-mediator": { - "put": { - "tags": ["mediation"], - "summary": "Set default mediator", - "produces": ["application/json"], - "parameters": [ - { - "name": "mediation_id", - "in": "path", - "description": "Mediation record identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/MediationRecord" - } - } - } - } - }, - "/multitenancy/wallet": { - "post": { - "tags": ["multitenancy"], - "summary": "Create a subwallet", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/CreateWalletRequest" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/CreateWalletResponse" - } - } - } - } - }, - "/multitenancy/wallet/{wallet_id}": { - "get": { - "tags": ["multitenancy"], - "summary": "Get a single subwallet", - "produces": ["application/json"], - "parameters": [ - { - "name": "wallet_id", - "in": "path", - "description": "Subwallet identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/WalletRecord" - } - } - } - }, - "put": { - "tags": ["multitenancy"], - "summary": "Update a subwallet", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/UpdateWalletRequest" - } - }, - { - "name": "wallet_id", - "in": "path", - "description": "Subwallet identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/WalletRecord" - } - } - } - } - }, - "/multitenancy/wallet/{wallet_id}/remove": { - "post": { - "tags": ["multitenancy"], - "summary": "Remove a subwallet", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/RemoveWalletRequest" - } - }, - { - "name": "wallet_id", - "in": "path", - "description": "Subwallet identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/MultitenantModuleResponse" - } - } - } - } - }, - "/multitenancy/wallet/{wallet_id}/token": { - "post": { - "tags": ["multitenancy"], - "summary": "Get auth token for a subwallet", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/CreateWalletTokenRequest" - } - }, - { - "name": "wallet_id", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/CreateWalletTokenResponse" - } - } - } - } - }, - "/multitenancy/wallets": { - "get": { - "tags": ["multitenancy"], - "summary": "Query subwallets", - "produces": ["application/json"], - "parameters": [ - { - "name": "descending", - "in": "query", - "description": "Order results in descending order if true", - "required": false, - "type": "boolean", - "default": false - }, - { - "name": "limit", - "in": "query", - "description": "Number of results to return", - "required": false, - "type": "integer", - "default": 100 - }, - { - "name": "offset", - "in": "query", - "description": "Offset for pagination", - "required": false, - "type": "integer", - "default": 0 - }, - { - "name": "order_by", - "in": "query", - "description": "The column to order results by. Only \"id\" is currently supported.", - "required": false, - "type": "string", - "default": "id", - "enum": ["id"] - }, - { - "name": "wallet_name", - "in": "query", - "description": "Wallet name", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/WalletList" - } - } - } - } - }, - "/out-of-band/create-invitation": { - "post": { - "tags": ["out-of-band"], - "summary": "Create a new connection invitation", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/InvitationCreateRequest" - } - }, - { - "name": "auto_accept", - "in": "query", - "description": "Auto-accept connection (defaults to configuration)", - "required": false, - "type": "boolean" - }, - { - "name": "create_unique_did", - "in": "query", - "description": "Create unique DID for this invitation (default false)", - "required": false, - "type": "boolean" - }, - { - "name": "multi_use", - "in": "query", - "description": "Create invitation for multiple use (default false)", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/InvitationRecord" - } - } - } - } - }, - "/out-of-band/invitations/{invi_msg_id}": { - "delete": { - "tags": ["out-of-band"], - "summary": "Delete records associated with invitation", - "produces": ["application/json"], - "parameters": [ - { - "name": "invi_msg_id", - "in": "path", - "description": "Invitation Message identifier", - "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}" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/InvitationRecordResponse" - } - } - } - } - }, - "/out-of-band/receive-invitation": { - "post": { - "tags": ["out-of-band"], - "summary": "Receive a new connection invitation", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/InvitationMessage" - } - }, - { - "name": "alias", - "in": "query", - "description": "Alias for connection", - "required": false, - "type": "string" - }, - { - "name": "auto_accept", - "in": "query", - "description": "Auto-accept connection (defaults to configuration)", - "required": false, - "type": "boolean" - }, - { - "name": "mediation_id", - "in": "query", - "description": "Identifier for active mediation record to be used", - "required": false, - "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}" - }, - { - "name": "use_existing_connection", - "in": "query", - "description": "Use an existing connection, if possible", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/OobRecord" - } - } - } - } - }, - "/plugins": { - "get": { - "tags": ["server"], - "summary": "Fetch the list of loaded plugins", - "produces": ["application/json"], - "parameters": [], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/AdminModules" - } - } - } - } - }, - "/present-proof-2.0/create-request": { - "post": { - "tags": ["present-proof v2.0"], - "summary": "Creates a presentation request not bound to any proposal or connection", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V20PresCreateRequestRequest" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V20PresExRecord" - } - } - } - } - }, - "/present-proof-2.0/records": { - "get": { - "tags": ["present-proof v2.0"], - "summary": "Fetch all present-proof exchange records", - "produces": ["application/json"], - "parameters": [ - { - "name": "connection_id", - "in": "query", - "description": "Connection identifier", - "required": false, - "type": "string" - }, - { - "name": "descending", - "in": "query", - "description": "Order results in descending order if true", - "required": false, - "type": "boolean", - "default": false - }, - { - "name": "limit", - "in": "query", - "description": "Number of results to return", - "required": false, - "type": "integer", - "default": 100 - }, - { - "name": "offset", - "in": "query", - "description": "Offset for pagination", - "required": false, - "type": "integer", - "default": 0 - }, - { - "name": "order_by", - "in": "query", - "description": "The column to order results by. Only \"id\" is currently supported.", - "required": false, - "type": "string", - "default": "id", - "enum": ["id"] - }, - { - "name": "role", - "in": "query", - "description": "Role assigned in presentation exchange", - "required": false, - "type": "string", - "enum": ["prover", "verifier"] - }, - { - "name": "state", - "in": "query", - "description": "Presentation exchange state", - "required": false, - "type": "string", - "enum": [ - "proposal-sent", - "proposal-received", - "request-sent", - "request-received", - "presentation-sent", - "presentation-received", - "done", - "abandoned" - ] - }, - { - "name": "thread_id", - "in": "query", - "description": "Thread identifier", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V20PresExRecordList" - } - } - } - } - }, - "/present-proof-2.0/records/{pres_ex_id}": { - "get": { - "tags": ["present-proof v2.0"], - "summary": "Fetch a single presentation exchange record", - "produces": ["application/json"], - "parameters": [ - { - "name": "pres_ex_id", - "in": "path", - "description": "Presentation exchange identifier", - "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}" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V20PresExRecord" - } - } - } - }, - "delete": { - "tags": ["present-proof v2.0"], - "summary": "Remove an existing presentation exchange record", - "produces": ["application/json"], - "parameters": [ - { - "name": "pres_ex_id", - "in": "path", - "description": "Presentation exchange identifier", - "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}" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V20PresentProofModuleResponse" - } - } - } - } - }, - "/present-proof-2.0/records/{pres_ex_id}/credentials": { - "get": { - "tags": ["present-proof v2.0"], - "summary": "Fetch credentials from wallet for presentation request", - "produces": ["application/json"], - "parameters": [ - { - "name": "pres_ex_id", - "in": "path", - "description": "Presentation exchange identifier", - "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}" - }, - { - "name": "count", - "in": "query", - "description": "Maximum number to retrieve", - "required": false, - "type": "string", - "pattern": "^[1-9][0-9]*$" - }, - { - "name": "extra_query", - "in": "query", - "description": "(JSON) object mapping referents to extra WQL queries", - "required": false, - "type": "string", - "pattern": "^{\\s*\".*?\"\\s*:\\s*{.*?}\\s*(,\\s*\".*?\"\\s*:\\s*{.*?}\\s*)*\\s*}$" - }, - { - "name": "referent", - "in": "query", - "description": "Proof request referents of interest, comma-separated", - "required": false, - "type": "string" - }, - { - "name": "start", - "in": "query", - "description": "Start index", - "required": false, - "type": "string", - "pattern": "^[0-9]*$" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/IndyCredPrecis" - } - } - } - } - } - }, - "/present-proof-2.0/records/{pres_ex_id}/problem-report": { - "post": { - "tags": ["present-proof v2.0"], - "summary": "Send a problem report for presentation exchange", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V20PresProblemReportRequest" - } - }, - { - "name": "pres_ex_id", - "in": "path", - "description": "Presentation exchange identifier", - "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}" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V20PresentProofModuleResponse" - } - } - } - } - }, - "/present-proof-2.0/records/{pres_ex_id}/send-presentation": { - "post": { - "tags": ["present-proof v2.0"], - "summary": "Sends a proof presentation", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V20PresSpecByFormatRequest" - } - }, - { - "name": "pres_ex_id", - "in": "path", - "description": "Presentation exchange identifier", - "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}" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V20PresExRecord" - } - } - } - } - }, - "/present-proof-2.0/records/{pres_ex_id}/send-request": { - "post": { - "tags": ["present-proof v2.0"], - "summary": "Sends a presentation request in reference to a proposal", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V20PresentationSendRequestToProposal" - } - }, - { - "name": "pres_ex_id", - "in": "path", - "description": "Presentation exchange identifier", - "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}" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V20PresExRecord" - } - } - } - } - }, - "/present-proof-2.0/records/{pres_ex_id}/verify-presentation": { - "post": { - "tags": ["present-proof v2.0"], - "summary": "Verify a received presentation", - "produces": ["application/json"], - "parameters": [ - { - "name": "pres_ex_id", - "in": "path", - "description": "Presentation exchange identifier", - "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}" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V20PresExRecord" - } - } - } - } - }, - "/present-proof-2.0/send-proposal": { - "post": { - "tags": ["present-proof v2.0"], - "summary": "Sends a presentation proposal", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V20PresProposalRequest" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V20PresExRecord" - } - } - } - } - }, - "/present-proof-2.0/send-request": { - "post": { - "tags": ["present-proof v2.0"], - "summary": "Sends a free presentation request not bound to any proposal", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V20PresSendRequestRequest" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V20PresExRecord" - } - } - } - } - }, - "/present-proof/create-request": { - "post": { - "tags": ["present-proof v1.0"], - "summary": "Creates a presentation request not bound to any proposal or connection", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V10PresentationCreateRequestRequest" - } - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V10PresentationExchange" - } - } - } - } - }, - "/present-proof/records": { - "get": { - "tags": ["present-proof v1.0"], - "summary": "Fetch all present-proof exchange records", - "produces": ["application/json"], - "parameters": [ - { - "name": "connection_id", - "in": "query", - "description": "Connection identifier", - "required": false, - "type": "string" - }, - { - "name": "descending", - "in": "query", - "description": "Order results in descending order if true", - "required": false, - "type": "boolean", - "default": false - }, - { - "name": "limit", - "in": "query", - "description": "Number of results to return", - "required": false, - "type": "integer", - "default": 100 - }, - { - "name": "offset", - "in": "query", - "description": "Offset for pagination", - "required": false, - "type": "integer", - "default": 0 - }, - { - "name": "order_by", - "in": "query", - "description": "The column to order results by. Only \"id\" is currently supported.", - "required": false, - "type": "string", - "default": "id", - "enum": ["id"] - }, - { - "name": "role", - "in": "query", - "description": "Role assigned in presentation exchange", - "required": false, - "type": "string", - "enum": ["prover", "verifier"] - }, - { - "name": "state", - "in": "query", - "description": "Presentation exchange state", - "required": false, - "type": "string", - "enum": [ - "proposal_sent", - "proposal_received", - "request_sent", - "request_received", - "presentation_sent", - "presentation_received", - "verified", - "presentation_acked", - "abandoned" - ] - }, - { - "name": "thread_id", - "in": "query", - "description": "Thread identifier", - "required": false, - "type": "string" - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V10PresentationExchangeList" - } - } - } - } - }, - "/present-proof/records/{pres_ex_id}": { - "get": { - "tags": ["present-proof v1.0"], - "summary": "Fetch a single presentation exchange record", - "produces": ["application/json"], - "parameters": [ - { - "name": "pres_ex_id", - "in": "path", - "description": "Presentation exchange identifier", - "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}" - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V10PresentationExchange" - } - } - } - }, - "delete": { - "tags": ["present-proof v1.0"], - "summary": "Remove an existing presentation exchange record", - "produces": ["application/json"], - "parameters": [ - { - "name": "pres_ex_id", - "in": "path", - "description": "Presentation exchange identifier", - "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}" - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V10PresentProofModuleResponse" - } - } - } - } - }, - "/present-proof/records/{pres_ex_id}/credentials": { - "get": { - "tags": ["present-proof v1.0"], - "summary": "Fetch credentials for a presentation request from wallet", - "produces": ["application/json"], - "parameters": [ - { - "name": "pres_ex_id", - "in": "path", - "description": "Presentation exchange identifier", - "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}" - }, - { - "name": "count", - "in": "query", - "description": "Maximum number to retrieve", - "required": false, - "type": "string", - "pattern": "^[1-9][0-9]*$" - }, - { - "name": "extra_query", - "in": "query", - "description": "(JSON) object mapping referents to extra WQL queries", - "required": false, - "type": "string", - "pattern": "^{\\s*\".*?\"\\s*:\\s*{.*?}\\s*(,\\s*\".*?\"\\s*:\\s*{.*?}\\s*)*\\s*}$" - }, - { - "name": "referent", - "in": "query", - "description": "Proof request referents of interest, comma-separated", - "required": false, - "type": "string" - }, - { - "name": "start", - "in": "query", - "description": "Start index", - "required": false, - "type": "string", - "pattern": "^[0-9]*$" - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/IndyCredPrecis" - } - } - } - } - } - }, - "/present-proof/records/{pres_ex_id}/problem-report": { - "post": { - "tags": ["present-proof v1.0"], - "summary": "Send a problem report for presentation exchange", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V10PresentationProblemReportRequest" - } - }, - { - "name": "pres_ex_id", - "in": "path", - "description": "Presentation exchange identifier", - "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}" - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V10PresentProofModuleResponse" - } - } - } - } - }, - "/present-proof/records/{pres_ex_id}/send-presentation": { - "post": { - "tags": ["present-proof v1.0"], - "summary": "Sends a proof presentation", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V10PresentationSendRequest" - } - }, - { - "name": "pres_ex_id", - "in": "path", - "description": "Presentation exchange identifier", - "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}" - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V10PresentationExchange" - } - } - } - } - }, - "/present-proof/records/{pres_ex_id}/send-request": { - "post": { - "tags": ["present-proof v1.0"], - "summary": "Sends a presentation request in reference to a proposal", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V10PresentationSendRequestToProposal" - } - }, - { - "name": "pres_ex_id", - "in": "path", - "description": "Presentation exchange identifier", - "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}" - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V10PresentationExchange" - } - } - } - } - }, - "/present-proof/records/{pres_ex_id}/verify-presentation": { - "post": { - "tags": ["present-proof v1.0"], - "summary": "Verify a received presentation", - "produces": ["application/json"], - "parameters": [ - { - "name": "pres_ex_id", - "in": "path", - "description": "Presentation exchange identifier", - "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}" - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V10PresentationExchange" - } - } - } - } - }, - "/present-proof/send-proposal": { - "post": { - "tags": ["present-proof v1.0"], - "summary": "Sends a presentation proposal", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V10PresentationProposalRequest" - } - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V10PresentationExchange" - } - } - } - } - }, - "/present-proof/send-request": { - "post": { - "tags": ["present-proof v1.0"], - "summary": "Sends a free presentation request not bound to any proposal", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/V10PresentationSendRequestRequest" - } - } - ], - "deprecated": true, - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/V10PresentationExchange" - } - } - } - } - }, - "/resolver/resolve/{did}": { - "get": { - "tags": ["resolver"], - "summary": "Retrieve doc for requested did", - "produces": ["application/json"], - "parameters": [ - { - "name": "did", - "in": "path", - "description": "DID", - "required": true, - "type": "string", - "pattern": "^did:([a-z0-9]+):((?:[a-zA-Z0-9._%-]*:)*[a-zA-Z0-9._%-]+)$" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ResolutionResult" - } - } - } - } - }, - "/revocation/active-registry/{cred_def_id}": { - "get": { - "tags": ["revocation"], - "summary": "Get current active revocation registry by credential definition id", - "produces": ["application/json"], - "parameters": [ - { - "name": "cred_def_id", - "in": "path", - "description": "Credential definition identifier", - "required": true, - "type": "string", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/RevRegResult" - } - } - } - } - }, - "/revocation/active-registry/{cred_def_id}/rotate": { - "post": { - "tags": ["revocation"], - "summary": "Rotate revocation registry", - "produces": ["application/json"], - "parameters": [ - { - "name": "cred_def_id", - "in": "path", - "description": "Credential definition identifier", - "required": true, - "type": "string", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/RevRegsCreated" - } - } - } - } - }, - "/revocation/clear-pending-revocations": { - "post": { - "tags": ["revocation"], - "summary": "Clear pending revocations", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/ClearPendingRevocationsRequest" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PublishRevocations" - } - } - } - } - }, - "/revocation/create-registry": { - "post": { - "tags": ["revocation"], - "summary": "Creates a new revocation registry", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/RevRegCreateRequest" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/RevRegResult" - } - } - } - } - }, - "/revocation/credential-record": { - "get": { - "tags": ["revocation"], - "summary": "Get credential revocation status", - "produces": ["application/json"], - "parameters": [ - { - "name": "cred_ex_id", - "in": "query", - "description": "Credential exchange identifier", - "required": false, - "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}" - }, - { - "name": "cred_rev_id", - "in": "query", - "description": "Credential revocation identifier", - "required": false, - "type": "string", - "pattern": "^[1-9][0-9]*$" - }, - { - "name": "rev_reg_id", - "in": "query", - "description": "Revocation registry identifier", - "required": false, - "type": "string", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/CredRevRecordResult" - } - } - } - } - }, - "/revocation/publish-revocations": { - "post": { - "tags": ["revocation"], - "summary": "Publish pending revocations to ledger", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/PublishRevocations" - } - }, - { - "name": "conn_id", - "in": "query", - "description": "Connection identifier", - "required": false, - "type": "string" - }, - { - "name": "create_transaction_for_endorser", - "in": "query", - "description": "Create Transaction For Endorser's signature", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TxnOrPublishRevocationsResult" - } - } - } - } - }, - "/revocation/registries/created": { - "get": { - "tags": ["revocation"], - "summary": "Search for matching revocation registries that current agent created", - "produces": ["application/json"], - "parameters": [ - { - "name": "cred_def_id", - "in": "query", - "description": "Credential definition identifier", - "required": false, - "type": "string", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - { - "name": "state", - "in": "query", - "description": "Revocation registry state", - "required": false, - "type": "string", - "enum": [ - "init", - "generated", - "posted", - "active", - "full", - "decommissioned" - ] - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/RevRegsCreated" - } - } - } - } - }, - "/revocation/registry/delete-tails-file": { - "delete": { - "tags": ["revocation"], - "summary": "Delete the tail files", - "produces": ["application/json"], - "parameters": [ - { - "name": "cred_def_id", - "in": "query", - "description": "Credential definition identifier", - "required": false, - "type": "string", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - { - "name": "rev_reg_id", - "in": "query", - "description": "Revocation registry identifier", - "required": false, - "type": "string", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TailsDeleteResponse" - } - } - } - } - }, - "/revocation/registry/{rev_reg_id}": { - "get": { - "tags": ["revocation"], - "summary": "Get revocation registry by revocation registry id", - "produces": ["application/json"], - "parameters": [ - { - "name": "rev_reg_id", - "in": "path", - "description": "Revocation Registry identifier", - "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:(.+$)" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/RevRegResult" - } - } - } - }, - "patch": { - "tags": ["revocation"], - "summary": "Update revocation registry with new public URI to its tails file", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/RevRegUpdateTailsFileUri" - } - }, - { - "name": "rev_reg_id", - "in": "path", - "description": "Revocation Registry identifier", - "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:(.+$)" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/RevRegResult" - } - } - } - } - }, - "/revocation/registry/{rev_reg_id}/definition": { - "post": { - "tags": ["revocation"], - "summary": "Send revocation registry definition to ledger", - "produces": ["application/json"], - "parameters": [ - { - "name": "rev_reg_id", - "in": "path", - "description": "Revocation Registry identifier", - "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:(.+$)" - }, - { - "name": "conn_id", - "in": "query", - "description": "Connection identifier", - "required": false, - "type": "string" - }, - { - "name": "create_transaction_for_endorser", - "in": "query", - "description": "Create Transaction For Endorser's signature", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TxnOrRevRegResult" - } - } - } - } - }, - "/revocation/registry/{rev_reg_id}/entry": { - "post": { - "tags": ["revocation"], - "summary": "Send revocation registry entry to ledger", - "produces": ["application/json"], - "parameters": [ - { - "name": "rev_reg_id", - "in": "path", - "description": "Revocation Registry identifier", - "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:(.+$)" - }, - { - "name": "conn_id", - "in": "query", - "description": "Connection identifier", - "required": false, - "type": "string" - }, - { - "name": "create_transaction_for_endorser", - "in": "query", - "description": "Create Transaction For Endorser's signature", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/RevRegResult" - } - } - } - } - }, - "/revocation/registry/{rev_reg_id}/fix-revocation-entry-state": { - "put": { - "tags": ["revocation"], - "summary": "Fix revocation state in wallet and return number of updated entries", - "produces": ["application/json"], - "parameters": [ - { - "name": "rev_reg_id", - "in": "path", - "description": "Revocation Registry identifier", - "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:(.+$)" - }, - { - "name": "apply_ledger_update", - "in": "query", - "description": "Apply updated accumulator transaction to ledger", - "required": true, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/RevRegWalletUpdatedResult" - } - } - } - } - }, - "/revocation/registry/{rev_reg_id}/issued": { - "get": { - "tags": ["revocation"], - "summary": "Get number of credentials issued against revocation registry", - "produces": ["application/json"], - "parameters": [ - { - "name": "rev_reg_id", - "in": "path", - "description": "Revocation Registry identifier", - "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:(.+$)" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/RevRegIssuedResult" - } - } - } - } - }, - "/revocation/registry/{rev_reg_id}/issued/details": { - "get": { - "tags": ["revocation"], - "summary": "Get details of credentials issued against revocation registry", - "produces": ["application/json"], - "parameters": [ - { - "name": "rev_reg_id", - "in": "path", - "description": "Revocation Registry identifier", - "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:(.+$)" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/CredRevRecordDetailsResult" - } - } - } - } - }, - "/revocation/registry/{rev_reg_id}/issued/indy_recs": { - "get": { - "tags": ["revocation"], - "summary": "Get details of revoked credentials from ledger", - "produces": ["application/json"], - "parameters": [ - { - "name": "rev_reg_id", - "in": "path", - "description": "Revocation Registry identifier", - "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:(.+$)" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/CredRevIndyRecordsResult" - } - } - } - } - }, - "/revocation/registry/{rev_reg_id}/set-state": { - "patch": { - "tags": ["revocation"], - "summary": "Set revocation registry state manually", - "produces": ["application/json"], - "parameters": [ - { - "name": "rev_reg_id", - "in": "path", - "description": "Revocation Registry identifier", - "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:(.+$)" - }, - { - "name": "state", - "in": "query", - "description": "Revocation registry state to set", - "required": true, - "type": "string", - "enum": ["init", "generated", "posted", "active", "full"] - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/RevRegResult" - } - } - } - } - }, - "/revocation/registry/{rev_reg_id}/tails-file": { - "get": { - "tags": ["revocation"], - "summary": "Download tails file", - "produces": ["application/octet-stream"], - "parameters": [ - { - "name": "rev_reg_id", - "in": "path", - "description": "Revocation Registry identifier", - "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:(.+$)" - } - ], - "responses": { - "200": { - "description": "tails file", - "schema": { - "type": "string", - "format": "binary" - } - } - } - }, - "put": { - "tags": ["revocation"], - "summary": "Upload local tails file to server", - "produces": ["application/json"], - "parameters": [ - { - "name": "rev_reg_id", - "in": "path", - "description": "Revocation Registry identifier", - "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:(.+$)" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/RevocationModuleResponse" - } - } - } - } - }, - "/revocation/revoke": { - "post": { - "tags": ["revocation"], - "summary": "Revoke an issued credential", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/RevokeRequest" - } - }, - { - "name": "conn_id", - "in": "query", - "description": "Connection identifier", - "required": false, - "type": "string" - }, - { - "name": "create_transaction_for_endorser", - "in": "query", - "description": "Create Transaction For Endorser's signature", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/RevocationModuleResponse" - } - } - } - } - }, - "/schemas": { - "post": { - "tags": ["schema"], - "summary": "Sends a schema to the ledger", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/SchemaSendRequest" - } - }, - { - "name": "conn_id", - "in": "query", - "description": "Connection identifier", - "required": false, - "type": "string" - }, - { - "name": "create_transaction_for_endorser", - "in": "query", - "description": "Create Transaction For Endorser's signature", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TxnOrSchemaSendResult" - } - } - } - } - }, - "/schemas/created": { - "get": { - "tags": ["schema"], - "summary": "Search for matching schema that agent originated", - "produces": ["application/json"], - "parameters": [ - { - "name": "schema_id", - "in": "query", - "description": "Schema identifier", - "required": false, - "type": "string", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - }, - { - "name": "schema_issuer_did", - "in": "query", - "description": "Schema issuer DID", - "required": false, - "type": "string", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - { - "name": "schema_name", - "in": "query", - "description": "Schema name", - "required": false, - "type": "string" - }, - { - "name": "schema_version", - "in": "query", - "description": "Schema version", - "required": false, - "type": "string", - "pattern": "^[0-9.]+$" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/SchemasCreatedResult" - } - } - } - } - }, - "/schemas/{schema_id}": { - "get": { - "tags": ["schema"], - "summary": "Gets a schema from the ledger", - "produces": ["application/json"], - "parameters": [ - { - "name": "schema_id", - "in": "path", - "description": "Schema identifier", - "required": true, - "type": "string", - "pattern": "^[1-9][0-9]*|[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/SchemaGetResult" - } - } - } - } - }, - "/schemas/{schema_id}/write_record": { - "post": { - "tags": ["schema"], - "summary": "Writes a schema non-secret record to the wallet", - "produces": ["application/json"], - "parameters": [ - { - "name": "schema_id", - "in": "path", - "description": "Schema identifier", - "required": true, - "type": "string", - "pattern": "^[1-9][0-9]*|[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/SchemaGetResult" - } - } - } - } - }, - "/settings": { - "get": { - "tags": ["settings"], - "summary": "Get the configurable settings associated with the profile.", - "produces": ["application/json"], - "parameters": [], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ProfileSettings" - } - } - } - }, - "put": { - "tags": ["settings"], - "summary": "Update configurable settings associated with the profile.", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/UpdateProfileSettings" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ProfileSettings" - } - } - } - } - }, - "/shutdown": { - "get": { - "tags": ["server"], - "summary": "Shut down server", - "produces": ["application/json"], - "parameters": [], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/AdminShutdown" - } - } - } - } - }, - "/status": { - "get": { - "tags": ["server"], - "summary": "Fetch the server status", - "produces": ["application/json"], - "parameters": [], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/AdminStatus" - } - } - } - } - }, - "/status/config": { - "get": { - "tags": ["server"], - "summary": "Fetch the server configuration", - "produces": ["application/json"], - "parameters": [], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/AdminConfig" - } - } - } - } - }, - "/status/live": { - "get": { - "tags": ["server"], - "summary": "Liveliness check", - "produces": ["application/json"], - "parameters": [], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/AdminStatusLiveliness" - } - } - } - } - }, - "/status/ready": { - "get": { - "tags": ["server"], - "summary": "Readiness check", - "produces": ["application/json"], - "parameters": [], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/AdminStatusReadiness" - } - } - } - } - }, - "/status/reset": { - "post": { - "tags": ["server"], - "summary": "Reset statistics", - "produces": ["application/json"], - "parameters": [], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/AdminReset" - } - } - } - } - }, - "/transaction/{tran_id}/resend": { - "post": { - "tags": ["endorse-transaction"], - "summary": "For Author to resend a particular transaction request", - "produces": ["application/json"], - "parameters": [ - { - "name": "tran_id", - "in": "path", - "description": "Transaction identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TransactionRecord" - } - } - } - } - }, - "/transactions": { - "get": { - "tags": ["endorse-transaction"], - "summary": "Query transactions", - "produces": ["application/json"], - "parameters": [], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TransactionList" - } - } - } - } - }, - "/transactions/create-request": { - "post": { - "tags": ["endorse-transaction"], - "summary": "For author to send a transaction request", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/Date" - } - }, - { - "name": "tran_id", - "in": "query", - "description": "Transaction identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TransactionRecord" - } - } - } - } - }, - "/transactions/{conn_id}/set-endorser-info": { - "post": { - "tags": ["endorse-transaction"], - "summary": "Set Endorser Info", - "produces": ["application/json"], - "parameters": [ - { - "name": "conn_id", - "in": "path", - "description": "Connection identifier", - "required": true, - "type": "string" - }, - { - "name": "endorser_did", - "in": "query", - "description": "Endorser DID", - "required": true, - "type": "string" - }, - { - "name": "endorser_name", - "in": "query", - "description": "Endorser Name", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/EndorserInfo" - } - } - } - } - }, - "/transactions/{conn_id}/set-endorser-role": { - "post": { - "tags": ["endorse-transaction"], - "summary": "Set transaction jobs", - "produces": ["application/json"], - "parameters": [ - { - "name": "conn_id", - "in": "path", - "description": "Connection identifier", - "required": true, - "type": "string" - }, - { - "name": "transaction_my_job", - "in": "query", - "description": "Transaction related jobs", - "required": false, - "type": "string", - "enum": ["TRANSACTION_AUTHOR", "TRANSACTION_ENDORSER", "reset"] - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TransactionJobs" - } - } - } - } - }, - "/transactions/{tran_id}": { - "get": { - "tags": ["endorse-transaction"], - "summary": "Fetch a single transaction record", - "produces": ["application/json"], - "parameters": [ - { - "name": "tran_id", - "in": "path", - "description": "Transaction identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TransactionRecord" - } - } - } - } - }, - "/transactions/{tran_id}/cancel": { - "post": { - "tags": ["endorse-transaction"], - "summary": "For Author to cancel a particular transaction request", - "produces": ["application/json"], - "parameters": [ - { - "name": "tran_id", - "in": "path", - "description": "Transaction identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TransactionRecord" - } - } - } - } - }, - "/transactions/{tran_id}/endorse": { - "post": { - "tags": ["endorse-transaction"], - "summary": "For Endorser to endorse a particular transaction record", - "produces": ["application/json"], - "parameters": [ - { - "name": "tran_id", - "in": "path", - "description": "Transaction identifier", - "required": true, - "type": "string" - }, - { - "name": "endorser_did", - "in": "query", - "description": "Endorser DID", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TransactionRecord" - } - } - } - } - }, - "/transactions/{tran_id}/refuse": { - "post": { - "tags": ["endorse-transaction"], - "summary": "For Endorser to refuse a particular transaction record", - "produces": ["application/json"], - "parameters": [ - { - "name": "tran_id", - "in": "path", - "description": "Transaction identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TransactionRecord" - } - } - } - } - }, - "/transactions/{tran_id}/write": { - "post": { - "tags": ["endorse-transaction"], - "summary": "For Author / Endorser to write an endorsed transaction to the ledger", - "produces": ["application/json"], - "parameters": [ - { - "name": "tran_id", - "in": "path", - "description": "Transaction identifier", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TransactionRecord" - } - } - } - } - }, - "/vc/credentials": { - "get": { - "tags": ["vc-api"], - "summary": "List credentials", - "produces": ["application/json"], - "parameters": [], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ListCredentialsResponse" - } - } - } - } - }, - "/vc/credentials/issue": { - "post": { - "tags": ["vc-api"], - "summary": "Issue a credential", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/IssueCredentialRequest" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/IssueCredentialResponse" - } - } - } - } - }, - "/vc/credentials/store": { - "post": { - "tags": ["vc-api"], - "summary": "Store a credential", - "produces": ["application/json"], - "parameters": [], - "responses": {} - } - }, - "/vc/credentials/verify": { - "post": { - "tags": ["vc-api"], - "summary": "Verify a credential", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/VerifyCredentialRequest" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/VerifyCredentialResponse" - } - } - } - } - }, - "/vc/credentials/{credential_id}": { - "get": { - "tags": ["vc-api"], - "summary": "Fetch credential by ID", - "produces": ["application/json"], - "parameters": [ - { - "name": "credential_id", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/FetchCredentialResponse" - } - } - } - } - }, - "/vc/presentations/prove": { - "post": { - "tags": ["vc-api"], - "summary": "Prove a presentation", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/ProvePresentationRequest" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ProvePresentationResponse" - } - } - } - } - }, - "/vc/presentations/verify": { - "post": { - "tags": ["vc-api"], - "summary": "Verify a Presentation", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/VerifyPresentationRequest" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/VerifyPresentationResponse" - } - } - } - } - }, - "/wallet/did": { - "get": { - "tags": ["wallet"], - "summary": "List wallet DIDs", - "produces": ["application/json"], - "parameters": [ - { - "name": "did", - "in": "query", - "description": "DID of interest", - "required": false, - "type": "string", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$" - }, - { - "name": "key_type", - "in": "query", - "description": "Key type to query for.", - "required": false, - "type": "string", - "enum": ["ed25519", "bls12381g2"] - }, - { - "name": "method", - "in": "query", - "description": "DID method to query for. e.g. sov to only fetch indy/sov DIDs", - "required": false, - "type": "string", - "enum": ["key", "sov", "did:peer:2", "did:peer:4"] - }, - { - "name": "posture", - "in": "query", - "description": "Whether DID is current public DID, posted to ledger but current public DID, or local to the wallet", - "required": false, - "type": "string", - "enum": ["public", "posted", "wallet_only"] - }, - { - "name": "verkey", - "in": "query", - "description": "Verification key of interest", - "required": false, - "type": "string", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/DIDList" - } - } - } - } - }, - "/wallet/did/create": { - "post": { - "tags": ["wallet"], - "summary": "Create a local DID", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/DIDCreate" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/DIDResult" - } - } - } - } - }, - "/wallet/did/local/rotate-keypair": { - "patch": { - "tags": ["wallet"], - "summary": "Rotate keypair for a DID not posted to the ledger", - "produces": ["application/json"], - "parameters": [ - { - "name": "did", - "in": "query", - "description": "DID of interest", - "required": true, - "type": "string", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/WalletModuleResponse" - } - } - } - } - }, - "/wallet/did/public": { - "get": { - "tags": ["wallet"], - "summary": "Fetch the current public DID", - "produces": ["application/json"], - "parameters": [], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/DIDResult" - } - } - } - }, - "post": { - "tags": ["wallet"], - "summary": "Assign the current public DID", - "produces": ["application/json"], - "parameters": [ - { - "name": "did", - "in": "query", - "description": "DID of interest", - "required": true, - "type": "string", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$" - }, - { - "name": "conn_id", - "in": "query", - "description": "Connection identifier", - "required": false, - "type": "string" - }, - { - "name": "create_transaction_for_endorser", - "in": "query", - "description": "Create Transaction For Endorser's signature", - "required": false, - "type": "boolean" - }, - { - "name": "mediation_id", - "in": "query", - "description": "Mediation identifier", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/DIDResult" - } - } - } - } - }, - "/wallet/get-did-endpoint": { - "get": { - "tags": ["wallet"], - "summary": "Query DID endpoint in wallet", - "produces": ["application/json"], - "parameters": [ - { - "name": "did", - "in": "query", - "description": "DID of interest", - "required": true, - "type": "string", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/DIDEndpoint" - } - } - } - } - }, - "/wallet/jwt/sign": { - "post": { - "tags": ["wallet"], - "summary": "Create a EdDSA jws using did keys with a given payload", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/JWSCreate" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/WalletModuleResponse" - } - } - } - } - }, - "/wallet/jwt/verify": { - "post": { - "tags": ["wallet"], - "summary": "Verify a EdDSA jws using did keys with a given JWS", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/JWSVerify" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/JWSVerifyResponse" - } - } - } - } - }, - "/wallet/sd-jwt/sign": { - "post": { - "tags": ["wallet"], - "summary": "Create a EdDSA sd-jws using did keys with a given payload", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/SDJWSCreate" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/WalletModuleResponse" - } - } - } - } - }, - "/wallet/sd-jwt/verify": { - "post": { - "tags": ["wallet"], - "summary": "Verify a EdDSA sd-jws using did keys with a given SD-JWS with optional key binding", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/SDJWSVerify" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/SDJWSVerifyResponse" - } - } - } - } - }, - "/wallet/set-did-endpoint": { - "post": { - "tags": ["wallet"], - "summary": "Update endpoint in wallet and on ledger if posted to it", - "produces": ["application/json"], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/DIDEndpointWithType" - } - }, - { - "name": "conn_id", - "in": "query", - "description": "Connection identifier", - "required": false, - "type": "string" - }, - { - "name": "create_transaction_for_endorser", - "in": "query", - "description": "Create Transaction For Endorser's signature", - "required": false, - "type": "boolean" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/WalletModuleResponse" - } - } - } - } - } - }, - "securityDefinitions": { - "AuthorizationHeader": { - "description": "Bearer token. Be sure to prepend token with 'Bearer '", - "type": "apiKey", - "name": "Authorization", - "in": "header" - } - }, - "definitions": { - "AMLRecord": { - "type": "object", - "properties": { - "aml": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "amlContext": { - "type": "string" - }, - "version": { - "type": "string" - } - } - }, - "ActionMenuFetchResult": { - "type": "object", - "properties": { - "result": { - "$ref": "#/definitions/ActionMenuFetchResult_result" - } - } - }, - "ActionMenuModulesResult": { - "type": "object" - }, - "AdminConfig": { - "type": "object", - "required": ["config"], - "properties": { - "config": { - "type": "object", - "description": "Configuration settings", - "properties": {} - } - } - }, - "AdminMediationDeny": { - "type": "object" - }, - "AdminModules": { - "type": "object", - "properties": { - "result": { - "type": "array", - "description": "List of admin modules", - "items": { - "type": "string", - "description": "admin module" - } - } - } - }, - "AdminReset": { - "type": "object" - }, - "AdminShutdown": { - "type": "object" - }, - "AdminStatus": { - "type": "object", - "properties": { - "conductor": { - "type": "object", - "description": "Conductor statistics", - "properties": {} - }, - "label": { - "type": "string", - "description": "Default label", - "x-nullable": true - }, - "timing": { - "type": "object", - "description": "Timing results", - "properties": {} - }, - "version": { - "type": "string", - "description": "Version code" - } - } - }, - "AdminStatusLiveliness": { - "type": "object", - "properties": { - "alive": { - "type": "boolean", - "example": true, - "description": "Liveliness status" - } - } - }, - "AdminStatusReadiness": { - "type": "object", - "properties": { - "ready": { - "type": "boolean", - "example": true, - "description": "Readiness status" - } - } - }, - "AnonCredsSchema": { - "type": "object", - "properties": { - "attrNames": { - "type": "array", - "description": "Schema attribute names", - "items": { - "type": "string", - "example": "score", - "description": "Attribute name" - } - }, - "issuerId": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv", - "description": "Issuer Identifier of the credential definition or schema" - }, - "name": { - "type": "string", - "example": "Example schema", - "description": "Schema name" - }, - "version": { - "type": "string", - "example": "1.0", - "description": "Schema version" - } - } - }, - "AttachDecorator": { - "type": "object", - "required": ["data"], - "properties": { - "@id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Attachment identifier" - }, - "byte_count": { - "type": "integer", - "example": 1234, - "description": "Byte count of data included by reference" - }, - "data": { - "$ref": "#/definitions/AttachDecoratorData" - }, - "description": { - "type": "string", - "example": "view from doorway, facing east, with lights off", - "description": "Human-readable description of content" - }, - "filename": { - "type": "string", - "example": "IMG1092348.png", - "description": "File name" - }, - "lastmod_time": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Hint regarding last modification datetime, in ISO-8601 format", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "mime-type": { - "type": "string", - "example": "image/png", - "description": "MIME type" - } - } - }, - "AttachDecoratorData": { - "type": "object", - "properties": { - "base64": { - "type": "string", - "example": "ey4uLn0=", - "description": "Base64-encoded data", - "pattern": "^[a-zA-Z0-9+/]*={0,2}$" - }, - "json": { - "example": "{\"sample\": \"content\"}", - "description": "JSON-serialized data" - }, - "jws": { - "$ref": "#/definitions/AttachDecoratorData_jws" - }, - "links": { - "type": "array", - "description": "List of hypertext links to data", - "items": { - "type": "string", - "example": "https://link.to/data" - } - }, - "sha256": { - "type": "string", - "example": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb", - "description": "SHA256 hash (binhex encoded) of content", - "pattern": "^[a-fA-F0-9+/]{64}$" - } - } - }, - "AttachDecoratorData1JWS": { - "type": "object", - "required": ["header", "signature"], - "properties": { - "header": { - "$ref": "#/definitions/AttachDecoratorDataJWSHeader" - }, - "protected": { - "type": "string", - "example": "ey4uLn0", - "description": "protected JWS header", - "pattern": "^[-_a-zA-Z0-9]*$" - }, - "signature": { - "type": "string", - "example": "ey4uLn0", - "description": "signature", - "pattern": "^[-_a-zA-Z0-9]*$" - } - } - }, - "AttachDecoratorDataJWS": { - "type": "object", - "properties": { - "header": { - "$ref": "#/definitions/AttachDecoratorDataJWSHeader" - }, - "protected": { - "type": "string", - "example": "ey4uLn0", - "description": "protected JWS header", - "pattern": "^[-_a-zA-Z0-9]*$" - }, - "signature": { - "type": "string", - "example": "ey4uLn0", - "description": "signature", - "pattern": "^[-_a-zA-Z0-9]*$" - }, - "signatures": { - "type": "array", - "description": "List of signatures", - "items": { - "$ref": "#/definitions/AttachDecoratorData1JWS" - } - } - } - }, - "AttachDecoratorDataJWSHeader": { - "type": "object", - "required": ["kid"], - "properties": { - "kid": { - "type": "string", - "example": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4", - "description": "Key identifier, in W3C did:key or DID URL format", - "pattern": "^did:(?:key:z[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+|sov:[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}(;.*)?(\\?.*)?#.+)$" - } - } - }, - "AttachmentDef": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "attachment-0", - "description": "Attachment identifier" - }, - "type": { - "type": "string", - "example": "present-proof", - "description": "Attachment type", - "enum": ["credential-offer", "present-proof"] - } - } - }, - "AttributeMimeTypesResult": { - "type": "object", - "properties": { - "results": { - "type": "object", - "additionalProperties": { - "type": "string", - "description": "MIME type" - }, - "x-nullable": true - } - } - }, - "BasicMessageModuleResponse": { - "type": "object" - }, - "ClaimFormat": { - "type": "object", - "properties": { - "di_vc": { - "type": "object", - "properties": {} - }, - "jwt": { - "type": "object", - "properties": {} - }, - "jwt_vc": { - "type": "object", - "properties": {} - }, - "jwt_vp": { - "type": "object", - "properties": {} - }, - "ldp": { - "type": "object", - "properties": {} - }, - "ldp_vc": { - "type": "object", - "properties": {} - }, - "ldp_vp": { - "type": "object", - "properties": {} - } - } - }, - "ClearPendingRevocationsRequest": { - "type": "object", - "properties": { - "purge": { - "type": "object", - "description": "Credential revocation ids by revocation registry id: omit for all, specify null or empty list for all pending per revocation registry", - "additionalProperties": { - "type": "array", - "items": { - "type": "string", - "example": "12345", - "description": "Credential revocation identifier", - "pattern": "^[1-9][0-9]*$" - } - } - } - } - }, - "ConfigurableWriteLedgers": { - "type": "object", - "properties": { - "write_ledgers": { - "type": "array", - "description": "List of configurable write ledgers identifiers", - "items": { - "type": "string", - "description": "Ledgers identifiers" - } - } - } - }, - "ConnRecord": { - "type": "object", - "required": ["connection_id"], - "properties": { - "accept": { - "type": "string", - "example": "auto", - "description": "Connection acceptance: manual or auto", - "enum": ["manual", "auto"] - }, - "alias": { - "type": "string", - "example": "Bob, providing quotes", - "description": "Optional alias to apply to connection for later use" - }, - "connection_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Connection identifier" - }, - "connection_protocol": { - "type": "string", - "example": "connections/1.0", - "description": "Connection protocol used", - "enum": ["connections/1.0", "didexchange/1.0", "didexchange/1.1"] - }, - "created_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of record creation", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "error_msg": { - "type": "string", - "example": "No DIDDoc provided; cannot connect to public DID", - "description": "Error message" - }, - "inbound_connection_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Inbound routing connection id to use" - }, - "invitation_key": { - "type": "string", - "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description": "Public key for connection", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - }, - "invitation_mode": { - "type": "string", - "example": "once", - "description": "Invitation mode", - "enum": ["once", "multi", "static"] - }, - "invitation_msg_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "ID of out-of-band invitation message" - }, - "my_did": { - "type": "string", - "example": "did:peer:WgWxqztrNooG92RXvxSTWv", - "description": "Our DID for connection", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$" - }, - "request_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Connection request identifier" - }, - "rfc23_state": { - "type": "string", - "example": "invitation-sent", - "description": "State per RFC 23", - "readOnly": true - }, - "state": { - "type": "string", - "example": "active", - "description": "Current record state" - }, - "their_did": { - "type": "string", - "example": "did:peer:WgWxqztrNooG92RXvxSTWv", - "description": "Their DID for connection", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$" - }, - "their_label": { - "type": "string", - "example": "Bob", - "description": "Their label for connection" - }, - "their_public_did": { - "type": "string", - "example": "2cpBmR3FqGKWi5EyUbpRY8", - "description": "Other agent's public DID for connection" - }, - "their_role": { - "type": "string", - "example": "requester", - "description": "Their role in the connection protocol", - "enum": ["invitee", "requester", "inviter", "responder"] - }, - "updated_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of last record update", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - } - } - }, - "ConnectionInvitation": { - "type": "object", - "properties": { - "@id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Message identifier" - }, - "@type": { - "type": "string", - "example": "https://didcomm.org/my-family/1.0/my-message-type", - "description": "Message type" - }, - "did": { - "type": "string", - "example": "did:peer:WgWxqztrNooG92RXvxSTWv", - "description": "DID for connection invitation", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$" - }, - "imageUrl": { - "type": "string", - "format": "url", - "example": "http://192.168.56.101/img/logo.jpg", - "description": "Optional image URL for connection invitation", - "x-nullable": true - }, - "label": { - "type": "string", - "example": "Bob", - "description": "Optional label for connection invitation" - }, - "recipientKeys": { - "type": "array", - "description": "List of recipient keys", - "items": { - "type": "string", - "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description": "Recipient public key", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - } - }, - "routingKeys": { - "type": "array", - "description": "List of routing keys", - "items": { - "type": "string", - "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description": "Routing key", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - } - }, - "serviceEndpoint": { - "type": "string", - "example": "http://192.168.56.101:8020", - "description": "Service endpoint at which to reach this agent" - } - } - }, - "ConnectionList": { - "type": "object", - "required": ["results"], - "properties": { - "results": { - "type": "array", - "description": "List of connection records", - "items": { - "$ref": "#/definitions/ConnRecord" - } - } - } - }, - "ConnectionMetadata": { - "type": "object", - "properties": { - "results": { - "type": "object", - "description": "Dictionary of metadata associated with connection.", - "properties": {} - } - } - }, - "ConnectionMetadataSetRequest": { - "type": "object", - "required": ["metadata"], - "properties": { - "metadata": { - "type": "object", - "description": "Dictionary of metadata to set for connection.", - "properties": {} - } - } - }, - "ConnectionModuleResponse": { - "type": "object" - }, - "ConnectionStaticRequest": { - "type": "object", - "properties": { - "alias": { - "type": "string", - "description": "Alias to assign to this connection" - }, - "my_did": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv", - "description": "Local DID", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "my_seed": { - "type": "string", - "description": "Seed to use for the local DID" - }, - "their_did": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv", - "description": "Remote DID", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "their_endpoint": { - "type": "string", - "example": "https://myhost:8021", - "description": "URL endpoint for other party", - "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$" - }, - "their_label": { - "type": "string", - "description": "Other party's label for this connection" - }, - "their_seed": { - "type": "string", - "description": "Seed to use for the remote DID" - }, - "their_verkey": { - "type": "string", - "description": "Remote verification key" - } - } - }, - "ConnectionStaticResult": { - "type": "object", - "required": [ - "my_did", - "my_endpoint", - "my_verkey", - "record", - "their_did", - "their_verkey" - ], - "properties": { - "my_did": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv", - "description": "Local DID", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "my_endpoint": { - "type": "string", - "example": "https://myhost:8021", - "description": "My URL endpoint", - "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$" - }, - "my_verkey": { - "type": "string", - "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description": "My verification key", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - }, - "record": { - "$ref": "#/definitions/ConnRecord" - }, - "their_did": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv", - "description": "Remote DID", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "their_verkey": { - "type": "string", - "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description": "Remote verification key", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - } - } - }, - "Constraints": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "$ref": "#/definitions/DIFField" - } - }, - "is_holder": { - "type": "array", - "items": { - "$ref": "#/definitions/DIFHolder" - } - }, - "limit_disclosure": { - "type": "string", - "description": "LimitDisclosure" - }, - "status_active": { - "type": "string", - "enum": ["required", "allowed", "disallowed"] - }, - "status_revoked": { - "type": "string", - "enum": ["required", "allowed", "disallowed"] - }, - "status_suspended": { - "type": "string", - "enum": ["required", "allowed", "disallowed"] - }, - "subject_is_issuer": { - "type": "string", - "description": "SubjectIsIssuer", - "enum": ["required", "preferred"] - } - } - }, - "CreateInvitationRequest": { - "type": "object", - "properties": { - "mediation_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Identifier for active mediation record to be used", - "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}" - }, - "metadata": { - "type": "object", - "description": "Optional metadata to attach to the connection created with the invitation", - "properties": {} - }, - "my_label": { - "type": "string", - "example": "Bob", - "description": "Optional label for connection invitation" - }, - "recipient_keys": { - "type": "array", - "description": "List of recipient keys", - "items": { - "type": "string", - "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description": "Recipient public key", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - } - }, - "routing_keys": { - "type": "array", - "description": "List of routing keys", - "items": { - "type": "string", - "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description": "Routing key", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - } - }, - "service_endpoint": { - "type": "string", - "example": "http://192.168.56.102:8020", - "description": "Connection endpoint" - } - } - }, - "CreateWalletRequest": { - "type": "object", - "properties": { - "extra_settings": { - "type": "object", - "description": "Agent config key-value pairs", - "properties": {} - }, - "image_url": { - "type": "string", - "example": "https://aries.ca/images/sample.png", - "description": "Image url for this wallet. This image url is publicized (self-attested) to other agents as part of forming a connection." - }, - "key_management_mode": { - "type": "string", - "example": "managed", - "description": "Key management method to use for this wallet.", - "enum": ["managed"] - }, - "label": { - "type": "string", - "example": "Alice", - "description": "Label for this wallet. This label is publicized (self-attested) to other agents as part of forming a connection." - }, - "wallet_dispatch_type": { - "type": "string", - "example": "default", - "description": "Webhook target dispatch type for this wallet. default: Dispatch only to webhooks associated with this wallet. base: Dispatch only to webhooks associated with the base wallet. both: Dispatch to both webhook targets.", - "enum": ["default", "both", "base"] - }, - "wallet_key": { - "type": "string", - "example": "MySecretKey123", - "description": "Master key used for key derivation." - }, - "wallet_key_derivation": { - "type": "string", - "example": "RAW", - "description": "Key derivation", - "enum": ["ARGON2I_MOD", "ARGON2I_INT", "RAW"] - }, - "wallet_name": { - "type": "string", - "example": "MyNewWallet", - "description": "Wallet name" - }, - "wallet_type": { - "type": "string", - "example": "askar", - "description": "Type of the wallet to create. Must be same as base wallet.", - "enum": ["askar", "askar-anoncreds", "in_memory"] - }, - "wallet_webhook_urls": { - "type": "array", - "description": "List of Webhook URLs associated with this subwallet", - "items": { - "type": "string", - "example": "http://localhost:8022/webhooks", - "description": "Optional webhook URL to receive webhook messages" - } - } - } - }, - "CreateWalletResponse": { - "type": "object", - "required": ["key_management_mode", "wallet_id"], - "properties": { - "created_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of record creation", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "key_management_mode": { - "type": "string", - "description": "Mode regarding management of wallet key", - "enum": ["managed", "unmanaged"] - }, - "settings": { - "type": "object", - "description": "Settings for this wallet.", - "properties": {} - }, - "state": { - "type": "string", - "example": "active", - "description": "Current record state" - }, - "token": { - "type": "string", - "example": "eyJhbGciOiJFZERTQSJ9.eyJhIjogIjAifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk", - "description": "Authorization token to authenticate wallet requests" - }, - "updated_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of last record update", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "wallet_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Wallet record ID" - } - } - }, - "CreateWalletTokenRequest": { - "type": "object", - "properties": { - "wallet_key": { - "type": "string", - "example": "MySecretKey123", - "description": "Master key used for key derivation. Only required for unmanaged wallets." - } - } - }, - "CreateWalletTokenResponse": { - "type": "object", - "properties": { - "token": { - "type": "string", - "example": "eyJhbGciOiJFZERTQSJ9.eyJhIjogIjAifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk", - "description": "Authorization token to authenticate wallet requests" - } - } - }, - "CredAttrSpec": { - "type": "object", - "required": ["name", "value"], - "properties": { - "mime-type": { - "type": "string", - "example": "image/jpeg", - "description": "MIME type: omit for (null) default", - "x-nullable": true - }, - "name": { - "type": "string", - "example": "favourite_drink", - "description": "Attribute name" - }, - "value": { - "type": "string", - "example": "martini", - "description": "Attribute value: base64-encode if MIME type is present" - } - } - }, - "CredDef": { - "type": "object", - "properties": { - "issuerId": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv", - "description": "Issuer Identifier of the credential definition or schema" - }, - "schemaId": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description": "Schema identifier" - }, - "tag": { - "type": "string", - "example": "default", - "description": "The tag value passed in by the Issuer to an AnonCred's Credential Definition create and store implementation." - }, - "type": { - "type": "string", - "enum": ["CL"] - }, - "value": { - "$ref": "#/definitions/CredDefValueSchemaAnoncreds" - } - } - }, - "CredDefPostOptions": { - "type": "object", - "properties": { - "create_transaction_for_endorser": { - "type": "boolean", - "example": false, - "description": "Create transaction for endorser (optional, default false). Use this for agents who don't specify an author role but want to create a transaction for an endorser to sign." - }, - "endorser_connection_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Connection identifier (optional) (this is an example). You can set this if you know the endorser's connection id you want to use. If not specified then the agent will attempt to find an endorser connection." - }, - "revocation_registry_size": { - "type": "integer", - "example": 1000, - "description": "Maximum number of credential revocations per registry" - }, - "support_revocation": { - "type": "boolean", - "description": "Support credential revocation" - } - } - }, - "CredDefPostRequest": { - "type": "object", - "properties": { - "credential_definition": { - "$ref": "#/definitions/InnerCredDef" - }, - "options": { - "$ref": "#/definitions/CredDefPostOptions" - } - } - }, - "CredDefResult": { - "type": "object", - "properties": { - "credential_definition_metadata": { - "type": "object", - "properties": {} - }, - "credential_definition_state": { - "$ref": "#/definitions/CredDefState" - }, - "job_id": { - "type": "string" - }, - "registration_metadata": { - "type": "object", - "properties": {} - } - } - }, - "CredDefState": { - "type": "object", - "properties": { - "credential_definition": { - "$ref": "#/definitions/CredDefState_credential_definition" - }, - "credential_definition_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description": "credential definition id", - "x-nullable": true - }, - "state": { - "type": "string", - "enum": ["finished", "failed", "action", "wait"] - } - } - }, - "CredDefValue": { - "type": "object", - "properties": { - "primary": { - "$ref": "#/definitions/CredDefValue_primary" - }, - "revocation": { - "$ref": "#/definitions/CredDefValue_revocation" - } - } - }, - "CredDefValuePrimary": { - "type": "object", - "properties": { - "n": { - "type": "string", - "example": "0", - "pattern": "^[0-9]*$" - }, - "r": { - "$ref": "#/definitions/Generated" - }, - "rctxt": { - "type": "string", - "example": "0", - "pattern": "^[0-9]*$" - }, - "s": { - "type": "string", - "example": "0", - "pattern": "^[0-9]*$" - }, - "z": { - "type": "string", - "example": "0", - "pattern": "^[0-9]*$" - } - } - }, - "CredDefValuePrimarySchemaAnoncreds": { - "type": "object", - "properties": { - "n": { - "type": "string", - "example": "0", - "pattern": "^[0-9]*$" - }, - "r": { - "type": "object", - "properties": {} - }, - "rctxt": { - "type": "string", - "example": "0", - "pattern": "^[0-9]*$" - }, - "s": { - "type": "string", - "example": "0", - "pattern": "^[0-9]*$" - }, - "z": { - "type": "string", - "example": "0", - "pattern": "^[0-9]*$" - } - } - }, - "CredDefValueRevocation": { - "type": "object", - "properties": { - "g": { - "type": "string", - "example": "1 1F14F&ECB578F 2 095E45DDF417D" - }, - "g_dash": { - "type": "string", - "example": "1 1D64716fCDC00C 1 0C781960FA66E3D3 2 095E45DDF417D" - }, - "h": { - "type": "string", - "example": "1 16675DAE54BFAE8 2 095E45DD417D" - }, - "h0": { - "type": "string", - "example": "1 21E5EF9476EAF18 2 095E45DDF417D" - }, - "h1": { - "type": "string", - "example": "1 236D1D99236090 2 095E45DDF417D" - }, - "h2": { - "type": "string", - "example": "1 1C3AE8D1F1E277 2 095E45DDF417D" - }, - "h_cap": { - "type": "string", - "example": "1 1B2A32CF3167 1 2490FEBF6EE55 1 0000000000000000" - }, - "htilde": { - "type": "string", - "example": "1 1D8549E8C0F8 2 095E45DDF417D" - }, - "pk": { - "type": "string", - "example": "1 142CD5E5A7DC 1 153885BD903312 2 095E45DDF417D" - }, - "u": { - "type": "string", - "example": "1 0C430AAB2B4710 1 1CB3A0932EE7E 1 0000000000000000" - }, - "y": { - "type": "string", - "example": "1 153558BD903312 2 095E45DDF417D 1 0000000000000000" - } - } - }, - "CredDefValueRevocationSchemaAnoncreds": { - "type": "object", - "properties": { - "g": { - "type": "string", - "example": "1 1F14F&ECB578F 2 095E45DDF417D" - }, - "g_dash": { - "type": "string", - "example": "1 1D64716fCDC00C 1 0C781960FA66E3D3 2 095E45DDF417D" - }, - "h": { - "type": "string", - "example": "1 16675DAE54BFAE8 2 095E45DD417D" - }, - "h0": { - "type": "string", - "example": "1 21E5EF9476EAF18 2 095E45DDF417D" - }, - "h1": { - "type": "string", - "example": "1 236D1D99236090 2 095E45DDF417D" - }, - "h2": { - "type": "string", - "example": "1 1C3AE8D1F1E277 2 095E45DDF417D" - }, - "h_cap": { - "type": "string", - "example": "1 1B2A32CF3167 1 2490FEBF6EE55 1 0000000000000000" - }, - "htilde": { - "type": "string", - "example": "1 1D8549E8C0F8 2 095E45DDF417D" - }, - "pk": { - "type": "string", - "example": "1 142CD5E5A7DC 1 153885BD903312 2 095E45DDF417D" - }, - "u": { - "type": "string", - "example": "1 0C430AAB2B4710 1 1CB3A0932EE7E 1 0000000000000000" - }, - "y": { - "type": "string", - "example": "1 153558BD903312 2 095E45DDF417D 1 0000000000000000" - } - } - }, - "CredDefValueSchemaAnoncreds": { - "type": "object", - "properties": { - "primary": { - "$ref": "#/definitions/CredDefValue_primary" - }, - "revocation": { - "$ref": "#/definitions/CredDefValue_revocation" - } - } - }, - "CredInfoList": { - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/definitions/IndyCredInfo" - } - } - } - }, - "CredRevIndyRecordsResult": { - "type": "object", - "properties": { - "rev_reg_delta": { - "type": "object", - "description": "Indy revocation registry delta", - "properties": {} - } - } - }, - "CredRevIndyRecordsResultSchemaAnoncreds": { - "type": "object", - "properties": { - "rev_reg_delta": { - "type": "object", - "description": "Indy revocation registry delta", - "properties": {} - } - } - }, - "CredRevRecordDetailsResult": { - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/definitions/IssuerCredRevRecord" - } - } - } - }, - "CredRevRecordDetailsResultSchemaAnoncreds": { - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/definitions/IssuerCredRevRecordSchemaAnoncreds" - } - } - } - }, - "CredRevRecordResult": { - "type": "object", - "properties": { - "result": { - "$ref": "#/definitions/IssuerCredRevRecord" - } - } - }, - "CredRevRecordResultSchemaAnoncreds": { - "type": "object", - "properties": { - "result": { - "$ref": "#/definitions/IssuerCredRevRecordSchemaAnoncreds" - } - } - }, - "CredRevokedResult": { - "type": "object", - "properties": { - "revoked": { - "type": "boolean", - "description": "Whether credential is revoked on the ledger" - } - } - }, - "Credential": { - "type": "object", - "required": [ - "@context", - "credentialSubject", - "issuanceDate", - "issuer", - "type" - ], - "properties": { - "@context": { - "type": "array", - "example": [ - "https://www.w3.org/2018/credentials/v1", - "https://www.w3.org/2018/credentials/examples/v1" - ], - "description": "The JSON-LD context of the credential", - "items": {} - }, - "credentialStatus": { - "example": "" - }, - "credentialSubject": { - "example": "" - }, - "expirationDate": { - "type": "string", - "example": "2010-01-01T19:23:24Z", - "description": "The expiration date", - "pattern": "^([0-9]{4})-([0-9]{2})-([0-9]{2})([Tt ]([0-9]{2}):([0-9]{2}):([0-9]{2})(\\.[0-9]+)?)?(([Zz]|([+-])([0-9]{2}):([0-9]{2})))?$" - }, - "id": { - "type": "string", - "example": "http://example.edu/credentials/1872", - "description": "The ID of the credential", - "pattern": "\\w+:(\\/?\\/?)[^\\s]+" - }, - "issuanceDate": { - "type": "string", - "example": "2010-01-01T19:23:24Z", - "description": "The issuance date", - "pattern": "^([0-9]{4})-([0-9]{2})-([0-9]{2})([Tt ]([0-9]{2}):([0-9]{2}):([0-9]{2})(\\.[0-9]+)?)?(([Zz]|([+-])([0-9]{2}):([0-9]{2})))?$" - }, - "issuer": { - "example": "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH", - "description": "The JSON-LD Verifiable Credential Issuer. Either string of object with id field." - }, - "proof": { - "$ref": "#/definitions/Credential_proof" - }, - "type": { - "type": "array", - "example": ["VerifiableCredential", "AlumniCredential"], - "description": "The JSON-LD type of the credential", - "items": { - "type": "string" - } - } - }, - "additionalProperties": true - }, - "CredentialDefinition": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description": "Credential definition identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "schemaId": { - "type": "string", - "example": "20", - "description": "Schema identifier within credential definition identifier" - }, - "tag": { - "type": "string", - "example": "tag", - "description": "Tag within credential definition identifier" - }, - "type": { - "example": "CL", - "description": "Signature type: CL for Camenisch-Lysyanskaya" - }, - "value": { - "$ref": "#/definitions/CredentialDefinition_value" - }, - "ver": { - "type": "string", - "example": "1.0", - "description": "Node protocol version", - "pattern": "^[0-9.]+$" - } - } - }, - "CredentialDefinitionGetResult": { - "type": "object", - "properties": { - "credential_definition": { - "$ref": "#/definitions/CredentialDefinition" - } - } - }, - "CredentialDefinitionSendRequest": { - "type": "object", - "properties": { - "revocation_registry_size": { - "type": "integer", - "example": 1000, - "description": "Revocation registry size", - "minimum": 4, - "maximum": 32768 - }, - "schema_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description": "Schema identifier", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - }, - "support_revocation": { - "type": "boolean", - "description": "Revocation supported flag" - }, - "tag": { - "type": "string", - "example": "default", - "description": "Credential definition identifier tag" - } - } - }, - "CredentialDefinitionSendResult": { - "type": "object", - "required": ["credential_definition_id"], - "properties": { - "credential_definition_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description": "Credential definition identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - } - } - }, - "CredentialDefinitionsCreatedResult": { - "type": "object", - "properties": { - "credential_definition_ids": { - "type": "array", - "items": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description": "Credential definition identifiers", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - } - } - } - }, - "CredentialOffer": { - "type": "object", - "required": ["offers~attach"], - "properties": { - "@id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Message identifier" - }, - "@type": { - "type": "string", - "example": "https://didcomm.org/my-family/1.0/my-message-type", - "description": "Message type" - }, - "comment": { - "type": "string", - "description": "Human-readable comment", - "x-nullable": true - }, - "credential_preview": { - "$ref": "#/definitions/CredentialPreview" - }, - "offers~attach": { - "type": "array", - "items": { - "$ref": "#/definitions/AttachDecorator" - } - } - } - }, - "CredentialPreview": { - "type": "object", - "required": ["attributes"], - "properties": { - "@type": { - "type": "string", - "example": "issue-credential/1.0/credential-preview", - "description": "Message type identifier" - }, - "attributes": { - "type": "array", - "items": { - "$ref": "#/definitions/CredAttrSpec" - } - } - } - }, - "CredentialProposal": { - "type": "object", - "properties": { - "@id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Message identifier" - }, - "@type": { - "type": "string", - "example": "https://didcomm.org/my-family/1.0/my-message-type", - "description": "Message type" - }, - "comment": { - "type": "string", - "description": "Human-readable comment", - "x-nullable": true - }, - "cred_def_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "credential_proposal": { - "$ref": "#/definitions/CredentialPreview" - }, - "issuer_did": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "schema_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - }, - "schema_issuer_did": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "schema_name": { - "type": "string" - }, - "schema_version": { - "type": "string", - "example": "1.0", - "pattern": "^[0-9.]+$" - } - } - }, - "CredentialStatusOptions": { - "type": "object", - "required": ["type"], - "properties": { - "type": { - "type": "string", - "example": "CredentialStatusList2017", - "description": "Credential status method type to use for the credential. Should match status method registered in the Verifiable Credential Extension Registry" - } - }, - "additionalProperties": true - }, - "DID": { - "type": "object", - "required": ["did", "key_type", "method", "posture", "verkey"], - "properties": { - "did": { - "type": "string", - "example": "did:peer:WgWxqztrNooG92RXvxSTWv", - "description": "DID of interest", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$" - }, - "key_type": { - "type": "string", - "example": "ed25519", - "description": "Key type associated with the DID", - "enum": ["ed25519", "bls12381g2"] - }, - "metadata": { - "type": "object", - "description": "Additional metadata associated with the DID", - "properties": {} - }, - "method": { - "type": "string", - "example": "sov", - "description": "Did method associated with the DID" - }, - "posture": { - "type": "string", - "example": "wallet_only", - "description": "Whether DID is current public DID, posted to ledger but not current public DID, or local to the wallet", - "enum": ["public", "posted", "wallet_only"] - }, - "verkey": { - "type": "string", - "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description": "Public verification key", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - } - } - }, - "DIDCreate": { - "type": "object", - "properties": { - "method": { - "type": "string", - "example": "sov", - "description": "Method for the requested DID.Supported methods are 'key', 'sov', and any other registered method." - }, - "options": { - "$ref": "#/definitions/DIDCreate_options" - }, - "seed": { - "type": "string", - "example": "000000000000000000000000Trustee1", - "description": "Optional seed to use for DID, Must be enabled in configuration before use." - } - } - }, - "DIDCreateOptions": { - "type": "object", - "required": ["key_type"], - "properties": { - "did": { - "type": "string", - "example": "did:peer:WgWxqztrNooG92RXvxSTWv", - "description": "Specify final value of the did (including did:: prefix)if the method supports or requires so.", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$" - }, - "key_type": { - "type": "string", - "example": "ed25519", - "description": "Key type to use for the DID keypair. Validated with the chosen DID method's supported key types.", - "enum": ["ed25519", "bls12381g2"] - } - } - }, - "DIDEndpoint": { - "type": "object", - "required": ["did"], - "properties": { - "did": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv", - "description": "DID of interest", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "endpoint": { - "type": "string", - "example": "https://myhost:8021", - "description": "Endpoint to set (omit to delete)", - "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$" - } - } - }, - "DIDEndpointWithType": { - "type": "object", - "required": ["did"], - "properties": { - "did": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv", - "description": "DID of interest", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "endpoint": { - "type": "string", - "example": "https://myhost:8021", - "description": "Endpoint to set (omit to delete)", - "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$" - }, - "endpoint_type": { - "type": "string", - "example": "Endpoint", - "description": "Endpoint type to set (default 'Endpoint'); affects only public or posted DIDs", - "enum": ["Endpoint", "Profile", "LinkedDomains"] - } - } - }, - "DIDList": { - "type": "object", - "properties": { - "results": { - "type": "array", - "description": "DID list", - "items": { - "$ref": "#/definitions/DID" - } - } - } - }, - "DIDResult": { - "type": "object", - "properties": { - "result": { - "$ref": "#/definitions/DID" - } - } - }, - "DIDRotateRequestJSON": { - "type": "object", - "required": ["to_did"], - "properties": { - "to_did": { - "type": "string", - "example": "did:web:example.com", - "description": "The DID the rotating party is rotating to" - } - } - }, - "DIDXRejectRequest": { - "type": "object", - "properties": { - "reason": { - "type": "string", - "example": "Request rejected", - "description": "Reason for rejecting the DID Exchange" - } - } - }, - "DIDXRequest": { - "type": "object", - "required": ["label"], - "properties": { - "@id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Message identifier" - }, - "@type": { - "type": "string", - "example": "https://didcomm.org/my-family/1.0/my-message-type", - "description": "Message type" - }, - "did": { - "type": "string", - "example": "did:peer:WgWxqztrNooG92RXvxSTWv", - "description": "DID of exchange", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$" - }, - "did_doc~attach": { - "$ref": "#/definitions/DIDXRequest_did_docattach" - }, - "goal": { - "type": "string", - "example": "To issue a Faber College Graduate credential", - "description": "A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message" - }, - "goal_code": { - "type": "string", - "example": "issue-vc", - "description": "A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message" - }, - "label": { - "type": "string", - "example": "Request to connect with Bob", - "description": "Label for DID exchange request" - } - } - }, - "DIFField": { - "type": "object", - "properties": { - "filter": { - "$ref": "#/definitions/Filter" - }, - "id": { - "type": "string", - "description": "ID" - }, - "path": { - "type": "array", - "items": { - "type": "string", - "description": "Path" - } - }, - "predicate": { - "type": "string", - "description": "Preference", - "enum": ["required", "preferred"] - }, - "purpose": { - "type": "string", - "description": "Purpose" - } - } - }, - "DIFHolder": { - "type": "object", - "properties": { - "directive": { - "type": "string", - "description": "Preference", - "enum": ["required", "preferred"] - }, - "field_id": { - "type": "array", - "items": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "FieldID", - "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}" - } - } - } - }, - "DIFOptions": { - "type": "object", - "properties": { - "challenge": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Challenge protect against replay attack", - "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}" - }, - "domain": { - "type": "string", - "example": "4jt78h47fh47", - "description": "Domain protect against replay attack" - } - } - }, - "DIFPresSpec": { - "type": "object", - "properties": { - "issuer_id": { - "type": "string", - "description": "Issuer identifier to sign the presentation, if different from current public DID" - }, - "presentation_definition": { - "$ref": "#/definitions/PresentationDefinition" - }, - "record_ids": { - "type": "object", - "example": { - "": ["", ""], - "": [""] - }, - "description": "Mapping of input_descriptor id to list of stored W3C credential record_id", - "properties": {} - }, - "reveal_doc": { - "type": "object", - "example": { - "@context": [ - "https://www.w3.org/2018/credentials/v1", - "https://w3id.org/security/bbs/v1" - ], - "@explicit": true, - "@requireAll": true, - "credentialSubject": { - "@explicit": true, - "@requireAll": true, - "Observation": [ - { - "effectiveDateTime": {}, - "@explicit": true, - "@requireAll": true - } - ] - }, - "issuanceDate": {}, - "issuer": {}, - "type": ["VerifiableCredential", "LabReport"] - }, - "description": "reveal doc [JSON-LD frame] dict used to derive the credential when selective disclosure is required", - "properties": {} - } - } - }, - "DIFProofProposal": { - "type": "object", - "properties": { - "input_descriptors": { - "type": "array", - "items": { - "$ref": "#/definitions/InputDescriptors" - } - }, - "options": { - "$ref": "#/definitions/DIFOptions" - } - } - }, - "DIFProofRequest": { - "type": "object", - "required": ["presentation_definition"], - "properties": { - "options": { - "$ref": "#/definitions/DIFOptions" - }, - "presentation_definition": { - "$ref": "#/definitions/PresentationDefinition" - } - }, - "additionalProperties": true - }, - "Date": { - "type": "object", - "required": ["expires_time"], - "properties": { - "expires_time": { - "type": "string", - "format": "date-time", - "example": "2021-03-29T05:22:19Z", - "description": "Expiry Date" - } - } - }, - "Disclose": { - "type": "object", - "required": ["protocols"], - "properties": { - "@id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Message identifier" - }, - "@type": { - "type": "string", - "example": "https://didcomm.org/my-family/1.0/my-message-type", - "description": "Message type" - }, - "protocols": { - "type": "array", - "description": "List of protocol descriptors", - "items": { - "$ref": "#/definitions/ProtocolDescriptor" - } - } - } - }, - "Disclosures": { - "type": "object", - "required": ["disclosures"], - "properties": { - "@id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Message identifier" - }, - "@type": { - "type": "string", - "example": "https://didcomm.org/my-family/1.0/my-message-type", - "description": "Message type" - }, - "disclosures": { - "type": "array", - "description": "List of protocol or goal_code descriptors", - "items": {} - } - } - }, - "Doc": { - "type": "object", - "required": ["credential", "options"], - "properties": { - "credential": { - "type": "object", - "description": "Credential to sign", - "properties": {} - }, - "options": { - "$ref": "#/definitions/Doc_options" - } - } - }, - "DocumentVerificationResult": { - "type": "object", - "required": ["verified"], - "properties": { - "document": { - "type": "object", - "properties": {} - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - }, - "results": { - "type": "array", - "items": { - "$ref": "#/definitions/ProofResult" - } - }, - "verified": { - "type": "boolean" - } - } - }, - "EndorserInfo": { - "type": "object", - "required": ["endorser_did"], - "properties": { - "endorser_did": { - "type": "string", - "description": "Endorser DID" - }, - "endorser_name": { - "type": "string", - "description": "Endorser Name" - } - } - }, - "EndpointsResult": { - "type": "object", - "properties": { - "my_endpoint": { - "type": "string", - "example": "https://myhost:8021", - "description": "My endpoint", - "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$" - }, - "their_endpoint": { - "type": "string", - "example": "https://myhost:8021", - "description": "Their endpoint", - "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$" - } - } - }, - "FetchCredentialResponse": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/VerifiableCredential" - } - } - }, - "Filter": { - "type": "object", - "properties": { - "const": { - "description": "Const" - }, - "enum": { - "type": "array", - "items": { - "description": "Enum" - } - }, - "exclusiveMaximum": { - "description": "ExclusiveMaximum" - }, - "exclusiveMinimum": { - "description": "ExclusiveMinimum" - }, - "format": { - "type": "string", - "description": "Format" - }, - "maxLength": { - "type": "integer", - "example": 1234, - "description": "Max Length" - }, - "maximum": { - "description": "Maximum" - }, - "minLength": { - "type": "integer", - "example": 1234, - "description": "Min Length" - }, - "minimum": { - "description": "Minimum" - }, - "not": { - "type": "boolean", - "example": false, - "description": "Not" - }, - "pattern": { - "type": "string", - "description": "Pattern" - }, - "type": { - "type": "string", - "description": "Type" - } - } - }, - "Generated": { - "type": "object", - "properties": { - "master_secret": { - "type": "string", - "example": "0", - "pattern": "^[0-9]*$" - }, - "number": { - "type": "string", - "example": "0", - "pattern": "^[0-9]*$" - }, - "remainder": { - "type": "string", - "example": "0", - "pattern": "^[0-9]*$" - } - } - }, - "GetCredDefResult": { - "type": "object", - "properties": { - "credential_definition": { - "$ref": "#/definitions/CredDefState_credential_definition" - }, - "credential_definition_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description": "credential definition id" - }, - "credential_definitions_metadata": { - "type": "object", - "properties": {} - }, - "resolution_metadata": { - "type": "object", - "properties": {} - } - } - }, - "GetCredDefsResponse": { - "type": "object", - "properties": { - "credential_definition_ids": { - "type": "array", - "items": { - "type": "string", - "example": "GvLGiRogTJubmj5B36qhYz:3:CL:8:faber.agent.degree_schema", - "description": "credential definition identifiers" - } - } - } - }, - "GetDIDEndpointResponse": { - "type": "object", - "properties": { - "endpoint": { - "type": "string", - "example": "https://myhost:8021", - "description": "Full verification key", - "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", - "x-nullable": true - } - } - }, - "GetDIDVerkeyResponse": { - "type": "object", - "properties": { - "verkey": { - "type": "string", - "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description": "Full verification key", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", - "x-nullable": true - } - } - }, - "GetNymRoleResponse": { - "type": "object", - "properties": { - "role": { - "type": "string", - "example": "ENDORSER", - "description": "Ledger role", - "enum": [ - "STEWARD", - "TRUSTEE", - "ENDORSER", - "NETWORK_MONITOR", - "USER", - "ROLE_REMOVE" - ] - } - } - }, - "GetSchemaResult": { - "type": "object", - "properties": { - "resolution_metadata": { - "type": "object", - "properties": {} - }, - "schema": { - "$ref": "#/definitions/AnonCredsSchema" - }, - "schema_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description": "Schema identifier" - }, - "schema_metadata": { - "type": "object", - "properties": {} - } - } - }, - "GetSchemasResponse": { - "type": "object", - "properties": { - "schema_ids": { - "type": "array", - "items": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description": "Schema identifiers" - } - } - } - }, - "Hangup": { - "type": "object", - "properties": { - "@id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Message identifier" - }, - "@type": { - "type": "string", - "example": "https://didcomm.org/my-family/1.0/my-message-type", - "description": "Message type" - } - } - }, - "HolderModuleResponse": { - "type": "object" - }, - "IndyAttrValue": { - "type": "object", - "required": ["encoded", "raw"], - "properties": { - "encoded": { - "type": "string", - "example": "-1", - "description": "Attribute encoded value", - "pattern": "^-?[0-9]*$" - }, - "raw": { - "type": "string", - "description": "Attribute raw value" - } - } - }, - "IndyCredAbstract": { - "type": "object", - "required": [ - "cred_def_id", - "key_correctness_proof", - "nonce", - "schema_id" - ], - "properties": { - "cred_def_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description": "Credential definition identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "key_correctness_proof": { - "$ref": "#/definitions/IndyCredAbstract_key_correctness_proof" - }, - "nonce": { - "type": "string", - "example": "0", - "description": "Nonce in credential abstract", - "pattern": "^[0-9]*$" - }, - "schema_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description": "Schema identifier", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - } - } - }, - "IndyCredInfo": { - "type": "object", - "properties": { - "attrs": { - "type": "object", - "description": "Attribute names and value", - "additionalProperties": { - "type": "string", - "example": "alice" - } - }, - "cred_def_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description": "Credential definition identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "cred_rev_id": { - "type": "string", - "example": "12345", - "description": "Credential revocation identifier", - "pattern": "^[1-9][0-9]*$", - "x-nullable": true - }, - "referent": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Wallet referent" - }, - "rev_reg_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", - "description": "Revocation registry identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", - "x-nullable": true - }, - "schema_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description": "Schema identifier", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - } - } - }, - "IndyCredPrecis": { - "type": "object", - "required": ["cred_info"], - "properties": { - "cred_info": { - "$ref": "#/definitions/IndyCredPrecis_cred_info" - }, - "interval": { - "$ref": "#/definitions/IndyCredPrecis_interval" - }, - "presentation_referents": { - "type": "array", - "items": { - "type": "string", - "example": "1_age_uuid", - "description": "presentation referent" - } - } - } - }, - "IndyCredRequest": { - "type": "object", - "required": [ - "blinded_ms", - "blinded_ms_correctness_proof", - "cred_def_id", - "nonce", - "prover_did" - ], - "properties": { - "blinded_ms": { - "type": "object", - "description": "Blinded master secret", - "properties": {} - }, - "blinded_ms_correctness_proof": { - "type": "object", - "description": "Blinded master secret correctness proof", - "properties": {} - }, - "cred_def_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description": "Credential definition identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "nonce": { - "type": "string", - "example": "0", - "description": "Nonce in credential request", - "pattern": "^[0-9]*$" - }, - "prover_did": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Prover DID/Random String/UUID" - } - } - }, - "IndyCredential": { - "type": "object", - "required": [ - "cred_def_id", - "schema_id", - "signature", - "signature_correctness_proof", - "values" - ], - "properties": { - "cred_def_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description": "Credential definition identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "rev_reg": { - "type": "object", - "description": "Revocation registry state", - "properties": {}, - "x-nullable": true - }, - "rev_reg_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", - "description": "Revocation registry identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", - "x-nullable": true - }, - "schema_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description": "Schema identifier", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - }, - "signature": { - "type": "object", - "description": "Credential signature", - "properties": {} - }, - "signature_correctness_proof": { - "type": "object", - "description": "Credential signature correctness proof", - "properties": {} - }, - "values": { - "type": "object", - "description": "Credential attributes", - "additionalProperties": { - "$ref": "#/definitions/IndyAttrValue" - } - }, - "witness": { - "type": "object", - "description": "Witness for revocation proof", - "properties": {}, - "x-nullable": true - } - } - }, - "IndyEQProof": { - "type": "object", - "properties": { - "a_prime": { - "type": "string", - "example": "0", - "pattern": "^[0-9]*$" - }, - "e": { - "type": "string", - "example": "0", - "pattern": "^[0-9]*$" - }, - "m": { - "type": "object", - "additionalProperties": { - "type": "string", - "example": "0", - "pattern": "^[0-9]*$" - } - }, - "m2": { - "type": "string", - "example": "0", - "pattern": "^[0-9]*$" - }, - "revealed_attrs": { - "type": "object", - "additionalProperties": { - "type": "string", - "example": "-1", - "pattern": "^-?[0-9]*$" - } - }, - "v": { - "type": "string", - "example": "0", - "pattern": "^[0-9]*$" - } - } - }, - "IndyGEProof": { - "type": "object", - "properties": { - "alpha": { - "type": "string", - "example": "0", - "pattern": "^[0-9]*$" - }, - "mj": { - "type": "string", - "example": "0", - "pattern": "^[0-9]*$" - }, - "predicate": { - "$ref": "#/definitions/IndyGEProofPred" - }, - "r": { - "type": "object", - "additionalProperties": { - "type": "string", - "example": "0", - "pattern": "^[0-9]*$" - } - }, - "t": { - "type": "object", - "additionalProperties": { - "type": "string", - "example": "0", - "pattern": "^[0-9]*$" - } - }, - "u": { - "type": "object", - "additionalProperties": { - "type": "string", - "example": "0", - "pattern": "^[0-9]*$" - } - } - } - }, - "IndyGEProofPred": { - "type": "object", - "properties": { - "attr_name": { - "type": "string", - "description": "Attribute name, indy-canonicalized" - }, - "p_type": { - "type": "string", - "description": "Predicate type", - "enum": ["LT", "LE", "GE", "GT"] - }, - "value": { - "type": "integer", - "description": "Predicate threshold value" - } - } - }, - "IndyKeyCorrectnessProof": { - "type": "object", - "required": ["c", "xr_cap", "xz_cap"], - "properties": { - "c": { - "type": "string", - "example": "0", - "description": "c in key correctness proof", - "pattern": "^[0-9]*$" - }, - "xr_cap": { - "type": "array", - "description": "xr_cap in key correctness proof", - "items": { - "type": "array", - "description": "xr_cap components in key correctness proof", - "items": { - "type": "string", - "description": "xr_cap component values in key correctness proof" - } - } - }, - "xz_cap": { - "type": "string", - "example": "0", - "description": "xz_cap in key correctness proof", - "pattern": "^[0-9]*$" - } - } - }, - "IndyNonRevocProof": { - "type": "object", - "properties": { - "c_list": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "x_list": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "IndyNonRevocationInterval": { - "type": "object", - "properties": { - "from": { - "type": "integer", - "example": 1640995199, - "description": "Earliest time of interest in non-revocation interval", - "minimum": 0, - "maximum": 18446744073709551615 - }, - "to": { - "type": "integer", - "example": 1640995199, - "description": "Latest time of interest in non-revocation interval", - "minimum": 0, - "maximum": 18446744073709551615 - } - } - }, - "IndyPresAttrSpec": { - "type": "object", - "required": ["name"], - "properties": { - "cred_def_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "mime-type": { - "type": "string", - "example": "image/jpeg", - "description": "MIME type (default null)" - }, - "name": { - "type": "string", - "example": "favourite_drink", - "description": "Attribute name" - }, - "referent": { - "type": "string", - "example": "0", - "description": "Credential referent" - }, - "value": { - "type": "string", - "example": "martini", - "description": "Attribute value" - } - } - }, - "IndyPresPredSpec": { - "type": "object", - "required": ["name", "predicate", "threshold"], - "properties": { - "cred_def_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description": "Credential definition identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "name": { - "type": "string", - "example": "high_score", - "description": "Attribute name" - }, - "predicate": { - "type": "string", - "example": ">=", - "description": "Predicate type ('<', '<=', '>=', or '>')", - "enum": ["<", "<=", ">=", ">"] - }, - "threshold": { - "type": "integer", - "description": "Threshold value" - } - } - }, - "IndyPresPreview": { - "type": "object", - "required": ["attributes", "predicates"], - "properties": { - "@type": { - "type": "string", - "example": "https://didcomm.org/present-proof/1.0/presentation-preview", - "description": "Message type identifier" - }, - "attributes": { - "type": "array", - "items": { - "$ref": "#/definitions/IndyPresAttrSpec" - } - }, - "predicates": { - "type": "array", - "items": { - "$ref": "#/definitions/IndyPresPredSpec" - } - } - } - }, - "IndyPresSpec": { - "type": "object", - "required": [ - "requested_attributes", - "requested_predicates", - "self_attested_attributes" - ], - "properties": { - "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" - } - }, - "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" - } - }, - "trace": { - "type": "boolean", - "example": false, - "description": "Whether to trace event (default false)" - } - } - }, - "IndyPrimaryProof": { - "type": "object", - "properties": { - "eq_proof": { - "$ref": "#/definitions/IndyPrimaryProof_eq_proof" - }, - "ge_proofs": { - "type": "array", - "description": "Indy GE proofs", - "items": { - "$ref": "#/definitions/IndyGEProof" - }, - "x-nullable": true - } - } - }, - "IndyProof": { - "type": "object", - "properties": { - "identifiers": { - "type": "array", - "description": "Indy proof.identifiers content", - "items": { - "$ref": "#/definitions/IndyProofIdentifier" - } - }, - "proof": { - "$ref": "#/definitions/IndyProof_proof" - }, - "requested_proof": { - "$ref": "#/definitions/IndyProof_requested_proof" - } - } - }, - "IndyProofIdentifier": { - "type": "object", - "properties": { - "cred_def_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description": "Credential definition identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "rev_reg_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", - "description": "Revocation registry identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", - "x-nullable": true - }, - "schema_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description": "Schema identifier", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - }, - "timestamp": { - "type": "integer", - "example": 1640995199, - "description": "Timestamp epoch", - "minimum": 0, - "maximum": 18446744073709551615, - "x-nullable": true - } - } - }, - "IndyProofProof": { - "type": "object", - "properties": { - "aggregated_proof": { - "$ref": "#/definitions/IndyProofProof_aggregated_proof" - }, - "proofs": { - "type": "array", - "description": "Indy proof proofs", - "items": { - "$ref": "#/definitions/IndyProofProofProofsProof" - } - } - } - }, - "IndyProofProofAggregatedProof": { - "type": "object", - "properties": { - "c_hash": { - "type": "string", - "description": "c_hash value" - }, - "c_list": { - "type": "array", - "description": "c_list value", - "items": { - "type": "array", - "items": { - "type": "integer" - } - } - } - } - }, - "IndyProofProofProofsProof": { - "type": "object", - "properties": { - "non_revoc_proof": { - "$ref": "#/definitions/IndyProofProofProofsProof_non_revoc_proof" - }, - "primary_proof": { - "$ref": "#/definitions/IndyProofProofProofsProof_primary_proof" - } - } - }, - "IndyProofReqAttrSpec": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "favouriteDrink", - "description": "Attribute name" - }, - "names": { - "type": "array", - "description": "Attribute name group", - "items": { - "type": "string", - "example": "age" - } - }, - "non_revoked": { - "$ref": "#/definitions/IndyProofReqAttrSpecNonRevoked" - }, - "restrictions": { - "type": "array", - "description": "If present, credential must satisfy one of given restrictions: specify schema_id, schema_issuer_did, schema_name, schema_version, issuer_did, cred_def_id, and/or attr::::value where represents a credential attribute name", - "items": { - "type": "object", - "additionalProperties": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag" - } - } - } - } - }, - "IndyProofReqAttrSpecNonRevoked": { - "type": "object", - "properties": { - "from": { - "type": "integer", - "example": 1640995199, - "description": "Earliest time of interest in non-revocation interval", - "minimum": 0, - "maximum": 18446744073709551615 - }, - "to": { - "type": "integer", - "example": 1640995199, - "description": "Latest time of interest in non-revocation interval", - "minimum": 0, - "maximum": 18446744073709551615 - } - } - }, - "IndyProofReqPredSpec": { - "type": "object", - "required": ["name", "p_type", "p_value"], - "properties": { - "name": { - "type": "string", - "example": "index", - "description": "Attribute name" - }, - "non_revoked": { - "$ref": "#/definitions/IndyProofReqPredSpecNonRevoked" - }, - "p_type": { - "type": "string", - "example": ">=", - "description": "Predicate type ('<', '<=', '>=', or '>')", - "enum": ["<", "<=", ">=", ">"] - }, - "p_value": { - "type": "integer", - "description": "Threshold value" - }, - "restrictions": { - "type": "array", - "description": "If present, credential must satisfy one of given restrictions: specify schema_id, schema_issuer_did, schema_name, schema_version, issuer_did, cred_def_id, and/or attr::::value where represents a credential attribute name", - "items": { - "type": "object", - "additionalProperties": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag" - } - } - } - } - }, - "IndyProofReqPredSpecNonRevoked": { - "type": "object", - "properties": { - "from": { - "type": "integer", - "example": 1640995199, - "description": "Earliest time of interest in non-revocation interval", - "minimum": 0, - "maximum": 18446744073709551615 - }, - "to": { - "type": "integer", - "example": 1640995199, - "description": "Latest time of interest in non-revocation interval", - "minimum": 0, - "maximum": 18446744073709551615 - } - } - }, - "IndyProofRequest": { - "type": "object", - "required": ["requested_attributes", "requested_predicates"], - "properties": { - "name": { - "type": "string", - "example": "Proof request", - "description": "Proof request name" - }, - "non_revoked": { - "$ref": "#/definitions/IndyProofRequestNonRevoked" - }, - "nonce": { - "type": "string", - "example": "1", - "description": "Nonce", - "pattern": "^[1-9][0-9]*$" - }, - "requested_attributes": { - "type": "object", - "description": "Requested attribute specifications of proof request", - "additionalProperties": { - "$ref": "#/definitions/IndyProofReqAttrSpec" - } - }, - "requested_predicates": { - "type": "object", - "description": "Requested predicate specifications of proof request", - "additionalProperties": { - "$ref": "#/definitions/IndyProofReqPredSpec" - } - }, - "version": { - "type": "string", - "example": "1.0", - "description": "Proof request version", - "pattern": "^[0-9.]+$" - } - } - }, - "IndyProofRequestNonRevoked": { - "type": "object", - "properties": { - "from": { - "type": "integer", - "example": 1640995199, - "description": "Earliest time of interest in non-revocation interval", - "minimum": 0, - "maximum": 18446744073709551615 - }, - "to": { - "type": "integer", - "example": 1640995199, - "description": "Latest time of interest in non-revocation interval", - "minimum": 0, - "maximum": 18446744073709551615 - } - } - }, - "IndyProofRequestedProof": { - "type": "object", - "properties": { - "predicates": { - "type": "object", - "description": "Proof requested proof predicates.", - "additionalProperties": { - "$ref": "#/definitions/IndyProofRequestedProofPredicate" - } - }, - "revealed_attr_groups": { - "type": "object", - "description": "Proof requested proof revealed attribute groups", - "additionalProperties": { - "$ref": "#/definitions/IndyProofRequestedProofRevealedAttrGroup" - }, - "x-nullable": true - }, - "revealed_attrs": { - "type": "object", - "description": "Proof requested proof revealed attributes", - "additionalProperties": { - "$ref": "#/definitions/IndyProofRequestedProofRevealedAttr" - }, - "x-nullable": true - }, - "self_attested_attrs": { - "type": "object", - "description": "Proof requested proof self-attested attributes", - "properties": {} - }, - "unrevealed_attrs": { - "type": "object", - "description": "Unrevealed attributes", - "properties": {} - } - } - }, - "IndyProofRequestedProofPredicate": { - "type": "object", - "properties": { - "sub_proof_index": { - "type": "integer", - "description": "Sub-proof index" - } - } - }, - "IndyProofRequestedProofRevealedAttr": { - "type": "object", - "properties": { - "encoded": { - "type": "string", - "example": "-1", - "description": "Encoded value", - "pattern": "^-?[0-9]*$" - }, - "raw": { - "type": "string", - "description": "Raw value" - }, - "sub_proof_index": { - "type": "integer", - "description": "Sub-proof index" - } - } - }, - "IndyProofRequestedProofRevealedAttrGroup": { - "type": "object", - "properties": { - "sub_proof_index": { - "type": "integer", - "description": "Sub-proof index" - }, - "values": { - "type": "object", - "description": "Indy proof requested proof revealed attr groups group value", - "additionalProperties": { - "$ref": "#/definitions/RawEncoded" - } - } - } - }, - "IndyRequestedCredsRequestedAttr": { - "type": "object", - "required": ["cred_id"], - "properties": { - "cred_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Wallet credential identifier (typically but not necessarily a UUID)" - }, - "revealed": { - "type": "boolean", - "description": "Whether to reveal attribute in proof (default true)" - } - } - }, - "IndyRequestedCredsRequestedPred": { - "type": "object", - "required": ["cred_id"], - "properties": { - "cred_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Wallet credential identifier (typically but not necessarily a UUID)" - }, - "timestamp": { - "type": "integer", - "example": 1640995199, - "description": "Epoch timestamp of interest for non-revocation proof", - "minimum": 0, - "maximum": 18446744073709551615 - } - } - }, - "IndyRevRegDef": { - "type": "object", - "properties": { - "credDefId": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description": "Credential definition identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", - "description": "Indy revocation registry identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)" - }, - "revocDefType": { - "type": "string", - "example": "CL_ACCUM", - "description": "Revocation registry type (specify CL_ACCUM)", - "enum": ["CL_ACCUM"] - }, - "tag": { - "type": "string", - "description": "Revocation registry tag" - }, - "value": { - "$ref": "#/definitions/IndyRevRegDef_value" - }, - "ver": { - "type": "string", - "example": "1.0", - "description": "Version of revocation registry definition", - "pattern": "^[0-9.]+$" - } - } - }, - "IndyRevRegDefValue": { - "type": "object", - "properties": { - "issuanceType": { - "type": "string", - "description": "Issuance type", - "enum": ["ISSUANCE_ON_DEMAND", "ISSUANCE_BY_DEFAULT"] - }, - "maxCredNum": { - "type": "integer", - "example": 10, - "description": "Maximum number of credentials; registry size", - "minimum": 1 - }, - "publicKeys": { - "$ref": "#/definitions/IndyRevRegDefValue_publicKeys" - }, - "tailsHash": { - "type": "string", - "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description": "Tails hash value", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - }, - "tailsLocation": { - "type": "string", - "description": "Tails file location" - } - } - }, - "IndyRevRegDefValuePublicKeys": { - "type": "object", - "properties": { - "accumKey": { - "$ref": "#/definitions/IndyRevRegDefValuePublicKeysAccumKey" - } - } - }, - "IndyRevRegDefValuePublicKeysAccumKey": { - "type": "object", - "properties": { - "z": { - "type": "string", - "example": "1 120F522F81E6B7 1 09F7A59005C4939854", - "description": "Value for z" - } - } - }, - "IndyRevRegEntry": { - "type": "object", - "properties": { - "value": { - "$ref": "#/definitions/IndyRevRegEntry_value" - }, - "ver": { - "type": "string", - "example": "1.0", - "description": "Version of revocation registry entry", - "pattern": "^[0-9.]+$" - } - } - }, - "IndyRevRegEntryValue": { - "type": "object", - "properties": { - "accum": { - "type": "string", - "example": "21 11792B036AED0AAA12A4 4 298B2571FFC63A737", - "description": "Accumulator value" - }, - "prevAccum": { - "type": "string", - "example": "21 137AC810975E4 6 76F0384B6F23", - "description": "Previous accumulator value" - }, - "revoked": { - "type": "array", - "description": "Revoked credential revocation identifiers", - "items": { - "type": "integer" - } - } - } - }, - "InnerCredDef": { - "type": "object", - "required": ["issuerId", "schemaId", "tag"], - "properties": { - "issuerId": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv", - "description": "Issuer Identifier of the credential definition" - }, - "schemaId": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description": "Schema identifier" - }, - "tag": { - "type": "string", - "example": "default", - "description": "Credential definition tag" - } - } - }, - "InnerRevRegDef": { - "type": "object", - "properties": { - "credDefId": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description": "Credential definition identifier" - }, - "issuerId": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv", - "description": "Issuer Identifier of the credential definition or schema" - }, - "maxCredNum": { - "type": "integer", - "example": 777, - "description": "Maximum number of credential revocations per registry" - }, - "tag": { - "type": "string", - "example": "default", - "description": "tag for revocation registry" - } - } - }, - "InputDescriptors": { - "type": "object", - "properties": { - "constraints": { - "$ref": "#/definitions/Constraints" - }, - "group": { - "type": "array", - "items": { - "type": "string", - "description": "Group" - } - }, - "id": { - "type": "string", - "description": "ID" - }, - "metadata": { - "type": "object", - "description": "Metadata dictionary", - "properties": {} - }, - "name": { - "type": "string", - "description": "Name" - }, - "purpose": { - "type": "string", - "description": "Purpose" - }, - "schema": { - "$ref": "#/definitions/InputDescriptors_schema" - } - } - }, - "IntroModuleResponse": { - "type": "object" - }, - "InvitationCreateRequest": { - "type": "object", - "properties": { - "accept": { - "type": "array", - "example": ["didcomm/aip1", "didcomm/aip2;env=rfc19"], - "description": "List of mime type in order of preference that should be use in responding to the message", - "items": { - "type": "string" - } - }, - "alias": { - "type": "string", - "example": "Barry", - "description": "Alias for connection" - }, - "attachments": { - "type": "array", - "description": "Optional invitation attachments", - "items": { - "$ref": "#/definitions/AttachmentDef" - } - }, - "goal": { - "type": "string", - "example": "To issue a Faber College Graduate credential", - "description": "A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message" - }, - "goal_code": { - "type": "string", - "example": "issue-vc", - "description": "A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message" - }, - "handshake_protocols": { - "type": "array", - "items": { - "type": "string", - "example": "https://didcomm.org/didexchange/1.0", - "description": "Handshake protocol to specify in invitation" - } - }, - "mediation_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Identifier for active mediation record to be used", - "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}" - }, - "metadata": { - "type": "object", - "description": "Optional metadata to attach to the connection created with the invitation", - "properties": {} - }, - "my_label": { - "type": "string", - "example": "Invitation to Barry", - "description": "Label for connection invitation" - }, - "protocol_version": { - "type": "string", - "example": "1.1", - "description": "OOB protocol version" - }, - "use_did": { - "type": "string", - "example": "did:example:123", - "description": "DID to use in invitation" - }, - "use_did_method": { - "type": "string", - "example": "did:peer:2", - "description": "DID method to use in invitation", - "enum": ["did:peer:2", "did:peer:4"] - }, - "use_public_did": { - "type": "boolean", - "example": false, - "description": "Whether to use public DID in invitation" - } - } - }, - "InvitationMessage": { - "type": "object", - "properties": { - "@id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Message identifier" - }, - "@type": { - "type": "string", - "example": "https://didcomm.org/my-family/1.0/my-message-type", - "description": "Message type" - }, - "accept": { - "type": "array", - "example": ["didcomm/aip1", "didcomm/aip2;env=rfc19"], - "description": "List of mime type in order of preference", - "items": { - "type": "string" - } - }, - "goal": { - "type": "string", - "example": "To issue a Faber College Graduate credential", - "description": "A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message" - }, - "goal_code": { - "type": "string", - "example": "issue-vc", - "description": "A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message" - }, - "handshake_protocols": { - "type": "array", - "items": { - "type": "string", - "example": "https://didcomm.org/didexchange/1.0", - "description": "Handshake protocol" - } - }, - "imageUrl": { - "type": "string", - "format": "url", - "example": "http://192.168.56.101/img/logo.jpg", - "description": "Optional image URL for out-of-band invitation", - "x-nullable": true - }, - "label": { - "type": "string", - "example": "Bob", - "description": "Optional label" - }, - "requests~attach": { - "type": "array", - "description": "Optional request attachment", - "items": { - "$ref": "#/definitions/AttachDecorator" - } - }, - "services": { - "type": "array", - "example": [ - { - "did": "WgWxqztrNooG92RXvxSTWv", - "id": "string", - "recipientKeys": [ - "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH" - ], - "routingKeys": [ - "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH" - ], - "serviceEndpoint": "http://192.168.56.101:8020", - "type": "string" - }, - "did:sov:WgWxqztrNooG92RXvxSTWv" - ], - "items": { - "description": "Either a DIDComm service object (as per RFC0067) or a DID string." - } - } - } - }, - "InvitationRecord": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of record creation", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "invi_msg_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Invitation message identifier" - }, - "invitation": { - "$ref": "#/definitions/InvitationRecord_invitation" - }, - "invitation_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Invitation record identifier" - }, - "invitation_url": { - "type": "string", - "example": "https://example.com/endpoint?c_i=eyJAdHlwZSI6ICIuLi4iLCAiLi4uIjogIi4uLiJ9XX0=", - "description": "Invitation message URL" - }, - "oob_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Out of band record identifier" - }, - "state": { - "type": "string", - "example": "await_response", - "description": "Out of band message exchange state" - }, - "trace": { - "type": "boolean", - "description": "Record trace information, based on agent configuration" - }, - "updated_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of last record update", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - } - } - }, - "InvitationRecordResponse": { - "type": "object" - }, - "InvitationResult": { - "type": "object", - "required": ["connection_id", "invitation", "invitation_url"], - "properties": { - "connection_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Connection identifier" - }, - "invitation": { - "$ref": "#/definitions/ConnectionInvitation" - }, - "invitation_url": { - "type": "string", - "example": "http://192.168.56.101:8020/invite?c_i=eyJAdHlwZSI6Li4ufQ==", - "description": "Invitation URL" - } - } - }, - "IssueCredentialModuleResponse": { - "type": "object" - }, - "IssueCredentialRequest": { - "type": "object", - "properties": { - "credential": { - "$ref": "#/definitions/Credential" - }, - "options": { - "$ref": "#/definitions/LDProofVCOptions" - } - } - }, - "IssueCredentialResponse": { - "type": "object", - "properties": { - "verifiableCredential": { - "$ref": "#/definitions/VerifiableCredential" - } - } - }, - "IssuerCredRevRecord": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of record creation", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "cred_def_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description": "Credential definition identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "cred_ex_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Credential exchange record identifier at credential issue" - }, - "cred_ex_version": { - "type": "string", - "description": "Credential exchange version" - }, - "cred_rev_id": { - "type": "string", - "example": "12345", - "description": "Credential revocation identifier", - "pattern": "^[1-9][0-9]*$" - }, - "record_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Issuer credential revocation record identifier" - }, - "rev_reg_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", - "description": "Revocation registry identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)" - }, - "state": { - "type": "string", - "example": "issued", - "description": "Issue credential revocation record state" - }, - "updated_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of last record update", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - } - } - }, - "IssuerCredRevRecordSchemaAnoncreds": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of record creation", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "cred_def_id": { - "type": "string", - "description": "Credential definition identifier" - }, - "cred_ex_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Credential exchange record identifier at credential issue" - }, - "cred_ex_version": { - "type": "string", - "description": "Credential exchange version" - }, - "cred_rev_id": { - "type": "string", - "description": "Credential revocation identifier" - }, - "record_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Issuer credential revocation record identifier" - }, - "rev_reg_id": { - "type": "string", - "description": "Revocation registry identifier" - }, - "state": { - "type": "string", - "example": "issued", - "description": "Issue credential revocation record state" - }, - "updated_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of last record update", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - } - } - }, - "IssuerRevRegRecord": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of record creation", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "cred_def_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description": "Credential definition identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "error_msg": { - "type": "string", - "example": "Revocation registry undefined", - "description": "Error message" - }, - "issuer_did": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv", - "description": "Issuer DID", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "max_cred_num": { - "type": "integer", - "example": 1000, - "description": "Maximum number of credentials for revocation registry" - }, - "pending_pub": { - "type": "array", - "description": "Credential revocation identifier for credential revoked and pending publication to ledger", - "items": { - "type": "string", - "example": "23" - } - }, - "record_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Issuer revocation registry record identifier" - }, - "revoc_def_type": { - "type": "string", - "example": "CL_ACCUM", - "description": "Revocation registry type (specify CL_ACCUM)", - "enum": ["CL_ACCUM"] - }, - "revoc_reg_def": { - "$ref": "#/definitions/IssuerRevRegRecord_revoc_reg_def" - }, - "revoc_reg_entry": { - "$ref": "#/definitions/IssuerRevRegRecord_revoc_reg_entry" - }, - "revoc_reg_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", - "description": "Revocation registry identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)" - }, - "state": { - "type": "string", - "example": "active", - "description": "Issue revocation registry record state" - }, - "tag": { - "type": "string", - "description": "Tag within issuer revocation registry identifier" - }, - "tails_hash": { - "type": "string", - "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description": "Tails hash", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - }, - "tails_local_path": { - "type": "string", - "description": "Local path to tails file" - }, - "tails_public_uri": { - "type": "string", - "description": "Public URI for tails file" - }, - "updated_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of last record update", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - } - } - }, - "JWSCreate": { - "type": "object", - "required": ["payload"], - "properties": { - "did": { - "type": "string", - "example": "did:peer:WgWxqztrNooG92RXvxSTWv", - "description": "DID of interest", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$" - }, - "headers": { - "type": "object", - "properties": {} - }, - "payload": { - "type": "object", - "properties": {} - }, - "verificationMethod": { - "type": "string", - "example": "did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL", - "description": "Information used for proof verification", - "pattern": "\\w+:(\\/?\\/?)[^\\s]+" - } - } - }, - "JWSVerify": { - "type": "object", - "properties": { - "jwt": { - "type": "string", - "example": "eyJhbGciOiJFZERTQSJ9.eyJhIjogIjAifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk", - "pattern": "^[a-zA-Z0-9_-]+\\.[a-zA-Z0-9_-]*\\.[a-zA-Z0-9_-]+$" - } - } - }, - "JWSVerifyResponse": { - "type": "object", - "required": ["headers", "kid", "payload", "valid"], - "properties": { - "error": { - "type": "string", - "description": "Error text" - }, - "headers": { - "type": "object", - "description": "Headers from verified JWT.", - "properties": {} - }, - "kid": { - "type": "string", - "description": "kid of signer" - }, - "payload": { - "type": "object", - "description": "Payload from verified JWT", - "properties": {} - }, - "valid": { - "type": "boolean" - } - } - }, - "Keylist": { - "type": "object", - "properties": { - "results": { - "type": "array", - "description": "List of keylist records", - "items": { - "$ref": "#/definitions/RouteRecord" - } - } - } - }, - "KeylistQuery": { - "type": "object", - "properties": { - "@id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Message identifier" - }, - "@type": { - "type": "string", - "example": "https://didcomm.org/my-family/1.0/my-message-type", - "description": "Message type" - }, - "filter": { - "type": "object", - "example": { - "filter": {} - }, - "description": "Query dictionary object", - "properties": {} - }, - "paginate": { - "$ref": "#/definitions/KeylistQuery_paginate" - } - } - }, - "KeylistQueryFilterRequest": { - "type": "object", - "properties": { - "filter": { - "type": "object", - "description": "Filter for keylist query", - "properties": {} - } - } - }, - "KeylistQueryPaginate": { - "type": "object", - "properties": { - "limit": { - "type": "integer", - "example": 30, - "description": "Limit for keylist query" - }, - "offset": { - "type": "integer", - "example": 0, - "description": "Offset value for query" - } - } - }, - "KeylistUpdate": { - "type": "object", - "properties": { - "@id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Message identifier" - }, - "@type": { - "type": "string", - "example": "https://didcomm.org/my-family/1.0/my-message-type", - "description": "Message type" - }, - "updates": { - "type": "array", - "description": "List of update rules", - "items": { - "$ref": "#/definitions/KeylistUpdateRule" - } - } - } - }, - "KeylistUpdateRequest": { - "type": "object", - "properties": { - "updates": { - "type": "array", - "items": { - "$ref": "#/definitions/KeylistUpdateRule" - } - } - } - }, - "KeylistUpdateRule": { - "type": "object", - "required": ["action", "recipient_key"], - "properties": { - "action": { - "type": "string", - "example": "add", - "description": "Action for specific key", - "enum": ["add", "remove"] - }, - "recipient_key": { - "type": "string", - "example": "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH", - "description": "Key to remove or add", - "pattern": "^did:key:z[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+$|^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - } - } - }, - "LDProofVCDetail": { - "type": "object", - "required": ["credential", "options"], - "properties": { - "credential": { - "$ref": "#/definitions/LDProofVCDetail_credential" - }, - "options": { - "$ref": "#/definitions/LDProofVCDetail_options" - } - }, - "additionalProperties": true - }, - "LDProofVCOptions": { - "type": "object", - "properties": { - "challenge": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "A challenge to include in the proof. SHOULD be provided by the requesting party of the credential (=holder)" - }, - "created": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "The date and time of the proof (with a maximum accuracy in seconds). Defaults to current system time", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "credentialStatus": { - "$ref": "#/definitions/LDProofVCOptions_credentialStatus" - }, - "domain": { - "type": "string", - "example": "example.com", - "description": "The intended domain of validity for the proof" - }, - "proofPurpose": { - "type": "string", - "example": "assertionMethod", - "description": "The proof purpose used for the proof. Should match proof purposes registered in the Linked Data Proofs Specification" - }, - "proofType": { - "type": "string", - "example": "Ed25519Signature2018", - "description": "The proof type used for the proof. Should match suites registered in the Linked Data Cryptographic Suite Registry" - }, - "verificationMethod": { - "type": "string", - "example": "did:example:123456#key-1", - "description": "The verification method to use for the proof. Should match a verification method in the wallet" - } - }, - "additionalProperties": true - }, - "LedgerConfigInstance": { - "type": "object", - "properties": { - "genesis_file": { - "type": "string", - "description": "genesis_file" - }, - "genesis_transactions": { - "type": "string", - "description": "genesis_transactions" - }, - "genesis_url": { - "type": "string", - "description": "genesis_url" - }, - "id": { - "type": "string", - "description": "ledger_id" - }, - "is_production": { - "type": "boolean", - "description": "is_production" - } - } - }, - "LedgerConfigList": { - "type": "object", - "required": ["ledger_config_list"], - "properties": { - "ledger_config_list": { - "type": "array", - "items": { - "$ref": "#/definitions/LedgerConfigInstance" - } - } - } - }, - "LedgerModulesResult": { - "type": "object" - }, - "LinkedDataProof": { - "type": "object", - "required": ["proofPurpose", "type", "verificationMethod"], - "properties": { - "challenge": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Associates a challenge with a proof, for use with a proofPurpose such as authentication" - }, - "created": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "The string value of an ISO8601 combined date and time string generated by the Signature Algorithm", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "domain": { - "type": "string", - "example": "https://example.com", - "description": "A string value specifying the restricted domain of the signature." - }, - "jws": { - "type": "string", - "example": "eyJhbGciOiAiRWREUc2UsICJjcml0IjogWyJiNjQiXX0..lKJU0Df_keblRKhZAS9Qq6zybm-HqUXNVZ8vgEPNTAjQ1Ch6YBKY7UBAjg6iBX5qBQ", - "description": "Associates a Detached Json Web Signature with a proof" - }, - "nonce": { - "type": "string", - "example": "CF69iO3nfvqRsRBNElE8b4wO39SyJHPM7Gg1nExltW5vSfQA1lvDCR/zXX1To0/4NLo==", - "description": "The nonce" - }, - "proofPurpose": { - "type": "string", - "example": "assertionMethod", - "description": "Proof purpose" - }, - "proofValue": { - "type": "string", - "example": "sy1AahqbzJQ63n9RtekmwzqZeVj494VppdAVJBnMYrTwft6cLJJGeTSSxCCJ6HKnRtwE7jjDh6sB2z2AAiZY9BBnCD8wUVgwqH3qchGRCuC2RugA4eQ9fUrR4Yuycac3caiaaay", - "description": "The proof value of a proof" - }, - "type": { - "type": "string", - "example": "Ed25519Signature2018", - "description": "Identifies the digital signature suite that was used to create the signature" - }, - "verificationMethod": { - "type": "string", - "example": "did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL", - "description": "Information used for proof verification", - "pattern": "\\w+:(\\/?\\/?)[^\\s]+" - } - }, - "additionalProperties": true - }, - "ListCredentialsResponse": { - "type": "object" - }, - "MediationCreateRequest": { - "type": "object" - }, - "MediationDeny": { - "type": "object", - "properties": { - "@id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Message identifier" - }, - "@type": { - "type": "string", - "example": "https://didcomm.org/my-family/1.0/my-message-type", - "description": "Message type" - } - } - }, - "MediationGrant": { - "type": "object", - "properties": { - "@id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Message identifier" - }, - "@type": { - "type": "string", - "example": "https://didcomm.org/my-family/1.0/my-message-type", - "description": "Message type" - }, - "endpoint": { - "type": "string", - "example": "http://192.168.56.102:8020/", - "description": "endpoint on which messages destined for the recipient are received." - }, - "routing_keys": { - "type": "array", - "items": { - "type": "string", - "description": "Keys to use for forward message packaging" - } - } - } - }, - "MediationIdMatchInfo": { - "type": "object", - "required": ["mediation_id"], - "properties": { - "mediation_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Mediation record identifier" - } - } - }, - "MediationList": { - "type": "object", - "required": ["results"], - "properties": { - "results": { - "type": "array", - "description": "List of mediation records", - "items": { - "$ref": "#/definitions/MediationRecord" - } - } - } - }, - "MediationRecord": { - "type": "object", - "required": ["connection_id", "role"], - "properties": { - "connection_id": { - "type": "string" - }, - "created_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of record creation", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "endpoint": { - "type": "string" - }, - "mediation_id": { - "type": "string" - }, - "mediator_terms": { - "type": "array", - "items": { - "type": "string" - } - }, - "recipient_terms": { - "type": "array", - "items": { - "type": "string" - } - }, - "role": { - "type": "string" - }, - "routing_keys": { - "type": "array", - "items": { - "type": "string", - "example": "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH", - "pattern": "^did:key:z[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+$" - } - }, - "state": { - "type": "string", - "example": "active", - "description": "Current record state" - }, - "updated_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of last record update", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - } - } - }, - "Menu": { - "type": "object", - "required": ["options"], - "properties": { - "@id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Message identifier" - }, - "@type": { - "type": "string", - "example": "https://didcomm.org/my-family/1.0/my-message-type", - "description": "Message type" - }, - "description": { - "type": "string", - "example": "This menu presents options", - "description": "Introductory text for the menu" - }, - "errormsg": { - "type": "string", - "example": "Error: item not found", - "description": "An optional error message to display in menu header" - }, - "options": { - "type": "array", - "description": "List of menu options", - "items": { - "$ref": "#/definitions/MenuOption" - } - }, - "title": { - "type": "string", - "example": "My Menu", - "description": "Menu title" - } - } - }, - "MenuForm": { - "type": "object", - "properties": { - "description": { - "type": "string", - "example": "Window preference settings", - "description": "Additional descriptive text for menu form" - }, - "params": { - "type": "array", - "description": "List of form parameters", - "items": { - "$ref": "#/definitions/MenuFormParam" - } - }, - "submit-label": { - "type": "string", - "example": "Send", - "description": "Alternative label for form submit button" - }, - "title": { - "type": "string", - "example": "Preferences", - "description": "Menu form title" - } - } - }, - "MenuFormParam": { - "type": "object", - "required": ["name", "title"], - "properties": { - "default": { - "type": "string", - "example": "0", - "description": "Default parameter value" - }, - "description": { - "type": "string", - "example": "Delay in seconds before starting", - "description": "Additional descriptive text for menu form parameter" - }, - "name": { - "type": "string", - "example": "delay", - "description": "Menu parameter name" - }, - "required": { - "type": "boolean", - "example": false, - "description": "Whether parameter is required" - }, - "title": { - "type": "string", - "example": "Delay in seconds", - "description": "Menu parameter title" - }, - "type": { - "type": "string", - "example": "int", - "description": "Menu form parameter input type" - } - } - }, - "MenuJson": { - "type": "object", - "required": ["options"], - "properties": { - "description": { - "type": "string", - "example": "User preferences for window settings", - "description": "Introductory text for the menu" - }, - "errormsg": { - "type": "string", - "example": "Error: item not present", - "description": "Optional error message to display in menu header" - }, - "options": { - "type": "array", - "description": "List of menu options", - "items": { - "$ref": "#/definitions/MenuOption" - } - }, - "title": { - "type": "string", - "example": "My Menu", - "description": "Menu title" - } - } - }, - "MenuOption": { - "type": "object", - "required": ["name", "title"], - "properties": { - "description": { - "type": "string", - "example": "Window display preferences", - "description": "Additional descriptive text for menu option" - }, - "disabled": { - "type": "boolean", - "example": false, - "description": "Whether to show option as disabled" - }, - "form": { - "$ref": "#/definitions/MenuForm" - }, - "name": { - "type": "string", - "example": "window_prefs", - "description": "Menu option name (unique identifier)" - }, - "title": { - "type": "string", - "example": "Window Preferences", - "description": "Menu option title" - } - } - }, - "MultitenantModuleResponse": { - "type": "object" - }, - "OobRecord": { - "type": "object", - "required": ["invi_msg_id", "invitation", "oob_id", "state"], - "properties": { - "attach_thread_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Connection record identifier" - }, - "connection_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Connection record identifier" - }, - "created_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of record creation", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "invi_msg_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Invitation message identifier" - }, - "invitation": { - "$ref": "#/definitions/InvitationRecord_invitation" - }, - "multi_use": { - "type": "boolean", - "example": true, - "description": "Allow for multiple uses of the oob invitation" - }, - "oob_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Oob record identifier" - }, - "our_recipient_key": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Recipient key used for oob invitation" - }, - "role": { - "type": "string", - "example": "receiver", - "description": "OOB Role", - "enum": ["sender", "receiver"] - }, - "state": { - "type": "string", - "example": "await-response", - "description": "Out of band message exchange state", - "enum": [ - "initial", - "prepare-response", - "await-response", - "reuse-not-accepted", - "reuse-accepted", - "done", - "deleted" - ] - }, - "their_service": { - "$ref": "#/definitions/ServiceDecorator" - }, - "trace": { - "type": "boolean", - "description": "Record trace information, based on agent configuration" - }, - "updated_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of last record update", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - } - } - }, - "PerformRequest": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "Query", - "description": "Menu option name" - }, - "params": { - "type": "object", - "description": "Input parameter values", - "additionalProperties": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" - } - } - } - }, - "PingRequest": { - "type": "object", - "properties": { - "comment": { - "type": "string", - "description": "Comment for the ping message", - "x-nullable": true - } - } - }, - "PingRequestResponse": { - "type": "object", - "properties": { - "thread_id": { - "type": "string", - "description": "Thread ID of the ping message" - } - } - }, - "Presentation": { - "type": "object", - "required": ["@context", "type"], - "properties": { - "@context": { - "type": "array", - "example": ["https://www.w3.org/2018/credentials/v1"], - "description": "The JSON-LD context of the presentation", - "items": {} - }, - "holder": { - "example": "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH", - "description": "The JSON-LD Verifiable Credential Holder. Either string of object with id field." - }, - "id": { - "type": "string", - "example": "http://example.edu/presentations/1872", - "description": "The ID of the presentation", - "pattern": "\\w+:(\\/?\\/?)[^\\s]+" - }, - "proof": { - "$ref": "#/definitions/Presentation_proof" - }, - "type": { - "type": "array", - "example": ["VerifiablePresentation"], - "description": "The JSON-LD type of the presentation", - "items": { - "type": "string" - } - }, - "verifiableCredential": { - "type": "array", - "items": { - "type": "object", - "properties": {} - } - } - }, - "additionalProperties": true - }, - "PresentationDefinition": { - "type": "object", - "properties": { - "format": { - "$ref": "#/definitions/ClaimFormat" - }, - "id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Unique Resource Identifier", - "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}" - }, - "input_descriptors": { - "type": "array", - "items": { - "$ref": "#/definitions/InputDescriptors" - } - }, - "name": { - "type": "string", - "description": "Human-friendly name that describes what the presentation definition pertains to" - }, - "purpose": { - "type": "string", - "description": "Describes the purpose for which the Presentation Definition's inputs are being requested" - }, - "submission_requirements": { - "type": "array", - "items": { - "$ref": "#/definitions/SubmissionRequirements" - } - } - } - }, - "PresentationProposal": { - "type": "object", - "required": ["presentation_proposal"], - "properties": { - "@id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Message identifier" - }, - "@type": { - "type": "string", - "example": "https://didcomm.org/my-family/1.0/my-message-type", - "description": "Message type" - }, - "comment": { - "type": "string", - "description": "Human-readable comment", - "x-nullable": true - }, - "presentation_proposal": { - "$ref": "#/definitions/IndyPresPreview" - } - } - }, - "PresentationRequest": { - "type": "object", - "required": ["request_presentations~attach"], - "properties": { - "@id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Message identifier" - }, - "@type": { - "type": "string", - "example": "https://didcomm.org/my-family/1.0/my-message-type", - "description": "Message type" - }, - "comment": { - "type": "string", - "description": "Human-readable comment", - "x-nullable": true - }, - "request_presentations~attach": { - "type": "array", - "items": { - "$ref": "#/definitions/AttachDecorator" - } - } - } - }, - "PresentationVerificationResult": { - "type": "object", - "required": ["verified"], - "properties": { - "credential_results": { - "type": "array", - "items": { - "$ref": "#/definitions/DocumentVerificationResult" - } - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - }, - "presentation_result": { - "$ref": "#/definitions/DocumentVerificationResult" - }, - "verified": { - "type": "boolean" - } - } - }, - "ProfileSettings": { - "type": "object", - "properties": { - "settings": { - "type": "object", - "example": { - "debug.invite_public": true, - "log.level": "INFO", - "public_invites": false - }, - "description": "Profile settings dict", - "properties": {} - } - } - }, - "ProofResult": { - "type": "object", - "properties": { - "error": { - "type": "string" - }, - "proof": { - "type": "object", - "properties": {} - }, - "purpose_result": { - "$ref": "#/definitions/PurposeResult" - }, - "verified": { - "type": "boolean" - } - } - }, - "ProtocolDescriptor": { - "type": "object", - "required": ["pid"], - "properties": { - "pid": { - "type": "string" - }, - "roles": { - "type": "array", - "description": "List of roles", - "items": { - "type": "string", - "example": "requester", - "description": "Role: requester or responder" - }, - "x-nullable": true - } - } - }, - "ProvePresentationRequest": { - "type": "object", - "properties": { - "options": { - "$ref": "#/definitions/LDProofVCOptions" - }, - "presentation": { - "$ref": "#/definitions/Presentation" - } - } - }, - "ProvePresentationResponse": { - "type": "object", - "properties": { - "verifiablePresentation": { - "$ref": "#/definitions/VerifiablePresentation" - } - } - }, - "PublishRevocations": { - "type": "object", - "properties": { - "rrid2crid": { - "type": "object", - "description": "Credential revocation ids by revocation registry id", - "additionalProperties": { - "type": "array", - "items": { - "type": "string", - "example": "12345", - "description": "Credential revocation identifier", - "pattern": "^[1-9][0-9]*$" - } - } - } - } - }, - "PublishRevocationsOptions": { - "type": "object", - "properties": { - "create_transaction_for_endorser": { - "type": "boolean", - "example": false, - "description": "Create transaction for endorser (optional, default false). Use this for agents who don't specify an author role but want to create a transaction for an endorser to sign." - }, - "endorser_connection_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Connection identifier (optional) (this is an example). You can set this if you know the endorser's connection id you want to use. If not specified then the agent will attempt to find an endorser connection." - } - } - }, - "PublishRevocationsResultSchemaAnoncreds": { - "type": "object", - "properties": { - "rrid2crid": { - "type": "object", - "description": "Credential revocation ids by revocation registry id", - "additionalProperties": { - "type": "array", - "items": { - "type": "string", - "example": "12345", - "description": "Credential revocation identifier", - "pattern": "^[1-9][0-9]*$" - } - } - } - } - }, - "PublishRevocationsSchemaAnoncreds": { - "type": "object", - "properties": { - "options": { - "$ref": "#/definitions/PublishRevocationsOptions" - }, - "rrid2crid": { - "type": "object", - "description": "Credential revocation ids by revocation registry id", - "additionalProperties": { - "type": "array", - "items": { - "type": "string", - "example": "12345", - "description": "Credential revocation identifier", - "pattern": "^[1-9][0-9]*$" - } - } - } - } - }, - "PurposeResult": { - "type": "object", - "properties": { - "controller": { - "type": "object", - "properties": {} - }, - "error": { - "type": "string" - }, - "valid": { - "type": "boolean" - } - } - }, - "Queries": { - "type": "object", - "properties": { - "@id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Message identifier" - }, - "@type": { - "type": "string", - "example": "https://didcomm.org/my-family/1.0/my-message-type", - "description": "Message type" - }, - "queries": { - "type": "array", - "items": { - "$ref": "#/definitions/QueryItem" - } - } - } - }, - "Query": { - "type": "object", - "required": ["query"], - "properties": { - "@id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Message identifier" - }, - "@type": { - "type": "string", - "example": "https://didcomm.org/my-family/1.0/my-message-type", - "description": "Message type" - }, - "comment": { - "type": "string", - "x-nullable": true - }, - "query": { - "type": "string" - } - } - }, - "QueryItem": { - "type": "object", - "required": ["feature-type", "match"], - "properties": { - "feature-type": { - "type": "string", - "description": "feature type", - "enum": ["protocol", "goal-code"] - }, - "match": { - "type": "string", - "description": "match" - } - } - }, - "RawEncoded": { - "type": "object", - "properties": { - "encoded": { - "type": "string", - "example": "-1", - "description": "Encoded value", - "pattern": "^-?[0-9]*$" - }, - "raw": { - "type": "string", - "description": "Raw value" - } - } - }, - "ReceiveInvitationRequest": { - "type": "object", - "properties": { - "@id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Message identifier" - }, - "@type": { - "type": "string", - "example": "https://didcomm.org/my-family/1.0/my-message-type", - "description": "Message type" - }, - "did": { - "type": "string", - "example": "did:peer:WgWxqztrNooG92RXvxSTWv", - "description": "DID for connection invitation", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$" - }, - "imageUrl": { - "type": "string", - "format": "url", - "example": "http://192.168.56.101/img/logo.jpg", - "description": "Optional image URL for connection invitation", - "x-nullable": true - }, - "label": { - "type": "string", - "example": "Bob", - "description": "Optional label for connection invitation" - }, - "recipientKeys": { - "type": "array", - "description": "List of recipient keys", - "items": { - "type": "string", - "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description": "Recipient public key", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - } - }, - "routingKeys": { - "type": "array", - "description": "List of routing keys", - "items": { - "type": "string", - "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description": "Routing key", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - } - }, - "serviceEndpoint": { - "type": "string", - "example": "http://192.168.56.101:8020", - "description": "Service endpoint at which to reach this agent" - } - } - }, - "RemoveWalletRequest": { - "type": "object", - "properties": { - "wallet_key": { - "type": "string", - "example": "MySecretKey123", - "description": "Master key used for key derivation. Only required for unmanaged wallets." - } - } - }, - "ResolutionResult": { - "type": "object", - "required": ["did_document", "metadata"], - "properties": { - "did_document": { - "type": "object", - "description": "DID Document", - "properties": {} - }, - "metadata": { - "type": "object", - "description": "Resolution metadata", - "properties": {} - } - } - }, - "RevList": { - "type": "object", - "properties": { - "currentAccumulator": { - "type": "string", - "example": "21 118...1FB", - "description": "The current accumulator value" - }, - "issuerId": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv", - "description": "Issuer Identifier of the credential definition or schema" - }, - "revRegDefId": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", - "description": "The ID of the revocation registry definition" - }, - "revocationList": { - "type": "array", - "example": [0, 1, 1, 0], - "description": "Bit list representing revoked credentials", - "items": { - "type": "integer" - } - }, - "timestamp": { - "type": "integer", - "example": "2021-12-31T23:59:59Z", - "description": "Timestamp at which revocation list is applicable" - } - } - }, - "RevListCreateRequest": { - "type": "object", - "properties": { - "options": { - "$ref": "#/definitions/RevListOptions" - }, - "rev_reg_def_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", - "description": "Revocation registry definition identifier" - } - } - }, - "RevListOptions": { - "type": "object", - "properties": { - "create_transaction_for_endorser": { - "type": "boolean", - "example": false, - "description": "Create transaction for endorser (optional, default false). Use this for agents who don't specify an author role but want to create a transaction for an endorser to sign." - }, - "endorser_connection_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Connection identifier (optional) (this is an example). You can set this if you know the endorser's connection id you want to use. If not specified then the agent will attempt to find an endorser connection." - } - } - }, - "RevListResult": { - "type": "object", - "properties": { - "job_id": { - "type": "string" - }, - "registration_metadata": { - "type": "object", - "properties": {} - }, - "revocation_list_metadata": { - "type": "object", - "properties": {} - }, - "revocation_list_state": { - "$ref": "#/definitions/RevListState" - } - } - }, - "RevListState": { - "type": "object", - "properties": { - "revocation_list": { - "$ref": "#/definitions/RevListState_revocation_list" - }, - "state": { - "type": "string", - "enum": ["finished", "failed", "action", "wait"] - } - } - }, - "RevRegCreateRequest": { - "type": "object", - "properties": { - "credential_definition_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description": "Credential definition identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "max_cred_num": { - "type": "integer", - "example": 1000, - "description": "Revocation registry size", - "minimum": 4, - "maximum": 32768 - } - } - }, - "RevRegCreateRequestSchemaAnoncreds": { - "type": "object", - "properties": { - "options": { - "$ref": "#/definitions/RevRegDefOptions" - }, - "revocation_registry_definition": { - "$ref": "#/definitions/InnerRevRegDef" - } - } - }, - "RevRegDef": { - "type": "object", - "properties": { - "credDefId": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description": "Credential definition identifier" - }, - "issuerId": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv", - "description": "Issuer Identifier of the credential definition or schema" - }, - "revocDefType": { - "type": "string" - }, - "tag": { - "type": "string", - "example": "default", - "description": "tag for the revocation registry definition" - }, - "value": { - "$ref": "#/definitions/RevRegDefValue" - } - } - }, - "RevRegDefOptions": { - "type": "object", - "properties": { - "create_transaction_for_endorser": { - "type": "boolean", - "example": false, - "description": "Create transaction for endorser (optional, default false). Use this for agents who don't specify an author role but want to create a transaction for an endorser to sign." - }, - "endorser_connection_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Connection identifier (optional) (this is an example). You can set this if you know the endorser's connection id you want to use. If not specified then the agent will attempt to find an endorser connection." - } - } - }, - "RevRegDefResult": { - "type": "object", - "properties": { - "job_id": { - "type": "string" - }, - "registration_metadata": { - "type": "object", - "properties": {} - }, - "revocation_registry_definition_metadata": { - "type": "object", - "properties": {} - }, - "revocation_registry_definition_state": { - "$ref": "#/definitions/RevRegDefState" - } - } - }, - "RevRegDefState": { - "type": "object", - "properties": { - "revocation_registry_definition": { - "$ref": "#/definitions/RevRegDefState_revocation_registry_definition" - }, - "revocation_registry_definition_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", - "description": "revocation registry definition id" - }, - "state": { - "type": "string", - "enum": [ - "finished", - "failed", - "action", - "wait", - "decommissioned", - "full" - ] - } - } - }, - "RevRegDefValue": { - "type": "object", - "properties": { - "maxCredNum": { - "type": "integer", - "example": 777 - }, - "publicKeys": { - "type": "object", - "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "properties": {} - }, - "tailsHash": { - "type": "string", - "example": "7Qen9RDyemMuV7xGQvp7NjwMSpyHieJyBakycxN7dX7P" - }, - "tailsLocation": { - "type": "string", - "example": "https://tails-server.com/hash/7Qen9RDyemMuV7xGQvp7NjwMSpyHieJyBakycxN7dX7P" - } - } - }, - "RevRegIssuedResult": { - "type": "object", - "properties": { - "result": { - "type": "integer", - "example": 0, - "description": "Number of credentials issued against revocation registry", - "minimum": 0 - } - } - }, - "RevRegIssuedResultSchemaAnoncreds": { - "type": "object", - "properties": { - "result": { - "type": "integer", - "example": 0, - "description": "Number of credentials issued against revocation registry", - "minimum": 0 - } - } - }, - "RevRegResult": { - "type": "object", - "properties": { - "result": { - "$ref": "#/definitions/IssuerRevRegRecord" - } - } - }, - "RevRegResultSchemaAnoncreds": { - "type": "object", - "properties": { - "result": { - "$ref": "#/definitions/IssuerRevRegRecord" - } - } - }, - "RevRegUpdateTailsFileUri": { - "type": "object", - "required": ["tails_public_uri"], - "properties": { - "tails_public_uri": { - "type": "string", - "format": "url", - "example": "http://192.168.56.133:6543/revocation/registry/WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0/tails-file", - "description": "Public URI to the tails file" - } - } - }, - "RevRegWalletUpdatedResult": { - "type": "object", - "properties": { - "accum_calculated": { - "type": "object", - "description": "Calculated accumulator for phantom revocations", - "properties": {} - }, - "accum_fixed": { - "type": "object", - "description": "Applied ledger transaction to fix revocations", - "properties": {} - }, - "rev_reg_delta": { - "type": "object", - "description": "Indy revocation registry delta", - "properties": {} - } - } - }, - "RevRegWalletUpdatedResultSchemaAnoncreds": { - "type": "object", - "properties": { - "accum_calculated": { - "type": "object", - "description": "Calculated accumulator for phantom revocations", - "properties": {} - }, - "accum_fixed": { - "type": "object", - "description": "Applied ledger transaction to fix revocations", - "properties": {} - }, - "rev_reg_delta": { - "type": "object", - "description": "Indy revocation registry delta", - "properties": {} - } - } - }, - "RevRegsCreated": { - "type": "object", - "properties": { - "rev_reg_ids": { - "type": "array", - "items": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", - "description": "Revocation registry identifiers", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)" - } - } - } - }, - "RevRegsCreatedSchemaAnoncreds": { - "type": "object", - "properties": { - "rev_reg_ids": { - "type": "array", - "items": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", - "description": "Revocation registry identifiers", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)" - } - } - } - }, - "RevocationAnoncredsModuleResponse": { - "type": "object" - }, - "RevocationModuleResponse": { - "type": "object" - }, - "RevokeRequest": { - "type": "object", - "properties": { - "comment": { - "type": "string", - "description": "Optional comment to include in revocation notification" - }, - "connection_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Connection ID to which the revocation notification will be sent; required if notify is true", - "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}" - }, - "cred_ex_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Credential exchange identifier", - "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}" - }, - "cred_rev_id": { - "type": "string", - "example": "12345", - "description": "Credential revocation identifier", - "pattern": "^[1-9][0-9]*$" - }, - "notify": { - "type": "boolean", - "description": "Send a notification to the credential recipient" - }, - "notify_version": { - "type": "string", - "description": "Specify which version of the revocation notification should be sent", - "enum": ["v1_0", "v2_0"] - }, - "publish": { - "type": "boolean", - "description": "(True) publish revocation to ledger immediately, or (default, False) mark it pending" - }, - "rev_reg_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", - "description": "Revocation registry identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)" - }, - "thread_id": { - "type": "string", - "description": "Thread ID of the credential exchange message thread resulting in the credential now being revoked; required if notify is true" - } - } - }, - "RevokeRequestSchemaAnoncreds": { - "type": "object", - "properties": { - "comment": { - "type": "string", - "description": "Optional comment to include in revocation notification" - }, - "connection_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Connection ID to which the revocation notification will be sent; required if notify is true", - "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}" - }, - "cred_ex_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Credential exchange identifier", - "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}" - }, - "cred_rev_id": { - "type": "string", - "example": "12345", - "description": "Credential revocation identifier", - "pattern": "^[1-9][0-9]*$" - }, - "notify": { - "type": "boolean", - "description": "Send a notification to the credential recipient" - }, - "notify_version": { - "type": "string", - "description": "Specify which version of the revocation notification should be sent", - "enum": ["v1_0", "v2_0"] - }, - "publish": { - "type": "boolean", - "description": "(True) publish revocation to ledger immediately, or (default, False) mark it pending" - }, - "rev_reg_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", - "description": "Revocation registry identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)" - }, - "thread_id": { - "type": "string", - "description": "Thread ID of the credential exchange message thread resulting in the credential now being revoked; required if notify is true" - } - } - }, - "Rotate": { - "type": "object", - "required": ["to_did"], - "properties": { - "@id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Message identifier" - }, - "@type": { - "type": "string", - "example": "https://didcomm.org/my-family/1.0/my-message-type", - "description": "Message type" - }, - "to_did": { - "type": "string", - "example": "did:example:newdid", - "description": "The DID the rotating party is rotating to" - } - } - }, - "RouteRecord": { - "type": "object", - "required": ["recipient_key"], - "properties": { - "connection_id": { - "type": "string" - }, - "created_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of record creation", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "recipient_key": { - "type": "string" - }, - "record_id": { - "type": "string" - }, - "role": { - "type": "string" - }, - "state": { - "type": "string", - "example": "active", - "description": "Current record state" - }, - "updated_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of last record update", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "wallet_id": { - "type": "string" - } - } - }, - "SDJWSCreate": { - "type": "object", - "required": ["payload"], - "properties": { - "did": { - "type": "string", - "example": "did:peer:WgWxqztrNooG92RXvxSTWv", - "description": "DID of interest", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$" - }, - "headers": { - "type": "object", - "properties": {} - }, - "non_sd_list": { - "type": "array", - "items": { - "type": "string", - "example": "", - "pattern": "[a-z0-9:\\[\\]_\\.@?\\(\\)]" - } - }, - "payload": { - "type": "object", - "properties": {} - }, - "verificationMethod": { - "type": "string", - "example": "did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL", - "description": "Information used for proof verification", - "pattern": "\\w+:(\\/?\\/?)[^\\s]+" - } - } - }, - "SDJWSVerify": { - "type": "object", - "properties": { - "sd_jwt": { - "type": "string", - "example": "eyJhbGciOiJFZERTQSJ9.eyJhIjogIjAifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk~WyJEM3BUSFdCYWNRcFdpREc2TWZKLUZnIiwgIkRFIl0~WyJPMTFySVRjRTdHcXExYW9oRkd0aDh3IiwgIlNBIl0~WyJkVmEzX1JlTGNsWTU0R1FHZm5oWlRnIiwgInVwZGF0ZWRfYXQiLCAxNTcwMDAwMDAwXQ", - "pattern": "^[a-zA-Z0-9_-]+\\.[a-zA-Z0-9_-]*\\.[a-zA-Z0-9_-]+(?:~[a-zA-Z0-9._-]+)*~?$" - } - } - }, - "SDJWSVerifyResponse": { - "type": "object", - "required": ["headers", "kid", "payload", "valid"], - "properties": { - "disclosures": { - "type": "array", - "example": [ - ["fx1iT_mETjGiC-JzRARnVg", "name", "Alice"], - [ - "n4-t3mlh8jSS6yMIT7QHnA", - "street_address", - { - "_sd": ["kLZrLK7enwfqeOzJ9-Ss88YS3mhjOAEk9lr_ix2Heng"] - } - ] - ], - "description": "Disclosure arrays associated with the SD-JWT", - "items": { - "type": "array", - "items": {} - } - }, - "error": { - "type": "string", - "description": "Error text" - }, - "headers": { - "type": "object", - "description": "Headers from verified JWT.", - "properties": {} - }, - "kid": { - "type": "string", - "description": "kid of signer" - }, - "payload": { - "type": "object", - "description": "Payload from verified JWT", - "properties": {} - }, - "valid": { - "type": "boolean" - } - } - }, - "Schema": { - "type": "object", - "properties": { - "attrNames": { - "type": "array", - "description": "Schema attribute names", - "items": { - "type": "string", - "example": "score", - "description": "Attribute name" - } - }, - "id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description": "Schema identifier", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - }, - "name": { - "type": "string", - "example": "schema_name", - "description": "Schema name" - }, - "seqNo": { - "type": "integer", - "example": 10, - "description": "Schema sequence number", - "minimum": 1 - }, - "ver": { - "type": "string", - "example": "1.0", - "description": "Node protocol version", - "pattern": "^[0-9.]+$" - }, - "version": { - "type": "string", - "example": "1.0", - "description": "Schema version", - "pattern": "^[0-9.]+$" - } - } - }, - "SchemaGetResult": { - "type": "object", - "properties": { - "schema": { - "$ref": "#/definitions/Schema" - } - } - }, - "SchemaInputDescriptor": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Required" - }, - "uri": { - "type": "string", - "description": "URI" - } - } - }, - "SchemaPostOption": { - "type": "object", - "properties": { - "create_transaction_for_endorser": { - "type": "boolean", - "example": false, - "description": "Create transaction for endorser (optional, default false). Use this for agents who don't specify an author role but want to create a transaction for an endorser to sign." - }, - "endorser_connection_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Connection identifier (optional) (this is an example). You can set this if you know the endorser's connection id you want to use. If not specified then the agent will attempt to find an endorser connection." - } - } - }, - "SchemaPostRequest": { - "type": "object", - "properties": { - "options": { - "$ref": "#/definitions/SchemaPostOption" - }, - "schema": { - "$ref": "#/definitions/AnonCredsSchema" - } - } - }, - "SchemaResult": { - "type": "object", - "properties": { - "job_id": { - "type": "string" - }, - "registration_metadata": { - "type": "object", - "properties": {} - }, - "schema_metadata": { - "type": "object", - "properties": {} - }, - "schema_state": { - "$ref": "#/definitions/SchemaState" - } - } - }, - "SchemaSendRequest": { - "type": "object", - "required": ["attributes", "schema_name", "schema_version"], - "properties": { - "attributes": { - "type": "array", - "description": "List of schema attributes", - "items": { - "type": "string", - "example": "score", - "description": "attribute name" - } - }, - "schema_name": { - "type": "string", - "example": "prefs", - "description": "Schema name" - }, - "schema_version": { - "type": "string", - "example": "1.0", - "description": "Schema version", - "pattern": "^[0-9.]+$" - } - } - }, - "SchemaSendResult": { - "type": "object", - "required": ["schema_id"], - "properties": { - "schema": { - "$ref": "#/definitions/SchemaSendResult_schema" - }, - "schema_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description": "Schema identifier", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - } - } - }, - "SchemaState": { - "type": "object", - "properties": { - "schema": { - "$ref": "#/definitions/AnonCredsSchema" - }, - "schema_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description": "Schema identifier" - }, - "state": { - "type": "string", - "enum": ["finished", "failed", "action", "wait"] - } - } - }, - "SchemasCreatedResult": { - "type": "object", - "properties": { - "schema_ids": { - "type": "array", - "items": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description": "Schema identifiers", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - } - } - } - }, - "SchemasInputDescriptorFilter": { - "type": "object", - "properties": { - "oneof_filter": { - "type": "boolean", - "description": "oneOf" - }, - "uri_groups": { - "type": "array", - "items": { - "type": "array", - "items": { - "$ref": "#/definitions/SchemaInputDescriptor" - } - } - } - } - }, - "SendMenu": { - "type": "object", - "required": ["menu"], - "properties": { - "menu": { - "$ref": "#/definitions/SendMenu_menu" - } - } - }, - "SendMessage": { - "type": "object", - "properties": { - "content": { - "type": "string", - "example": "Hello", - "description": "Message content" - } - } - }, - "ServiceDecorator": { - "type": "object", - "required": ["recipientKeys", "serviceEndpoint"], - "properties": { - "recipientKeys": { - "type": "array", - "description": "List of recipient keys", - "items": { - "type": "string", - "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description": "Recipient public key", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - } - }, - "routingKeys": { - "type": "array", - "description": "List of routing keys", - "items": { - "type": "string", - "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description": "Routing key", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - } - }, - "serviceEndpoint": { - "type": "string", - "example": "http://192.168.56.101:8020", - "description": "Service endpoint at which to reach this agent" - } - } - }, - "SignRequest": { - "type": "object", - "required": ["doc", "verkey"], - "properties": { - "doc": { - "$ref": "#/definitions/Doc" - }, - "verkey": { - "type": "string", - "description": "Verkey to use for signing" - } - } - }, - "SignResponse": { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "Error text" - }, - "signed_doc": { - "type": "object", - "description": "Signed document", - "properties": {} - } - } - }, - "SignatureOptions": { - "type": "object", - "required": ["proofPurpose", "verificationMethod"], - "properties": { - "challenge": { - "type": "string" - }, - "domain": { - "type": "string" - }, - "proofPurpose": { - "type": "string" - }, - "type": { - "type": "string" - }, - "verificationMethod": { - "type": "string" - } - } - }, - "SignedDoc": { - "type": "object", - "required": ["proof"], - "properties": { - "proof": { - "$ref": "#/definitions/SignedDoc_proof" - } - }, - "additionalProperties": true - }, - "SubmissionRequirements": { - "type": "object", - "properties": { - "count": { - "type": "integer", - "example": 1234, - "description": "Count Value" - }, - "from": { - "type": "string", - "description": "From" - }, - "from_nested": { - "type": "array", - "items": { - "$ref": "#/definitions/SubmissionRequirements" - } - }, - "max": { - "type": "integer", - "example": 1234, - "description": "Max Value" - }, - "min": { - "type": "integer", - "example": 1234, - "description": "Min Value" - }, - "name": { - "type": "string", - "description": "Name" - }, - "purpose": { - "type": "string", - "description": "Purpose" - }, - "rule": { - "type": "string", - "description": "Selection", - "enum": ["all", "pick"] - } - } - }, - "TAAAccept": { - "type": "object", - "properties": { - "mechanism": { - "type": "string" - }, - "text": { - "type": "string" - }, - "version": { - "type": "string" - } - } - }, - "TAAAcceptance": { - "type": "object", - "properties": { - "mechanism": { - "type": "string" - }, - "time": { - "type": "integer", - "example": 1640995199, - "minimum": 0, - "maximum": 18446744073709551615 - } - } - }, - "TAAInfo": { - "type": "object", - "properties": { - "aml_record": { - "$ref": "#/definitions/AMLRecord" - }, - "taa_accepted": { - "$ref": "#/definitions/TAAAcceptance" - }, - "taa_record": { - "$ref": "#/definitions/TAARecord" - }, - "taa_required": { - "type": "boolean" - } - } - }, - "TAARecord": { - "type": "object", - "properties": { - "digest": { - "type": "string" - }, - "text": { - "type": "string" - }, - "version": { - "type": "string" - } - } - }, - "TAAResult": { - "type": "object", - "properties": { - "result": { - "$ref": "#/definitions/TAAInfo" - } - } - }, - "TailsDeleteResponse": { - "type": "object", - "properties": { - "message": { - "type": "string" - } - } - }, - "TransactionJobs": { - "type": "object", - "properties": { - "transaction_my_job": { - "type": "string", - "description": "My transaction related job", - "enum": ["TRANSACTION_AUTHOR", "TRANSACTION_ENDORSER", "reset"] - }, - "transaction_their_job": { - "type": "string", - "description": "Their transaction related job", - "enum": ["TRANSACTION_AUTHOR", "TRANSACTION_ENDORSER", "reset"] - } - } - }, - "TransactionList": { - "type": "object", - "properties": { - "results": { - "type": "array", - "description": "List of transaction records", - "items": { - "$ref": "#/definitions/TransactionRecord" - } - } - } - }, - "TransactionRecord": { - "type": "object", - "properties": { - "_type": { - "type": "string", - "example": "101", - "description": "Transaction type" - }, - "connection_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "The connection identifier for this particular transaction record" - }, - "created_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of record creation", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "endorser_write_txn": { - "type": "boolean", - "example": false, - "description": "Request Endorser to write the ledger transaction, this parameter is deprecated and no longer supported." - }, - "formats": { - "type": "array", - "items": { - "type": "object", - "example": { - "attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "format": "dif/endorse-transaction/request@v1.0" - }, - "additionalProperties": { - "type": "string" - } - } - }, - "messages_attach": { - "type": "array", - "items": { - "type": "object", - "example": { - "@id": "143c458d-1b1c-40c7-ab85-4d16808ddf0a", - "data": { - "json": "{\"endorser\": \"V4SGRU86Z58d6TV7PBUe6f\",\"identifier\": \"LjgpST2rjsoxYegQDRm7EL\",\"operation\": {\"data\": {\"attr_names\": [\"first_name\", \"last_name\"],\"name\": \"test_schema\",\"version\": \"2.1\",},\"type\": \"101\",},\"protocolVersion\": 2,\"reqId\": 1597766666168851000,\"signatures\": {\"LjgpST2rjsox\": \"4ATKMn6Y9sTgwqaGTm7py2c2M8x1EVDTWKZArwyuPgjU\"}, \"taaAcceptance\": {\"mechanism\": \"manual\",\"taaDigest\": \"f50fe2c2ab977006761d36bd6f23e4c6a7e0fc2feb9f62\",\"time\": 1597708800,}}" - }, - "mime-type": "application/json" - }, - "properties": {} - } - }, - "meta_data": { - "type": "object", - "example": { - "context": { - "param1": "param1_value", - "param2": "param2_value" - }, - "post_process": [ - { - "topic": "topic_value", - "other": "other_value" - } - ] - }, - "properties": {} - }, - "signature_request": { - "type": "array", - "items": { - "type": "object", - "example": { - "author_goal_code": "aries.transaction.ledger.write", - "context": "did:sov", - "method": "add-signature", - "signature_type": "default", - "signer_goal_code": "aries.transaction.endorse" - }, - "properties": {} - } - }, - "signature_response": { - "type": "array", - "items": { - "type": "object", - "example": { - "context": "did:sov", - "message_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "method": "add-signature", - "signer_goal_code": "aries.transaction.refuse" - }, - "properties": {} - } - }, - "state": { - "type": "string", - "example": "active", - "description": "Current record state" - }, - "thread_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Thread Identifier" - }, - "timing": { - "type": "object", - "example": { - "expires_time": "2020-12-13T17:29:06+0000" - }, - "properties": {} - }, - "trace": { - "type": "boolean", - "description": "Record trace information, based on agent configuration" - }, - "transaction_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Transaction identifier" - }, - "updated_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of last record update", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - } - } - }, - "TxnOrCredentialDefinitionSendResult": { - "type": "object", - "properties": { - "sent": { - "$ref": "#/definitions/CredentialDefinitionSendResult" - }, - "txn": { - "$ref": "#/definitions/TxnOrCredentialDefinitionSendResult_txn" - } - } - }, - "TxnOrPublishRevocationsResult": { - "type": "object", - "properties": { - "rrid2crid": { - "type": "object", - "description": "Credential revocation ids by revocation registry id", - "additionalProperties": { - "type": "array", - "items": { - "type": "string", - "example": "12345", - "description": "Credential revocation identifier", - "pattern": "^[1-9][0-9]*$" - } - } - }, - "txn": { - "type": "array", - "items": { - "type": "object", - "description": "Revocation registry revocations transaction to endorse", - "allOf": [ - { - "$ref": "#/definitions/TransactionRecord" - } - ] - } - } - } - }, - "TxnOrRegisterLedgerNymResponse": { - "type": "object", - "properties": { - "success": { - "type": "boolean", - "example": true, - "description": "Success of nym registration operation" - }, - "txn": { - "$ref": "#/definitions/TxnOrRegisterLedgerNymResponse_txn" - } - } - }, - "TxnOrRevRegResult": { - "type": "object", - "properties": { - "sent": { - "$ref": "#/definitions/RevRegResult" - }, - "txn": { - "$ref": "#/definitions/TxnOrRevRegResult_txn" - } - } - }, - "TxnOrSchemaSendResult": { - "type": "object", - "properties": { - "sent": { - "$ref": "#/definitions/TxnOrSchemaSendResult_sent" - }, - "txn": { - "$ref": "#/definitions/TxnOrSchemaSendResult_txn" - } - } - }, - "UpdateProfileSettings": { - "type": "object", - "properties": { - "extra_settings": { - "type": "object", - "example": { - "ACAPY_INVITE_PUBLIC": true, - "log-level": "INFO", - "public-invites": false - }, - "description": "Agent config key-value pairs", - "properties": {} - } - } - }, - "UpdateWalletRequest": { - "type": "object", - "properties": { - "extra_settings": { - "type": "object", - "description": "Agent config key-value pairs", - "properties": {} - }, - "image_url": { - "type": "string", - "example": "https://aries.ca/images/sample.png", - "description": "Image url for this wallet. This image url is publicized (self-attested) to other agents as part of forming a connection." - }, - "label": { - "type": "string", - "example": "Alice", - "description": "Label for this wallet. This label is publicized (self-attested) to other agents as part of forming a connection." - }, - "wallet_dispatch_type": { - "type": "string", - "example": "default", - "description": "Webhook target dispatch type for this wallet. default: Dispatch only to webhooks associated with this wallet. base: Dispatch only to webhooks associated with the base wallet. both: Dispatch to both webhook targets.", - "enum": ["default", "both", "base"] - }, - "wallet_webhook_urls": { - "type": "array", - "description": "List of Webhook URLs associated with this subwallet", - "items": { - "type": "string", - "example": "http://localhost:8022/webhooks", - "description": "Optional webhook URL to receive webhook messages" - } - } - } - }, - "UpgradeResult": { - "type": "object" - }, - "V10CredentialBoundOfferRequest": { - "type": "object", - "properties": { - "counter_proposal": { - "$ref": "#/definitions/V10CredentialBoundOfferRequest_counter_proposal" - } - } - }, - "V10CredentialConnFreeOfferRequest": { - "type": "object", - "required": ["cred_def_id", "credential_preview"], - "properties": { - "auto_issue": { - "type": "boolean", - "description": "Whether to respond automatically to credential requests, creating and issuing requested credentials" - }, - "auto_remove": { - "type": "boolean", - "description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "comment": { - "type": "string", - "description": "Human-readable comment", - "x-nullable": true - }, - "cred_def_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description": "Credential definition identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "credential_preview": { - "$ref": "#/definitions/CredentialPreview" - }, - "trace": { - "type": "boolean", - "description": "Record trace information, based on agent configuration" - } - } - }, - "V10CredentialCreate": { - "type": "object", - "required": ["credential_proposal"], - "properties": { - "auto_remove": { - "type": "boolean", - "description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "comment": { - "type": "string", - "description": "Human-readable comment", - "x-nullable": true - }, - "cred_def_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description": "Credential definition identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "credential_proposal": { - "$ref": "#/definitions/CredentialPreview" - }, - "issuer_did": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv", - "description": "Credential issuer DID", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "schema_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description": "Schema identifier", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - }, - "schema_issuer_did": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv", - "description": "Schema issuer DID", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "schema_name": { - "type": "string", - "example": "preferences", - "description": "Schema name" - }, - "schema_version": { - "type": "string", - "example": "1.0", - "description": "Schema version", - "pattern": "^[0-9.]+$" - }, - "trace": { - "type": "boolean", - "description": "Record trace information, based on agent configuration" - } - } - }, - "V10CredentialExchange": { - "type": "object", - "properties": { - "auto_issue": { - "type": "boolean", - "example": false, - "description": "Issuer choice to issue to request in this credential exchange" - }, - "auto_offer": { - "type": "boolean", - "example": false, - "description": "Holder choice to accept offer in this credential exchange" - }, - "auto_remove": { - "type": "boolean", - "example": false, - "description": "Issuer choice to remove this credential exchange record when complete" - }, - "connection_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Connection identifier" - }, - "created_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of record creation", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "credential": { - "$ref": "#/definitions/V10CredentialExchange_credential" - }, - "credential_definition_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description": "Credential definition identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "credential_exchange_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Credential exchange identifier" - }, - "credential_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Credential identifier" - }, - "credential_offer": { - "$ref": "#/definitions/V10CredentialExchange_credential_offer" - }, - "credential_offer_dict": { - "$ref": "#/definitions/V10CredentialExchange_credential_offer_dict" - }, - "credential_proposal_dict": { - "$ref": "#/definitions/V10CredentialExchange_credential_proposal_dict" - }, - "credential_request": { - "$ref": "#/definitions/V10CredentialExchange_credential_request" - }, - "credential_request_metadata": { - "type": "object", - "description": "(Indy) credential request metadata", - "properties": {} - }, - "error_msg": { - "type": "string", - "example": "Credential definition identifier is not set in proposal", - "description": "Error message" - }, - "initiator": { - "type": "string", - "example": "self", - "description": "Issue-credential exchange initiator: self or external", - "enum": ["self", "external"] - }, - "parent_thread_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Parent thread identifier" - }, - "raw_credential": { - "$ref": "#/definitions/V10CredentialExchange_raw_credential" - }, - "revoc_reg_id": { - "type": "string", - "description": "Revocation registry identifier" - }, - "revocation_id": { - "type": "string", - "description": "Credential identifier within revocation registry" - }, - "role": { - "type": "string", - "example": "issuer", - "description": "Issue-credential exchange role: holder or issuer", - "enum": ["holder", "issuer"] - }, - "schema_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description": "Schema identifier", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - }, - "state": { - "type": "string", - "example": "credential_acked", - "description": "Issue-credential exchange state" - }, - "thread_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Thread identifier" - }, - "trace": { - "type": "boolean", - "description": "Record trace information, based on agent configuration" - }, - "updated_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of last record update", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - } - } - }, - "V10CredentialExchangeAutoRemoveRequest": { - "type": "object", - "properties": { - "auto_remove": { - "type": "boolean", - "description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)" - } - } - }, - "V10CredentialExchangeListResult": { - "type": "object", - "properties": { - "results": { - "type": "array", - "description": "Aries#0036 v1.0 credential exchange records", - "items": { - "$ref": "#/definitions/V10CredentialExchange" - } - } - } - }, - "V10CredentialFreeOfferRequest": { - "type": "object", - "required": ["connection_id", "cred_def_id", "credential_preview"], - "properties": { - "auto_issue": { - "type": "boolean", - "description": "Whether to respond automatically to credential requests, creating and issuing requested credentials" - }, - "auto_remove": { - "type": "boolean", - "description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "comment": { - "type": "string", - "description": "Human-readable comment", - "x-nullable": true - }, - "connection_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Connection identifier" - }, - "cred_def_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description": "Credential definition identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "credential_preview": { - "$ref": "#/definitions/CredentialPreview" - }, - "trace": { - "type": "boolean", - "description": "Record trace information, based on agent configuration" - } - } - }, - "V10CredentialIssueRequest": { - "type": "object", - "properties": { - "comment": { - "type": "string", - "description": "Human-readable comment", - "x-nullable": true - } - } - }, - "V10CredentialProblemReportRequest": { - "type": "object", - "required": ["description"], - "properties": { - "description": { - "type": "string" - } - } - }, - "V10CredentialProposalRequestMand": { - "type": "object", - "required": ["connection_id", "credential_proposal"], - "properties": { - "auto_remove": { - "type": "boolean", - "description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "comment": { - "type": "string", - "description": "Human-readable comment", - "x-nullable": true - }, - "connection_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Connection identifier" - }, - "cred_def_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description": "Credential definition identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "credential_proposal": { - "$ref": "#/definitions/CredentialPreview" - }, - "issuer_did": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv", - "description": "Credential issuer DID", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "schema_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description": "Schema identifier", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - }, - "schema_issuer_did": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv", - "description": "Schema issuer DID", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "schema_name": { - "type": "string", - "example": "preferences", - "description": "Schema name" - }, - "schema_version": { - "type": "string", - "example": "1.0", - "description": "Schema version", - "pattern": "^[0-9.]+$" - }, - "trace": { - "type": "boolean", - "description": "Record trace information, based on agent configuration" - } - } - }, - "V10CredentialProposalRequestOpt": { - "type": "object", - "required": ["connection_id"], - "properties": { - "auto_remove": { - "type": "boolean", - "description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "comment": { - "type": "string", - "description": "Human-readable comment", - "x-nullable": true - }, - "connection_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Connection identifier" - }, - "cred_def_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description": "Credential definition identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "credential_proposal": { - "$ref": "#/definitions/CredentialPreview" - }, - "issuer_did": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv", - "description": "Credential issuer DID", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "schema_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description": "Schema identifier", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - }, - "schema_issuer_did": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv", - "description": "Schema issuer DID", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "schema_name": { - "type": "string", - "example": "preferences", - "description": "Schema name" - }, - "schema_version": { - "type": "string", - "example": "1.0", - "description": "Schema version", - "pattern": "^[0-9.]+$" - }, - "trace": { - "type": "boolean", - "description": "Record trace information, based on agent configuration" - } - } - }, - "V10CredentialStoreRequest": { - "type": "object", - "properties": { - "credential_id": { - "type": "string" - } - } - }, - "V10DiscoveryExchangeListResult": { - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "type": "object", - "description": "Discover Features v1.0 exchange record", - "allOf": [ - { - "$ref": "#/definitions/V10DiscoveryRecord" - } - ] - } - } - } - }, - "V10DiscoveryRecord": { - "type": "object", - "properties": { - "connection_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Connection identifier" - }, - "created_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of record creation", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "disclose": { - "$ref": "#/definitions/V10DiscoveryRecord_disclose" - }, - "discovery_exchange_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Credential exchange identifier" - }, - "query_msg": { - "$ref": "#/definitions/V10DiscoveryRecord_query_msg" - }, - "state": { - "type": "string", - "example": "active", - "description": "Current record state" - }, - "thread_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Thread identifier" - }, - "trace": { - "type": "boolean", - "description": "Record trace information, based on agent configuration" - }, - "updated_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of last record update", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - } - } - }, - "V10PresentProofModuleResponse": { - "type": "object" - }, - "V10PresentationCreateRequestRequest": { - "type": "object", - "required": ["proof_request"], - "properties": { - "auto_remove": { - "type": "boolean", - "description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "auto_verify": { - "type": "boolean", - "example": false, - "description": "Verifier choice to auto-verify proof presentation" - }, - "comment": { - "type": "string", - "x-nullable": true - }, - "proof_request": { - "$ref": "#/definitions/IndyProofRequest" - }, - "trace": { - "type": "boolean", - "example": false, - "description": "Whether to trace event (default false)" - } - } - }, - "V10PresentationExchange": { - "type": "object", - "properties": { - "auto_present": { - "type": "boolean", - "example": false, - "description": "Prover choice to auto-present proof as verifier requests" - }, - "auto_remove": { - "type": "boolean", - "example": false, - "description": "Verifier choice to remove this presentation exchange record when complete" - }, - "auto_verify": { - "type": "boolean", - "description": "Verifier choice to auto-verify proof presentation" - }, - "connection_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Connection identifier" - }, - "created_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of record creation", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "error_msg": { - "type": "string", - "example": "Invalid structure", - "description": "Error message" - }, - "initiator": { - "type": "string", - "example": "self", - "description": "Present-proof exchange initiator: self or external", - "enum": ["self", "external"] - }, - "presentation": { - "$ref": "#/definitions/V10PresentationExchange_presentation" - }, - "presentation_exchange_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Presentation exchange identifier" - }, - "presentation_proposal_dict": { - "$ref": "#/definitions/V10PresentationExchange_presentation_proposal_dict" - }, - "presentation_request": { - "$ref": "#/definitions/V10PresentationExchange_presentation_request" - }, - "presentation_request_dict": { - "$ref": "#/definitions/V10PresentationExchange_presentation_request_dict" - }, - "role": { - "type": "string", - "example": "prover", - "description": "Present-proof exchange role: prover or verifier", - "enum": ["prover", "verifier"] - }, - "state": { - "type": "string", - "example": "verified", - "description": "Present-proof exchange state" - }, - "thread_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Thread identifier" - }, - "trace": { - "type": "boolean", - "description": "Record trace information, based on agent configuration" - }, - "updated_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of last record update", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "verified": { - "type": "string", - "example": "true", - "description": "Whether presentation is verified: true or false", - "enum": ["true", "false"] - }, - "verified_msgs": { - "type": "array", - "items": { - "type": "string", - "description": "Proof verification warning or error information" - } - } - } - }, - "V10PresentationExchangeList": { - "type": "object", - "properties": { - "results": { - "type": "array", - "description": "Aries RFC 37 v1.0 presentation exchange records", - "items": { - "$ref": "#/definitions/V10PresentationExchange" - } - } - } - }, - "V10PresentationProblemReportRequest": { - "type": "object", - "required": ["description"], - "properties": { - "description": { - "type": "string" - } - } - }, - "V10PresentationProposalRequest": { - "type": "object", - "required": ["connection_id", "presentation_proposal"], - "properties": { - "auto_present": { - "type": "boolean", - "description": "Whether to respond automatically to presentation requests, building and presenting requested proof" - }, - "auto_remove": { - "type": "boolean", - "description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "comment": { - "type": "string", - "description": "Human-readable comment", - "x-nullable": true - }, - "connection_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Connection identifier" - }, - "presentation_proposal": { - "$ref": "#/definitions/IndyPresPreview" - }, - "trace": { - "type": "boolean", - "example": false, - "description": "Whether to trace event (default false)" - } - } - }, - "V10PresentationSendRequest": { - "type": "object", - "required": [ - "requested_attributes", - "requested_predicates", - "self_attested_attributes" - ], - "properties": { - "auto_remove": { - "type": "boolean", - "description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "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" - } - }, - "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" - } - }, - "trace": { - "type": "boolean", - "example": false, - "description": "Whether to trace event (default false)" - } - } - }, - "V10PresentationSendRequestRequest": { - "type": "object", - "required": ["connection_id", "proof_request"], - "properties": { - "auto_remove": { - "type": "boolean", - "description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "auto_verify": { - "type": "boolean", - "example": false, - "description": "Verifier choice to auto-verify proof presentation" - }, - "comment": { - "type": "string", - "x-nullable": true - }, - "connection_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Connection identifier" - }, - "proof_request": { - "$ref": "#/definitions/IndyProofRequest" - }, - "trace": { - "type": "boolean", - "example": false, - "description": "Whether to trace event (default false)" - } - } - }, - "V10PresentationSendRequestToProposal": { - "type": "object", - "properties": { - "auto_remove": { - "type": "boolean", - "description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "auto_verify": { - "type": "boolean", - "example": false, - "description": "Verifier choice to auto-verify proof presentation" - }, - "trace": { - "type": "boolean", - "example": false, - "description": "Whether to trace event (default false)" - } - } - }, - "V20CredAttrSpec": { - "type": "object", - "required": ["name", "value"], - "properties": { - "mime-type": { - "type": "string", - "example": "image/jpeg", - "description": "MIME type: omit for (null) default", - "x-nullable": true - }, - "name": { - "type": "string", - "example": "favourite_drink", - "description": "Attribute name" - }, - "value": { - "type": "string", - "example": "martini", - "description": "Attribute value: base64-encode if MIME type is present" - } - } - }, - "V20CredBoundOfferRequest": { - "type": "object", - "properties": { - "counter_preview": { - "$ref": "#/definitions/V20CredBoundOfferRequest_counter_preview" - }, - "filter": { - "$ref": "#/definitions/V20CredBoundOfferRequest_filter" - } - } - }, - "V20CredExFree": { - "type": "object", - "required": ["connection_id", "filter"], - "properties": { - "auto_remove": { - "type": "boolean", - "description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "comment": { - "type": "string", - "description": "Human-readable comment", - "x-nullable": true - }, - "connection_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Connection identifier" - }, - "credential_preview": { - "$ref": "#/definitions/V20CredPreview" - }, - "filter": { - "$ref": "#/definitions/V20CredBoundOfferRequest_filter" - }, - "replacement_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Optional identifier used to manage credential replacement", - "x-nullable": true - }, - "trace": { - "type": "boolean", - "description": "Record trace information, based on agent configuration" - }, - "verification_method": { - "type": "string", - "description": "For ld-proofs. Verification method for signing.", - "x-nullable": true - } - } - }, - "V20CredExRecord": { - "type": "object", - "properties": { - "auto_issue": { - "type": "boolean", - "example": false, - "description": "Issuer choice to issue to request in this credential exchange" - }, - "auto_offer": { - "type": "boolean", - "example": false, - "description": "Holder choice to accept offer in this credential exchange" - }, - "auto_remove": { - "type": "boolean", - "example": false, - "description": "Issuer choice to remove this credential exchange record when complete" - }, - "by_format": { - "$ref": "#/definitions/V20CredExRecord_by_format" - }, - "connection_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Connection identifier" - }, - "created_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of record creation", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "cred_ex_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Credential exchange identifier" - }, - "cred_issue": { - "$ref": "#/definitions/V20CredExRecord_cred_issue" - }, - "cred_offer": { - "$ref": "#/definitions/V10CredentialExchange_credential_offer_dict" - }, - "cred_preview": { - "$ref": "#/definitions/V20CredExRecord_cred_preview" - }, - "cred_proposal": { - "$ref": "#/definitions/V10CredentialExchange_credential_proposal_dict" - }, - "cred_request": { - "$ref": "#/definitions/V20CredExRecord_cred_request" - }, - "error_msg": { - "type": "string", - "example": "The front fell off", - "description": "Error message" - }, - "initiator": { - "type": "string", - "example": "self", - "description": "Issue-credential exchange initiator: self or external", - "enum": ["self", "external"] - }, - "parent_thread_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Parent thread identifier" - }, - "role": { - "type": "string", - "example": "issuer", - "description": "Issue-credential exchange role: holder or issuer", - "enum": ["issuer", "holder"] - }, - "state": { - "type": "string", - "example": "done", - "description": "Issue-credential exchange state", - "enum": [ - "proposal-sent", - "proposal-received", - "offer-sent", - "offer-received", - "request-sent", - "request-received", - "credential-issued", - "credential-received", - "done", - "credential-revoked", - "abandoned", - "deleted" - ] - }, - "thread_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Thread identifier" - }, - "trace": { - "type": "boolean", - "description": "Record trace information, based on agent configuration" - }, - "updated_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of last record update", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - } - } - }, - "V20CredExRecordByFormat": { - "type": "object", - "properties": { - "cred_issue": { - "type": "object", - "properties": {} - }, - "cred_offer": { - "type": "object", - "properties": {} - }, - "cred_proposal": { - "type": "object", - "properties": {} - }, - "cred_request": { - "type": "object", - "properties": {} - } - } - }, - "V20CredExRecordDetail": { - "type": "object", - "properties": { - "cred_ex_record": { - "$ref": "#/definitions/V20CredExRecordDetail_cred_ex_record" - }, - "indy": { - "$ref": "#/definitions/V20CredExRecordIndy" - }, - "ld_proof": { - "$ref": "#/definitions/V20CredExRecordLDProof" - }, - "vc_di": { - "$ref": "#/definitions/V20CredExRecord" - } - } - }, - "V20CredExRecordIndy": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of record creation", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "cred_ex_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Corresponding v2.0 credential exchange record identifier" - }, - "cred_ex_indy_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Record identifier" - }, - "cred_id_stored": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Credential identifier stored in wallet" - }, - "cred_request_metadata": { - "type": "object", - "description": "Credential request metadata for indy holder", - "properties": {} - }, - "cred_rev_id": { - "type": "string", - "example": "12345", - "description": "Credential revocation identifier within revocation registry", - "pattern": "^[1-9][0-9]*$" - }, - "rev_reg_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", - "description": "Revocation registry identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)" - }, - "state": { - "type": "string", - "example": "active", - "description": "Current record state" - }, - "updated_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of last record update", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - } - } - }, - "V20CredExRecordLDProof": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of record creation", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "cred_ex_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Corresponding v2.0 credential exchange record identifier" - }, - "cred_ex_ld_proof_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Record identifier" - }, - "cred_id_stored": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Credential identifier stored in wallet" - }, - "state": { - "type": "string", - "example": "active", - "description": "Current record state" - }, - "updated_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of last record update", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - } - } - }, - "V20CredExRecordListResult": { - "type": "object", - "properties": { - "results": { - "type": "array", - "description": "Credential exchange records and corresponding detail records", - "items": { - "$ref": "#/definitions/V20CredExRecordDetail" - } - } - } - }, - "V20CredFilter": { - "type": "object", - "properties": { - "indy": { - "$ref": "#/definitions/V20CredFilter_indy" - }, - "ld_proof": { - "$ref": "#/definitions/V20CredFilter_ld_proof" - }, - "vc_di": { - "$ref": "#/definitions/V20CredFilter_vc_di" - } - } - }, - "V20CredFilterIndy": { - "type": "object", - "properties": { - "cred_def_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description": "Credential definition identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "issuer_did": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv", - "description": "Credential issuer DID", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "schema_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description": "Schema identifier", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - }, - "schema_issuer_did": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv", - "description": "Schema issuer DID", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "schema_name": { - "type": "string", - "example": "preferences", - "description": "Schema name" - }, - "schema_version": { - "type": "string", - "example": "1.0", - "description": "Schema version", - "pattern": "^[0-9.]+$" - } - } - }, - "V20CredFilterLDProof": { - "type": "object", - "required": ["ld_proof"], - "properties": { - "ld_proof": { - "$ref": "#/definitions/V20CredFilter_ld_proof" - } - } - }, - "V20CredFilterVCDI": { - "type": "object", - "properties": { - "cred_def_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description": "Credential definition identifier", - "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "issuer_did": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv", - "description": "Credential issuer DID", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "schema_id": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description": "Schema identifier", - "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - }, - "schema_issuer_did": { - "type": "string", - "example": "WgWxqztrNooG92RXvxSTWv", - "description": "Schema issuer DID", - "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "schema_name": { - "type": "string", - "example": "preferences", - "description": "Schema name" - }, - "schema_version": { - "type": "string", - "example": "1.0", - "description": "Schema version", - "pattern": "^[0-9.]+$" - } - } - }, - "V20CredFormat": { - "type": "object", - "required": ["attach_id", "format"], - "properties": { - "attach_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Attachment identifier" - }, - "format": { - "type": "string", - "example": "aries/ld-proof-vc-detail@v1.0", - "description": "Attachment format specifier" - } - } - }, - "V20CredIssue": { - "type": "object", - "required": ["credentials~attach", "formats"], - "properties": { - "@id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Message identifier" - }, - "@type": { - "type": "string", - "example": "https://didcomm.org/my-family/1.0/my-message-type", - "description": "Message type" - }, - "comment": { - "type": "string", - "description": "Human-readable comment", - "x-nullable": true - }, - "credentials~attach": { - "type": "array", - "description": "Credential attachments", - "items": { - "$ref": "#/definitions/AttachDecorator" - } - }, - "formats": { - "type": "array", - "description": "Acceptable attachment formats", - "items": { - "$ref": "#/definitions/V20CredFormat" - } - }, - "replacement_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Issuer-unique identifier to coordinate credential replacement" - } - } - }, - "V20CredIssueProblemReportRequest": { - "type": "object", - "required": ["description"], - "properties": { - "description": { - "type": "string" - } - } - }, - "V20CredIssueRequest": { - "type": "object", - "properties": { - "comment": { - "type": "string", - "description": "Human-readable comment", - "x-nullable": true - } - } - }, - "V20CredOffer": { - "type": "object", - "required": ["formats", "offers~attach"], - "properties": { - "@id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Message identifier" - }, - "@type": { - "type": "string", - "example": "https://didcomm.org/my-family/1.0/my-message-type", - "description": "Message type" - }, - "comment": { - "type": "string", - "description": "Human-readable comment", - "x-nullable": true - }, - "credential_preview": { - "$ref": "#/definitions/V20CredPreview" - }, - "formats": { - "type": "array", - "description": "Acceptable credential formats", - "items": { - "$ref": "#/definitions/V20CredFormat" - } - }, - "offers~attach": { - "type": "array", - "description": "Offer attachments", - "items": { - "$ref": "#/definitions/AttachDecorator" - } - }, - "replacement_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Issuer-unique identifier to coordinate credential replacement" - } - } - }, - "V20CredOfferConnFreeRequest": { - "type": "object", - "required": ["filter"], - "properties": { - "auto_issue": { - "type": "boolean", - "description": "Whether to respond automatically to credential requests, creating and issuing requested credentials" - }, - "auto_remove": { - "type": "boolean", - "description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "comment": { - "type": "string", - "description": "Human-readable comment", - "x-nullable": true - }, - "credential_preview": { - "$ref": "#/definitions/V20CredPreview" - }, - "filter": { - "$ref": "#/definitions/V20CredBoundOfferRequest_filter" - }, - "replacement_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Optional identifier used to manage credential replacement", - "x-nullable": true - }, - "trace": { - "type": "boolean", - "description": "Record trace information, based on agent configuration" - } - } - }, - "V20CredOfferRequest": { - "type": "object", - "required": ["connection_id", "filter"], - "properties": { - "auto_issue": { - "type": "boolean", - "description": "Whether to respond automatically to credential requests, creating and issuing requested credentials" - }, - "auto_remove": { - "type": "boolean", - "description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "comment": { - "type": "string", - "description": "Human-readable comment", - "x-nullable": true - }, - "connection_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Connection identifier" - }, - "credential_preview": { - "$ref": "#/definitions/V20CredPreview" - }, - "filter": { - "$ref": "#/definitions/V20CredBoundOfferRequest_filter" - }, - "replacement_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Optional identifier used to manage credential replacement", - "x-nullable": true - }, - "trace": { - "type": "boolean", - "description": "Record trace information, based on agent configuration" - } - } - }, - "V20CredPreview": { - "type": "object", - "required": ["attributes"], - "properties": { - "@type": { - "type": "string", - "example": "issue-credential/2.0/credential-preview", - "description": "Message type identifier" - }, - "attributes": { - "type": "array", - "items": { - "$ref": "#/definitions/V20CredAttrSpec" - } - } - } - }, - "V20CredProposal": { - "type": "object", - "required": ["filters~attach", "formats"], - "properties": { - "@id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Message identifier" - }, - "@type": { - "type": "string", - "example": "https://didcomm.org/my-family/1.0/my-message-type", - "description": "Message type" - }, - "comment": { - "type": "string", - "description": "Human-readable comment", - "x-nullable": true - }, - "credential_preview": { - "$ref": "#/definitions/V20CredProposal_credential_preview" - }, - "filters~attach": { - "type": "array", - "description": "Credential filter per acceptable format on corresponding identifier", - "items": { - "$ref": "#/definitions/AttachDecorator" - } - }, - "formats": { - "type": "array", - "description": "Attachment formats", - "items": { - "$ref": "#/definitions/V20CredFormat" - } - } - } - }, - "V20CredRequest": { - "type": "object", - "required": ["formats", "requests~attach"], - "properties": { - "@id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Message identifier" - }, - "@type": { - "type": "string", - "example": "https://didcomm.org/my-family/1.0/my-message-type", - "description": "Message type" - }, - "comment": { - "type": "string", - "description": "Human-readable comment", - "x-nullable": true - }, - "formats": { - "type": "array", - "description": "Acceptable attachment formats", - "items": { - "$ref": "#/definitions/V20CredFormat" - } - }, - "requests~attach": { - "type": "array", - "description": "Request attachments", - "items": { - "$ref": "#/definitions/AttachDecorator" - } - } - } - }, - "V20CredRequestFree": { - "type": "object", - "required": ["connection_id", "filter"], - "properties": { - "auto_remove": { - "type": "boolean", - "description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "comment": { - "type": "string", - "description": "Human-readable comment", - "x-nullable": true - }, - "connection_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Connection identifier" - }, - "filter": { - "$ref": "#/definitions/V20CredBoundOfferRequest_filter" - }, - "holder_did": { - "type": "string", - "example": "did:key:ahsdkjahsdkjhaskjdhakjshdkajhsdkjahs", - "description": "Holder DID to substitute for the credentialSubject.id", - "x-nullable": true - }, - "trace": { - "type": "boolean", - "example": false, - "description": "Whether to trace event (default false)" - } - } - }, - "V20CredRequestRequest": { - "type": "object", - "properties": { - "auto_remove": { - "type": "boolean", - "description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "holder_did": { - "type": "string", - "example": "did:key:ahsdkjahsdkjhaskjdhakjshdkajhsdkjahs", - "description": "Holder DID to substitute for the credentialSubject.id", - "x-nullable": true - } - } - }, - "V20CredStoreRequest": { - "type": "object", - "properties": { - "credential_id": { - "type": "string" - } - } - }, - "V20DiscoveryExchangeListResult": { - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "type": "object", - "description": "Discover Features v2.0 exchange record", - "allOf": [ - { - "$ref": "#/definitions/V20DiscoveryRecord" - } - ] - } - } - } - }, - "V20DiscoveryExchangeResult": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/V20DiscoveryExchangeResult_results" - } - } - }, - "V20DiscoveryRecord": { - "type": "object", - "properties": { - "connection_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Connection identifier" - }, - "created_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of record creation", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "disclosures": { - "$ref": "#/definitions/V20DiscoveryRecord_disclosures" - }, - "discovery_exchange_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Credential exchange identifier" - }, - "queries_msg": { - "$ref": "#/definitions/V20DiscoveryRecord_queries_msg" - }, - "state": { - "type": "string", - "example": "active", - "description": "Current record state" - }, - "thread_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Thread identifier" - }, - "trace": { - "type": "boolean", - "description": "Record trace information, based on agent configuration" - }, - "updated_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of last record update", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - } - } - }, - "V20IssueCredSchemaCore": { - "type": "object", - "required": ["filter"], - "properties": { - "auto_remove": { - "type": "boolean", - "description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "comment": { - "type": "string", - "description": "Human-readable comment", - "x-nullable": true - }, - "credential_preview": { - "$ref": "#/definitions/V20CredPreview" - }, - "filter": { - "$ref": "#/definitions/V20CredBoundOfferRequest_filter" - }, - "replacement_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Optional identifier used to manage credential replacement", - "x-nullable": true - }, - "trace": { - "type": "boolean", - "description": "Record trace information, based on agent configuration" - } - } - }, - "V20IssueCredentialModuleResponse": { - "type": "object" - }, - "V20Pres": { - "type": "object", - "required": ["formats", "presentations~attach"], - "properties": { - "@id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Message identifier" - }, - "@type": { - "type": "string", - "example": "https://didcomm.org/my-family/1.0/my-message-type", - "description": "Message type" - }, - "comment": { - "type": "string", - "description": "Human-readable comment", - "x-nullable": true - }, - "formats": { - "type": "array", - "description": "Acceptable attachment formats", - "items": { - "$ref": "#/definitions/V20PresFormat" - } - }, - "presentations~attach": { - "type": "array", - "items": { - "$ref": "#/definitions/AttachDecorator" - } - } - } - }, - "V20PresCreateRequestRequest": { - "type": "object", - "required": ["presentation_request"], - "properties": { - "auto_remove": { - "type": "boolean", - "description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "auto_verify": { - "type": "boolean", - "example": false, - "description": "Verifier choice to auto-verify proof presentation" - }, - "comment": { - "type": "string", - "x-nullable": true - }, - "presentation_request": { - "$ref": "#/definitions/V20PresRequestByFormat" - }, - "trace": { - "type": "boolean", - "example": false, - "description": "Whether to trace event (default false)" - } - } - }, - "V20PresExRecord": { - "type": "object", - "properties": { - "auto_present": { - "type": "boolean", - "example": false, - "description": "Prover choice to auto-present proof as verifier requests" - }, - "auto_remove": { - "type": "boolean", - "example": false, - "description": "Verifier choice to remove this presentation exchange record when complete" - }, - "auto_verify": { - "type": "boolean", - "description": "Verifier choice to auto-verify proof presentation" - }, - "by_format": { - "$ref": "#/definitions/V20PresExRecord_by_format" - }, - "connection_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Connection identifier" - }, - "created_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of record creation", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "error_msg": { - "type": "string", - "example": "Invalid structure", - "description": "Error message" - }, - "initiator": { - "type": "string", - "example": "self", - "description": "Present-proof exchange initiator: self or external", - "enum": ["self", "external"] - }, - "pres": { - "$ref": "#/definitions/V20PresExRecord_pres" - }, - "pres_ex_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Presentation exchange identifier" - }, - "pres_proposal": { - "$ref": "#/definitions/V10PresentationExchange_presentation_proposal_dict" - }, - "pres_request": { - "$ref": "#/definitions/V10PresentationExchange_presentation_request_dict" - }, - "role": { - "type": "string", - "example": "prover", - "description": "Present-proof exchange role: prover or verifier", - "enum": ["prover", "verifier"] - }, - "state": { - "type": "string", - "description": "Present-proof exchange state", - "enum": [ - "proposal-sent", - "proposal-received", - "request-sent", - "request-received", - "presentation-sent", - "presentation-received", - "done", - "abandoned", - "deleted" - ] - }, - "thread_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Thread identifier" - }, - "trace": { - "type": "boolean", - "description": "Record trace information, based on agent configuration" - }, - "updated_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of last record update", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "verified": { - "type": "string", - "example": "true", - "description": "Whether presentation is verified: 'true' or 'false'", - "enum": ["true", "false"] - }, - "verified_msgs": { - "type": "array", - "items": { - "type": "string", - "description": "Proof verification warning or error information" - } - } - } - }, - "V20PresExRecordByFormat": { - "type": "object", - "properties": { - "pres": { - "type": "object", - "properties": {} - }, - "pres_proposal": { - "type": "object", - "properties": {} - }, - "pres_request": { - "type": "object", - "properties": {} - } - } - }, - "V20PresExRecordList": { - "type": "object", - "properties": { - "results": { - "type": "array", - "description": "Presentation exchange records", - "items": { - "$ref": "#/definitions/V20PresExRecord" - } - } - } - }, - "V20PresFormat": { - "type": "object", - "required": ["attach_id", "format"], - "properties": { - "attach_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Attachment identifier" - }, - "format": { - "type": "string", - "example": "dif/presentation-exchange/submission@v1.0", - "description": "Attachment format specifier" - } - } - }, - "V20PresProblemReportRequest": { - "type": "object", - "required": ["description"], - "properties": { - "description": { - "type": "string" - } - } - }, - "V20PresProposal": { - "type": "object", - "required": ["formats", "proposals~attach"], - "properties": { - "@id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Message identifier" - }, - "@type": { - "type": "string", - "example": "https://didcomm.org/my-family/1.0/my-message-type", - "description": "Message type" - }, - "comment": { - "type": "string", - "description": "Human-readable comment" - }, - "formats": { - "type": "array", - "description": "Acceptable attachment formats", - "items": { - "$ref": "#/definitions/V20PresFormat" - } - }, - "proposals~attach": { - "type": "array", - "description": "Attachment per acceptable format on corresponding identifier", - "items": { - "$ref": "#/definitions/AttachDecorator" - } - } - } - }, - "V20PresProposalByFormat": { - "type": "object", - "properties": { - "dif": { - "$ref": "#/definitions/V20PresProposalByFormat_dif" - }, - "indy": { - "$ref": "#/definitions/V20PresProposalByFormat_indy" - } - } - }, - "V20PresProposalRequest": { - "type": "object", - "required": ["connection_id", "presentation_proposal"], - "properties": { - "auto_present": { - "type": "boolean", - "description": "Whether to respond automatically to presentation requests, building and presenting requested proof" - }, - "auto_remove": { - "type": "boolean", - "description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "comment": { - "type": "string", - "description": "Human-readable comment", - "x-nullable": true - }, - "connection_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Connection identifier" - }, - "presentation_proposal": { - "$ref": "#/definitions/V20PresProposalByFormat" - }, - "trace": { - "type": "boolean", - "example": false, - "description": "Whether to trace event (default false)" - } - } - }, - "V20PresRequest": { - "type": "object", - "required": ["formats", "request_presentations~attach"], - "properties": { - "@id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Message identifier" - }, - "@type": { - "type": "string", - "example": "https://didcomm.org/my-family/1.0/my-message-type", - "description": "Message type" - }, - "comment": { - "type": "string", - "description": "Human-readable comment" - }, - "formats": { - "type": "array", - "description": "Acceptable attachment formats", - "items": { - "$ref": "#/definitions/V20PresFormat" - } - }, - "request_presentations~attach": { - "type": "array", - "description": "Attachment per acceptable format on corresponding identifier", - "items": { - "$ref": "#/definitions/AttachDecorator" - } - }, - "will_confirm": { - "type": "boolean", - "description": "Whether verifier will send confirmation ack" - } - } - }, - "V20PresRequestByFormat": { - "type": "object", - "properties": { - "dif": { - "$ref": "#/definitions/V20PresRequestByFormat_dif" - }, - "indy": { - "$ref": "#/definitions/V20PresRequestByFormat_indy" - } - } - }, - "V20PresSendRequestRequest": { - "type": "object", - "required": ["connection_id", "presentation_request"], - "properties": { - "auto_remove": { - "type": "boolean", - "description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "auto_verify": { - "type": "boolean", - "example": false, - "description": "Verifier choice to auto-verify proof presentation" - }, - "comment": { - "type": "string", - "x-nullable": true - }, - "connection_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Connection identifier" - }, - "presentation_request": { - "$ref": "#/definitions/V20PresRequestByFormat" - }, - "trace": { - "type": "boolean", - "example": false, - "description": "Whether to trace event (default false)" - } - } - }, - "V20PresSpecByFormatRequest": { - "type": "object", - "properties": { - "auto_remove": { - "type": "boolean", - "description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "dif": { - "$ref": "#/definitions/V20PresSpecByFormatRequest_dif" - }, - "indy": { - "$ref": "#/definitions/V20PresSpecByFormatRequest_indy" - }, - "trace": { - "type": "boolean", - "description": "Record trace information, based on agent configuration" - } - } - }, - "V20PresentProofModuleResponse": { - "type": "object" - }, - "V20PresentationSendRequestToProposal": { - "type": "object", - "properties": { - "auto_remove": { - "type": "boolean", - "description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "auto_verify": { - "type": "boolean", - "example": false, - "description": "Verifier choice to auto-verify proof presentation" - }, - "trace": { - "type": "boolean", - "example": false, - "description": "Whether to trace event (default false)" - } - } - }, - "VCRecord": { - "type": "object", - "properties": { - "contexts": { - "type": "array", - "items": { - "type": "string", - "example": "https://myhost:8021", - "description": "Context", - "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$" - } - }, - "cred_tags": { - "type": "object", - "additionalProperties": { - "type": "string", - "description": "Retrieval tag value" - } - }, - "cred_value": { - "type": "object", - "description": "(JSON-serializable) credential value", - "properties": {} - }, - "expanded_types": { - "type": "array", - "items": { - "type": "string", - "example": "https://w3id.org/citizenship#PermanentResidentCard", - "description": "JSON-LD expanded type extracted from type and context" - } - }, - "given_id": { - "type": "string", - "example": "http://example.edu/credentials/3732", - "description": "Credential identifier" - }, - "issuer_id": { - "type": "string", - "example": "https://example.edu/issuers/14", - "description": "Issuer identifier" - }, - "proof_types": { - "type": "array", - "items": { - "type": "string", - "example": "Ed25519Signature2018", - "description": "Signature suite used for proof" - } - }, - "record_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Record identifier" - }, - "schema_ids": { - "type": "array", - "items": { - "type": "string", - "example": "https://example.org/examples/degree.json", - "description": "Schema identifier" - } - }, - "subject_ids": { - "type": "array", - "items": { - "type": "string", - "example": "did:example:ebfeb1f712ebc6f1c276e12ec21", - "description": "Subject identifier" - } - } - } - }, - "VCRecordList": { - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/definitions/VCRecord" - } - } - } - }, - "VerifiableCredential": { - "type": "object", - "required": [ - "@context", - "credentialSubject", - "issuanceDate", - "issuer", - "proof", - "type" - ], - "properties": { - "@context": { - "type": "array", - "example": [ - "https://www.w3.org/2018/credentials/v1", - "https://www.w3.org/2018/credentials/examples/v1" - ], - "description": "The JSON-LD context of the credential", - "items": {} - }, - "credentialStatus": { - "example": "" - }, - "credentialSubject": { - "example": "" - }, - "expirationDate": { - "type": "string", - "example": "2010-01-01T19:23:24Z", - "description": "The expiration date", - "pattern": "^([0-9]{4})-([0-9]{2})-([0-9]{2})([Tt ]([0-9]{2}):([0-9]{2}):([0-9]{2})(\\.[0-9]+)?)?(([Zz]|([+-])([0-9]{2}):([0-9]{2})))?$" - }, - "id": { - "type": "string", - "example": "http://example.edu/credentials/1872", - "description": "The ID of the credential", - "pattern": "\\w+:(\\/?\\/?)[^\\s]+" - }, - "issuanceDate": { - "type": "string", - "example": "2010-01-01T19:23:24Z", - "description": "The issuance date", - "pattern": "^([0-9]{4})-([0-9]{2})-([0-9]{2})([Tt ]([0-9]{2}):([0-9]{2}):([0-9]{2})(\\.[0-9]+)?)?(([Zz]|([+-])([0-9]{2}):([0-9]{2})))?$" - }, - "issuer": { - "example": "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH", - "description": "The JSON-LD Verifiable Credential Issuer. Either string of object with id field." - }, - "proof": { - "$ref": "#/definitions/Credential_proof" - }, - "type": { - "type": "array", - "example": ["VerifiableCredential", "AlumniCredential"], - "description": "The JSON-LD type of the credential", - "items": { - "type": "string" - } - } - }, - "additionalProperties": true - }, - "VerifiablePresentation": { - "type": "object", - "required": ["@context", "proof", "type"], - "properties": { - "@context": { - "type": "array", - "example": ["https://www.w3.org/2018/credentials/v1"], - "description": "The JSON-LD context of the presentation", - "items": {} - }, - "holder": { - "example": "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH", - "description": "The JSON-LD Verifiable Credential Holder. Either string of object with id field." - }, - "id": { - "type": "string", - "example": "http://example.edu/presentations/1872", - "description": "The ID of the presentation", - "pattern": "\\w+:(\\/?\\/?)[^\\s]+" - }, - "proof": { - "$ref": "#/definitions/Presentation_proof" - }, - "type": { - "type": "array", - "example": ["VerifiablePresentation"], - "description": "The JSON-LD type of the presentation", - "items": { - "type": "string" - } - }, - "verifiableCredential": { - "type": "array", - "items": { - "type": "object", - "properties": {} - } - } - }, - "additionalProperties": true - }, - "VerifyCredentialRequest": { - "type": "object", - "properties": { - "options": { - "$ref": "#/definitions/LDProofVCOptions" - }, - "verifiableCredential": { - "$ref": "#/definitions/VerifiableCredential" - } - } - }, - "VerifyCredentialResponse": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/PresentationVerificationResult" - } - } - }, - "VerifyPresentationRequest": { - "type": "object", - "properties": { - "options": { - "$ref": "#/definitions/LDProofVCOptions" - }, - "verifiablePresentation": { - "$ref": "#/definitions/VerifiablePresentation" - } - } - }, - "VerifyPresentationResponse": { - "type": "object", - "properties": { - "results": { - "$ref": "#/definitions/PresentationVerificationResult" - } - } - }, - "VerifyRequest": { - "type": "object", - "required": ["doc"], - "properties": { - "doc": { - "$ref": "#/definitions/VerifyRequest_doc" - }, - "verkey": { - "type": "string", - "description": "Verkey to use for doc verification" - } - } - }, - "VerifyResponse": { - "type": "object", - "required": ["valid"], - "properties": { - "error": { - "type": "string", - "description": "Error text" - }, - "valid": { - "type": "boolean" - } - } - }, - "W3CCredentialsListRequest": { - "type": "object", - "properties": { - "contexts": { - "type": "array", - "items": { - "type": "string", - "example": "https://myhost:8021", - "description": "Credential context to match", - "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$" - } - }, - "given_id": { - "type": "string", - "description": "Given credential id to match" - }, - "issuer_id": { - "type": "string", - "description": "Credential issuer identifier to match" - }, - "max_results": { - "type": "integer", - "description": "Maximum number of results to return" - }, - "proof_types": { - "type": "array", - "items": { - "type": "string", - "example": "Ed25519Signature2018", - "description": "Signature suite used for proof" - } - }, - "schema_ids": { - "type": "array", - "description": "Schema identifiers, all of which to match", - "items": { - "type": "string", - "example": "https://myhost:8021", - "description": "Credential schema identifier", - "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$" - } - }, - "subject_ids": { - "type": "array", - "description": "Subject identifiers, all of which to match", - "items": { - "type": "string", - "description": "Subject identifier" - } - }, - "tag_query": { - "type": "object", - "description": "Tag filter", - "additionalProperties": { - "type": "string", - "description": "Tag value" - } - }, - "types": { - "type": "array", - "items": { - "type": "string", - "example": "https://myhost:8021", - "description": "Credential type to match", - "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$" - } - } - } - }, - "WalletList": { - "type": "object", - "properties": { - "results": { - "type": "array", - "description": "List of wallet records", - "items": { - "$ref": "#/definitions/WalletRecord" - } - } - } - }, - "WalletModuleResponse": { - "type": "object" - }, - "WalletRecord": { - "type": "object", - "required": ["key_management_mode", "wallet_id"], - "properties": { - "created_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of record creation", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "key_management_mode": { - "type": "string", - "description": "Mode regarding management of wallet key", - "enum": ["managed", "unmanaged"] - }, - "settings": { - "type": "object", - "description": "Settings for this wallet.", - "properties": {} - }, - "state": { - "type": "string", - "example": "active", - "description": "Current record state" - }, - "updated_at": { - "type": "string", - "example": "2021-12-31T23:59:59Z", - "description": "Time of last record update", - "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "wallet_id": { - "type": "string", - "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description": "Wallet record ID" - } - } - }, - "WriteLedger": { - "type": "object", - "properties": { - "ledger_id": { - "type": "string" - } - } - }, - "ActionMenuFetchResult_result": { - "type": "object", - "description": "Action menu" - }, - "AttachDecoratorData_jws": { - "type": "object", - "description": "Detached Java Web Signature" - }, - "CredDefState_credential_definition": { - "type": "object", - "description": "credential definition" - }, - "CredDefValue_primary": { - "type": "object", - "description": "Primary value for credential definition" - }, - "CredDefValue_revocation": { - "type": "object", - "description": "Revocation value for credential definition" - }, - "Credential_proof": { - "type": "object", - "description": "The proof of the credential", - "example": "{\"created\":\"2019-12-11T03:50:55\",\"jws\":\"eyJhbGciOiAiRWREU0EiLCAiYjY0IjogZmFsc2UsICJjcml0JiNjQiXX0..lKJU0Df_keblRKhZAS9Qq6zybm-HqUXNVZ8vgEPNTAjQKBhQDxvXNo7nvtUBb_Eq1Ch6YBKY5qBQ\",\"proofPurpose\":\"assertionMethod\",\"type\":\"Ed25519Signature2018\",\"verificationMethod\":\"did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL\"}" - }, - "CredentialDefinition_value": { - "type": "object", - "description": "Credential definition primary and revocation values" - }, - "DIDCreate_options": { - "type": "object", - "description": "To define a key type and/or a did depending on chosen DID method." - }, - "DIDXRequest_did_docattach": { - "type": "object", - "description": "As signed attachment, DID Doc associated with DID" - }, - "Doc_options": { - "type": "object", - "description": "Signature options" - }, - "IndyCredAbstract_key_correctness_proof": { - "type": "object", - "description": "Key correctness proof" - }, - "IndyCredPrecis_cred_info": { - "type": "object", - "description": "Credential info" - }, - "IndyCredPrecis_interval": { - "type": "object", - "description": "Non-revocation interval from presentation request" - }, - "IndyPrimaryProof_eq_proof": { - "type": "object", - "description": "Indy equality proof", - "x-nullable": true - }, - "IndyProof_proof": { - "type": "object", - "description": "Indy proof.proof content" - }, - "IndyProof_requested_proof": { - "type": "object", - "description": "Indy proof.requested_proof content" - }, - "IndyProofProof_aggregated_proof": { - "type": "object", - "description": "Indy proof aggregated proof" - }, - "IndyProofProofProofsProof_non_revoc_proof": { - "type": "object", - "description": "Indy non-revocation proof", - "x-nullable": true - }, - "IndyProofProofProofsProof_primary_proof": { - "type": "object", - "description": "Indy primary proof" - }, - "IndyRevRegDef_value": { - "type": "object", - "description": "Revocation registry definition value" - }, - "IndyRevRegDefValue_publicKeys": { - "type": "object", - "description": "Public keys" - }, - "IndyRevRegEntry_value": { - "type": "object", - "description": "Revocation registry entry value" - }, - "InputDescriptors_schema": { - "type": "object", - "description": "Accepts a list of schema or a dict containing filters like oneof_filter.", - "example": "{\"oneof_filter\":[[{\"uri\":\"https://www.w3.org/Test1#Test1\"},{\"uri\":\"https://www.w3.org/Test2#Test2\"}],{\"oneof_filter\":[[{\"uri\":\"https://www.w3.org/Test1#Test1\"}],[{\"uri\":\"https://www.w3.org/Test2#Test2\"}]]}]}" - }, - "InvitationRecord_invitation": { - "type": "object", - "description": "Out of band invitation message" - }, - "IssuerRevRegRecord_revoc_reg_def": { - "type": "object", - "description": "Revocation registry definition" - }, - "IssuerRevRegRecord_revoc_reg_entry": { - "type": "object", - "description": "Revocation registry entry" - }, - "KeylistQuery_paginate": { - "type": "object", - "description": "Pagination info" - }, - "LDProofVCDetail_credential": { - "type": "object", - "description": "Detail of the JSON-LD Credential to be issued", - "example": "{\"@context\":[\"https://www.w3.org/2018/credentials/v1\",\"https://w3id.org/citizenship/v1\"],\"credentialSubject\":{\"familyName\":\"SMITH\",\"gender\":\"Male\",\"givenName\":\"JOHN\",\"type\":[\"PermanentResident\",\"Person\"]},\"description\":\"Government of Example Permanent Resident Card.\",\"identifier\":\"83627465\",\"issuanceDate\":\"2019-12-03T12:19:52Z\",\"issuer\":\"did:key:z6MkmjY8GnV5i9YTDtPETC2uUAW6ejw3nk5mXF5yci5ab7th\",\"name\":\"Permanent Resident Card\",\"type\":[\"VerifiableCredential\",\"PermanentResidentCard\"]}" - }, - "LDProofVCDetail_options": { - "type": "object", - "description": "Options for specifying how the linked data proof is created.", - "example": "{\"proofType\":\"Ed25519Signature2018\"}" - }, - "LDProofVCOptions_credentialStatus": { - "type": "object", - "description": "The credential status mechanism to use for the credential. Omitting the property indicates the issued credential will not include a credential status" - }, - "Presentation_proof": { - "type": "object", - "description": "The proof of the presentation", - "example": "{\"created\":\"2019-12-11T03:50:55\",\"jws\":\"eyJhbGciOiAiRWREU0EiLCAiYjY0IjogZmFsc2UsICJjcml0JiNjQiXX0..lKJU0Df_keblRKhZAS9Qq6zybm-HqUXNVZ8vgEPNTAjQKBhQDxvXNo7nvtUBb_Eq1Ch6YBKY5qBQ\",\"proofPurpose\":\"assertionMethod\",\"type\":\"Ed25519Signature2018\",\"verificationMethod\":\"did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL\"}" - }, - "RevListState_revocation_list": { - "type": "object", - "description": "revocation list" - }, - "RevRegDefState_revocation_registry_definition": { - "type": "object", - "description": "revocation registry definition" - }, - "SchemaSendResult_schema": { - "type": "object", - "description": "Schema definition" - }, - "SendMenu_menu": { - "type": "object", - "description": "Menu to send to connection" - }, - "SignedDoc_proof": { - "type": "object", - "description": "Linked data proof" - }, - "TxnOrCredentialDefinitionSendResult_txn": { - "type": "object", - "description": "Credential definition transaction to endorse" - }, - "TxnOrRegisterLedgerNymResponse_txn": { - "type": "object", - "description": "DID transaction to endorse" - }, - "TxnOrRevRegResult_txn": { - "type": "object", - "description": "Revocation registry definition transaction to endorse" - }, - "TxnOrSchemaSendResult_sent": { - "type": "object", - "description": "Content sent" - }, - "TxnOrSchemaSendResult_txn": { - "type": "object", - "description": "Schema transaction to endorse" - }, - "V10CredentialBoundOfferRequest_counter_proposal": { - "type": "object", - "description": "Optional counter-proposal" - }, - "V10CredentialExchange_credential": { - "type": "object", - "description": "Credential as stored" - }, - "V10CredentialExchange_credential_offer": { - "type": "object", - "description": "(Indy) credential offer" - }, - "V10CredentialExchange_credential_offer_dict": { - "type": "object", - "description": "Credential offer message" - }, - "V10CredentialExchange_credential_proposal_dict": { - "type": "object", - "description": "Credential proposal message" - }, - "V10CredentialExchange_credential_request": { - "type": "object", - "description": "(Indy) credential request" - }, - "V10CredentialExchange_raw_credential": { - "type": "object", - "description": "Credential as received, prior to storage in holder wallet" - }, - "V10DiscoveryRecord_disclose": { - "type": "object", - "description": "Disclose message" - }, - "V10DiscoveryRecord_query_msg": { - "type": "object", - "description": "Query message" - }, - "V10PresentationExchange_presentation": { - "type": "object", - "description": "(Indy) presentation (also known as proof)" - }, - "V10PresentationExchange_presentation_proposal_dict": { - "type": "object", - "description": "Presentation proposal message" - }, - "V10PresentationExchange_presentation_request": { - "type": "object", - "description": "(Indy) presentation request (also known as proof request)" - }, - "V10PresentationExchange_presentation_request_dict": { - "type": "object", - "description": "Presentation request message" - }, - "V20CredBoundOfferRequest_counter_preview": { - "type": "object", - "description": "Optional content for counter-proposal" - }, - "V20CredBoundOfferRequest_filter": { - "type": "object", - "description": "Credential specification criteria by format" - }, - "V20CredExRecord_by_format": { - "type": "object", - "description": "Attachment content by format for proposal, offer, request, and issue" - }, - "V20CredExRecord_cred_issue": { - "type": "object", - "description": "Serialized credential issue message" - }, - "V20CredExRecord_cred_preview": { - "type": "object", - "description": "Credential preview from credential proposal" - }, - "V20CredExRecord_cred_request": { - "type": "object", - "description": "Serialized credential request message" - }, - "V20CredExRecordDetail_cred_ex_record": { - "type": "object", - "description": "Credential exchange record" - }, - "V20CredFilter_indy": { - "type": "object", - "description": "Credential filter for indy" - }, - "V20CredFilter_ld_proof": { - "type": "object", - "description": "Credential filter for linked data proof" - }, - "V20CredFilter_vc_di": { - "type": "object", - "description": "Credential filter for vc_di" - }, - "V20CredProposal_credential_preview": { - "type": "object", - "description": "Credential preview" - }, - "V20DiscoveryExchangeResult_results": { - "type": "object", - "description": "Discover Features v2.0 exchange record" - }, - "V20DiscoveryRecord_disclosures": { - "type": "object", - "description": "Disclosures message" - }, - "V20DiscoveryRecord_queries_msg": { - "type": "object", - "description": "Queries message" - }, - "V20PresExRecord_by_format": { - "type": "object", - "description": "Attachment content by format for proposal, request, and presentation" - }, - "V20PresExRecord_pres": { - "type": "object", - "description": "Presentation message" - }, - "V20PresProposalByFormat_dif": { - "type": "object", - "description": "Presentation proposal for DIF" - }, - "V20PresProposalByFormat_indy": { - "type": "object", - "description": "Presentation proposal for indy" - }, - "V20PresRequestByFormat_dif": { - "type": "object", - "description": "Presentation request for DIF" - }, - "V20PresRequestByFormat_indy": { - "type": "object", - "description": "Presentation request for indy" - }, - "V20PresSpecByFormatRequest_dif": { - "type": "object", - "description": "Optional Presentation specification for DIF, overrides the PresentationExchange record's PresRequest" - }, - "V20PresSpecByFormatRequest_indy": { - "type": "object", - "description": "Presentation specification for indy" - }, - "VerifyRequest_doc": { - "type": "object", - "description": "Signed document" - } - } -} +{"paths": {"/action-menu/{conn_id}/close": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ActionMenuModulesResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["action-menu"], "summary": "Close the active menu associated with a connection", "produces": ["application/json"]}}, "/action-menu/{conn_id}/fetch": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ActionMenuFetchResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["action-menu"], "summary": "Fetch the active menu", "produces": ["application/json"]}}, "/action-menu/{conn_id}/perform": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ActionMenuModulesResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/PerformRequest"}}, {"in": "path", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["action-menu"], "summary": "Perform an action associated with the active menu", "produces": ["application/json"]}}, "/action-menu/{conn_id}/request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ActionMenuModulesResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["action-menu"], "summary": "Request the active menu", "produces": ["application/json"]}}, "/action-menu/{conn_id}/send-menu": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ActionMenuModulesResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/SendMenu"}}, {"in": "path", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["action-menu"], "summary": "Send an action menu to a connection", "produces": ["application/json"]}}, "/anoncreds/credential-definition": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredDefResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/CredDefPostRequest"}}], "tags": ["anoncreds - credential definitions"], "summary": "Create a credential definition on the connected ledger", "produces": ["application/json"]}}, "/anoncreds/credential-definition/{cred_def_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/GetCredDefResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_def_id", "type": "string", "description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "required": true}], "tags": ["anoncreds - credential definitions"], "summary": "Retrieve an individual credential definition details", "produces": ["application/json"]}}, "/anoncreds/credential-definitions": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/GetCredDefsResponse"}, "description": ""}}, "parameters": [{"in": "query", "name": "issuer_id", "type": "string", "description": "Issuer Identifier of the credential definition", "example": "WgWxqztrNooG92RXvxSTWv", "required": false}, {"in": "query", "name": "schema_id", "type": "string", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "required": false}, {"in": "query", "name": "schema_name", "type": "string", "description": "Schema name", "example": "example-schema", "required": false}, {"in": "query", "name": "schema_version", "type": "string", "description": "Schema version", "example": "1.0", "required": false}], "tags": ["anoncreds - credential definitions"], "summary": "Retrieve all credential definition ids", "produces": ["application/json"]}}, "/anoncreds/registry/{rev_reg_id}/active": {"put": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevocationModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "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", "required": true}], "tags": ["anoncreds - revocation"], "summary": "Update the active registry", "produces": ["application/json"]}}, "/anoncreds/registry/{rev_reg_id}/tails-file": {"put": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevocationModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "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", "required": true}], "tags": ["anoncreds - revocation"], "summary": "Upload local tails file to server", "produces": ["application/json"]}}, "/anoncreds/revocation-list": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevListResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/RevListCreateRequest"}}], "tags": ["anoncreds - revocation"], "summary": "Create and publish a revocation status list on the connected ledger", "produces": ["application/json"]}}, "/anoncreds/revocation-registry-definition": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegDefResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/RevRegCreateRequestSchemaAnoncreds"}}], "tags": ["anoncreds - revocation"], "summary": "Create and publish a registration revocation on the connected ledger", "produces": ["application/json"]}}, "/anoncreds/revocation/active-registry/{cred_def_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegResultSchemaAnoncreds"}, "description": ""}}, "parameters": [{"in": "path", "name": "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", "required": true}], "tags": ["anoncreds - revocation"], "summary": "Get current active revocation registry by credential definition id", "produces": ["application/json"]}}, "/anoncreds/revocation/active-registry/{cred_def_id}/rotate": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegsCreatedSchemaAnoncreds"}, "description": ""}}, "parameters": [{"in": "path", "name": "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", "required": true}], "tags": ["anoncreds - revocation"], "summary": "Rotate revocation registry", "produces": ["application/json"]}}, "/anoncreds/revocation/credential-record": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredRevRecordResultSchemaAnoncreds"}, "description": ""}}, "parameters": [{"in": "query", "name": "cred_ex_id", "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", "required": false}, {"in": "query", "name": "cred_rev_id", "type": "string", "pattern": "^[1-9][0-9]*$", "description": "Credential revocation identifier", "example": "12345", "required": false}, {"in": "query", "name": "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", "required": false}], "tags": ["anoncreds - revocation"], "summary": "Get credential revocation status", "produces": ["application/json"]}}, "/anoncreds/revocation/publish-revocations": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/PublishRevocationsResultSchemaAnoncreds"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/PublishRevocationsSchemaAnoncreds"}}], "tags": ["anoncreds - revocation"], "summary": "Publish pending revocations to ledger", "produces": ["application/json"]}}, "/anoncreds/revocation/registries": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegsCreatedSchemaAnoncreds"}, "description": ""}}, "parameters": [{"in": "query", "name": "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", "required": false}, {"in": "query", "name": "state", "type": "string", "enum": ["finished", "failed", "action", "wait", "decommissioned", "full"], "description": "Revocation registry state", "required": false}], "tags": ["anoncreds - revocation"], "summary": "Search for matching revocation registries that current agent created", "produces": ["application/json"]}}, "/anoncreds/revocation/registry/{rev_reg_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegResultSchemaAnoncreds"}, "description": ""}}, "parameters": [{"in": "path", "name": "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", "required": true}], "tags": ["anoncreds - revocation"], "summary": "Get revocation registry by revocation registry id", "produces": ["application/json"]}}, "/anoncreds/revocation/registry/{rev_reg_id}/fix-revocation-entry-state": {"put": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegWalletUpdatedResultSchemaAnoncreds"}, "description": ""}}, "parameters": [{"in": "path", "name": "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", "required": true}, {"in": "query", "name": "apply_ledger_update", "type": "boolean", "description": "Apply updated accumulator transaction to ledger", "required": true}], "tags": ["anoncreds - revocation"], "summary": "Fix revocation state in wallet and return number of updated entries", "produces": ["application/json"]}}, "/anoncreds/revocation/registry/{rev_reg_id}/issued": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegIssuedResultSchemaAnoncreds"}, "description": ""}}, "parameters": [{"in": "path", "name": "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", "required": true}], "tags": ["anoncreds - revocation"], "summary": "Get number of credentials issued against revocation registry", "produces": ["application/json"]}}, "/anoncreds/revocation/registry/{rev_reg_id}/issued/details": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredRevRecordDetailsResultSchemaAnoncreds"}, "description": ""}}, "parameters": [{"in": "path", "name": "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", "required": true}], "tags": ["anoncreds - revocation"], "summary": "Get details of credentials issued against revocation registry", "produces": ["application/json"]}}, "/anoncreds/revocation/registry/{rev_reg_id}/issued/indy_recs": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredRevIndyRecordsResultSchemaAnoncreds"}, "description": ""}}, "parameters": [{"in": "path", "name": "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", "required": true}], "tags": ["anoncreds - revocation"], "summary": "Get details of revoked credentials from ledger", "produces": ["application/json"]}}, "/anoncreds/revocation/registry/{rev_reg_id}/set-state": {"patch": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegResultSchemaAnoncreds"}, "description": ""}}, "parameters": [{"in": "path", "name": "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", "required": true}, {"in": "query", "name": "state", "type": "string", "enum": ["finished", "failed", "action", "wait", "decommissioned", "full"], "description": "Revocation registry state to set", "required": true}], "tags": ["anoncreds - revocation"], "summary": "Set revocation registry state manually", "produces": ["application/json"]}}, "/anoncreds/revocation/registry/{rev_reg_id}/tails-file": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevocationAnoncredsModuleResponse"}, "description": "tails file"}}, "parameters": [{"in": "path", "name": "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", "required": true}], "tags": ["anoncreds - revocation"], "summary": "Download tails file", "produces": ["application/octet-stream"]}}, "/anoncreds/revocation/revoke": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevocationAnoncredsModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/RevokeRequestSchemaAnoncreds"}}], "tags": ["anoncreds - revocation"], "summary": "Revoke an issued credential", "produces": ["application/json"]}}, "/anoncreds/schema": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/SchemaResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/SchemaPostRequest"}}], "tags": ["anoncreds - schemas"], "summary": "Create a schema on the connected ledger", "produces": ["application/json"]}}, "/anoncreds/schema/{schema_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/GetSchemaResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "schema_id", "type": "string", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "required": true}], "tags": ["anoncreds - schemas"], "summary": "Retrieve an individual schemas details", "produces": ["application/json"]}}, "/anoncreds/schemas": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/GetSchemasResponse"}, "description": ""}}, "parameters": [{"in": "query", "name": "schema_issuer_id", "type": "string", "description": "Schema issuer identifier", "example": "WgWxqztrNooG92RXvxSTWv", "required": false}, {"in": "query", "name": "schema_name", "type": "string", "description": "Schema name", "example": "example-schema", "required": false}, {"in": "query", "name": "schema_version", "type": "string", "description": "Schema version", "example": "1.0", "required": false}], "tags": ["anoncreds - schemas"], "summary": "Retrieve all schema ids", "produces": ["application/json"]}}, "/anoncreds/wallet/upgrade": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/UpgradeResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "wallet_name", "type": "string", "description": "Name of wallet to upgrade to anoncreds", "example": "base-wallet", "required": true}], "tags": ["anoncreds - wallet upgrade"], "summary": "\n Upgrade the wallet from askar to anoncreds - Be very careful with this! You \n cannot go back! See migration guide for more information.\n ", "produces": ["application/json"]}}, "/connections": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnectionList"}, "description": ""}}, "parameters": [{"in": "query", "name": "alias", "type": "string", "description": "Alias", "example": "Barry", "required": false}, {"in": "query", "name": "connection_protocol", "type": "string", "enum": ["connections/1.0", "didexchange/1.0", "didexchange/1.1"], "description": "Connection protocol used", "example": "connections/1.0", "required": false}, {"in": "query", "name": "descending", "type": "boolean", "default": false, "description": "Order results in descending order if true", "required": false}, {"in": "query", "name": "invitation_key", "type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "description": "invitation key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "required": false}, {"in": "query", "name": "invitation_msg_id", "type": "string", "description": "Identifier of the associated Invitation Message", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false}, {"in": "query", "name": "limit", "type": "integer", "default": 100, "description": "Number of results to return", "example": 50, "required": false}, {"in": "query", "name": "my_did", "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "description": "My DID", "example": "WgWxqztrNooG92RXvxSTWv", "required": false}, {"in": "query", "name": "offset", "type": "integer", "default": 0, "description": "Offset for pagination", "example": 0, "required": false}, {"in": "query", "name": "order_by", "type": "string", "default": "id", "enum": ["id"], "description": "The column to order results by. Only \"id\" is currently supported.", "required": false}, {"in": "query", "name": "state", "type": "string", "enum": ["abandoned", "active", "completed", "error", "init", "invitation", "request", "response", "start"], "description": "Connection state", "required": false}, {"in": "query", "name": "their_did", "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "description": "Their DID", "example": "WgWxqztrNooG92RXvxSTWv", "required": false}, {"in": "query", "name": "their_public_did", "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "description": "Their Public DID", "example": "WgWxqztrNooG92RXvxSTWv", "required": false}, {"in": "query", "name": "their_role", "type": "string", "enum": ["invitee", "requester", "inviter", "responder"], "description": "Their role in the connection protocol", "example": "invitee", "required": false}], "tags": ["connection"], "summary": "Query agent-to-agent connections", "produces": ["application/json"]}}, "/connections/create-invitation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/InvitationResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/CreateInvitationRequest"}}, {"in": "query", "name": "alias", "type": "string", "description": "Alias", "example": "Barry", "required": false}, {"in": "query", "name": "auto_accept", "type": "boolean", "description": "Auto-accept connection (defaults to configuration)", "required": false}, {"in": "query", "name": "multi_use", "type": "boolean", "description": "Create invitation for multiple use (default false)", "required": false}, {"in": "query", "name": "public", "type": "boolean", "description": "Create invitation from public DID (default false)", "required": false}], "tags": ["connection"], "summary": "Create a new connection invitation", "deprecated": true, "produces": ["application/json"]}}, "/connections/create-static": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnectionStaticResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/ConnectionStaticRequest"}}], "tags": ["connection"], "summary": "Create a new static connection", "produces": ["application/json"]}}, "/connections/receive-invitation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/ReceiveInvitationRequest"}}, {"in": "query", "name": "alias", "type": "string", "description": "Alias", "example": "Barry", "required": false}, {"in": "query", "name": "auto_accept", "type": "boolean", "description": "Auto-accept connection (defaults to configuration)", "required": false}, {"in": "query", "name": "mediation_id", "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": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false}], "tags": ["connection"], "summary": "Receive a new connection invitation", "deprecated": true, "produces": ["application/json"]}}, "/connections/{conn_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["connection"], "summary": "Fetch a single connection record", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnectionModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["connection"], "summary": "Remove an existing connection record", "produces": ["application/json"]}}, "/connections/{conn_id}/accept-invitation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}, {"in": "query", "name": "mediation_id", "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": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false}, {"in": "query", "name": "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", "required": false}, {"in": "query", "name": "my_label", "type": "string", "description": "Label for connection", "example": "Broker", "required": false}], "tags": ["connection"], "summary": "Accept a stored connection invitation", "deprecated": true, "produces": ["application/json"]}}, "/connections/{conn_id}/accept-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}, {"in": "query", "name": "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", "required": false}], "tags": ["connection"], "summary": "Accept a stored connection request", "deprecated": true, "produces": ["application/json"]}}, "/connections/{conn_id}/endpoints": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/EndpointsResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["connection"], "summary": "Fetch connection remote endpoint", "produces": ["application/json"]}}, "/connections/{conn_id}/metadata": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnectionMetadata"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}, {"in": "query", "name": "key", "type": "string", "description": "Key to retrieve.", "required": false}], "tags": ["connection"], "summary": "Fetch connection metadata", "produces": ["application/json"]}, "post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnectionMetadata"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/ConnectionMetadataSetRequest"}}, {"in": "path", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["connection"], "summary": "Set connection metadata", "produces": ["application/json"]}}, "/connections/{conn_id}/send-message": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/BasicMessageModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/SendMessage"}}, {"in": "path", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["basicmessage"], "summary": "Send a basic message to a connection", "produces": ["application/json"]}}, "/connections/{conn_id}/send-ping": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/PingRequestResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/PingRequest"}}, {"in": "path", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["trustping"], "summary": "Send a trust ping to a connection", "produces": ["application/json"]}}, "/connections/{conn_id}/start-introduction": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/IntroModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}, {"in": "query", "name": "target_connection_id", "type": "string", "description": "Target connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}, {"in": "query", "name": "message", "type": "string", "description": "Message", "example": "Allow me to introduce ...", "required": false}], "tags": ["introduction"], "summary": "Start an introduction between two connections", "produces": ["application/json"]}}, "/credential-definitions": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TxnOrCredentialDefinitionSendResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/CredentialDefinitionSendRequest"}}, {"in": "query", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false}, {"in": "query", "name": "create_transaction_for_endorser", "type": "boolean", "description": "Create Transaction For Endorser's signature", "required": false}], "tags": ["credential-definition"], "summary": "Sends a credential definition to the ledger", "produces": ["application/json"]}}, "/credential-definitions/created": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredentialDefinitionsCreatedResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "cred_def_id", "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", "required": false}, {"in": "query", "name": "issuer_did", "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Issuer DID", "example": "WgWxqztrNooG92RXvxSTWv", "required": false}, {"in": "query", "name": "schema_id", "type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "required": false}, {"in": "query", "name": "schema_issuer_did", "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Schema issuer DID", "example": "WgWxqztrNooG92RXvxSTWv", "required": false}, {"in": "query", "name": "schema_name", "type": "string", "description": "Schema name", "example": "membership", "required": false}, {"in": "query", "name": "schema_version", "type": "string", "pattern": "^[0-9.]+$", "description": "Schema version", "example": "1.0", "required": false}], "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/CredentialDefinitionGetResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "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", "required": true}], "tags": ["credential-definition"], "summary": "Gets a credential definition from the ledger", "produces": ["application/json"]}}, "/credential-definitions/{cred_def_id}/write_record": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredentialDefinitionGetResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "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", "required": true}], "tags": ["credential-definition"], "summary": "Writes a credential definition non-secret record to the wallet", "produces": ["application/json"]}}, "/credential/mime-types/{credential_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AttributeMimeTypesResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "credential_id", "type": "string", "description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["credentials"], "summary": "Get attribute MIME types from wallet", "produces": ["application/json"]}}, "/credential/revoked/{credential_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredRevokedResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "credential_id", "type": "string", "description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}, {"in": "query", "name": "from", "type": "string", "pattern": "^[0-9]*$", "description": "Earliest epoch of revocation status interval of interest", "example": "0", "required": false}, {"in": "query", "name": "to", "type": "string", "pattern": "^[0-9]*$", "description": "Latest epoch of revocation status interval of interest", "example": "0", "required": false}], "tags": ["credentials"], "summary": "Query credential revocation status by id", "produces": ["application/json"]}}, "/credential/w3c/{credential_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/VCRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "credential_id", "type": "string", "description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["credentials"], "summary": "Fetch W3C credential from wallet by id", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/HolderModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "credential_id", "type": "string", "description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["credentials"], "summary": "Remove W3C credential from wallet by id", "produces": ["application/json"]}}, "/credential/{credential_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/IndyCredInfo"}, "description": ""}}, "parameters": [{"in": "path", "name": "credential_id", "type": "string", "description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["credentials"], "summary": "Fetch credential from wallet by id", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/HolderModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "credential_id", "type": "string", "description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["credentials"], "summary": "Remove credential from wallet by id", "produces": ["application/json"]}}, "/credentials": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredInfoList"}, "description": ""}}, "parameters": [{"in": "query", "name": "count", "type": "string", "pattern": "^[1-9][0-9]*$", "description": "Maximum number to retrieve", "example": "1", "required": false}, {"in": "query", "name": "start", "type": "string", "pattern": "^[0-9]*$", "description": "Start index", "example": "0", "required": false}, {"in": "query", "name": "wql", "type": "string", "pattern": "^{.*}$", "description": "(JSON) WQL query", "example": "{\"attr::name::value\": \"Alex\"}", "required": false}], "tags": ["credentials"], "summary": "Fetch credentials from wallet", "produces": ["application/json"]}}, "/credentials/w3c": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/VCRecordList"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/W3CCredentialsListRequest"}}, {"in": "query", "name": "count", "type": "string", "pattern": "^[1-9][0-9]*$", "description": "Maximum number to retrieve", "example": "1", "required": false}, {"in": "query", "name": "start", "type": "string", "pattern": "^[0-9]*$", "description": "Start index", "example": "0", "required": false}, {"in": "query", "name": "wql", "type": "string", "pattern": "^{.*}$", "description": "(JSON) WQL query", "example": "{\"attr::name::value\": \"Alex\"}", "required": false}], "tags": ["credentials"], "summary": "Fetch W3C credentials from wallet", "produces": ["application/json"]}}, "/did-rotate/{conn_id}/hangup": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/Hangup"}, "description": "Hangup agent message for observer"}}, "parameters": [{"in": "path", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["did-rotate"], "summary": "Send hangup of DID rotation as a rotator", "produces": ["application/json"]}}, "/did-rotate/{conn_id}/rotate": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/Rotate"}, "description": "Rotate agent message for observer"}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/DIDRotateRequestJSON"}}, {"in": "path", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["did-rotate"], "summary": "Begin rotation of a DID as a rotator", "produces": ["application/json"]}}, "/didexchange/create-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "query", "name": "their_public_did", "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "description": "Qualified public DID to which to request connection", "example": "did:peer:WgWxqztrNooG92RXvxSTWv", "required": true}, {"in": "query", "name": "alias", "type": "string", "description": "Alias for connection", "example": "Barry", "required": false}, {"in": "query", "name": "auto_accept", "type": "boolean", "description": "Auto-accept connection (defaults to configuration)", "required": false}, {"in": "query", "name": "goal", "type": "string", "description": "A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message", "example": "To issue a Faber College Graduate credential", "required": false}, {"in": "query", "name": "goal_code", "type": "string", "description": "A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message", "example": "issue-vc", "required": false}, {"in": "query", "name": "mediation_id", "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": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false}, {"in": "query", "name": "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", "required": false}, {"in": "query", "name": "my_label", "type": "string", "description": "Label for connection request", "example": "Broker", "required": false}, {"in": "query", "name": "protocol", "type": "string", "enum": ["didexchange/1.0", "didexchange/1.1"], "description": "Which DID Exchange Protocol version to use", "example": "didexchange/1.0", "required": false}, {"in": "query", "name": "use_did", "type": "string", "description": "The DID to use to for this connection", "example": "did:example:1234", "required": false}, {"in": "query", "name": "use_did_method", "type": "string", "enum": ["did:peer:2", "did:peer:4"], "description": "The DID method to use to generate a DID for this connection", "example": "did:peer:4", "required": false}, {"in": "query", "name": "use_public_did", "type": "boolean", "description": "Use public DID for this connection", "required": false}], "tags": ["did-exchange"], "summary": "Create and send a request against public DID's implicit invitation", "produces": ["application/json"]}}, "/didexchange/receive-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/DIDXRequest"}}, {"in": "query", "name": "alias", "type": "string", "description": "Alias for connection", "example": "Barry", "required": false}, {"in": "query", "name": "auto_accept", "type": "boolean", "description": "Auto-accept connection (defaults to configuration)", "required": false}, {"in": "query", "name": "mediation_id", "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": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false}, {"in": "query", "name": "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", "required": false}], "tags": ["did-exchange"], "summary": "Receive request against public DID's implicit invitation", "deprecated": true, "produces": ["application/json"]}}, "/didexchange/{conn_id}/accept-invitation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}, {"in": "query", "name": "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", "required": false}, {"in": "query", "name": "my_label", "type": "string", "description": "Label for connection request", "example": "Broker", "required": false}, {"in": "query", "name": "use_did", "type": "string", "description": "The DID to use to for this connection", "example": "did:example:1234", "required": false}, {"in": "query", "name": "use_did_method", "type": "string", "enum": ["did:peer:2", "did:peer:4"], "description": "The DID method to use to generate a DID for this connection", "example": "did:peer:4", "required": false}], "tags": ["did-exchange"], "summary": "Accept a stored connection invitation", "produces": ["application/json"]}}, "/didexchange/{conn_id}/accept-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}, {"in": "query", "name": "mediation_id", "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": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false}, {"in": "query", "name": "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", "required": false}, {"in": "query", "name": "use_public_did", "type": "boolean", "description": "Use public DID for this connection", "required": false}], "tags": ["did-exchange"], "summary": "Accept a stored connection request", "produces": ["application/json"]}}, "/didexchange/{conn_id}/reject": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConnRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/DIDXRejectRequest"}}, {"in": "path", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["did-exchange"], "summary": "Abandon or reject a DID Exchange", "produces": ["application/json"]}}, "/discover-features-2.0/queries": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20DiscoveryExchangeResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "connection_id", "type": "string", "description": "Connection identifier, if none specified, then the query will provide features for this agent.", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false}, {"in": "query", "name": "query_goal_code", "type": "string", "description": "Goal-code feature-type query", "example": "*", "required": false}, {"in": "query", "name": "query_protocol", "type": "string", "description": "Protocol feature-type query", "example": "*", "required": false}], "tags": ["discover-features v2.0"], "summary": "Query supported features", "produces": ["application/json"]}}, "/discover-features-2.0/records": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20DiscoveryExchangeListResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "connection_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false}], "tags": ["discover-features v2.0"], "summary": "Discover Features v2.0 records", "produces": ["application/json"]}}, "/discover-features/query": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10DiscoveryRecord"}, "description": ""}}, "parameters": [{"in": "query", "name": "comment", "type": "string", "description": "Comment", "example": "test", "required": false}, {"in": "query", "name": "connection_id", "type": "string", "description": "Connection identifier, if none specified, then the query will provide features for this agent.", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false}, {"in": "query", "name": "query", "type": "string", "description": "Protocol feature query", "example": "*", "required": false}], "tags": ["discover-features"], "summary": "Query supported features", "produces": ["application/json"]}}, "/discover-features/records": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10DiscoveryExchangeListResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "connection_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false}], "tags": ["discover-features"], "summary": "Discover Features records", "produces": ["application/json"]}}, "/issue-credential-2.0/create": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20IssueCredSchemaCore"}}], "tags": ["issue-credential v2.0"], "summary": "Create a credential record without sending (generally for use with Out-Of-Band)", "produces": ["application/json"]}}, "/issue-credential-2.0/create-offer": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredOfferConnFreeRequest"}}], "tags": ["issue-credential v2.0"], "summary": "Create a credential offer, independent of any proposal or connection", "produces": ["application/json"]}}, "/issue-credential-2.0/records": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecordListResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "connection_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false}, {"in": "query", "name": "descending", "type": "boolean", "default": false, "description": "Order results in descending order if true", "required": false}, {"in": "query", "name": "limit", "type": "integer", "default": 100, "description": "Number of results to return", "example": 50, "required": false}, {"in": "query", "name": "offset", "type": "integer", "default": 0, "description": "Offset for pagination", "example": 0, "required": false}, {"in": "query", "name": "order_by", "type": "string", "default": "id", "enum": ["id"], "description": "The column to order results by. Only \"id\" is currently supported.", "required": false}, {"in": "query", "name": "role", "type": "string", "enum": ["issuer", "holder"], "description": "Role assigned in credential exchange", "required": false}, {"in": "query", "name": "state", "type": "string", "enum": ["proposal-sent", "proposal-received", "offer-sent", "offer-received", "request-sent", "request-received", "credential-issued", "credential-received", "done", "credential-revoked", "abandoned"], "description": "Credential exchange state", "required": false}, {"in": "query", "name": "thread_id", "type": "string", "description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false}], "tags": ["issue-credential v2.0"], "summary": "Fetch all credential exchange records", "produces": ["application/json"]}}, "/issue-credential-2.0/records/{cred_ex_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecordDetail"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_ex_id", "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", "required": true}], "tags": ["issue-credential v2.0"], "summary": "Fetch a single credential exchange record", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20IssueCredentialModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_ex_id", "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", "required": true}], "tags": ["issue-credential v2.0"], "summary": "Remove an existing credential exchange record", "produces": ["application/json"]}}, "/issue-credential-2.0/records/{cred_ex_id}/issue": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecordDetail"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredIssueRequest"}}, {"in": "path", "name": "cred_ex_id", "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", "required": true}], "tags": ["issue-credential v2.0"], "summary": "Send holder a credential", "produces": ["application/json"]}}, "/issue-credential-2.0/records/{cred_ex_id}/problem-report": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20IssueCredentialModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredIssueProblemReportRequest"}}, {"in": "path", "name": "cred_ex_id", "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", "required": true}], "tags": ["issue-credential v2.0"], "summary": "Send a problem report for credential exchange", "produces": ["application/json"]}}, "/issue-credential-2.0/records/{cred_ex_id}/send-offer": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredBoundOfferRequest"}}, {"in": "path", "name": "cred_ex_id", "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", "required": true}], "tags": ["issue-credential v2.0"], "summary": "Send holder a credential offer in reference to a proposal with preview", "produces": ["application/json"]}}, "/issue-credential-2.0/records/{cred_ex_id}/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredRequestRequest"}}, {"in": "path", "name": "cred_ex_id", "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", "required": true}], "tags": ["issue-credential v2.0"], "summary": "Send issuer a credential request", "produces": ["application/json"]}}, "/issue-credential-2.0/records/{cred_ex_id}/store": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecordDetail"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredStoreRequest"}}, {"in": "path", "name": "cred_ex_id", "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", "required": true}], "tags": ["issue-credential v2.0"], "summary": "Store a received credential", "produces": ["application/json"]}}, "/issue-credential-2.0/send": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredExFree"}}], "tags": ["issue-credential v2.0"], "summary": "Send holder a credential, automating entire flow", "produces": ["application/json"]}}, "/issue-credential-2.0/send-offer": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredOfferRequest"}}], "tags": ["issue-credential v2.0"], "summary": "Send holder a credential offer, independent of any proposal", "produces": ["application/json"]}}, "/issue-credential-2.0/send-proposal": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredExFree"}}], "tags": ["issue-credential v2.0"], "summary": "Send issuer a credential proposal", "produces": ["application/json"]}}, "/issue-credential-2.0/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20CredExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20CredRequestFree"}}], "tags": ["issue-credential v2.0"], "summary": "Send issuer a credential request not bound to an existing thread. Indy credentials cannot start at a request", "produces": ["application/json"]}}, "/issue-credential/create": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialCreate"}}], "tags": ["issue-credential v1.0"], "summary": "Create a credential record without sending (generally for use with Out-Of-Band)", "deprecated": true, "produces": ["application/json"]}}, "/issue-credential/create-offer": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialConnFreeOfferRequest"}}], "tags": ["issue-credential v1.0"], "summary": "Create a credential offer, independent of any proposal or connection", "deprecated": true, "produces": ["application/json"]}}, "/issue-credential/records": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchangeListResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "connection_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false}, {"in": "query", "name": "descending", "type": "boolean", "default": false, "description": "Order results in descending order if true", "required": false}, {"in": "query", "name": "limit", "type": "integer", "default": 100, "description": "Number of results to return", "example": 50, "required": false}, {"in": "query", "name": "offset", "type": "integer", "default": 0, "description": "Offset for pagination", "example": 0, "required": false}, {"in": "query", "name": "order_by", "type": "string", "default": "id", "enum": ["id"], "description": "The column to order results by. Only \"id\" is currently supported.", "required": false}, {"in": "query", "name": "role", "type": "string", "enum": ["issuer", "holder"], "description": "Role assigned in credential exchange", "required": false}, {"in": "query", "name": "state", "type": "string", "enum": ["proposal_sent", "proposal_received", "offer_sent", "offer_received", "request_sent", "request_received", "credential_issued", "credential_received", "credential_acked", "credential_revoked", "abandoned"], "description": "Credential exchange state", "required": false}, {"in": "query", "name": "thread_id", "type": "string", "description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false}], "tags": ["issue-credential v1.0"], "summary": "Fetch all credential exchange records", "deprecated": true, "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_ex_id", "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", "required": true}], "tags": ["issue-credential v1.0"], "summary": "Fetch a single credential exchange record", "deprecated": true, "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/IssueCredentialModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "cred_ex_id", "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", "required": true}], "tags": ["issue-credential v1.0"], "summary": "Remove an existing credential exchange record", "deprecated": true, "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}/issue": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialIssueRequest"}}, {"in": "path", "name": "cred_ex_id", "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", "required": true}], "tags": ["issue-credential v1.0"], "summary": "Send holder a credential", "deprecated": true, "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}/problem-report": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/IssueCredentialModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialProblemReportRequest"}}, {"in": "path", "name": "cred_ex_id", "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", "required": true}], "tags": ["issue-credential v1.0"], "summary": "Send a problem report for credential exchange", "deprecated": true, "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}/send-offer": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialBoundOfferRequest"}}, {"in": "path", "name": "cred_ex_id", "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", "required": true}], "tags": ["issue-credential v1.0"], "summary": "Send holder a credential offer in reference to a proposal with preview", "deprecated": true, "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialExchangeAutoRemoveRequest"}}, {"in": "path", "name": "cred_ex_id", "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", "required": true}], "tags": ["issue-credential v1.0"], "summary": "Send issuer a credential request", "deprecated": true, "produces": ["application/json"]}}, "/issue-credential/records/{cred_ex_id}/store": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialStoreRequest"}}, {"in": "path", "name": "cred_ex_id", "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", "required": true}], "tags": ["issue-credential v1.0"], "summary": "Store a received credential", "deprecated": true, "produces": ["application/json"]}}, "/issue-credential/send": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialProposalRequestMand"}}], "tags": ["issue-credential v1.0"], "summary": "Send holder a credential, automating entire flow", "deprecated": true, "produces": ["application/json"]}}, "/issue-credential/send-offer": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialFreeOfferRequest"}}], "tags": ["issue-credential v1.0"], "summary": "Send holder a credential offer, independent of any proposal", "deprecated": true, "produces": ["application/json"]}}, "/issue-credential/send-proposal": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10CredentialExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10CredentialProposalRequestOpt"}}], "tags": ["issue-credential v1.0"], "summary": "Send issuer a credential proposal", "deprecated": true, "produces": ["application/json"]}}, "/jsonld/sign": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/SignResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/SignRequest"}}], "tags": ["jsonld"], "summary": "Sign a JSON-LD structure and return it", "deprecated": true, "produces": ["application/json"]}}, "/jsonld/verify": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/VerifyResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/VerifyRequest"}}], "tags": ["jsonld"], "summary": "Verify a JSON-LD structure.", "deprecated": true, "produces": ["application/json"]}}, "/ledger/config": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/LedgerConfigList"}, "description": ""}}, "parameters": [], "tags": ["ledger"], "summary": "Fetch the multiple ledger configuration currently in use", "produces": ["application/json"]}}, "/ledger/did-endpoint": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/GetDIDEndpointResponse"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv", "required": true}, {"in": "query", "name": "endpoint_type", "type": "string", "enum": ["Endpoint", "Profile", "LinkedDomains"], "description": "Endpoint type of interest (default 'Endpoint')", "example": "Endpoint", "required": false}], "tags": ["ledger"], "summary": "Get the endpoint for a DID from the ledger.", "produces": ["application/json"]}}, "/ledger/did-verkey": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/GetDIDVerkeyResponse"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv", "required": true}], "tags": ["ledger"], "summary": "Get the verkey for a DID from the ledger.", "produces": ["application/json"]}}, "/ledger/get-nym-role": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/GetNymRoleResponse"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv", "required": true}], "tags": ["ledger"], "summary": "Get the role from the NYM registration of a public DID.", "produces": ["application/json"]}}, "/ledger/get-write-ledger": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/WriteLedger"}, "description": ""}}, "parameters": [], "tags": ["ledger"], "summary": "Fetch the current write ledger", "produces": ["application/json"]}}, "/ledger/get-write-ledgers": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/ConfigurableWriteLedgers"}, "description": ""}}, "parameters": [], "tags": ["ledger"], "summary": "Fetch list of available write ledgers", "produces": ["application/json"]}}, "/ledger/register-nym": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TxnOrRegisterLedgerNymResponse"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "DID to register", "example": "WgWxqztrNooG92RXvxSTWv", "required": true}, {"in": "query", "name": "verkey", "type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "description": "Verification key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "required": true}, {"in": "query", "name": "alias", "type": "string", "description": "Alias", "example": "Barry", "required": false}, {"in": "query", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false}, {"in": "query", "name": "create_transaction_for_endorser", "type": "boolean", "description": "Create Transaction For Endorser's signature", "required": false}, {"in": "query", "name": "role", "type": "string", "enum": ["STEWARD", "TRUSTEE", "ENDORSER", "NETWORK_MONITOR", "reset"], "description": "Role", "required": false}], "tags": ["ledger"], "summary": "Send a NYM registration to the ledger.", "produces": ["application/json"]}}, "/ledger/rotate-public-did-keypair": {"patch": {"responses": {"200": {"schema": {"$ref": "#/definitions/LedgerModulesResult"}, "description": ""}}, "parameters": [], "tags": ["ledger"], "summary": "Rotate key pair for public DID.", "produces": ["application/json"]}}, "/ledger/taa": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/TAAResult"}, "description": ""}}, "parameters": [], "tags": ["ledger"], "summary": "Fetch the current transaction author agreement, if any", "produces": ["application/json"]}}, "/ledger/taa/accept": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/LedgerModulesResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/TAAAccept"}}], "tags": ["ledger"], "summary": "Accept the transaction author agreement", "produces": ["application/json"]}}, "/ledger/{ledger_id}/set-write-ledger": {"put": {"responses": {"200": {"schema": {"$ref": "#/definitions/WriteLedger"}, "description": ""}}, "parameters": [{"in": "path", "name": "ledger_id", "type": "string", "required": true}], "tags": ["ledger"], "summary": "Set write ledger", "produces": ["application/json"]}}, "/mediation/default-mediator": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/MediationRecord"}, "description": ""}}, "parameters": [], "tags": ["mediation"], "summary": "Get default mediator", "produces": ["application/json"]}, "delete": {"responses": {"201": {"schema": {"$ref": "#/definitions/MediationRecord"}, "description": ""}}, "parameters": [], "tags": ["mediation"], "summary": "Clear default mediator", "produces": ["application/json"]}}, "/mediation/keylists": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/Keylist"}, "description": ""}}, "parameters": [{"in": "query", "name": "conn_id", "type": "string", "description": "Connection identifier (optional)", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false}, {"in": "query", "name": "role", "type": "string", "default": "server", "enum": ["client", "server"], "description": "Filer on role, 'client' for keys mediated by other agents, 'server' for keys mediated by this agent", "required": false}], "tags": ["mediation"], "summary": "Retrieve keylists by connection or role", "produces": ["application/json"]}}, "/mediation/keylists/{mediation_id}/send-keylist-query": {"post": {"responses": {"201": {"schema": {"$ref": "#/definitions/KeylistQuery"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/KeylistQueryFilterRequest"}}, {"in": "path", "name": "mediation_id", "type": "string", "description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}, {"in": "query", "name": "paginate_limit", "type": "integer", "default": -1, "description": "limit number of results", "required": false}, {"in": "query", "name": "paginate_offset", "type": "integer", "default": 0, "description": "offset to use in pagination", "required": false}], "tags": ["mediation"], "summary": "Send keylist query to mediator", "produces": ["application/json"]}}, "/mediation/keylists/{mediation_id}/send-keylist-update": {"post": {"responses": {"201": {"schema": {"$ref": "#/definitions/KeylistUpdate"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/KeylistUpdateRequest"}}, {"in": "path", "name": "mediation_id", "type": "string", "description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["mediation"], "summary": "Send keylist update to mediator", "produces": ["application/json"]}}, "/mediation/request/{conn_id}": {"post": {"responses": {"201": {"schema": {"$ref": "#/definitions/MediationRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/MediationCreateRequest"}}, {"in": "path", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["mediation"], "summary": "Request mediation from connection", "produces": ["application/json"]}}, "/mediation/requests": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/MediationList"}, "description": ""}}, "parameters": [{"in": "query", "name": "conn_id", "type": "string", "description": "Connection identifier (optional)", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false}, {"in": "query", "name": "state", "type": "string", "enum": ["request", "granted", "denied"], "description": "Mediation state (optional)", "example": "granted", "required": false}], "tags": ["mediation"], "summary": "Query mediation requests, returns list of all mediation records", "produces": ["application/json"]}}, "/mediation/requests/{mediation_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/MediationRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "mediation_id", "type": "string", "description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["mediation"], "summary": "Retrieve mediation request record", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/MediationRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "mediation_id", "type": "string", "description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["mediation"], "summary": "Delete mediation request by ID", "produces": ["application/json"]}}, "/mediation/requests/{mediation_id}/deny": {"post": {"responses": {"201": {"schema": {"$ref": "#/definitions/MediationDeny"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/AdminMediationDeny"}}, {"in": "path", "name": "mediation_id", "type": "string", "description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["mediation"], "summary": "Deny a stored mediation request", "produces": ["application/json"]}}, "/mediation/requests/{mediation_id}/grant": {"post": {"responses": {"201": {"schema": {"$ref": "#/definitions/MediationGrant"}, "description": ""}}, "parameters": [{"in": "path", "name": "mediation_id", "type": "string", "description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["mediation"], "summary": "Grant received mediation", "produces": ["application/json"]}}, "/mediation/update-keylist/{conn_id}": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/KeylistUpdate"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/MediationIdMatchInfo"}}, {"in": "path", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["mediation"], "summary": "Update keylist for a connection", "produces": ["application/json"]}}, "/mediation/{mediation_id}/default-mediator": {"put": {"responses": {"201": {"schema": {"$ref": "#/definitions/MediationRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "mediation_id", "type": "string", "description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["mediation"], "summary": "Set default mediator", "produces": ["application/json"]}}, "/multitenancy/wallet": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/CreateWalletResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/CreateWalletRequest"}}], "tags": ["multitenancy"], "summary": "Create a subwallet", "produces": ["application/json"]}}, "/multitenancy/wallet/{wallet_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/WalletRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "wallet_id", "type": "string", "description": "Subwallet identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["multitenancy"], "summary": "Get a single subwallet", "produces": ["application/json"]}, "put": {"responses": {"200": {"schema": {"$ref": "#/definitions/WalletRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/UpdateWalletRequest"}}, {"in": "path", "name": "wallet_id", "type": "string", "description": "Subwallet identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["multitenancy"], "summary": "Update a subwallet", "produces": ["application/json"]}}, "/multitenancy/wallet/{wallet_id}/remove": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/MultitenantModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/RemoveWalletRequest"}}, {"in": "path", "name": "wallet_id", "type": "string", "description": "Subwallet identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["multitenancy"], "summary": "Remove a subwallet", "produces": ["application/json"]}}, "/multitenancy/wallet/{wallet_id}/token": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/CreateWalletTokenResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/CreateWalletTokenRequest"}}, {"in": "path", "name": "wallet_id", "required": true, "type": "string"}], "tags": ["multitenancy"], "summary": "Get auth token for a subwallet", "produces": ["application/json"]}}, "/multitenancy/wallets": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/WalletList"}, "description": ""}}, "parameters": [{"in": "query", "name": "descending", "type": "boolean", "default": false, "description": "Order results in descending order if true", "required": false}, {"in": "query", "name": "limit", "type": "integer", "default": 100, "description": "Number of results to return", "example": 50, "required": false}, {"in": "query", "name": "offset", "type": "integer", "default": 0, "description": "Offset for pagination", "example": 0, "required": false}, {"in": "query", "name": "order_by", "type": "string", "default": "id", "enum": ["id"], "description": "The column to order results by. Only \"id\" is currently supported.", "required": false}, {"in": "query", "name": "wallet_name", "type": "string", "description": "Wallet name", "example": "MyNewWallet", "required": false}], "tags": ["multitenancy"], "summary": "Query subwallets", "produces": ["application/json"]}}, "/out-of-band/create-invitation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/InvitationRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/InvitationCreateRequest"}}, {"in": "query", "name": "auto_accept", "type": "boolean", "description": "Auto-accept connection (defaults to configuration)", "required": false}, {"in": "query", "name": "create_unique_did", "type": "boolean", "description": "Create unique DID for this invitation (default false)", "required": false}, {"in": "query", "name": "multi_use", "type": "boolean", "description": "Create invitation for multiple use (default false)", "required": false}], "tags": ["out-of-band"], "summary": "Create a new connection invitation", "produces": ["application/json"]}}, "/out-of-band/invitations/{invi_msg_id}": {"delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/InvitationRecordResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "invi_msg_id", "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": "Invitation Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["out-of-band"], "summary": "Delete records associated with invitation", "produces": ["application/json"]}}, "/out-of-band/receive-invitation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/OobRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/InvitationMessage"}}, {"in": "query", "name": "alias", "type": "string", "description": "Alias for connection", "example": "Barry", "required": false}, {"in": "query", "name": "auto_accept", "type": "boolean", "description": "Auto-accept connection (defaults to configuration)", "required": false}, {"in": "query", "name": "mediation_id", "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": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false}, {"in": "query", "name": "use_existing_connection", "type": "boolean", "description": "Use an existing connection, if possible", "required": false}], "tags": ["out-of-band"], "summary": "Receive a new connection invitation", "produces": ["application/json"]}}, "/plugins": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminModules"}, "description": ""}}, "parameters": [], "tags": ["server"], "summary": "Fetch the list of loaded plugins", "produces": ["application/json"]}}, "/present-proof-2.0/create-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20PresCreateRequestRequest"}}], "tags": ["present-proof v2.0"], "summary": "Creates a presentation request not bound to any proposal or connection", "produces": ["application/json"]}}, "/present-proof-2.0/records": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecordList"}, "description": ""}}, "parameters": [{"in": "query", "name": "connection_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false}, {"in": "query", "name": "descending", "type": "boolean", "default": false, "description": "Order results in descending order if true", "required": false}, {"in": "query", "name": "limit", "type": "integer", "default": 100, "description": "Number of results to return", "example": 50, "required": false}, {"in": "query", "name": "offset", "type": "integer", "default": 0, "description": "Offset for pagination", "example": 0, "required": false}, {"in": "query", "name": "order_by", "type": "string", "default": "id", "enum": ["id"], "description": "The column to order results by. Only \"id\" is currently supported.", "required": false}, {"in": "query", "name": "role", "type": "string", "enum": ["prover", "verifier"], "description": "Role assigned in presentation exchange", "required": false}, {"in": "query", "name": "state", "type": "string", "enum": ["proposal-sent", "proposal-received", "request-sent", "request-received", "presentation-sent", "presentation-received", "done", "abandoned"], "description": "Presentation exchange state", "required": false}, {"in": "query", "name": "thread_id", "type": "string", "description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false}], "tags": ["present-proof v2.0"], "summary": "Fetch all present-proof exchange records", "produces": ["application/json"]}}, "/present-proof-2.0/records/{pres_ex_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "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", "required": true}], "tags": ["present-proof v2.0"], "summary": "Fetch a single presentation exchange record", "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresentProofModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "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", "required": true}], "tags": ["present-proof v2.0"], "summary": "Remove an existing presentation exchange record", "produces": ["application/json"]}}, "/present-proof-2.0/records/{pres_ex_id}/credentials": {"get": {"responses": {"200": {"schema": {"type": "array", "items": {"$ref": "#/definitions/IndyCredPrecis"}}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "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", "required": true}, {"in": "query", "name": "count", "type": "string", "pattern": "^[1-9][0-9]*$", "description": "Maximum number to retrieve", "example": "1", "required": false}, {"in": "query", "name": "extra_query", "type": "string", "pattern": "^{\\s*\".*?\"\\s*:\\s*{.*?}\\s*(,\\s*\".*?\"\\s*:\\s*{.*?}\\s*)*\\s*}$", "description": "(JSON) object mapping referents to extra WQL queries", "example": "{\"0_drink_uuid\": {\"attr::drink::value\": \"martini\"}}", "required": false}, {"in": "query", "name": "referent", "type": "string", "description": "Proof request referents of interest, comma-separated", "example": "1_name_uuid,2_score_uuid", "required": false}, {"in": "query", "name": "start", "type": "string", "pattern": "^[0-9]*$", "description": "Start index", "example": "0", "required": false}], "tags": ["present-proof v2.0"], "summary": "Fetch credentials from wallet for presentation request", "produces": ["application/json"]}}, "/present-proof-2.0/records/{pres_ex_id}/problem-report": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresentProofModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20PresProblemReportRequest"}}, {"in": "path", "name": "pres_ex_id", "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", "required": true}], "tags": ["present-proof v2.0"], "summary": "Send a problem report for presentation exchange", "produces": ["application/json"]}}, "/present-proof-2.0/records/{pres_ex_id}/send-presentation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20PresSpecByFormatRequest"}}, {"in": "path", "name": "pres_ex_id", "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", "required": true}], "tags": ["present-proof v2.0"], "summary": "Sends a proof presentation", "produces": ["application/json"]}}, "/present-proof-2.0/records/{pres_ex_id}/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20PresentationSendRequestToProposal"}}, {"in": "path", "name": "pres_ex_id", "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", "required": true}], "tags": ["present-proof v2.0"], "summary": "Sends a presentation request in reference to a proposal", "produces": ["application/json"]}}, "/present-proof-2.0/records/{pres_ex_id}/verify-presentation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "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", "required": true}], "tags": ["present-proof v2.0"], "summary": "Verify a received presentation", "produces": ["application/json"]}}, "/present-proof-2.0/send-proposal": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20PresProposalRequest"}}], "tags": ["present-proof v2.0"], "summary": "Sends a presentation proposal", "produces": ["application/json"]}}, "/present-proof-2.0/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V20PresExRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V20PresSendRequestRequest"}}], "tags": ["present-proof v2.0"], "summary": "Sends a free presentation request not bound to any proposal", "produces": ["application/json"]}}, "/present-proof/create-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10PresentationCreateRequestRequest"}}], "tags": ["present-proof v1.0"], "summary": "Creates a presentation request not bound to any proposal or connection", "deprecated": true, "produces": ["application/json"]}}, "/present-proof/records": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchangeList"}, "description": ""}}, "parameters": [{"in": "query", "name": "connection_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false}, {"in": "query", "name": "descending", "type": "boolean", "default": false, "description": "Order results in descending order if true", "required": false}, {"in": "query", "name": "limit", "type": "integer", "default": 100, "description": "Number of results to return", "example": 50, "required": false}, {"in": "query", "name": "offset", "type": "integer", "default": 0, "description": "Offset for pagination", "example": 0, "required": false}, {"in": "query", "name": "order_by", "type": "string", "default": "id", "enum": ["id"], "description": "The column to order results by. Only \"id\" is currently supported.", "required": false}, {"in": "query", "name": "role", "type": "string", "enum": ["prover", "verifier"], "description": "Role assigned in presentation exchange", "required": false}, {"in": "query", "name": "state", "type": "string", "enum": ["proposal_sent", "proposal_received", "request_sent", "request_received", "presentation_sent", "presentation_received", "verified", "presentation_acked", "abandoned"], "description": "Presentation exchange state", "required": false}, {"in": "query", "name": "thread_id", "type": "string", "description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false}], "tags": ["present-proof v1.0"], "summary": "Fetch all present-proof exchange records", "deprecated": true, "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "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", "required": true}], "tags": ["present-proof v1.0"], "summary": "Fetch a single presentation exchange record", "deprecated": true, "produces": ["application/json"]}, "delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentProofModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "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", "required": true}], "tags": ["present-proof v1.0"], "summary": "Remove an existing presentation exchange record", "deprecated": true, "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}/credentials": {"get": {"responses": {"200": {"schema": {"type": "array", "items": {"$ref": "#/definitions/IndyCredPrecis"}}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "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", "required": true}, {"in": "query", "name": "count", "type": "string", "pattern": "^[1-9][0-9]*$", "description": "Maximum number to retrieve", "example": "1", "required": false}, {"in": "query", "name": "extra_query", "type": "string", "pattern": "^{\\s*\".*?\"\\s*:\\s*{.*?}\\s*(,\\s*\".*?\"\\s*:\\s*{.*?}\\s*)*\\s*}$", "description": "(JSON) object mapping referents to extra WQL queries", "example": "{\"0_drink_uuid\": {\"attr::drink::value\": \"martini\"}}", "required": false}, {"in": "query", "name": "referent", "type": "string", "description": "Proof request referents of interest, comma-separated", "example": "1_name_uuid,2_score_uuid", "required": false}, {"in": "query", "name": "start", "type": "string", "pattern": "^[0-9]*$", "description": "Start index", "example": "0", "required": false}], "tags": ["present-proof v1.0"], "summary": "Fetch credentials for a presentation request from wallet", "deprecated": true, "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}/problem-report": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentProofModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10PresentationProblemReportRequest"}}, {"in": "path", "name": "pres_ex_id", "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", "required": true}], "tags": ["present-proof v1.0"], "summary": "Send a problem report for presentation exchange", "deprecated": true, "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}/send-presentation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10PresentationSendRequest"}}, {"in": "path", "name": "pres_ex_id", "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", "required": true}], "tags": ["present-proof v1.0"], "summary": "Sends a proof presentation", "deprecated": true, "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10PresentationSendRequestToProposal"}}, {"in": "path", "name": "pres_ex_id", "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", "required": true}], "tags": ["present-proof v1.0"], "summary": "Sends a presentation request in reference to a proposal", "deprecated": true, "produces": ["application/json"]}}, "/present-proof/records/{pres_ex_id}/verify-presentation": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": ""}}, "parameters": [{"in": "path", "name": "pres_ex_id", "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", "required": true}], "tags": ["present-proof v1.0"], "summary": "Verify a received presentation", "deprecated": true, "produces": ["application/json"]}}, "/present-proof/send-proposal": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10PresentationProposalRequest"}}], "tags": ["present-proof v1.0"], "summary": "Sends a presentation proposal", "deprecated": true, "produces": ["application/json"]}}, "/present-proof/send-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/V10PresentationExchange"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/V10PresentationSendRequestRequest"}}], "tags": ["present-proof v1.0"], "summary": "Sends a free presentation request not bound to any proposal", "deprecated": true, "produces": ["application/json"]}}, "/resolver/resolve/{did}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/ResolutionResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "did", "type": "string", "pattern": "^did:([a-z0-9]+):((?:[a-zA-Z0-9._%-]*:)*[a-zA-Z0-9._%-]+)$", "description": "DID", "example": "did:ted:WgWxqztrNooG92RXvxSTWv", "required": true}], "tags": ["resolver"], "summary": "Retrieve doc for requested did", "produces": ["application/json"]}}, "/revocation/active-registry/{cred_def_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "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", "required": true}], "tags": ["revocation"], "summary": "Get current active revocation registry by credential definition id", "produces": ["application/json"]}}, "/revocation/active-registry/{cred_def_id}/rotate": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegsCreated"}, "description": ""}}, "parameters": [{"in": "path", "name": "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", "required": true}], "tags": ["revocation"], "summary": "Rotate revocation registry", "produces": ["application/json"]}}, "/revocation/clear-pending-revocations": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/PublishRevocations"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/ClearPendingRevocationsRequest"}}], "tags": ["revocation"], "summary": "Clear pending revocations", "produces": ["application/json"]}}, "/revocation/create-registry": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/RevRegCreateRequest"}}], "tags": ["revocation"], "summary": "Creates a new revocation registry", "produces": ["application/json"]}}, "/revocation/credential-record": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredRevRecordResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "cred_ex_id", "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", "required": false}, {"in": "query", "name": "cred_rev_id", "type": "string", "pattern": "^[1-9][0-9]*$", "description": "Credential revocation identifier", "example": "12345", "required": false}, {"in": "query", "name": "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", "required": false}], "tags": ["revocation"], "summary": "Get credential revocation status", "produces": ["application/json"]}}, "/revocation/publish-revocations": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TxnOrPublishRevocationsResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/PublishRevocations"}}, {"in": "query", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false}, {"in": "query", "name": "create_transaction_for_endorser", "type": "boolean", "description": "Create Transaction For Endorser's signature", "required": false}], "tags": ["revocation"], "summary": "Publish pending revocations to ledger", "produces": ["application/json"]}}, "/revocation/registries/created": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegsCreated"}, "description": ""}}, "parameters": [{"in": "query", "name": "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", "required": false}, {"in": "query", "name": "state", "type": "string", "enum": ["init", "generated", "posted", "active", "full", "decommissioned"], "description": "Revocation registry state", "required": false}], "tags": ["revocation"], "summary": "Search for matching revocation registries that current agent created", "produces": ["application/json"]}}, "/revocation/registry/delete-tails-file": {"delete": {"responses": {"200": {"schema": {"$ref": "#/definitions/TailsDeleteResponse"}, "description": ""}}, "parameters": [{"in": "query", "name": "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", "required": false}, {"in": "query", "name": "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", "required": false}], "tags": ["revocation"], "summary": "Delete the tail files", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "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", "required": true}], "tags": ["revocation"], "summary": "Get revocation registry by revocation registry id", "produces": ["application/json"]}, "patch": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/RevRegUpdateTailsFileUri"}}, {"in": "path", "name": "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", "required": true}], "tags": ["revocation"], "summary": "Update revocation registry with new public URI to its tails file", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/definition": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TxnOrRevRegResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "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", "required": true}, {"in": "query", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false}, {"in": "query", "name": "create_transaction_for_endorser", "type": "boolean", "description": "Create Transaction For Endorser's signature", "required": false}], "tags": ["revocation"], "summary": "Send revocation registry definition to ledger", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/entry": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "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", "required": true}, {"in": "query", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false}, {"in": "query", "name": "create_transaction_for_endorser", "type": "boolean", "description": "Create Transaction For Endorser's signature", "required": false}], "tags": ["revocation"], "summary": "Send revocation registry entry to ledger", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/fix-revocation-entry-state": {"put": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegWalletUpdatedResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "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", "required": true}, {"in": "query", "name": "apply_ledger_update", "type": "boolean", "description": "Apply updated accumulator transaction to ledger", "required": true}], "tags": ["revocation"], "summary": "Fix revocation state in wallet and return number of updated entries", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/issued": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegIssuedResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "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", "required": true}], "tags": ["revocation"], "summary": "Get number of credentials issued against revocation registry", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/issued/details": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredRevRecordDetailsResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "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", "required": true}], "tags": ["revocation"], "summary": "Get details of credentials issued against revocation registry", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/issued/indy_recs": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/CredRevIndyRecordsResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "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", "required": true}], "tags": ["revocation"], "summary": "Get details of revoked credentials from ledger", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/set-state": {"patch": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevRegResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "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", "required": true}, {"in": "query", "name": "state", "type": "string", "enum": ["init", "generated", "posted", "active", "full"], "description": "Revocation registry state to set", "required": true}], "tags": ["revocation"], "summary": "Set revocation registry state manually", "produces": ["application/json"]}}, "/revocation/registry/{rev_reg_id}/tails-file": {"put": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevocationModuleResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "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", "required": true}], "tags": ["revocation"], "summary": "Upload local tails file to server", "produces": ["application/json"]}, "get": {"responses": {"200": {"schema": {"type": "string", "format": "binary"}, "description": "tails file"}}, "parameters": [{"in": "path", "name": "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", "required": true}], "tags": ["revocation"], "summary": "Download tails file", "produces": ["application/octet-stream"]}}, "/revocation/revoke": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/RevocationModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/RevokeRequest"}}, {"in": "query", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false}, {"in": "query", "name": "create_transaction_for_endorser", "type": "boolean", "description": "Create Transaction For Endorser's signature", "required": false}], "tags": ["revocation"], "summary": "Revoke an issued credential", "produces": ["application/json"]}}, "/schemas": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TxnOrSchemaSendResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/SchemaSendRequest"}}, {"in": "query", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false}, {"in": "query", "name": "create_transaction_for_endorser", "type": "boolean", "description": "Create Transaction For Endorser's signature", "required": false}], "tags": ["schema"], "summary": "Sends a schema to the ledger", "produces": ["application/json"]}}, "/schemas/created": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/SchemasCreatedResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "schema_id", "type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "required": false}, {"in": "query", "name": "schema_issuer_did", "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "description": "Schema issuer DID", "example": "WgWxqztrNooG92RXvxSTWv", "required": false}, {"in": "query", "name": "schema_name", "type": "string", "description": "Schema name", "example": "membership", "required": false}, {"in": "query", "name": "schema_version", "type": "string", "pattern": "^[0-9.]+$", "description": "Schema version", "example": "1.0", "required": false}], "tags": ["schema"], "summary": "Search for matching schema that agent originated", "produces": ["application/json"]}}, "/schemas/{schema_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/SchemaGetResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "schema_id", "type": "string", "pattern": "^[1-9][0-9]*|[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "required": true}], "tags": ["schema"], "summary": "Gets a schema from the ledger", "produces": ["application/json"]}}, "/schemas/{schema_id}/write_record": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/SchemaGetResult"}, "description": ""}}, "parameters": [{"in": "path", "name": "schema_id", "type": "string", "pattern": "^[1-9][0-9]*|[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "required": true}], "tags": ["schema"], "summary": "Writes a schema non-secret record to the wallet", "produces": ["application/json"]}}, "/settings": {"put": {"responses": {"200": {"schema": {"$ref": "#/definitions/ProfileSettings"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/UpdateProfileSettings"}}], "tags": ["settings"], "summary": "Update configurable settings associated with the profile.", "produces": ["application/json"]}, "get": {"responses": {"200": {"schema": {"$ref": "#/definitions/ProfileSettings"}, "description": ""}}, "parameters": [], "tags": ["settings"], "summary": "Get the configurable settings associated with the profile.", "produces": ["application/json"]}}, "/shutdown": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminShutdown"}, "description": ""}}, "parameters": [], "tags": ["server"], "summary": "Shut down server", "produces": ["application/json"]}}, "/status": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminStatus"}, "description": ""}}, "parameters": [], "tags": ["server"], "summary": "Fetch the server status", "produces": ["application/json"]}}, "/status/config": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminConfig"}, "description": ""}}, "parameters": [], "tags": ["server"], "summary": "Fetch the server configuration", "produces": ["application/json"]}}, "/status/live": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminStatusLiveliness"}, "description": ""}}, "parameters": [], "tags": ["server"], "summary": "Liveliness check", "produces": ["application/json"]}}, "/status/ready": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminStatusReadiness"}, "description": ""}}, "parameters": [], "tags": ["server"], "summary": "Readiness check", "produces": ["application/json"]}}, "/status/reset": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/AdminReset"}, "description": ""}}, "parameters": [], "tags": ["server"], "summary": "Reset statistics", "produces": ["application/json"]}}, "/transaction/{tran_id}/resend": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "tran_id", "type": "string", "description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["endorse-transaction"], "summary": "For Author to resend a particular transaction request", "produces": ["application/json"]}}, "/transactions": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionList"}, "description": ""}}, "parameters": [], "tags": ["endorse-transaction"], "summary": "Query transactions", "produces": ["application/json"]}}, "/transactions/create-request": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionRecord"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/Date"}}, {"in": "query", "name": "tran_id", "type": "string", "description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["endorse-transaction"], "summary": "For author to send a transaction request", "produces": ["application/json"]}}, "/transactions/{conn_id}/set-endorser-info": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/EndorserInfo"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}, {"in": "query", "name": "endorser_did", "type": "string", "description": "Endorser DID", "required": true}, {"in": "query", "name": "endorser_name", "type": "string", "description": "Endorser Name", "required": false}], "tags": ["endorse-transaction"], "summary": "Set Endorser Info", "produces": ["application/json"]}}, "/transactions/{conn_id}/set-endorser-role": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionJobs"}, "description": ""}}, "parameters": [{"in": "path", "name": "conn_id", "type": "string", "description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}, {"in": "query", "name": "transaction_my_job", "type": "string", "enum": ["TRANSACTION_AUTHOR", "TRANSACTION_ENDORSER", "reset"], "description": "Transaction related jobs", "required": false}], "tags": ["endorse-transaction"], "summary": "Set transaction jobs", "produces": ["application/json"]}}, "/transactions/{tran_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "tran_id", "type": "string", "description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["endorse-transaction"], "summary": "Fetch a single transaction record", "produces": ["application/json"]}}, "/transactions/{tran_id}/cancel": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "tran_id", "type": "string", "description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["endorse-transaction"], "summary": "For Author to cancel a particular transaction request", "produces": ["application/json"]}}, "/transactions/{tran_id}/endorse": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "tran_id", "type": "string", "description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}, {"in": "query", "name": "endorser_did", "type": "string", "description": "Endorser DID", "required": false}], "tags": ["endorse-transaction"], "summary": "For Endorser to endorse a particular transaction record", "produces": ["application/json"]}}, "/transactions/{tran_id}/refuse": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "tran_id", "type": "string", "description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["endorse-transaction"], "summary": "For Endorser to refuse a particular transaction record", "produces": ["application/json"]}}, "/transactions/{tran_id}/write": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/TransactionRecord"}, "description": ""}}, "parameters": [{"in": "path", "name": "tran_id", "type": "string", "description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": true}], "tags": ["endorse-transaction"], "summary": "For Author / Endorser to write an endorsed transaction to the ledger", "produces": ["application/json"]}}, "/vc/credentials": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/ListCredentialsResponse"}, "description": ""}}, "parameters": [], "tags": ["vc-api"], "summary": "List credentials", "produces": ["application/json"]}}, "/vc/credentials/issue": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/IssueCredentialResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/IssueCredentialRequest"}}], "tags": ["vc-api"], "summary": "Issue a credential", "produces": ["application/json"]}}, "/vc/credentials/store": {"post": {"responses": {}, "parameters": [], "tags": ["vc-api"], "summary": "Store a credential", "produces": ["application/json"]}}, "/vc/credentials/verify": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/VerifyCredentialResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/VerifyCredentialRequest"}}], "tags": ["vc-api"], "summary": "Verify a credential", "produces": ["application/json"]}}, "/vc/credentials/{credential_id}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/FetchCredentialResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "credential_id", "required": true, "type": "string"}], "tags": ["vc-api"], "summary": "Fetch credential by ID", "produces": ["application/json"]}}, "/vc/di/add-proof": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/AddProofResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/AddProof"}}], "tags": ["vc"], "summary": "Add a DataIntegrityProof to a document.", "produces": ["application/json"]}}, "/vc/di/verify": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/VerifyDiResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/VerifyDiRequest"}}], "tags": ["vc"], "summary": "Verify a document secured with a data integrity proof.", "produces": ["application/json"]}}, "/vc/presentations/prove": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/ProvePresentationResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/ProvePresentationRequest"}}], "tags": ["vc-api"], "summary": "Prove a presentation", "produces": ["application/json"]}}, "/vc/presentations/verify": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/VerifyPresentationResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/VerifyPresentationRequest"}}], "tags": ["vc-api"], "summary": "Verify a Presentation", "produces": ["application/json"]}}, "/wallet/did": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/DIDList"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "description": "DID of interest", "example": "did:peer:WgWxqztrNooG92RXvxSTWv", "required": false}, {"in": "query", "name": "key_type", "type": "string", "enum": ["ed25519", "bls12381g2"], "example": "ed25519", "description": "Key type to query for.", "required": false}, {"in": "query", "name": "method", "type": "string", "enum": ["key", "sov", "did:peer:2", "did:peer:4"], "example": "key", "description": "DID method to query for. e.g. sov to only fetch indy/sov DIDs", "required": false}, {"in": "query", "name": "posture", "type": "string", "enum": ["public", "posted", "wallet_only"], "description": "Whether DID is current public DID, posted to ledger but current public DID, or local to the wallet", "example": "wallet_only", "required": false}, {"in": "query", "name": "verkey", "type": "string", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "description": "Verification key of interest", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "required": false}], "tags": ["wallet"], "summary": "List wallet DIDs", "produces": ["application/json"]}}, "/wallet/did/create": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/DIDResult"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/DIDCreate"}}], "tags": ["wallet"], "summary": "Create a local DID", "produces": ["application/json"]}}, "/wallet/did/local/rotate-keypair": {"patch": {"responses": {"200": {"schema": {"$ref": "#/definitions/WalletModuleResponse"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "description": "DID of interest", "example": "did:peer:WgWxqztrNooG92RXvxSTWv", "required": true}], "tags": ["wallet"], "summary": "Rotate keypair for a DID not posted to the ledger", "produces": ["application/json"]}}, "/wallet/did/public": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/DIDResult"}, "description": ""}}, "parameters": [], "tags": ["wallet"], "summary": "Fetch the current public DID", "produces": ["application/json"]}, "post": {"responses": {"200": {"schema": {"$ref": "#/definitions/DIDResult"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "description": "DID of interest", "example": "did:peer:WgWxqztrNooG92RXvxSTWv", "required": true}, {"in": "query", "name": "conn_id", "type": "string", "description": "Connection identifier", "required": false}, {"in": "query", "name": "create_transaction_for_endorser", "type": "boolean", "description": "Create Transaction For Endorser's signature", "required": false}, {"in": "query", "name": "mediation_id", "type": "string", "description": "Mediation identifier", "required": false}], "tags": ["wallet"], "summary": "Assign the current public DID", "produces": ["application/json"]}}, "/wallet/get-did-endpoint": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/DIDEndpoint"}, "description": ""}}, "parameters": [{"in": "query", "name": "did", "type": "string", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "description": "DID of interest", "example": "did:peer:WgWxqztrNooG92RXvxSTWv", "required": true}], "tags": ["wallet"], "summary": "Query DID endpoint in wallet", "produces": ["application/json"]}}, "/wallet/jwt/sign": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/WalletModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/JWSCreate"}}], "tags": ["wallet"], "summary": "Create a EdDSA jws using did keys with a given payload", "produces": ["application/json"]}}, "/wallet/jwt/verify": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/JWSVerifyResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/JWSVerify"}}], "tags": ["wallet"], "summary": "Verify a EdDSA jws using did keys with a given JWS", "produces": ["application/json"]}}, "/wallet/keys": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/CreateKeyResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/CreateKeyRequest"}}], "tags": ["wallet"], "summary": "Create a key pair", "produces": ["application/json"]}, "put": {"responses": {"200": {"schema": {"$ref": "#/definitions/UpdateKeyResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/UpdateKeyRequest"}}], "tags": ["wallet"], "summary": "Update a key pair's kid", "produces": ["application/json"]}}, "/wallet/keys/{multikey}": {"get": {"responses": {"200": {"schema": {"$ref": "#/definitions/FetchKeyResponse"}, "description": ""}}, "parameters": [{"in": "path", "name": "multikey", "required": true, "type": "string"}], "tags": ["wallet"], "summary": "Fetch key info.", "produces": ["application/json"]}}, "/wallet/sd-jwt/sign": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/WalletModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/SDJWSCreate"}}], "tags": ["wallet"], "summary": "Create a EdDSA sd-jws using did keys with a given payload", "produces": ["application/json"]}}, "/wallet/sd-jwt/verify": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/SDJWSVerifyResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/SDJWSVerify"}}], "tags": ["wallet"], "summary": "Verify a EdDSA sd-jws using did keys with a given SD-JWS with optional key binding", "produces": ["application/json"]}}, "/wallet/set-did-endpoint": {"post": {"responses": {"200": {"schema": {"$ref": "#/definitions/WalletModuleResponse"}, "description": ""}}, "parameters": [{"in": "body", "required": false, "name": "body", "schema": {"$ref": "#/definitions/DIDEndpointWithType"}}, {"in": "query", "name": "conn_id", "type": "string", "description": "Connection identifier", "required": false}, {"in": "query", "name": "create_transaction_for_endorser", "type": "boolean", "description": "Create Transaction For Endorser's signature", "required": false}], "tags": ["wallet"], "summary": "Update endpoint in wallet and on ledger if posted to it", "produces": ["application/json"]}}}, "info": {"title": "Aries Cloud Agent", "version": "v1.1.1b1"}, "swagger": "2.0", "definitions": {"AMLRecord": {"properties": {"aml": {"additionalProperties": {"type": "string"}, "type": "object"}, "amlContext": {"type": "string"}, "version": {"type": "string"}}, "type": "object"}, "ActionMenuFetchResult": {"properties": {"result": {"allOf": [{"$ref": "#/definitions/Menu"}], "description": "Action menu"}}, "type": "object"}, "ActionMenuModulesResult": {"properties": {}, "type": "object"}, "AddProof": {"properties": {"document": {"example": {"hello": "world"}, "type": "object"}, "options": {"allOf": [{"$ref": "#/definitions/DataIntegrityProofOptions"}], "example": {"cryptosuite": "eddsa-jcs-2022", "proofPurpose": "assertionMethod", "type": "DataIntegrityProof", "verificationMethod": "did:web:example.com#key-01"}}}, "required": ["document"], "type": "object"}, "AddProofResponse": {"properties": {"secured_document": {"example": {"hello": "world"}, "type": "object"}}, "required": ["secured_document"], "type": "object"}, "AdminConfig": {"properties": {"config": {"description": "Configuration settings", "type": "object"}}, "required": ["config"], "type": "object"}, "AdminMediationDeny": {"properties": {}, "type": "object"}, "AdminModules": {"properties": {"result": {"description": "List of admin modules", "items": {"description": "admin module", "type": "string"}, "type": "array"}}, "type": "object"}, "AdminReset": {"properties": {}, "type": "object"}, "AdminShutdown": {"properties": {}, "type": "object"}, "AdminStatus": {"properties": {"conductor": {"description": "Conductor statistics", "type": "object"}, "label": {"description": "Default label", "type": "string", "x-nullable": true}, "timing": {"description": "Timing results", "type": "object"}, "version": {"description": "Version code", "type": "string"}}, "type": "object"}, "AdminStatusLiveliness": {"properties": {"alive": {"description": "Liveliness status", "example": true, "type": "boolean"}}, "type": "object"}, "AdminStatusReadiness": {"properties": {"ready": {"description": "Readiness status", "example": true, "type": "boolean"}}, "type": "object"}, "AnonCredsSchema": {"properties": {"attrNames": {"description": "Schema attribute names", "items": {"description": "Attribute name", "example": "score", "type": "string"}, "type": "array"}, "issuerId": {"description": "Issuer Identifier of the credential definition or schema", "example": "WgWxqztrNooG92RXvxSTWv", "type": "string"}, "name": {"description": "Schema name", "example": "Example schema", "type": "string"}, "version": {"description": "Schema version", "example": "1.0", "type": "string"}}, "type": "object"}, "AttachDecorator": {"properties": {"@id": {"description": "Attachment identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "byte_count": {"description": "Byte count of data included by reference", "example": 1234, "type": "integer"}, "data": {"$ref": "#/definitions/AttachDecoratorData"}, "description": {"description": "Human-readable description of content", "example": "view from doorway, facing east, with lights off", "type": "string"}, "filename": {"description": "File name", "example": "IMG1092348.png", "type": "string"}, "lastmod_time": {"description": "Hint regarding last modification datetime, in ISO-8601 format", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "mime-type": {"description": "MIME type", "example": "image/png", "type": "string"}}, "required": ["data"], "type": "object"}, "AttachDecoratorData": {"properties": {"base64": {"description": "Base64-encoded data", "example": "ey4uLn0=", "pattern": "^[a-zA-Z0-9+/]*={0,2}$", "type": "string"}, "json": {"description": "JSON-serialized data", "example": "{\"sample\": \"content\"}"}, "jws": {"allOf": [{"$ref": "#/definitions/AttachDecoratorDataJWS"}], "description": "Detached Java Web Signature"}, "links": {"description": "List of hypertext links to data", "items": {"example": "https://link.to/data", "type": "string"}, "type": "array"}, "sha256": {"description": "SHA256 hash (binhex encoded) of content", "example": "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb", "pattern": "^[a-fA-F0-9+/]{64}$", "type": "string"}}, "type": "object"}, "AttachDecoratorData1JWS": {"properties": {"header": {"$ref": "#/definitions/AttachDecoratorDataJWSHeader"}, "protected": {"description": "protected JWS header", "example": "ey4uLn0", "pattern": "^[-_a-zA-Z0-9]*$", "type": "string"}, "signature": {"description": "signature", "example": "ey4uLn0", "pattern": "^[-_a-zA-Z0-9]*$", "type": "string"}}, "required": ["header", "signature"], "type": "object"}, "AttachDecoratorDataJWS": {"properties": {"header": {"$ref": "#/definitions/AttachDecoratorDataJWSHeader"}, "protected": {"description": "protected JWS header", "example": "ey4uLn0", "pattern": "^[-_a-zA-Z0-9]*$", "type": "string"}, "signature": {"description": "signature", "example": "ey4uLn0", "pattern": "^[-_a-zA-Z0-9]*$", "type": "string"}, "signatures": {"description": "List of signatures", "items": {"$ref": "#/definitions/AttachDecoratorData1JWS"}, "type": "array"}}, "type": "object"}, "AttachDecoratorDataJWSHeader": {"properties": {"kid": {"description": "Key identifier, in W3C did:key or DID URL format", "example": "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4", "pattern": "^did:(?:key:z[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+|sov:[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}(;.*)?(\\?.*)?#.+)$", "type": "string"}}, "required": ["kid"], "type": "object"}, "AttachmentDef": {"properties": {"id": {"description": "Attachment identifier", "example": "attachment-0", "type": "string"}, "type": {"description": "Attachment type", "enum": ["credential-offer", "present-proof"], "example": "present-proof", "type": "string"}}, "type": "object"}, "AttributeMimeTypesResult": {"properties": {"results": {"additionalProperties": {"description": "MIME type", "type": "string"}, "type": "object", "x-nullable": true}}, "type": "object"}, "BasicMessageModuleResponse": {"properties": {}, "type": "object"}, "ClaimFormat": {"properties": {"di_vc": {"type": "object"}, "jwt": {"type": "object"}, "jwt_vc": {"type": "object"}, "jwt_vp": {"type": "object"}, "ldp": {"type": "object"}, "ldp_vc": {"type": "object"}, "ldp_vp": {"type": "object"}}, "type": "object"}, "ClearPendingRevocationsRequest": {"properties": {"purge": {"additionalProperties": {"items": {"description": "Credential revocation identifier", "example": "12345", "pattern": "^[1-9][0-9]*$", "type": "string"}, "type": "array"}, "description": "Credential revocation ids by revocation registry id: omit for all, specify null or empty list for all pending per revocation registry", "type": "object"}}, "type": "object"}, "ConfigurableWriteLedgers": {"properties": {"write_ledgers": {"description": "List of configurable write ledgers identifiers", "items": {"description": "Ledgers identifiers", "type": "string"}, "type": "array"}}, "type": "object"}, "ConnRecord": {"properties": {"accept": {"description": "Connection acceptance: manual or auto", "enum": ["manual", "auto"], "example": "auto", "type": "string"}, "alias": {"description": "Optional alias to apply to connection for later use", "example": "Bob, providing quotes", "type": "string"}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "connection_protocol": {"description": "Connection protocol used", "enum": ["connections/1.0", "didexchange/1.0", "didexchange/1.1"], "example": "connections/1.0", "type": "string"}, "created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "error_msg": {"description": "Error message", "example": "No DIDDoc provided; cannot connect to public DID", "type": "string"}, "inbound_connection_id": {"description": "Inbound routing connection id to use", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "invitation_key": {"description": "Public key for connection", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "invitation_mode": {"description": "Invitation mode", "enum": ["once", "multi", "static"], "example": "once", "type": "string"}, "invitation_msg_id": {"description": "ID of out-of-band invitation message", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "my_did": {"description": "Our DID for connection", "example": "did:peer:WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "type": "string"}, "request_id": {"description": "Connection request identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "rfc23_state": {"description": "State per RFC 23", "example": "invitation-sent", "readOnly": true, "type": "string"}, "state": {"description": "Current record state", "example": "active", "type": "string"}, "their_did": {"description": "Their DID for connection", "example": "did:peer:WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "type": "string"}, "their_label": {"description": "Their label for connection", "example": "Bob", "type": "string"}, "their_public_did": {"description": "Other agent's public DID for connection", "example": "2cpBmR3FqGKWi5EyUbpRY8", "type": "string"}, "their_role": {"description": "Their role in the connection protocol", "enum": ["invitee", "requester", "inviter", "responder"], "example": "requester", "type": "string"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "required": ["connection_id"], "type": "object"}, "ConnectionInvitation": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "type": "string"}, "did": {"description": "DID for connection invitation", "example": "did:peer:WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "type": "string"}, "imageUrl": {"description": "Optional image URL for connection invitation", "example": "http://192.168.56.101/img/logo.jpg", "format": "url", "type": "string", "x-nullable": true}, "label": {"description": "Optional label for connection invitation", "example": "Bob", "type": "string"}, "recipientKeys": {"description": "List of recipient keys", "items": {"description": "Recipient public key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "type": "array"}, "routingKeys": {"description": "List of routing keys", "items": {"description": "Routing key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "type": "array"}, "serviceEndpoint": {"description": "Service endpoint at which to reach this agent", "example": "http://192.168.56.101:8020", "type": "string"}}, "type": "object"}, "ConnectionList": {"properties": {"results": {"description": "List of connection records", "items": {"$ref": "#/definitions/ConnRecord"}, "type": "array"}}, "required": ["results"], "type": "object"}, "ConnectionMetadata": {"properties": {"results": {"description": "Dictionary of metadata associated with connection.", "type": "object"}}, "type": "object"}, "ConnectionMetadataSetRequest": {"properties": {"metadata": {"description": "Dictionary of metadata to set for connection.", "type": "object"}}, "required": ["metadata"], "type": "object"}, "ConnectionModuleResponse": {"properties": {}, "type": "object"}, "ConnectionStaticRequest": {"properties": {"alias": {"description": "Alias to assign to this connection", "type": "string"}, "my_did": {"description": "Local DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "my_seed": {"description": "Seed to use for the local DID", "type": "string"}, "their_did": {"description": "Remote DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "their_endpoint": {"description": "URL endpoint for other party", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "their_label": {"description": "Other party's label for this connection", "type": "string"}, "their_seed": {"description": "Seed to use for the remote DID", "type": "string"}, "their_verkey": {"description": "Remote verification key", "type": "string"}}, "type": "object"}, "ConnectionStaticResult": {"properties": {"my_did": {"description": "Local DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "my_endpoint": {"description": "My URL endpoint", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "my_verkey": {"description": "My verification key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "record": {"$ref": "#/definitions/ConnRecord"}, "their_did": {"description": "Remote DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "their_verkey": {"description": "Remote verification key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}}, "required": ["my_did", "my_endpoint", "my_verkey", "record", "their_did", "their_verkey"], "type": "object"}, "Constraints": {"properties": {"fields": {"items": {"$ref": "#/definitions/DIFField"}, "type": "array"}, "is_holder": {"items": {"$ref": "#/definitions/DIFHolder"}, "type": "array"}, "limit_disclosure": {"description": "LimitDisclosure", "type": "string"}, "status_active": {"enum": ["required", "allowed", "disallowed"], "type": "string"}, "status_revoked": {"enum": ["required", "allowed", "disallowed"], "type": "string"}, "status_suspended": {"enum": ["required", "allowed", "disallowed"], "type": "string"}, "subject_is_issuer": {"description": "SubjectIsIssuer", "enum": ["required", "preferred"], "type": "string"}}, "type": "object"}, "CreateInvitationRequest": {"properties": {"mediation_id": {"description": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "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}", "type": "string"}, "metadata": {"description": "Optional metadata to attach to the connection created with the invitation", "type": "object"}, "my_label": {"description": "Optional label for connection invitation", "example": "Bob", "type": "string"}, "recipient_keys": {"description": "List of recipient keys", "items": {"description": "Recipient public key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "type": "array"}, "routing_keys": {"description": "List of routing keys", "items": {"description": "Routing key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "type": "array"}, "service_endpoint": {"description": "Connection endpoint", "example": "http://192.168.56.102:8020", "type": "string"}}, "type": "object"}, "CreateKeyRequest": {"properties": {"alg": {"description": "Which key algorithm to use.", "example": "ed25519", "type": "string"}, "kid": {"description": "Optional kid to bind to the keypair, such as a verificationMethod.", "example": "did:web:example.com#key-01", "type": "string"}, "seed": {"description": "Optional seed to generate the key pair. Must enable insecure wallet mode.", "example": "00000000000000000000000000000000", "type": "string"}}, "type": "object"}, "CreateKeyResponse": {"properties": {"kid": {"description": "The associated kid", "example": "did:web:example.com#key-01", "type": "string"}, "multikey": {"description": "The Public Key Multibase format (multikey)", "example": "z6MkgKA7yrw5kYSiDuQFcye4bMaJpcfHFry3Bx45pdWh3s8i", "type": "string"}}, "type": "object"}, "CreateWalletRequest": {"properties": {"extra_settings": {"description": "Agent config key-value pairs", "type": "object"}, "image_url": {"description": "Image url for this wallet. This image url is publicized (self-attested) to other agents as part of forming a connection.", "example": "https://aries.ca/images/sample.png", "type": "string"}, "key_management_mode": {"description": "Key management method to use for this wallet.", "enum": ["managed"], "example": "managed", "type": "string"}, "label": {"description": "Label for this wallet. This label is publicized (self-attested) to other agents as part of forming a connection.", "example": "Alice", "type": "string"}, "wallet_dispatch_type": {"description": "Webhook target dispatch type for this wallet. default: Dispatch only to webhooks associated with this wallet. base: Dispatch only to webhooks associated with the base wallet. both: Dispatch to both webhook targets.", "enum": ["default", "both", "base"], "example": "default", "type": "string"}, "wallet_key": {"description": "Master key used for key derivation.", "example": "MySecretKey123", "type": "string"}, "wallet_key_derivation": {"description": "Key derivation", "enum": ["ARGON2I_MOD", "ARGON2I_INT", "RAW"], "example": "RAW", "type": "string"}, "wallet_name": {"description": "Wallet name", "example": "MyNewWallet", "type": "string"}, "wallet_type": {"description": "Type of the wallet to create. Must be same as base wallet.", "enum": ["askar", "askar-anoncreds", "in_memory"], "example": "askar", "type": "string"}, "wallet_webhook_urls": {"description": "List of Webhook URLs associated with this subwallet", "items": {"description": "Optional webhook URL to receive webhook messages", "example": "http://localhost:8022/webhooks", "type": "string"}, "type": "array"}}, "type": "object"}, "CreateWalletResponse": {"properties": {"created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "key_management_mode": {"description": "Mode regarding management of wallet key", "enum": ["managed", "unmanaged"], "type": "string"}, "settings": {"description": "Settings for this wallet.", "type": "object"}, "state": {"description": "Current record state", "example": "active", "type": "string"}, "token": {"description": "Authorization token to authenticate wallet requests", "example": "eyJhbGciOiJFZERTQSJ9.eyJhIjogIjAifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk", "type": "string"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "wallet_id": {"description": "Wallet record ID", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}}, "required": ["key_management_mode", "wallet_id"], "type": "object"}, "CreateWalletTokenRequest": {"properties": {"wallet_key": {"description": "Master key used for key derivation. Only required for unmanaged wallets.", "example": "MySecretKey123", "type": "string"}}, "type": "object"}, "CreateWalletTokenResponse": {"properties": {"token": {"description": "Authorization token to authenticate wallet requests", "example": "eyJhbGciOiJFZERTQSJ9.eyJhIjogIjAifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk", "type": "string"}}, "type": "object"}, "CredAttrSpec": {"properties": {"mime-type": {"description": "MIME type: omit for (null) default", "example": "image/jpeg", "type": "string", "x-nullable": true}, "name": {"description": "Attribute name", "example": "favourite_drink", "type": "string"}, "value": {"description": "Attribute value: base64-encode if MIME type is present", "example": "martini", "type": "string"}}, "required": ["name", "value"], "type": "object"}, "CredDef": {"properties": {"issuerId": {"description": "Issuer Identifier of the credential definition or schema", "example": "WgWxqztrNooG92RXvxSTWv", "type": "string"}, "schemaId": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "type": "string"}, "tag": {"description": "The tag value passed in by the Issuer to an AnonCred's Credential Definition create and store implementation.", "example": "default", "type": "string"}, "type": {"enum": ["CL"], "type": "string"}, "value": {"$ref": "#/definitions/CredDefValueSchemaAnoncreds"}}, "type": "object"}, "CredDefPostOptions": {"properties": {"create_transaction_for_endorser": {"description": "Create transaction for endorser (optional, default false). Use this for agents who don't specify an author role but want to create a transaction for an endorser to sign.", "example": false, "type": "boolean"}, "endorser_connection_id": {"description": "Connection identifier (optional) (this is an example). You can set this if you know the endorser's connection id you want to use. If not specified then the agent will attempt to find an endorser connection.", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "revocation_registry_size": {"description": "Maximum number of credential revocations per registry", "example": 1000, "type": "integer"}, "support_revocation": {"description": "Support credential revocation", "type": "boolean"}}, "type": "object"}, "CredDefPostRequest": {"properties": {"credential_definition": {"$ref": "#/definitions/InnerCredDef"}, "options": {"$ref": "#/definitions/CredDefPostOptions"}}, "type": "object"}, "CredDefResult": {"properties": {"credential_definition_metadata": {"type": "object"}, "credential_definition_state": {"$ref": "#/definitions/CredDefState"}, "job_id": {"type": "string"}, "registration_metadata": {"type": "object"}}, "type": "object"}, "CredDefState": {"properties": {"credential_definition": {"allOf": [{"$ref": "#/definitions/CredDef"}], "description": "credential definition"}, "credential_definition_id": {"description": "credential definition id", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "type": "string", "x-nullable": true}, "state": {"enum": ["finished", "failed", "action", "wait"], "type": "string"}}, "type": "object"}, "CredDefValue": {"properties": {"primary": {"allOf": [{"$ref": "#/definitions/CredDefValuePrimary"}], "description": "Primary value for credential definition"}, "revocation": {"allOf": [{"$ref": "#/definitions/CredDefValueRevocation"}], "description": "Revocation value for credential definition"}}, "type": "object"}, "CredDefValuePrimary": {"properties": {"n": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "r": {"$ref": "#/definitions/Generated"}, "rctxt": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "s": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "z": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}}, "type": "object"}, "CredDefValuePrimarySchemaAnoncreds": {"properties": {"n": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "r": {"type": "object"}, "rctxt": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "s": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "z": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}}, "type": "object"}, "CredDefValueRevocation": {"properties": {"g": {"example": "1 1F14F&ECB578F 2 095E45DDF417D", "type": "string"}, "g_dash": {"example": "1 1D64716fCDC00C 1 0C781960FA66E3D3 2 095E45DDF417D", "type": "string"}, "h": {"example": "1 16675DAE54BFAE8 2 095E45DD417D", "type": "string"}, "h0": {"example": "1 21E5EF9476EAF18 2 095E45DDF417D", "type": "string"}, "h1": {"example": "1 236D1D99236090 2 095E45DDF417D", "type": "string"}, "h2": {"example": "1 1C3AE8D1F1E277 2 095E45DDF417D", "type": "string"}, "h_cap": {"example": "1 1B2A32CF3167 1 2490FEBF6EE55 1 0000000000000000", "type": "string"}, "htilde": {"example": "1 1D8549E8C0F8 2 095E45DDF417D", "type": "string"}, "pk": {"example": "1 142CD5E5A7DC 1 153885BD903312 2 095E45DDF417D", "type": "string"}, "u": {"example": "1 0C430AAB2B4710 1 1CB3A0932EE7E 1 0000000000000000", "type": "string"}, "y": {"example": "1 153558BD903312 2 095E45DDF417D 1 0000000000000000", "type": "string"}}, "type": "object"}, "CredDefValueRevocationSchemaAnoncreds": {"properties": {"g": {"example": "1 1F14F&ECB578F 2 095E45DDF417D", "type": "string"}, "g_dash": {"example": "1 1D64716fCDC00C 1 0C781960FA66E3D3 2 095E45DDF417D", "type": "string"}, "h": {"example": "1 16675DAE54BFAE8 2 095E45DD417D", "type": "string"}, "h0": {"example": "1 21E5EF9476EAF18 2 095E45DDF417D", "type": "string"}, "h1": {"example": "1 236D1D99236090 2 095E45DDF417D", "type": "string"}, "h2": {"example": "1 1C3AE8D1F1E277 2 095E45DDF417D", "type": "string"}, "h_cap": {"example": "1 1B2A32CF3167 1 2490FEBF6EE55 1 0000000000000000", "type": "string"}, "htilde": {"example": "1 1D8549E8C0F8 2 095E45DDF417D", "type": "string"}, "pk": {"example": "1 142CD5E5A7DC 1 153885BD903312 2 095E45DDF417D", "type": "string"}, "u": {"example": "1 0C430AAB2B4710 1 1CB3A0932EE7E 1 0000000000000000", "type": "string"}, "y": {"example": "1 153558BD903312 2 095E45DDF417D 1 0000000000000000", "type": "string"}}, "type": "object"}, "CredDefValueSchemaAnoncreds": {"properties": {"primary": {"allOf": [{"$ref": "#/definitions/CredDefValuePrimarySchemaAnoncreds"}], "description": "Primary value for credential definition"}, "revocation": {"allOf": [{"$ref": "#/definitions/CredDefValueRevocationSchemaAnoncreds"}], "description": "Revocation value for credential definition"}}, "type": "object"}, "CredInfoList": {"properties": {"results": {"items": {"$ref": "#/definitions/IndyCredInfo"}, "type": "array"}}, "type": "object"}, "CredRevIndyRecordsResult": {"properties": {"rev_reg_delta": {"description": "Indy revocation registry delta", "type": "object"}}, "type": "object"}, "CredRevIndyRecordsResultSchemaAnoncreds": {"properties": {"rev_reg_delta": {"description": "Indy revocation registry delta", "type": "object"}}, "type": "object"}, "CredRevRecordDetailsResult": {"properties": {"results": {"items": {"$ref": "#/definitions/IssuerCredRevRecord"}, "type": "array"}}, "type": "object"}, "CredRevRecordDetailsResultSchemaAnoncreds": {"properties": {"results": {"items": {"$ref": "#/definitions/IssuerCredRevRecordSchemaAnoncreds"}, "type": "array"}}, "type": "object"}, "CredRevRecordResult": {"properties": {"result": {"$ref": "#/definitions/IssuerCredRevRecord"}}, "type": "object"}, "CredRevRecordResultSchemaAnoncreds": {"properties": {"result": {"$ref": "#/definitions/IssuerCredRevRecordSchemaAnoncreds"}}, "type": "object"}, "CredRevokedResult": {"properties": {"revoked": {"description": "Whether credential is revoked on the ledger", "type": "boolean"}}, "type": "object"}, "Credential": {"additionalProperties": true, "properties": {"@context": {"description": "The JSON-LD context of the credential", "example": ["https://www.w3.org/2018/credentials/v1", "https://www.w3.org/2018/credentials/examples/v1"], "items": {}, "type": "array"}, "credentialStatus": {"example": {"id": "https://example.com/credentials/status/3#94567", "statusListCredential": "https://example.com/credentials/status/3", "statusListIndex": "94567", "statusPurpose": "revocation", "type": "BitstringStatusListEntry"}}, "credentialSubject": {"example": {"alumniOf": {"id": "did:example:c276e12ec21ebfeb1f712ebc6f1"}, "id": "did:example:ebfeb1f712ebc6f1c276e12ec21"}}, "expirationDate": {"description": "The expiration date", "example": "2010-01-01T19:23:24Z", "pattern": "^([0-9]{4})-([0-9]{2})-([0-9]{2})([Tt ]([0-9]{2}):([0-9]{2}):([0-9]{2})(\\.[0-9]+)?)?(([Zz]|([+-])([0-9]{2}):([0-9]{2})))?$", "type": "string"}, "id": {"description": "The ID of the credential", "example": "http://example.edu/credentials/1872", "pattern": "\\w+:(\\/?\\/?)[^\\s]+", "type": "string"}, "issuanceDate": {"description": "The issuance date", "example": "2010-01-01T19:23:24Z", "pattern": "^([0-9]{4})-([0-9]{2})-([0-9]{2})([Tt ]([0-9]{2}):([0-9]{2}):([0-9]{2})(\\.[0-9]+)?)?(([Zz]|([+-])([0-9]{2}):([0-9]{2})))?$", "type": "string"}, "issuer": {"description": "The JSON-LD Verifiable Credential Issuer. Either string of object with id field.", "example": "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH"}, "proof": {"allOf": [{"$ref": "#/definitions/LinkedDataProof"}], "description": "The proof of the credential", "example": {"created": "2019-12-11T03:50:55", "jws": "eyJhbGciOiAiRWREU0EiLCAiYjY0IjogZmFsc2UsICJjcml0JiNjQiXX0..lKJU0Df_keblRKhZAS9Qq6zybm-HqUXNVZ8vgEPNTAjQKBhQDxvXNo7nvtUBb_Eq1Ch6YBKY5qBQ", "proofPurpose": "assertionMethod", "type": "Ed25519Signature2018", "verificationMethod": "did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL"}}, "type": {"description": "The JSON-LD type of the credential", "example": ["VerifiableCredential", "AlumniCredential"], "items": {"type": "string"}, "type": "array"}}, "required": ["@context", "credentialSubject", "issuanceDate", "issuer", "type"], "type": "object"}, "CredentialDefinition": {"properties": {"id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "schemaId": {"description": "Schema identifier within credential definition identifier", "example": "20", "type": "string"}, "tag": {"description": "Tag within credential definition identifier", "example": "tag", "type": "string"}, "type": {"default": "CL", "description": "Signature type: CL for Camenisch-Lysyanskaya", "example": "CL"}, "value": {"allOf": [{"$ref": "#/definitions/CredDefValue"}], "description": "Credential definition primary and revocation values"}, "ver": {"description": "Node protocol version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "type": "object"}, "CredentialDefinitionGetResult": {"properties": {"credential_definition": {"$ref": "#/definitions/CredentialDefinition"}}, "type": "object"}, "CredentialDefinitionSendRequest": {"properties": {"revocation_registry_size": {"description": "Revocation registry size", "example": 1000, "maximum": 32768, "minimum": 4, "type": "integer"}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "support_revocation": {"description": "Revocation supported flag", "type": "boolean"}, "tag": {"description": "Credential definition identifier tag", "example": "default", "type": "string"}}, "type": "object"}, "CredentialDefinitionSendResult": {"properties": {"credential_definition_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}}, "required": ["credential_definition_id"], "type": "object"}, "CredentialDefinitionsCreatedResult": {"properties": {"credential_definition_ids": {"items": {"description": "Credential definition identifiers", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "type": "array"}}, "type": "object"}, "CredentialOffer": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "credential_preview": {"$ref": "#/definitions/CredentialPreview"}, "offers~attach": {"items": {"$ref": "#/definitions/AttachDecorator"}, "type": "array"}}, "required": ["offers~attach"], "type": "object"}, "CredentialPreview": {"properties": {"@type": {"description": "Message type identifier", "example": "issue-credential/1.0/credential-preview", "type": "string"}, "attributes": {"items": {"$ref": "#/definitions/CredAttrSpec"}, "type": "array"}}, "required": ["attributes"], "type": "object"}, "CredentialProposal": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "cred_def_id": {"example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "credential_proposal": {"$ref": "#/definitions/CredentialPreview"}, "issuer_did": {"example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "schema_id": {"example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "schema_issuer_did": {"example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "schema_name": {"type": "string"}, "schema_version": {"example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "type": "object"}, "CredentialStatusOptions": {"additionalProperties": true, "properties": {"type": {"description": "Credential status method type to use for the credential. Should match status method registered in the Verifiable Credential Extension Registry", "example": "CredentialStatusList2017", "type": "string"}}, "required": ["type"], "type": "object"}, "DID": {"properties": {"did": {"description": "DID of interest", "example": "did:peer:WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "type": "string"}, "key_type": {"description": "Key type associated with the DID", "enum": ["ed25519", "bls12381g2"], "example": "ed25519", "type": "string"}, "metadata": {"description": "Additional metadata associated with the DID", "type": "object"}, "method": {"description": "Did method associated with the DID", "example": "sov", "type": "string"}, "posture": {"description": "Whether DID is current public DID, posted to ledger but not current public DID, or local to the wallet", "enum": ["public", "posted", "wallet_only"], "example": "wallet_only", "type": "string"}, "verkey": {"description": "Public verification key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}}, "required": ["did", "key_type", "method", "posture", "verkey"], "type": "object"}, "DIDCreate": {"properties": {"method": {"description": "Method for the requested DID.Supported methods are 'key', 'sov', and any other registered method.", "example": "sov", "type": "string"}, "options": {"allOf": [{"$ref": "#/definitions/DIDCreateOptions"}], "description": "To define a key type and/or a did depending on chosen DID method."}, "seed": {"description": "Optional seed to use for DID, Must be enabled in configuration before use.", "example": "000000000000000000000000Trustee1", "type": "string"}}, "type": "object"}, "DIDCreateOptions": {"properties": {"did": {"description": "Specify final value of the did (including did:: prefix)if the method supports or requires so.", "example": "did:peer:WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "type": "string"}, "key_type": {"description": "Key type to use for the DID keypair. Validated with the chosen DID method's supported key types.", "enum": ["ed25519", "bls12381g2"], "example": "ed25519", "type": "string"}}, "required": ["key_type"], "type": "object"}, "DIDEndpoint": {"properties": {"did": {"description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "endpoint": {"description": "Endpoint to set (omit to delete)", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}}, "required": ["did"], "type": "object"}, "DIDEndpointWithType": {"properties": {"did": {"description": "DID of interest", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "endpoint": {"description": "Endpoint to set (omit to delete)", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "endpoint_type": {"description": "Endpoint type to set (default 'Endpoint'); affects only public or posted DIDs", "enum": ["Endpoint", "Profile", "LinkedDomains"], "example": "Endpoint", "type": "string"}, "mediation_id": {"description": "Mediation ID to use for endpoint information.", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "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}", "type": "string"}}, "required": ["did"], "type": "object"}, "DIDList": {"properties": {"results": {"description": "DID list", "items": {"$ref": "#/definitions/DID"}, "type": "array"}}, "type": "object"}, "DIDResult": {"properties": {"result": {"$ref": "#/definitions/DID"}}, "type": "object"}, "DIDRotateRequestJSON": {"properties": {"to_did": {"description": "The DID the rotating party is rotating to", "example": "did:web:example.com", "type": "string"}}, "required": ["to_did"], "type": "object"}, "DIDXRejectRequest": {"properties": {"reason": {"description": "Reason for rejecting the DID Exchange", "example": "Request rejected", "type": "string"}}, "type": "object"}, "DIDXRequest": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "type": "string"}, "did": {"description": "DID of exchange", "example": "did:peer:WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "type": "string"}, "did_doc~attach": {"allOf": [{"$ref": "#/definitions/AttachDecorator"}], "description": "As signed attachment, DID Doc associated with DID"}, "goal": {"description": "A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message", "example": "To issue a Faber College Graduate credential", "type": "string"}, "goal_code": {"description": "A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message", "example": "issue-vc", "type": "string"}, "label": {"description": "Label for DID exchange request", "example": "Request to connect with Bob", "type": "string"}}, "required": ["label"], "type": "object"}, "DIFField": {"properties": {"filter": {"$ref": "#/definitions/Filter"}, "id": {"description": "ID", "type": "string"}, "path": {"items": {"description": "Path", "type": "string"}, "type": "array"}, "predicate": {"description": "Preference", "enum": ["required", "preferred"], "type": "string"}, "purpose": {"description": "Purpose", "type": "string"}}, "type": "object"}, "DIFHolder": {"properties": {"directive": {"description": "Preference", "enum": ["required", "preferred"], "type": "string"}, "field_id": {"items": {"description": "FieldID", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "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}", "type": "string"}, "type": "array"}}, "type": "object"}, "DIFOptions": {"properties": {"challenge": {"description": "Challenge protect against replay attack", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "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}", "type": "string"}, "domain": {"description": "Domain protect against replay attack", "example": "4jt78h47fh47", "type": "string"}}, "type": "object"}, "DIFPresSpec": {"properties": {"issuer_id": {"description": "Issuer identifier to sign the presentation, if different from current public DID", "type": "string"}, "presentation_definition": {"$ref": "#/definitions/PresentationDefinition"}, "record_ids": {"description": "Mapping of input_descriptor id to list of stored W3C credential record_id", "example": {"": ["", ""], "": [""]}, "type": "object"}, "reveal_doc": {"description": "reveal doc [JSON-LD frame] dict used to derive the credential when selective disclosure is required", "example": {"@context": ["https://www.w3.org/2018/credentials/v1", "https://w3id.org/security/bbs/v1"], "@explicit": true, "@requireAll": true, "credentialSubject": {"@explicit": true, "@requireAll": true, "Observation": [{"effectiveDateTime": {}, "@explicit": true, "@requireAll": true}]}, "issuanceDate": {}, "issuer": {}, "type": ["VerifiableCredential", "LabReport"]}, "type": "object"}}, "type": "object"}, "DIFProofProposal": {"properties": {"input_descriptors": {"items": {"$ref": "#/definitions/InputDescriptors"}, "type": "array"}, "options": {"$ref": "#/definitions/DIFOptions"}}, "type": "object"}, "DIFProofRequest": {"additionalProperties": true, "properties": {"options": {"$ref": "#/definitions/DIFOptions"}, "presentation_definition": {"$ref": "#/definitions/PresentationDefinition"}}, "required": ["presentation_definition"], "type": "object"}, "DataIntegrityProofOptions": {"additionalProperties": true, "properties": {"challenge": {"description": "The value is used once for a particular domain and window of time. This value is used to mitigate replay attacks.", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "created": {"description": "The date and time the proof was created is OPTIONAL and, if included, MUST be specified as an [XMLSCHEMA11-2] dateTimeStamp string", "example": "2010-01-01T19:23:24Z", "type": "string"}, "cryptosuite": {"description": "An identifier for the cryptographic suite that can be used to verify the proof.", "example": "eddsa-jcs-2022", "type": "string"}, "domain": {"description": "It conveys one or more security domains in which the proof is meant to be used.", "example": "example.com", "type": "string"}, "expires": {"description": "The expires property is OPTIONAL and, if present, specifies when the proof expires. If present, it MUST be an [XMLSCHEMA11-2] dateTimeStamp string", "example": "2010-01-01T19:23:24Z", "type": "string"}, "id": {"description": "An optional identifier for the proof, which MUST be a URL [URL], such as a UUID as a URN", "example": "urn:uuid:6a1676b8-b51f-11ed-937b-d76685a20ff5", "type": "string"}, "nonce": {"description": "One use of this field is to increase privacy by decreasing linkability that is the result of deterministically generated signatures.", "example": "CF69iO3nfvqRsRBNElE8b4wO39SyJHPM7Gg1nExltW5vSfQA1lvDCR/zXX1To0/4NLo==", "type": "string"}, "previousProof": {"description": "Each value identifies another data integrity proof that MUST verify before the current proof is processed.", "example": "urn:uuid:6a1676b8-b51f-11ed-937b-d76685a20ff5", "type": "string"}, "proofPurpose": {"description": "The proof purpose acts as a safeguard to prevent the proof from being misused by being applied to a purpose other than the one that was intended.", "example": "assertionMethod", "type": "string"}, "proofValue": {"description": "The value of the proof signature.", "example": "zsy1AahqbzJQ63n9RtekmwzqZeVj494VppdAVJBnMYrTwft6cLJJGeTSSxCCJ6HKnRtwE7jjDh6sB2z2AAiZY9BBnCD8wUVgwqH3qchGRCuC2RugA4eQ9fUrR4Yuycac3caiaaay", "type": "string"}, "type": {"description": "The specific type of proof MUST be specified as a string that maps to a URL [URL].", "example": "DataIntegrityProof", "type": "string"}, "verificationMethod": {"description": "A verification method is the means and information needed to verify the proof. ", "example": "did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL", "pattern": "\\w+:(\\/?\\/?)[^\\s]+", "type": "string"}}, "required": ["cryptosuite", "proofPurpose", "type", "verificationMethod"], "type": "object"}, "Date": {"properties": {"expires_time": {"description": "Expiry Date", "example": "2021-03-29T05:22:19Z", "format": "date-time", "type": "string"}}, "required": ["expires_time"], "type": "object"}, "Disclose": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "type": "string"}, "protocols": {"description": "List of protocol descriptors", "items": {"$ref": "#/definitions/ProtocolDescriptor"}, "type": "array"}}, "required": ["protocols"], "type": "object"}, "Disclosures": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "type": "string"}, "disclosures": {"description": "List of protocol or goal_code descriptors", "items": {}, "type": "array"}}, "required": ["disclosures"], "type": "object"}, "Doc": {"properties": {"credential": {"description": "Credential to sign", "type": "object"}, "options": {"allOf": [{"$ref": "#/definitions/SignatureOptions"}], "description": "Signature options"}}, "required": ["credential", "options"], "type": "object"}, "DocumentVerificationResult": {"properties": {"document": {"type": "object"}, "errors": {"items": {"type": "string"}, "type": "array"}, "results": {"items": {"$ref": "#/definitions/ProofResult"}, "type": "array"}, "verified": {"type": "boolean"}}, "required": ["verified"], "type": "object"}, "EndorserInfo": {"properties": {"endorser_did": {"description": "Endorser DID", "type": "string"}, "endorser_name": {"description": "Endorser Name", "type": "string"}}, "required": ["endorser_did"], "type": "object"}, "EndpointsResult": {"properties": {"my_endpoint": {"description": "My endpoint", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "their_endpoint": {"description": "Their endpoint", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}}, "type": "object"}, "FetchCredentialResponse": {"properties": {"results": {"$ref": "#/definitions/VerifiableCredential"}}, "type": "object"}, "FetchKeyResponse": {"properties": {"kid": {"description": "The associated kid", "example": "did:web:example.com#key-01", "type": "string"}, "multikey": {"description": "The Public Key Multibase format (multikey)", "example": "z6MkgKA7yrw5kYSiDuQFcye4bMaJpcfHFry3Bx45pdWh3s8i", "type": "string"}}, "type": "object"}, "Filter": {"properties": {"const": {"description": "Const"}, "enum": {"items": {"description": "Enum"}, "type": "array"}, "exclusiveMaximum": {"description": "ExclusiveMaximum"}, "exclusiveMinimum": {"description": "ExclusiveMinimum"}, "format": {"description": "Format", "type": "string"}, "maxLength": {"description": "Max Length", "example": 1234, "type": "integer"}, "maximum": {"description": "Maximum"}, "minLength": {"description": "Min Length", "example": 1234, "type": "integer"}, "minimum": {"description": "Minimum"}, "not": {"description": "Not", "example": false, "type": "boolean"}, "pattern": {"description": "Pattern", "type": "string"}, "type": {"description": "Type", "type": "string"}}, "type": "object"}, "Generated": {"properties": {"master_secret": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "number": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "remainder": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}}, "type": "object"}, "GetCredDefResult": {"properties": {"credential_definition": {"allOf": [{"$ref": "#/definitions/CredDef"}], "description": "credential definition"}, "credential_definition_id": {"description": "credential definition id", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "type": "string"}, "credential_definitions_metadata": {"type": "object"}, "resolution_metadata": {"type": "object"}}, "type": "object"}, "GetCredDefsResponse": {"properties": {"credential_definition_ids": {"items": {"description": "credential definition identifiers", "example": "GvLGiRogTJubmj5B36qhYz:3:CL:8:faber.agent.degree_schema", "type": "string"}, "type": "array"}}, "type": "object"}, "GetDIDEndpointResponse": {"properties": {"endpoint": {"description": "Full verification key", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string", "x-nullable": true}}, "type": "object"}, "GetDIDVerkeyResponse": {"properties": {"verkey": {"description": "Full verification key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string", "x-nullable": true}}, "type": "object"}, "GetNymRoleResponse": {"properties": {"role": {"description": "Ledger role", "enum": ["STEWARD", "TRUSTEE", "ENDORSER", "NETWORK_MONITOR", "USER", "ROLE_REMOVE"], "example": "ENDORSER", "type": "string"}}, "type": "object"}, "GetSchemaResult": {"properties": {"resolution_metadata": {"type": "object"}, "schema": {"$ref": "#/definitions/AnonCredsSchema"}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "type": "string"}, "schema_metadata": {"type": "object"}}, "type": "object"}, "GetSchemasResponse": {"properties": {"schema_ids": {"items": {"description": "Schema identifiers", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "type": "string"}, "type": "array"}}, "type": "object"}, "Hangup": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "type": "string"}}, "type": "object"}, "HolderModuleResponse": {"properties": {}, "type": "object"}, "IndyAttrValue": {"properties": {"encoded": {"description": "Attribute encoded value", "example": "-1", "pattern": "^-?[0-9]*$", "type": "string"}, "raw": {"description": "Attribute raw value", "type": "string"}}, "required": ["encoded", "raw"], "type": "object"}, "IndyCredAbstract": {"properties": {"cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "key_correctness_proof": {"allOf": [{"$ref": "#/definitions/IndyKeyCorrectnessProof"}], "description": "Key correctness proof"}, "nonce": {"description": "Nonce in credential abstract", "example": "0", "pattern": "^[0-9]*$", "type": "string"}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}}, "required": ["cred_def_id", "key_correctness_proof", "nonce", "schema_id"], "type": "object"}, "IndyCredInfo": {"properties": {"attrs": {"additionalProperties": {"example": "alice", "type": "string"}, "description": "Attribute names and value", "type": "object"}, "cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "cred_rev_id": {"description": "Credential revocation identifier", "example": "12345", "pattern": "^[1-9][0-9]*$", "type": "string", "x-nullable": true}, "referent": {"description": "Wallet referent", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "rev_reg_id": {"description": "Revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string", "x-nullable": true}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}}, "type": "object"}, "IndyCredPrecis": {"properties": {"cred_info": {"allOf": [{"$ref": "#/definitions/IndyCredInfo"}], "description": "Credential info"}, "interval": {"allOf": [{"$ref": "#/definitions/IndyNonRevocationInterval"}], "description": "Non-revocation interval from presentation request"}, "presentation_referents": {"items": {"description": "presentation referent", "example": "1_age_uuid", "type": "string"}, "type": "array"}}, "required": ["cred_info"], "type": "object"}, "IndyCredRequest": {"properties": {"blinded_ms": {"description": "Blinded master secret", "type": "object"}, "blinded_ms_correctness_proof": {"description": "Blinded master secret correctness proof", "type": "object"}, "cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "nonce": {"description": "Nonce in credential request", "example": "0", "pattern": "^[0-9]*$", "type": "string"}, "prover_did": {"description": "Prover DID/Random String/UUID", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}}, "required": ["blinded_ms", "blinded_ms_correctness_proof", "cred_def_id", "nonce", "prover_did"], "type": "object"}, "IndyCredential": {"properties": {"cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "rev_reg": {"description": "Revocation registry state", "type": "object", "x-nullable": true}, "rev_reg_id": {"description": "Revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string", "x-nullable": true}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "signature": {"description": "Credential signature", "type": "object"}, "signature_correctness_proof": {"description": "Credential signature correctness proof", "type": "object"}, "values": {"additionalProperties": {"$ref": "#/definitions/IndyAttrValue"}, "description": "Credential attributes", "type": "object"}, "witness": {"description": "Witness for revocation proof", "type": "object", "x-nullable": true}}, "required": ["cred_def_id", "schema_id", "signature", "signature_correctness_proof", "values"], "type": "object"}, "IndyEQProof": {"properties": {"a_prime": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "e": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "m": {"additionalProperties": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "type": "object"}, "m2": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "revealed_attrs": {"additionalProperties": {"example": "-1", "pattern": "^-?[0-9]*$", "type": "string"}, "type": "object"}, "v": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}}, "type": "object"}, "IndyGEProof": {"properties": {"alpha": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "mj": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "predicate": {"$ref": "#/definitions/IndyGEProofPred"}, "r": {"additionalProperties": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "type": "object"}, "t": {"additionalProperties": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "type": "object"}, "u": {"additionalProperties": {"example": "0", "pattern": "^[0-9]*$", "type": "string"}, "type": "object"}}, "type": "object"}, "IndyGEProofPred": {"properties": {"attr_name": {"description": "Attribute name, indy-canonicalized", "type": "string"}, "p_type": {"description": "Predicate type", "enum": ["LT", "LE", "GE", "GT"], "type": "string"}, "value": {"description": "Predicate threshold value", "type": "integer"}}, "type": "object"}, "IndyKeyCorrectnessProof": {"properties": {"c": {"description": "c in key correctness proof", "example": "0", "pattern": "^[0-9]*$", "type": "string"}, "xr_cap": {"description": "xr_cap in key correctness proof", "items": {"description": "xr_cap components in key correctness proof", "items": {"description": "xr_cap component values in key correctness proof", "type": "string"}, "type": "array"}, "type": "array"}, "xz_cap": {"description": "xz_cap in key correctness proof", "example": "0", "pattern": "^[0-9]*$", "type": "string"}}, "required": ["c", "xr_cap", "xz_cap"], "type": "object"}, "IndyNonRevocProof": {"properties": {"c_list": {"additionalProperties": {"type": "string"}, "type": "object"}, "x_list": {"additionalProperties": {"type": "string"}, "type": "object"}}, "type": "object"}, "IndyNonRevocationInterval": {"properties": {"from": {"description": "Earliest time of interest in non-revocation interval", "example": 1640995199, "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}, "to": {"description": "Latest time of interest in non-revocation interval", "example": 1640995199, "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}}, "type": "object"}, "IndyPresAttrSpec": {"properties": {"cred_def_id": {"example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "mime-type": {"description": "MIME type (default null)", "example": "image/jpeg", "type": "string"}, "name": {"description": "Attribute name", "example": "favourite_drink", "type": "string"}, "referent": {"description": "Credential referent", "example": "0", "type": "string"}, "value": {"description": "Attribute value", "example": "martini", "type": "string"}}, "required": ["name"], "type": "object"}, "IndyPresPredSpec": {"properties": {"cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "name": {"description": "Attribute name", "example": "high_score", "type": "string"}, "predicate": {"description": "Predicate type ('<', '<=', '>=', or '>')", "enum": ["<", "<=", ">=", ">"], "example": ">=", "type": "string"}, "threshold": {"description": "Threshold value", "type": "integer"}}, "required": ["name", "predicate", "threshold"], "type": "object"}, "IndyPresPreview": {"properties": {"@type": {"description": "Message type identifier", "example": "https://didcomm.org/present-proof/1.0/presentation-preview", "type": "string"}, "attributes": {"items": {"$ref": "#/definitions/IndyPresAttrSpec"}, "type": "array"}, "predicates": {"items": {"$ref": "#/definitions/IndyPresPredSpec"}, "type": "array"}}, "required": ["attributes", "predicates"], "type": "object"}, "IndyPresSpec": {"properties": {"requested_attributes": {"additionalProperties": {"$ref": "#/definitions/IndyRequestedCredsRequestedAttr"}, "description": "Nested object mapping proof request attribute referents to requested-attribute specifiers", "type": "object"}, "requested_predicates": {"additionalProperties": {"$ref": "#/definitions/IndyRequestedCredsRequestedPred"}, "description": "Nested object mapping proof request predicate referents to requested-predicate specifiers", "type": "object"}, "self_attested_attributes": {"additionalProperties": {"description": "Self-attested attribute values to use in requested-credentials structure for proof construction", "example": "self_attested_value", "type": "string"}, "description": "Self-attested attributes to build into proof", "type": "object"}, "trace": {"description": "Whether to trace event (default false)", "example": false, "type": "boolean"}}, "required": ["requested_attributes", "requested_predicates", "self_attested_attributes"], "type": "object"}, "IndyPrimaryProof": {"properties": {"eq_proof": {"allOf": [{"$ref": "#/definitions/IndyEQProof"}], "description": "Indy equality proof", "x-nullable": true}, "ge_proofs": {"description": "Indy GE proofs", "items": {"$ref": "#/definitions/IndyGEProof"}, "type": "array", "x-nullable": true}}, "type": "object"}, "IndyProof": {"properties": {"identifiers": {"description": "Indy proof.identifiers content", "items": {"$ref": "#/definitions/IndyProofIdentifier"}, "type": "array"}, "proof": {"allOf": [{"$ref": "#/definitions/IndyProofProof"}], "description": "Indy proof.proof content"}, "requested_proof": {"allOf": [{"$ref": "#/definitions/IndyProofRequestedProof"}], "description": "Indy proof.requested_proof content"}}, "type": "object"}, "IndyProofIdentifier": {"properties": {"cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "rev_reg_id": {"description": "Revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string", "x-nullable": true}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "timestamp": {"description": "Timestamp epoch", "example": 1640995199, "maximum": 18446744073709551615, "minimum": 0, "type": "integer", "x-nullable": true}}, "type": "object"}, "IndyProofProof": {"properties": {"aggregated_proof": {"allOf": [{"$ref": "#/definitions/IndyProofProofAggregatedProof"}], "description": "Indy proof aggregated proof"}, "proofs": {"description": "Indy proof proofs", "items": {"$ref": "#/definitions/IndyProofProofProofsProof"}, "type": "array"}}, "type": "object"}, "IndyProofProofAggregatedProof": {"properties": {"c_hash": {"description": "c_hash value", "type": "string"}, "c_list": {"description": "c_list value", "items": {"items": {"type": "integer"}, "type": "array"}, "type": "array"}}, "type": "object"}, "IndyProofProofProofsProof": {"properties": {"non_revoc_proof": {"allOf": [{"$ref": "#/definitions/IndyNonRevocProof"}], "description": "Indy non-revocation proof", "x-nullable": true}, "primary_proof": {"allOf": [{"$ref": "#/definitions/IndyPrimaryProof"}], "description": "Indy primary proof"}}, "type": "object"}, "IndyProofReqAttrSpec": {"properties": {"name": {"description": "Attribute name", "example": "favouriteDrink", "type": "string"}, "names": {"description": "Attribute name group", "items": {"example": "age", "type": "string"}, "type": "array"}, "non_revoked": {"$ref": "#/definitions/IndyProofReqAttrSpecNonRevoked", "x-nullable": true}, "restrictions": {"description": "If present, credential must satisfy one of given restrictions: specify schema_id, schema_issuer_did, schema_name, schema_version, issuer_did, cred_def_id, and/or attr::::value where represents a credential attribute name", "items": {"additionalProperties": {"example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "type": "string"}, "type": "object"}, "type": "array"}}, "type": "object"}, "IndyProofReqAttrSpecNonRevoked": {"properties": {"from": {"description": "Earliest time of interest in non-revocation interval", "example": 1640995199, "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}, "to": {"description": "Latest time of interest in non-revocation interval", "example": 1640995199, "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}}, "type": "object"}, "IndyProofReqPredSpec": {"properties": {"name": {"description": "Attribute name", "example": "index", "type": "string"}, "non_revoked": {"$ref": "#/definitions/IndyProofReqPredSpecNonRevoked", "x-nullable": true}, "p_type": {"description": "Predicate type ('<', '<=', '>=', or '>')", "enum": ["<", "<=", ">=", ">"], "example": ">=", "type": "string"}, "p_value": {"description": "Threshold value", "type": "integer"}, "restrictions": {"description": "If present, credential must satisfy one of given restrictions: specify schema_id, schema_issuer_did, schema_name, schema_version, issuer_did, cred_def_id, and/or attr::::value where represents a credential attribute name", "items": {"additionalProperties": {"example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "type": "string"}, "type": "object"}, "type": "array"}}, "required": ["name", "p_type", "p_value"], "type": "object"}, "IndyProofReqPredSpecNonRevoked": {"properties": {"from": {"description": "Earliest time of interest in non-revocation interval", "example": 1640995199, "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}, "to": {"description": "Latest time of interest in non-revocation interval", "example": 1640995199, "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}}, "type": "object"}, "IndyProofRequest": {"properties": {"name": {"description": "Proof request name", "example": "Proof request", "type": "string"}, "non_revoked": {"$ref": "#/definitions/IndyProofRequestNonRevoked", "x-nullable": true}, "nonce": {"description": "Nonce", "example": "1", "pattern": "^[1-9][0-9]*$", "type": "string"}, "requested_attributes": {"additionalProperties": {"$ref": "#/definitions/IndyProofReqAttrSpec"}, "description": "Requested attribute specifications of proof request", "type": "object"}, "requested_predicates": {"additionalProperties": {"$ref": "#/definitions/IndyProofReqPredSpec"}, "description": "Requested predicate specifications of proof request", "type": "object"}, "version": {"description": "Proof request version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "required": ["requested_attributes", "requested_predicates"], "type": "object"}, "IndyProofRequestNonRevoked": {"properties": {"from": {"description": "Earliest time of interest in non-revocation interval", "example": 1640995199, "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}, "to": {"description": "Latest time of interest in non-revocation interval", "example": 1640995199, "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}}, "type": "object"}, "IndyProofRequestedProof": {"properties": {"predicates": {"additionalProperties": {"$ref": "#/definitions/IndyProofRequestedProofPredicate"}, "description": "Proof requested proof predicates.", "type": "object"}, "revealed_attr_groups": {"additionalProperties": {"$ref": "#/definitions/IndyProofRequestedProofRevealedAttrGroup"}, "description": "Proof requested proof revealed attribute groups", "type": "object", "x-nullable": true}, "revealed_attrs": {"additionalProperties": {"$ref": "#/definitions/IndyProofRequestedProofRevealedAttr"}, "description": "Proof requested proof revealed attributes", "type": "object", "x-nullable": true}, "self_attested_attrs": {"description": "Proof requested proof self-attested attributes", "type": "object"}, "unrevealed_attrs": {"description": "Unrevealed attributes", "type": "object"}}, "type": "object"}, "IndyProofRequestedProofPredicate": {"properties": {"sub_proof_index": {"description": "Sub-proof index", "type": "integer"}}, "type": "object"}, "IndyProofRequestedProofRevealedAttr": {"properties": {"encoded": {"description": "Encoded value", "example": "-1", "pattern": "^-?[0-9]*$", "type": "string"}, "raw": {"description": "Raw value", "type": "string"}, "sub_proof_index": {"description": "Sub-proof index", "type": "integer"}}, "type": "object"}, "IndyProofRequestedProofRevealedAttrGroup": {"properties": {"sub_proof_index": {"description": "Sub-proof index", "type": "integer"}, "values": {"additionalProperties": {"$ref": "#/definitions/RawEncoded"}, "description": "Indy proof requested proof revealed attr groups group value", "type": "object"}}, "type": "object"}, "IndyRequestedCredsRequestedAttr": {"properties": {"cred_id": {"description": "Wallet credential identifier (typically but not necessarily a UUID)", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "revealed": {"description": "Whether to reveal attribute in proof (default true)", "type": "boolean"}}, "required": ["cred_id"], "type": "object"}, "IndyRequestedCredsRequestedPred": {"properties": {"cred_id": {"description": "Wallet credential identifier (typically but not necessarily a UUID)", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "timestamp": {"description": "Epoch timestamp of interest for non-revocation proof", "example": 1640995199, "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}}, "required": ["cred_id"], "type": "object"}, "IndyRevRegDef": {"properties": {"credDefId": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "id": {"description": "Indy revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string"}, "revocDefType": {"description": "Revocation registry type (specify CL_ACCUM)", "enum": ["CL_ACCUM"], "example": "CL_ACCUM", "type": "string"}, "tag": {"description": "Revocation registry tag", "type": "string"}, "value": {"allOf": [{"$ref": "#/definitions/IndyRevRegDefValue"}], "description": "Revocation registry definition value"}, "ver": {"description": "Version of revocation registry definition", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "type": "object"}, "IndyRevRegDefValue": {"properties": {"issuanceType": {"description": "Issuance type", "enum": ["ISSUANCE_ON_DEMAND", "ISSUANCE_BY_DEFAULT"], "type": "string"}, "maxCredNum": {"description": "Maximum number of credentials; registry size", "example": 10, "minimum": 1, "type": "integer"}, "publicKeys": {"allOf": [{"$ref": "#/definitions/IndyRevRegDefValuePublicKeys"}], "description": "Public keys"}, "tailsHash": {"description": "Tails hash value", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "tailsLocation": {"description": "Tails file location", "type": "string"}}, "type": "object"}, "IndyRevRegDefValuePublicKeys": {"properties": {"accumKey": {"$ref": "#/definitions/IndyRevRegDefValuePublicKeysAccumKey"}}, "type": "object"}, "IndyRevRegDefValuePublicKeysAccumKey": {"properties": {"z": {"description": "Value for z", "example": "1 120F522F81E6B7 1 09F7A59005C4939854", "type": "string"}}, "type": "object"}, "IndyRevRegEntry": {"properties": {"value": {"allOf": [{"$ref": "#/definitions/IndyRevRegEntryValue"}], "description": "Revocation registry entry value"}, "ver": {"description": "Version of revocation registry entry", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "type": "object"}, "IndyRevRegEntryValue": {"properties": {"accum": {"description": "Accumulator value", "example": "21 11792B036AED0AAA12A4 4 298B2571FFC63A737", "type": "string"}, "prevAccum": {"description": "Previous accumulator value", "example": "21 137AC810975E4 6 76F0384B6F23", "type": "string"}, "revoked": {"description": "Revoked credential revocation identifiers", "items": {"type": "integer"}, "type": "array"}}, "type": "object"}, "InnerCredDef": {"properties": {"issuerId": {"description": "Issuer Identifier of the credential definition", "example": "WgWxqztrNooG92RXvxSTWv", "type": "string"}, "schemaId": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "type": "string"}, "tag": {"description": "Credential definition tag", "example": "default", "type": "string"}}, "required": ["issuerId", "schemaId", "tag"], "type": "object"}, "InnerRevRegDef": {"properties": {"credDefId": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "type": "string"}, "issuerId": {"description": "Issuer Identifier of the credential definition or schema", "example": "WgWxqztrNooG92RXvxSTWv", "type": "string"}, "maxCredNum": {"description": "Maximum number of credential revocations per registry", "example": 777, "type": "integer"}, "tag": {"description": "tag for revocation registry", "example": "default", "type": "string"}}, "type": "object"}, "InputDescriptors": {"properties": {"constraints": {"$ref": "#/definitions/Constraints"}, "group": {"items": {"description": "Group", "type": "string"}, "type": "array"}, "id": {"description": "ID", "type": "string"}, "metadata": {"description": "Metadata dictionary", "type": "object"}, "name": {"description": "Name", "type": "string"}, "purpose": {"description": "Purpose", "type": "string"}, "schema": {"allOf": [{"$ref": "#/definitions/SchemasInputDescriptorFilter"}], "description": "Accepts a list of schema or a dict containing filters like oneof_filter.", "example": {"oneof_filter": [[{"uri": "https://www.w3.org/Test1#Test1"}, {"uri": "https://www.w3.org/Test2#Test2"}], {"oneof_filter": [[{"uri": "https://www.w3.org/Test1#Test1"}], [{"uri": "https://www.w3.org/Test2#Test2"}]]}]}}}, "type": "object"}, "IntroModuleResponse": {"properties": {}, "type": "object"}, "InvitationCreateRequest": {"properties": {"accept": {"description": "List of mime type in order of preference that should be use in responding to the message", "example": ["didcomm/aip1", "didcomm/aip2;env=rfc19"], "items": {"type": "string"}, "type": "array"}, "alias": {"description": "Alias for connection", "example": "Barry", "type": "string"}, "attachments": {"description": "Optional invitation attachments", "items": {"$ref": "#/definitions/AttachmentDef"}, "type": "array"}, "goal": {"description": "A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message", "example": "To issue a Faber College Graduate credential", "type": "string"}, "goal_code": {"description": "A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message", "example": "issue-vc", "type": "string"}, "handshake_protocols": {"items": {"description": "Handshake protocol to specify in invitation", "example": "https://didcomm.org/didexchange/1.0", "type": "string"}, "type": "array"}, "mediation_id": {"description": "Identifier for active mediation record to be used", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "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}", "type": "string"}, "metadata": {"description": "Optional metadata to attach to the connection created with the invitation", "type": "object"}, "my_label": {"description": "Label for connection invitation", "example": "Invitation to Barry", "type": "string"}, "protocol_version": {"description": "OOB protocol version", "example": "1.1", "type": "string"}, "use_did": {"description": "DID to use in invitation", "example": "did:example:123", "type": "string"}, "use_did_method": {"description": "DID method to use in invitation", "enum": ["did:peer:2", "did:peer:4"], "example": "did:peer:2", "type": "string"}, "use_public_did": {"description": "Whether to use public DID in invitation", "example": false, "type": "boolean"}}, "type": "object"}, "InvitationMessage": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "type": "string"}, "accept": {"description": "List of mime type in order of preference", "example": ["didcomm/aip1", "didcomm/aip2;env=rfc19"], "items": {"type": "string"}, "type": "array"}, "goal": {"description": "A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message", "example": "To issue a Faber College Graduate credential", "type": "string"}, "goal_code": {"description": "A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message", "example": "issue-vc", "type": "string"}, "handshake_protocols": {"items": {"description": "Handshake protocol", "example": "https://didcomm.org/didexchange/1.0", "type": "string"}, "type": "array"}, "imageUrl": {"description": "Optional image URL for out-of-band invitation", "example": "http://192.168.56.101/img/logo.jpg", "format": "url", "type": "string", "x-nullable": true}, "label": {"description": "Optional label", "example": "Bob", "type": "string"}, "requests~attach": {"description": "Optional request attachment", "items": {"$ref": "#/definitions/AttachDecorator"}, "type": "array"}, "services": {"example": [{"did": "WgWxqztrNooG92RXvxSTWv", "id": "string", "recipientKeys": ["did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH"], "routingKeys": ["did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH"], "serviceEndpoint": "http://192.168.56.101:8020", "type": "string"}, "did:sov:WgWxqztrNooG92RXvxSTWv"], "items": {"description": "Either a DIDComm service object (as per RFC0067) or a DID string."}, "type": "array"}}, "type": "object"}, "InvitationRecord": {"properties": {"created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "invi_msg_id": {"description": "Invitation message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "invitation": {"allOf": [{"$ref": "#/definitions/InvitationMessage"}], "description": "Out of band invitation message"}, "invitation_id": {"description": "Invitation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "invitation_url": {"description": "Invitation message URL", "example": "https://example.com/endpoint?c_i=eyJAdHlwZSI6ICIuLi4iLCAiLi4uIjogIi4uLiJ9XX0=", "type": "string"}, "oob_id": {"description": "Out of band record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "state": {"description": "Out of band message exchange state", "example": "await_response", "type": "string"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "type": "object"}, "InvitationRecordResponse": {"properties": {}, "type": "object"}, "InvitationResult": {"properties": {"connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "invitation": {"$ref": "#/definitions/ConnectionInvitation"}, "invitation_url": {"description": "Invitation URL", "example": "http://192.168.56.101:8020/invite?c_i=eyJAdHlwZSI6Li4ufQ==", "type": "string"}}, "required": ["connection_id", "invitation", "invitation_url"], "type": "object"}, "IssueCredentialModuleResponse": {"properties": {}, "type": "object"}, "IssueCredentialRequest": {"properties": {"credential": {"$ref": "#/definitions/Credential"}, "options": {"$ref": "#/definitions/LDProofVCOptions"}}, "type": "object"}, "IssueCredentialResponse": {"properties": {"verifiableCredential": {"$ref": "#/definitions/VerifiableCredential"}}, "type": "object"}, "IssuerCredRevRecord": {"properties": {"created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "cred_ex_id": {"description": "Credential exchange record identifier at credential issue", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "cred_ex_version": {"description": "Credential exchange version", "type": "string"}, "cred_rev_id": {"description": "Credential revocation identifier", "example": "12345", "pattern": "^[1-9][0-9]*$", "type": "string"}, "record_id": {"description": "Issuer credential revocation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "rev_reg_id": {"description": "Revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string"}, "state": {"description": "Issue credential revocation record state", "example": "issued", "type": "string"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "type": "object"}, "IssuerCredRevRecordSchemaAnoncreds": {"properties": {"created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "cred_def_id": {"description": "Credential definition identifier", "type": "string"}, "cred_ex_id": {"description": "Credential exchange record identifier at credential issue", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "cred_ex_version": {"description": "Credential exchange version", "type": "string"}, "cred_rev_id": {"description": "Credential revocation identifier", "type": "string"}, "record_id": {"description": "Issuer credential revocation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "rev_reg_id": {"description": "Revocation registry identifier", "type": "string"}, "state": {"description": "Issue credential revocation record state", "example": "issued", "type": "string"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "type": "object"}, "IssuerRevRegRecord": {"properties": {"created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "error_msg": {"description": "Error message", "example": "Revocation registry undefined", "type": "string"}, "issuer_did": {"description": "Issuer DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "max_cred_num": {"description": "Maximum number of credentials for revocation registry", "example": 1000, "type": "integer"}, "pending_pub": {"description": "Credential revocation identifier for credential revoked and pending publication to ledger", "items": {"example": "23", "type": "string"}, "type": "array"}, "record_id": {"description": "Issuer revocation registry record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "revoc_def_type": {"description": "Revocation registry type (specify CL_ACCUM)", "enum": ["CL_ACCUM"], "example": "CL_ACCUM", "type": "string"}, "revoc_reg_def": {"allOf": [{"$ref": "#/definitions/IndyRevRegDef"}], "description": "Revocation registry definition"}, "revoc_reg_entry": {"allOf": [{"$ref": "#/definitions/IndyRevRegEntry"}], "description": "Revocation registry entry"}, "revoc_reg_id": {"description": "Revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string"}, "state": {"description": "Issue revocation registry record state", "example": "active", "type": "string"}, "tag": {"description": "Tag within issuer revocation registry identifier", "type": "string"}, "tails_hash": {"description": "Tails hash", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "tails_local_path": {"description": "Local path to tails file", "type": "string"}, "tails_public_uri": {"description": "Public URI for tails file", "type": "string"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "type": "object"}, "JWSCreate": {"properties": {"did": {"description": "DID of interest", "example": "did:peer:WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "type": "string"}, "headers": {"type": "object"}, "payload": {"type": "object"}, "verificationMethod": {"description": "Information used for proof verification", "example": "did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL", "pattern": "\\w+:(\\/?\\/?)[^\\s]+", "type": "string"}}, "required": ["payload"], "type": "object"}, "JWSVerify": {"properties": {"jwt": {"example": "eyJhbGciOiJFZERTQSJ9.eyJhIjogIjAifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk", "pattern": "^[a-zA-Z0-9_-]+\\.[a-zA-Z0-9_-]*\\.[a-zA-Z0-9_-]+$", "type": "string"}}, "type": "object"}, "JWSVerifyResponse": {"properties": {"error": {"description": "Error text", "type": "string"}, "headers": {"description": "Headers from verified JWT.", "type": "object"}, "kid": {"description": "kid of signer", "type": "string"}, "payload": {"description": "Payload from verified JWT", "type": "object"}, "valid": {"type": "boolean"}}, "required": ["headers", "kid", "payload", "valid"], "type": "object"}, "Keylist": {"properties": {"results": {"description": "List of keylist records", "items": {"$ref": "#/definitions/RouteRecord"}, "type": "array"}}, "type": "object"}, "KeylistQuery": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "type": "string"}, "filter": {"description": "Query dictionary object", "example": {"filter": {}}, "type": "object"}, "paginate": {"allOf": [{"$ref": "#/definitions/KeylistQueryPaginate"}], "description": "Pagination info"}}, "type": "object"}, "KeylistQueryFilterRequest": {"properties": {"filter": {"description": "Filter for keylist query", "type": "object"}}, "type": "object"}, "KeylistQueryPaginate": {"properties": {"limit": {"description": "Limit for keylist query", "example": 30, "type": "integer"}, "offset": {"description": "Offset value for query", "example": 0, "type": "integer"}}, "type": "object"}, "KeylistUpdate": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "type": "string"}, "updates": {"description": "List of update rules", "items": {"$ref": "#/definitions/KeylistUpdateRule"}, "type": "array"}}, "type": "object"}, "KeylistUpdateRequest": {"properties": {"updates": {"items": {"$ref": "#/definitions/KeylistUpdateRule"}, "type": "array"}}, "type": "object"}, "KeylistUpdateRule": {"properties": {"action": {"description": "Action for specific key", "enum": ["add", "remove"], "example": "add", "type": "string"}, "recipient_key": {"description": "Key to remove or add", "example": "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH", "pattern": "^did:key:z[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+$|^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}}, "required": ["action", "recipient_key"], "type": "object"}, "LDProofVCDetail": {"additionalProperties": true, "properties": {"credential": {"allOf": [{"$ref": "#/definitions/Credential"}], "description": "Detail of the JSON-LD Credential to be issued", "example": {"@context": ["https://www.w3.org/2018/credentials/v1", "https://w3id.org/citizenship/v1"], "credentialSubject": {"familyName": "SMITH", "gender": "Male", "givenName": "JOHN", "type": ["PermanentResident", "Person"]}, "description": "Government of Example Permanent Resident Card.", "identifier": "83627465", "issuanceDate": "2019-12-03T12:19:52Z", "issuer": "did:key:z6MkmjY8GnV5i9YTDtPETC2uUAW6ejw3nk5mXF5yci5ab7th", "name": "Permanent Resident Card", "type": ["VerifiableCredential", "PermanentResidentCard"]}}, "options": {"allOf": [{"$ref": "#/definitions/LDProofVCOptions"}], "description": "Options for specifying how the linked data proof is created.", "example": {"proofType": "Ed25519Signature2018"}}}, "required": ["credential", "options"], "type": "object"}, "LDProofVCOptions": {"additionalProperties": true, "properties": {"challenge": {"description": "A challenge to include in the proof. SHOULD be provided by the requesting party of the credential (=holder)", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "created": {"description": "The date and time of the proof (with a maximum accuracy in seconds). Defaults to current system time", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "credentialStatus": {"allOf": [{"$ref": "#/definitions/CredentialStatusOptions"}], "description": "The credential status mechanism to use for the credential. Omitting the property indicates the issued credential will not include a credential status"}, "domain": {"description": "The intended domain of validity for the proof", "example": "example.com", "type": "string"}, "proofPurpose": {"description": "The proof purpose used for the proof. Should match proof purposes registered in the Linked Data Proofs Specification", "example": "assertionMethod", "type": "string"}, "proofType": {"description": "The proof type used for the proof. Should match suites registered in the Linked Data Cryptographic Suite Registry", "example": "Ed25519Signature2018", "type": "string"}, "verificationMethod": {"description": "The verification method to use for the proof. Should match a verification method in the wallet", "example": "did:example:123456#key-1", "type": "string"}}, "type": "object"}, "LedgerConfigInstance": {"properties": {"genesis_file": {"description": "genesis_file", "type": "string"}, "genesis_transactions": {"description": "genesis_transactions", "type": "string"}, "genesis_url": {"description": "genesis_url", "type": "string"}, "id": {"description": "ledger_id", "type": "string"}, "is_production": {"description": "is_production", "type": "boolean"}}, "type": "object"}, "LedgerConfigList": {"properties": {"ledger_config_list": {"items": {"$ref": "#/definitions/LedgerConfigInstance"}, "type": "array"}}, "required": ["ledger_config_list"], "type": "object"}, "LedgerModulesResult": {"properties": {}, "type": "object"}, "LinkedDataProof": {"additionalProperties": true, "properties": {"challenge": {"description": "Associates a challenge with a proof, for use with a proofPurpose such as authentication", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "created": {"description": "The string value of an ISO8601 combined date and time string generated by the Signature Algorithm", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "domain": {"description": "A string value specifying the restricted domain of the signature.", "example": "https://example.com", "type": "string"}, "jws": {"description": "Associates a Detached Json Web Signature with a proof", "example": "eyJhbGciOiAiRWREUc2UsICJjcml0IjogWyJiNjQiXX0..lKJU0Df_keblRKhZAS9Qq6zybm-HqUXNVZ8vgEPNTAjQ1Ch6YBKY7UBAjg6iBX5qBQ", "type": "string"}, "nonce": {"description": "The nonce", "example": "CF69iO3nfvqRsRBNElE8b4wO39SyJHPM7Gg1nExltW5vSfQA1lvDCR/zXX1To0/4NLo==", "type": "string"}, "proofPurpose": {"description": "Proof purpose", "example": "assertionMethod", "type": "string"}, "proofValue": {"description": "The proof value of a proof", "example": "sy1AahqbzJQ63n9RtekmwzqZeVj494VppdAVJBnMYrTwft6cLJJGeTSSxCCJ6HKnRtwE7jjDh6sB2z2AAiZY9BBnCD8wUVgwqH3qchGRCuC2RugA4eQ9fUrR4Yuycac3caiaaay", "type": "string"}, "type": {"description": "Identifies the digital signature suite that was used to create the signature", "example": "Ed25519Signature2018", "type": "string"}, "verificationMethod": {"description": "Information used for proof verification", "example": "did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL", "pattern": "\\w+:(\\/?\\/?)[^\\s]+", "type": "string"}}, "required": ["proofPurpose", "type", "verificationMethod"], "type": "object"}, "ListCredentialsResponse": {"properties": {}, "type": "object"}, "MediationCreateRequest": {"properties": {}, "type": "object"}, "MediationDeny": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "type": "string"}}, "type": "object"}, "MediationGrant": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "type": "string"}, "endpoint": {"description": "endpoint on which messages destined for the recipient are received.", "example": "http://192.168.56.102:8020/", "type": "string"}, "routing_keys": {"items": {"description": "Keys to use for forward message packaging", "type": "string"}, "type": "array"}}, "type": "object"}, "MediationIdMatchInfo": {"properties": {"mediation_id": {"description": "Mediation record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}}, "required": ["mediation_id"], "type": "object"}, "MediationList": {"properties": {"results": {"description": "List of mediation records", "items": {"$ref": "#/definitions/MediationRecord"}, "type": "array"}}, "required": ["results"], "type": "object"}, "MediationRecord": {"properties": {"connection_id": {"type": "string"}, "created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "endpoint": {"type": "string"}, "mediation_id": {"type": "string"}, "mediator_terms": {"items": {"type": "string"}, "type": "array"}, "recipient_terms": {"items": {"type": "string"}, "type": "array"}, "role": {"type": "string"}, "routing_keys": {"items": {"example": "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH", "pattern": "^did:key:z[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+$", "type": "string"}, "type": "array"}, "state": {"description": "Current record state", "example": "active", "type": "string"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "required": ["connection_id", "role"], "type": "object"}, "Menu": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "type": "string"}, "description": {"description": "Introductory text for the menu", "example": "This menu presents options", "type": "string"}, "errormsg": {"description": "An optional error message to display in menu header", "example": "Error: item not found", "type": "string"}, "options": {"description": "List of menu options", "items": {"$ref": "#/definitions/MenuOption"}, "type": "array"}, "title": {"description": "Menu title", "example": "My Menu", "type": "string"}}, "required": ["options"], "type": "object"}, "MenuForm": {"properties": {"description": {"description": "Additional descriptive text for menu form", "example": "Window preference settings", "type": "string"}, "params": {"description": "List of form parameters", "items": {"$ref": "#/definitions/MenuFormParam"}, "type": "array"}, "submit-label": {"description": "Alternative label for form submit button", "example": "Send", "type": "string"}, "title": {"description": "Menu form title", "example": "Preferences", "type": "string"}}, "type": "object"}, "MenuFormParam": {"properties": {"default": {"description": "Default parameter value", "example": "0", "type": "string"}, "description": {"description": "Additional descriptive text for menu form parameter", "example": "Delay in seconds before starting", "type": "string"}, "name": {"description": "Menu parameter name", "example": "delay", "type": "string"}, "required": {"description": "Whether parameter is required", "example": "False", "type": "boolean"}, "title": {"description": "Menu parameter title", "example": "Delay in seconds", "type": "string"}, "type": {"description": "Menu form parameter input type", "example": "int", "type": "string"}}, "required": ["name", "title"], "type": "object"}, "MenuJson": {"properties": {"description": {"description": "Introductory text for the menu", "example": "User preferences for window settings", "type": "string"}, "errormsg": {"description": "Optional error message to display in menu header", "example": "Error: item not present", "type": "string"}, "options": {"description": "List of menu options", "items": {"$ref": "#/definitions/MenuOption"}, "type": "array"}, "title": {"description": "Menu title", "example": "My Menu", "type": "string"}}, "required": ["options"], "type": "object"}, "MenuOption": {"properties": {"description": {"description": "Additional descriptive text for menu option", "example": "Window display preferences", "type": "string"}, "disabled": {"description": "Whether to show option as disabled", "example": "False", "type": "boolean"}, "form": {"$ref": "#/definitions/MenuForm"}, "name": {"description": "Menu option name (unique identifier)", "example": "window_prefs", "type": "string"}, "title": {"description": "Menu option title", "example": "Window Preferences", "type": "string"}}, "required": ["name", "title"], "type": "object"}, "MultitenantModuleResponse": {"properties": {}, "type": "object"}, "OobRecord": {"properties": {"attach_thread_id": {"description": "Connection record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "connection_id": {"description": "Connection record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "invi_msg_id": {"description": "Invitation message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "invitation": {"allOf": [{"$ref": "#/definitions/InvitationMessage"}], "description": "Out of band invitation message"}, "multi_use": {"description": "Allow for multiple uses of the oob invitation", "example": true, "type": "boolean"}, "oob_id": {"description": "Oob record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "our_recipient_key": {"description": "Recipient key used for oob invitation", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "role": {"description": "OOB Role", "enum": ["sender", "receiver"], "example": "receiver", "type": "string"}, "state": {"description": "Out of band message exchange state", "enum": ["initial", "prepare-response", "await-response", "reuse-not-accepted", "reuse-accepted", "done", "deleted"], "example": "await-response", "type": "string"}, "their_service": {"$ref": "#/definitions/ServiceDecorator"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "required": ["invi_msg_id", "invitation", "oob_id", "state"], "type": "object"}, "PerformRequest": {"properties": {"name": {"description": "Menu option name", "example": "Query", "type": "string"}, "params": {"additionalProperties": {"example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "description": "Input parameter values", "type": "object"}}, "type": "object"}, "PingRequest": {"properties": {"comment": {"description": "Comment for the ping message", "type": "string", "x-nullable": true}}, "type": "object"}, "PingRequestResponse": {"properties": {"thread_id": {"description": "Thread ID of the ping message", "type": "string"}}, "type": "object"}, "Presentation": {"additionalProperties": true, "properties": {"@context": {"description": "The JSON-LD context of the presentation", "example": ["https://www.w3.org/2018/credentials/v1"], "items": {}, "type": "array"}, "holder": {"description": "The JSON-LD Verifiable Credential Holder. Either string of object with id field.", "example": "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH"}, "id": {"description": "The ID of the presentation", "example": "http://example.edu/presentations/1872", "pattern": "\\w+:(\\/?\\/?)[^\\s]+", "type": "string"}, "proof": {"allOf": [{"$ref": "#/definitions/LinkedDataProof"}], "description": "The proof of the presentation", "example": {"created": "2019-12-11T03:50:55", "jws": "eyJhbGciOiAiRWREU0EiLCAiYjY0IjogZmFsc2UsICJjcml0JiNjQiXX0..lKJU0Df_keblRKhZAS9Qq6zybm-HqUXNVZ8vgEPNTAjQKBhQDxvXNo7nvtUBb_Eq1Ch6YBKY5qBQ", "proofPurpose": "assertionMethod", "type": "Ed25519Signature2018", "verificationMethod": "did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL"}}, "type": {"description": "The JSON-LD type of the presentation", "example": ["VerifiablePresentation"], "items": {"type": "string"}, "type": "array"}, "verifiableCredential": {"items": {"type": "object"}, "type": "array"}}, "required": ["@context", "type"], "type": "object"}, "PresentationDefinition": {"properties": {"format": {"$ref": "#/definitions/ClaimFormat"}, "id": {"description": "Unique Resource Identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "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}", "type": "string"}, "input_descriptors": {"items": {"$ref": "#/definitions/InputDescriptors"}, "type": "array"}, "name": {"description": "Human-friendly name that describes what the presentation definition pertains to", "type": "string"}, "purpose": {"description": "Describes the purpose for which the Presentation Definition's inputs are being requested", "type": "string"}, "submission_requirements": {"items": {"$ref": "#/definitions/SubmissionRequirements"}, "type": "array"}}, "type": "object"}, "PresentationProposal": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "presentation_proposal": {"$ref": "#/definitions/IndyPresPreview"}}, "required": ["presentation_proposal"], "type": "object"}, "PresentationRequest": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "request_presentations~attach": {"items": {"$ref": "#/definitions/AttachDecorator"}, "type": "array"}}, "required": ["request_presentations~attach"], "type": "object"}, "PresentationVerificationResult": {"properties": {"credential_results": {"items": {"$ref": "#/definitions/DocumentVerificationResult"}, "type": "array"}, "errors": {"items": {"type": "string"}, "type": "array"}, "presentation_result": {"$ref": "#/definitions/DocumentVerificationResult"}, "verified": {"type": "boolean"}}, "required": ["verified"], "type": "object"}, "ProfileSettings": {"properties": {"settings": {"description": "Profile settings dict", "example": {"debug.invite_public": true, "log.level": "INFO", "public_invites": false}, "type": "object"}}, "type": "object"}, "ProofResult": {"properties": {"error": {"type": "string"}, "proof": {"type": "object"}, "purpose_result": {"$ref": "#/definitions/PurposeResult"}, "verified": {"type": "boolean"}}, "type": "object"}, "ProtocolDescriptor": {"properties": {"pid": {"type": "string"}, "roles": {"description": "List of roles", "items": {"description": "Role: requester or responder", "example": "requester", "type": "string"}, "type": "array", "x-nullable": true}}, "required": ["pid"], "type": "object"}, "ProvePresentationRequest": {"properties": {"options": {"$ref": "#/definitions/LDProofVCOptions"}, "presentation": {"$ref": "#/definitions/Presentation"}}, "type": "object"}, "ProvePresentationResponse": {"properties": {"verifiablePresentation": {"$ref": "#/definitions/VerifiablePresentation"}}, "type": "object"}, "PublishRevocations": {"properties": {"rrid2crid": {"additionalProperties": {"items": {"description": "Credential revocation identifier", "example": "12345", "pattern": "^[1-9][0-9]*$", "type": "string"}, "type": "array"}, "description": "Credential revocation ids by revocation registry id", "type": "object"}}, "type": "object"}, "PublishRevocationsOptions": {"properties": {"create_transaction_for_endorser": {"description": "Create transaction for endorser (optional, default false). Use this for agents who don't specify an author role but want to create a transaction for an endorser to sign.", "example": false, "required": false, "type": "boolean"}, "endorser_connection_id": {"description": "Connection identifier (optional) (this is an example). You can set this if you know the endorser's connection id you want to use. If not specified then the agent will attempt to find an endorser connection.", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "required": false, "type": "string"}}, "type": "object"}, "PublishRevocationsResultSchemaAnoncreds": {"properties": {"rrid2crid": {"additionalProperties": {"items": {"description": "Credential revocation identifier", "example": "12345", "pattern": "^[1-9][0-9]*$", "type": "string"}, "type": "array"}, "description": "Credential revocation ids by revocation registry id", "type": "object"}}, "type": "object"}, "PublishRevocationsSchemaAnoncreds": {"properties": {"options": {"$ref": "#/definitions/PublishRevocationsOptions"}, "rrid2crid": {"additionalProperties": {"items": {"description": "Credential revocation identifier", "example": "12345", "pattern": "^[1-9][0-9]*$", "type": "string"}, "type": "array"}, "description": "Credential revocation ids by revocation registry id", "type": "object"}}, "type": "object"}, "PurposeResult": {"properties": {"controller": {"type": "object"}, "error": {"type": "string"}, "valid": {"type": "boolean"}}, "type": "object"}, "Queries": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "type": "string"}, "queries": {"items": {"$ref": "#/definitions/QueryItem"}, "type": "array"}}, "type": "object"}, "Query": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "type": "string"}, "comment": {"type": "string", "x-nullable": true}, "query": {"type": "string"}}, "required": ["query"], "type": "object"}, "QueryItem": {"properties": {"feature-type": {"description": "feature type", "enum": ["protocol", "goal-code"], "type": "string"}, "match": {"description": "match", "type": "string"}}, "required": ["feature-type", "match"], "type": "object"}, "RawEncoded": {"properties": {"encoded": {"description": "Encoded value", "example": "-1", "pattern": "^-?[0-9]*$", "type": "string"}, "raw": {"description": "Raw value", "type": "string"}}, "type": "object"}, "ReceiveInvitationRequest": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "type": "string"}, "did": {"description": "DID for connection invitation", "example": "did:peer:WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "type": "string"}, "imageUrl": {"description": "Optional image URL for connection invitation", "example": "http://192.168.56.101/img/logo.jpg", "format": "url", "type": "string", "x-nullable": true}, "label": {"description": "Optional label for connection invitation", "example": "Bob", "type": "string"}, "recipientKeys": {"description": "List of recipient keys", "items": {"description": "Recipient public key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "type": "array"}, "routingKeys": {"description": "List of routing keys", "items": {"description": "Routing key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "type": "array"}, "serviceEndpoint": {"description": "Service endpoint at which to reach this agent", "example": "http://192.168.56.101:8020", "type": "string"}}, "type": "object"}, "RemoveWalletRequest": {"properties": {"wallet_key": {"description": "Master key used for key derivation. Only required for unmanaged wallets.", "example": "MySecretKey123", "type": "string"}}, "type": "object"}, "ResolutionResult": {"properties": {"did_document": {"description": "DID Document", "type": "object"}, "metadata": {"description": "Resolution metadata", "type": "object"}}, "required": ["did_document", "metadata"], "type": "object"}, "RevList": {"properties": {"currentAccumulator": {"description": "The current accumulator value", "example": "21 118...1FB", "type": "string"}, "issuerId": {"description": "Issuer Identifier of the credential definition or schema", "example": "WgWxqztrNooG92RXvxSTWv", "type": "string"}, "revRegDefId": {"description": "The ID of the revocation registry definition", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "type": "string"}, "revocationList": {"description": "Bit list representing revoked credentials", "example": [0, 1, 1, 0], "items": {"type": "integer"}, "type": "array"}, "timestamp": {"description": "Timestamp at which revocation list is applicable", "example": "2021-12-31T23:59:59Z", "type": "integer"}}, "type": "object"}, "RevListCreateRequest": {"properties": {"options": {"$ref": "#/definitions/RevListOptions"}, "rev_reg_def_id": {"description": "Revocation registry definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "type": "string"}}, "type": "object"}, "RevListOptions": {"properties": {"create_transaction_for_endorser": {"description": "Create transaction for endorser (optional, default false). Use this for agents who don't specify an author role but want to create a transaction for an endorser to sign.", "example": false, "type": "boolean"}, "endorser_connection_id": {"description": "Connection identifier (optional) (this is an example). You can set this if you know the endorser's connection id you want to use. If not specified then the agent will attempt to find an endorser connection.", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}}, "type": "object"}, "RevListResult": {"properties": {"job_id": {"type": "string"}, "registration_metadata": {"type": "object"}, "revocation_list_metadata": {"type": "object"}, "revocation_list_state": {"$ref": "#/definitions/RevListState"}}, "type": "object"}, "RevListState": {"properties": {"revocation_list": {"allOf": [{"$ref": "#/definitions/RevList"}], "description": "revocation list"}, "state": {"enum": ["finished", "failed", "action", "wait"], "type": "string"}}, "type": "object"}, "RevRegCreateRequest": {"properties": {"credential_definition_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "max_cred_num": {"description": "Revocation registry size", "example": 1000, "maximum": 32768, "minimum": 4, "type": "integer"}}, "type": "object"}, "RevRegCreateRequestSchemaAnoncreds": {"properties": {"options": {"$ref": "#/definitions/RevRegDefOptions"}, "revocation_registry_definition": {"$ref": "#/definitions/InnerRevRegDef"}}, "type": "object"}, "RevRegDef": {"properties": {"credDefId": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "type": "string"}, "issuerId": {"description": "Issuer Identifier of the credential definition or schema", "example": "WgWxqztrNooG92RXvxSTWv", "type": "string"}, "revocDefType": {"type": "string"}, "tag": {"description": "tag for the revocation registry definition", "example": "default", "type": "string"}, "value": {"$ref": "#/definitions/RevRegDefValue"}}, "type": "object"}, "RevRegDefOptions": {"properties": {"create_transaction_for_endorser": {"description": "Create transaction for endorser (optional, default false). Use this for agents who don't specify an author role but want to create a transaction for an endorser to sign.", "example": false, "type": "boolean"}, "endorser_connection_id": {"description": "Connection identifier (optional) (this is an example). You can set this if you know the endorser's connection id you want to use. If not specified then the agent will attempt to find an endorser connection.", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}}, "type": "object"}, "RevRegDefResult": {"properties": {"job_id": {"type": "string"}, "registration_metadata": {"type": "object"}, "revocation_registry_definition_metadata": {"type": "object"}, "revocation_registry_definition_state": {"$ref": "#/definitions/RevRegDefState"}}, "type": "object"}, "RevRegDefState": {"properties": {"revocation_registry_definition": {"allOf": [{"$ref": "#/definitions/RevRegDef"}], "description": "revocation registry definition"}, "revocation_registry_definition_id": {"description": "revocation registry definition id", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "type": "string"}, "state": {"enum": ["finished", "failed", "action", "wait", "decommissioned", "full"], "type": "string"}}, "type": "object"}, "RevRegDefValue": {"properties": {"maxCredNum": {"example": 777, "type": "integer"}, "publicKeys": {"example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "type": "object"}, "tailsHash": {"example": "7Qen9RDyemMuV7xGQvp7NjwMSpyHieJyBakycxN7dX7P", "type": "string"}, "tailsLocation": {"example": "https://tails-server.com/hash/7Qen9RDyemMuV7xGQvp7NjwMSpyHieJyBakycxN7dX7P", "type": "string"}}, "type": "object"}, "RevRegIssuedResult": {"properties": {"result": {"description": "Number of credentials issued against revocation registry", "example": 0, "minimum": 0, "type": "integer"}}, "type": "object"}, "RevRegIssuedResultSchemaAnoncreds": {"properties": {"result": {"description": "Number of credentials issued against revocation registry", "example": 0, "minimum": 0, "type": "integer"}}, "type": "object"}, "RevRegResult": {"properties": {"result": {"$ref": "#/definitions/IssuerRevRegRecord"}}, "type": "object"}, "RevRegResultSchemaAnoncreds": {"properties": {"result": {"$ref": "#/definitions/IssuerRevRegRecord"}}, "type": "object"}, "RevRegUpdateTailsFileUri": {"properties": {"tails_public_uri": {"description": "Public URI to the tails file", "example": "http://192.168.56.133:6543/revocation/registry/WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0/tails-file", "format": "url", "type": "string"}}, "required": ["tails_public_uri"], "type": "object"}, "RevRegWalletUpdatedResult": {"properties": {"accum_calculated": {"description": "Calculated accumulator for phantom revocations", "type": "object"}, "accum_fixed": {"description": "Applied ledger transaction to fix revocations", "type": "object"}, "rev_reg_delta": {"description": "Indy revocation registry delta", "type": "object"}}, "type": "object"}, "RevRegWalletUpdatedResultSchemaAnoncreds": {"properties": {"accum_calculated": {"description": "Calculated accumulator for phantom revocations", "type": "object"}, "accum_fixed": {"description": "Applied ledger transaction to fix revocations", "type": "object"}, "rev_reg_delta": {"description": "Indy revocation registry delta", "type": "object"}}, "type": "object"}, "RevRegsCreated": {"properties": {"rev_reg_ids": {"items": {"description": "Revocation registry identifiers", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string"}, "type": "array"}}, "type": "object"}, "RevRegsCreatedSchemaAnoncreds": {"properties": {"rev_reg_ids": {"items": {"description": "Revocation registry identifiers", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string"}, "type": "array"}}, "type": "object"}, "RevocationAnoncredsModuleResponse": {"properties": {}, "type": "object"}, "RevocationModuleResponse": {"properties": {}, "type": "object"}, "RevokeRequest": {"properties": {"comment": {"description": "Optional comment to include in revocation notification", "type": "string"}, "connection_id": {"description": "Connection ID to which the revocation notification will be sent; required if notify is true", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "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}", "type": "string"}, "cred_ex_id": {"description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "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}", "type": "string"}, "cred_rev_id": {"description": "Credential revocation identifier", "example": "12345", "pattern": "^[1-9][0-9]*$", "type": "string"}, "notify": {"description": "Send a notification to the credential recipient", "type": "boolean"}, "notify_version": {"description": "Specify which version of the revocation notification should be sent", "enum": ["v1_0", "v2_0"], "type": "string"}, "publish": {"description": "(True) publish revocation to ledger immediately, or (default, False) mark it pending", "type": "boolean"}, "rev_reg_id": {"description": "Revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string"}, "thread_id": {"description": "Thread ID of the credential exchange message thread resulting in the credential now being revoked; required if notify is true", "type": "string"}}, "type": "object"}, "RevokeRequestSchemaAnoncreds": {"properties": {"comment": {"description": "Optional comment to include in revocation notification", "type": "string"}, "connection_id": {"description": "Connection ID to which the revocation notification will be sent; required if notify is true", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "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}", "type": "string"}, "cred_ex_id": {"description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "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}", "type": "string"}, "cred_rev_id": {"description": "Credential revocation identifier", "example": "12345", "pattern": "^[1-9][0-9]*$", "type": "string"}, "notify": {"description": "Send a notification to the credential recipient", "type": "boolean"}, "notify_version": {"description": "Specify which version of the revocation notification should be sent", "enum": ["v1_0", "v2_0"], "type": "string"}, "publish": {"description": "(True) publish revocation to ledger immediately, or (default, False) mark it pending", "type": "boolean"}, "rev_reg_id": {"description": "Revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string"}, "thread_id": {"description": "Thread ID of the credential exchange message thread resulting in the credential now being revoked; required if notify is true", "type": "string"}}, "type": "object"}, "Rotate": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "type": "string"}, "to_did": {"description": "The DID the rotating party is rotating to", "example": "did:example:newdid", "type": "string"}}, "required": ["to_did"], "type": "object"}, "RouteRecord": {"properties": {"connection_id": {"type": "string"}, "created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "recipient_key": {"type": "string"}, "record_id": {"type": "string"}, "role": {"type": "string"}, "state": {"description": "Current record state", "example": "active", "type": "string"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "wallet_id": {"type": "string"}}, "required": ["recipient_key"], "type": "object"}, "SDJWSCreate": {"properties": {"did": {"description": "DID of interest", "example": "did:peer:WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", "type": "string"}, "headers": {"type": "object"}, "non_sd_list": {"items": {"example": ["name", "address", "address.street_address", "nationalities[1:3]"], "pattern": "[a-z0-9:\\[\\]_\\.@?\\(\\)]", "type": "string"}, "type": "array"}, "payload": {"type": "object"}, "verificationMethod": {"description": "Information used for proof verification", "example": "did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL", "pattern": "\\w+:(\\/?\\/?)[^\\s]+", "type": "string"}}, "required": ["payload"], "type": "object"}, "SDJWSVerify": {"properties": {"sd_jwt": {"example": "eyJhbGciOiJFZERTQSJ9.eyJhIjogIjAifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk~WyJEM3BUSFdCYWNRcFdpREc2TWZKLUZnIiwgIkRFIl0~WyJPMTFySVRjRTdHcXExYW9oRkd0aDh3IiwgIlNBIl0~WyJkVmEzX1JlTGNsWTU0R1FHZm5oWlRnIiwgInVwZGF0ZWRfYXQiLCAxNTcwMDAwMDAwXQ", "pattern": "^[a-zA-Z0-9_-]+\\.[a-zA-Z0-9_-]*\\.[a-zA-Z0-9_-]+(?:~[a-zA-Z0-9._-]+)*~?$", "type": "string"}}, "type": "object"}, "SDJWSVerifyResponse": {"properties": {"disclosures": {"description": "Disclosure arrays associated with the SD-JWT", "example": [["fx1iT_mETjGiC-JzRARnVg", "name", "Alice"], ["n4-t3mlh8jSS6yMIT7QHnA", "street_address", {"_sd": ["kLZrLK7enwfqeOzJ9-Ss88YS3mhjOAEk9lr_ix2Heng"]}]], "items": {"items": {}, "type": "array"}, "type": "array"}, "error": {"description": "Error text", "type": "string"}, "headers": {"description": "Headers from verified JWT.", "type": "object"}, "kid": {"description": "kid of signer", "type": "string"}, "payload": {"description": "Payload from verified JWT", "type": "object"}, "valid": {"type": "boolean"}}, "required": ["headers", "kid", "payload", "valid"], "type": "object"}, "Schema": {"properties": {"attrNames": {"description": "Schema attribute names", "items": {"description": "Attribute name", "example": "score", "type": "string"}, "type": "array"}, "id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "name": {"description": "Schema name", "example": "schema_name", "type": "string"}, "seqNo": {"description": "Schema sequence number", "example": 10, "minimum": 1, "type": "integer"}, "ver": {"description": "Node protocol version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}, "version": {"description": "Schema version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "type": "object"}, "SchemaGetResult": {"properties": {"schema": {"$ref": "#/definitions/Schema"}}, "type": "object"}, "SchemaInputDescriptor": {"properties": {"required": {"description": "Required", "type": "boolean"}, "uri": {"description": "URI", "type": "string"}}, "type": "object"}, "SchemaPostOption": {"properties": {"create_transaction_for_endorser": {"description": "Create transaction for endorser (optional, default false). Use this for agents who don't specify an author role but want to create a transaction for an endorser to sign.", "example": false, "type": "boolean"}, "endorser_connection_id": {"description": "Connection identifier (optional) (this is an example). You can set this if you know the endorser's connection id you want to use. If not specified then the agent will attempt to find an endorser connection.", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}}, "type": "object"}, "SchemaPostRequest": {"properties": {"options": {"$ref": "#/definitions/SchemaPostOption"}, "schema": {"$ref": "#/definitions/AnonCredsSchema"}}, "type": "object"}, "SchemaResult": {"properties": {"job_id": {"type": "string"}, "registration_metadata": {"type": "object"}, "schema_metadata": {"type": "object"}, "schema_state": {"$ref": "#/definitions/SchemaState"}}, "type": "object"}, "SchemaSendRequest": {"properties": {"attributes": {"description": "List of schema attributes", "items": {"description": "attribute name", "example": "score", "type": "string"}, "type": "array"}, "schema_name": {"description": "Schema name", "example": "prefs", "type": "string"}, "schema_version": {"description": "Schema version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "required": ["attributes", "schema_name", "schema_version"], "type": "object"}, "SchemaSendResult": {"properties": {"schema": {"allOf": [{"$ref": "#/definitions/Schema"}], "description": "Schema definition"}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}}, "required": ["schema_id"], "type": "object"}, "SchemaState": {"properties": {"schema": {"$ref": "#/definitions/AnonCredsSchema"}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "type": "string"}, "state": {"enum": ["finished", "failed", "action", "wait"], "type": "string"}}, "type": "object"}, "SchemasCreatedResult": {"properties": {"schema_ids": {"items": {"description": "Schema identifiers", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "type": "array"}}, "type": "object"}, "SchemasInputDescriptorFilter": {"properties": {"oneof_filter": {"description": "oneOf", "type": "boolean"}, "uri_groups": {"items": {"items": {"$ref": "#/definitions/SchemaInputDescriptor"}, "type": "array"}, "type": "array"}}, "type": "object"}, "SendMenu": {"properties": {"menu": {"allOf": [{"$ref": "#/definitions/MenuJson"}], "description": "Menu to send to connection"}}, "required": ["menu"], "type": "object"}, "SendMessage": {"properties": {"content": {"description": "Message content", "example": "Hello", "type": "string"}}, "type": "object"}, "ServiceDecorator": {"properties": {"recipientKeys": {"description": "List of recipient keys", "items": {"description": "Recipient public key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "type": "array"}, "routingKeys": {"description": "List of routing keys", "items": {"description": "Routing key", "example": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type": "string"}, "type": "array"}, "serviceEndpoint": {"description": "Service endpoint at which to reach this agent", "example": "http://192.168.56.101:8020", "type": "string"}}, "required": ["recipientKeys", "serviceEndpoint"], "type": "object"}, "SignRequest": {"properties": {"doc": {"$ref": "#/definitions/Doc"}, "verkey": {"description": "Verkey to use for signing", "type": "string"}}, "required": ["doc", "verkey"], "type": "object"}, "SignResponse": {"properties": {"error": {"description": "Error text", "type": "string"}, "signed_doc": {"description": "Signed document", "type": "object"}}, "type": "object"}, "SignatureOptions": {"properties": {"challenge": {"type": "string"}, "domain": {"type": "string"}, "proofPurpose": {"type": "string"}, "type": {"type": "string"}, "verificationMethod": {"type": "string"}}, "required": ["proofPurpose", "verificationMethod"], "type": "object"}, "SignedDoc": {"additionalProperties": true, "properties": {"proof": {"allOf": [{"$ref": "#/definitions/SignatureOptions"}], "description": "Linked data proof"}}, "required": ["proof"], "type": "object"}, "SubmissionRequirements": {"properties": {"count": {"description": "Count Value", "example": 1234, "type": "integer"}, "from": {"description": "From", "type": "string"}, "from_nested": {"items": {"$ref": "#/definitions/SubmissionRequirements"}, "type": "array"}, "max": {"description": "Max Value", "example": 1234, "type": "integer"}, "min": {"description": "Min Value", "example": 1234, "type": "integer"}, "name": {"description": "Name", "type": "string"}, "purpose": {"description": "Purpose", "type": "string"}, "rule": {"description": "Selection", "enum": ["all", "pick"], "type": "string"}}, "type": "object"}, "TAAAccept": {"properties": {"mechanism": {"type": "string"}, "text": {"type": "string"}, "version": {"type": "string"}}, "type": "object"}, "TAAAcceptance": {"properties": {"mechanism": {"type": "string"}, "time": {"example": 1640995199, "maximum": 18446744073709551615, "minimum": 0, "type": "integer"}}, "type": "object"}, "TAAInfo": {"properties": {"aml_record": {"$ref": "#/definitions/AMLRecord"}, "taa_accepted": {"$ref": "#/definitions/TAAAcceptance"}, "taa_record": {"$ref": "#/definitions/TAARecord"}, "taa_required": {"type": "boolean"}}, "type": "object"}, "TAARecord": {"properties": {"digest": {"type": "string"}, "text": {"type": "string"}, "version": {"type": "string"}}, "type": "object"}, "TAAResult": {"properties": {"result": {"$ref": "#/definitions/TAAInfo"}}, "type": "object"}, "TailsDeleteResponse": {"properties": {"message": {"type": "string"}}, "type": "object"}, "TransactionJobs": {"properties": {"transaction_my_job": {"description": "My transaction related job", "enum": ["TRANSACTION_AUTHOR", "TRANSACTION_ENDORSER", "reset"], "type": "string"}, "transaction_their_job": {"description": "Their transaction related job", "enum": ["TRANSACTION_AUTHOR", "TRANSACTION_ENDORSER", "reset"], "type": "string"}}, "type": "object"}, "TransactionList": {"properties": {"results": {"description": "List of transaction records", "items": {"$ref": "#/definitions/TransactionRecord"}, "type": "array"}}, "type": "object"}, "TransactionRecord": {"properties": {"_type": {"description": "Transaction type", "example": "101", "type": "string"}, "connection_id": {"description": "The connection identifier for this particular transaction record", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "endorser_write_txn": {"description": "Request Endorser to write the ledger transaction, this parameter is deprecated and no longer supported.", "example": false, "type": "boolean"}, "formats": {"items": {"additionalProperties": {"type": "string"}, "example": {"attach_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "format": "dif/endorse-transaction/request@v1.0"}, "type": "object"}, "type": "array"}, "messages_attach": {"items": {"example": {"@id": "143c458d-1b1c-40c7-ab85-4d16808ddf0a", "data": {"json": "{\"endorser\": \"V4SGRU86Z58d6TV7PBUe6f\",\"identifier\": \"LjgpST2rjsoxYegQDRm7EL\",\"operation\": {\"data\": {\"attr_names\": [\"first_name\", \"last_name\"],\"name\": \"test_schema\",\"version\": \"2.1\",},\"type\": \"101\",},\"protocolVersion\": 2,\"reqId\": 1597766666168851000,\"signatures\": {\"LjgpST2rjsox\": \"4ATKMn6Y9sTgwqaGTm7py2c2M8x1EVDTWKZArwyuPgjU\"}, \"taaAcceptance\": {\"mechanism\": \"manual\",\"taaDigest\": \"f50fe2c2ab977006761d36bd6f23e4c6a7e0fc2feb9f62\",\"time\": 1597708800,}}"}, "mime-type": "application/json"}, "type": "object"}, "type": "array"}, "meta_data": {"example": {"context": {"param1": "param1_value", "param2": "param2_value"}, "post_process": [{"topic": "topic_value", "other": "other_value"}]}, "type": "object"}, "signature_request": {"items": {"example": {"author_goal_code": "aries.transaction.ledger.write", "context": "did:sov", "method": "add-signature", "signature_type": "default", "signer_goal_code": "aries.transaction.endorse"}, "type": "object"}, "type": "array"}, "signature_response": {"items": {"example": {"context": "did:sov", "message_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "method": "add-signature", "signer_goal_code": "aries.transaction.refuse"}, "type": "object"}, "type": "array"}, "state": {"description": "Current record state", "example": "active", "type": "string"}, "thread_id": {"description": "Thread Identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "timing": {"example": {"expires_time": "2020-12-13T17:29:06+0000"}, "type": "object"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}, "transaction_id": {"description": "Transaction identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "type": "object"}, "TxnOrCredentialDefinitionSendResult": {"properties": {"sent": {"$ref": "#/definitions/CredentialDefinitionSendResult"}, "txn": {"allOf": [{"$ref": "#/definitions/TransactionRecord"}], "description": "Credential definition transaction to endorse"}}, "type": "object"}, "TxnOrPublishRevocationsResult": {"properties": {"rrid2crid": {"additionalProperties": {"items": {"description": "Credential revocation identifier", "example": "12345", "pattern": "^[1-9][0-9]*$", "type": "string"}, "type": "array"}, "description": "Credential revocation ids by revocation registry id", "type": "object"}, "txn": {"items": {"allOf": [{"$ref": "#/definitions/TransactionRecord"}], "description": "Revocation registry revocations transaction to endorse"}, "type": "array"}}, "type": "object"}, "TxnOrRegisterLedgerNymResponse": {"properties": {"success": {"description": "Success of nym registration operation", "example": true, "type": "boolean"}, "txn": {"allOf": [{"$ref": "#/definitions/TransactionRecord"}], "description": "DID transaction to endorse"}}, "type": "object"}, "TxnOrRevRegResult": {"properties": {"sent": {"$ref": "#/definitions/RevRegResult"}, "txn": {"allOf": [{"$ref": "#/definitions/TransactionRecord"}], "description": "Revocation registry definition transaction to endorse"}}, "type": "object"}, "TxnOrSchemaSendResult": {"properties": {"sent": {"allOf": [{"$ref": "#/definitions/SchemaSendResult"}], "description": "Content sent"}, "txn": {"allOf": [{"$ref": "#/definitions/TransactionRecord"}], "description": "Schema transaction to endorse"}}, "type": "object"}, "UpdateKeyRequest": {"properties": {"kid": {"description": "New kid to bind to the key pair, such as a verificationMethod.", "example": "did:web:example.com#key-02", "type": "string"}, "multikey": {"description": "Multikey of the key pair to update", "example": "z6MkgKA7yrw5kYSiDuQFcye4bMaJpcfHFry3Bx45pdWh3s8i", "type": "string"}}, "required": ["kid", "multikey"], "type": "object"}, "UpdateKeyResponse": {"properties": {"kid": {"description": "The associated kid", "example": "did:web:example.com#key-02", "type": "string"}, "multikey": {"description": "The Public Key Multibase format (multikey)", "example": "z6MkgKA7yrw5kYSiDuQFcye4bMaJpcfHFry3Bx45pdWh3s8i", "type": "string"}}, "type": "object"}, "UpdateProfileSettings": {"properties": {"extra_settings": {"description": "Agent config key-value pairs", "example": {"ACAPY_INVITE_PUBLIC": true, "log-level": "INFO", "public-invites": false}, "type": "object"}}, "type": "object"}, "UpdateWalletRequest": {"properties": {"extra_settings": {"description": "Agent config key-value pairs", "type": "object"}, "image_url": {"description": "Image url for this wallet. This image url is publicized (self-attested) to other agents as part of forming a connection.", "example": "https://aries.ca/images/sample.png", "type": "string"}, "label": {"description": "Label for this wallet. This label is publicized (self-attested) to other agents as part of forming a connection.", "example": "Alice", "type": "string"}, "wallet_dispatch_type": {"description": "Webhook target dispatch type for this wallet. default: Dispatch only to webhooks associated with this wallet. base: Dispatch only to webhooks associated with the base wallet. both: Dispatch to both webhook targets.", "enum": ["default", "both", "base"], "example": "default", "type": "string"}, "wallet_webhook_urls": {"description": "List of Webhook URLs associated with this subwallet", "items": {"description": "Optional webhook URL to receive webhook messages", "example": "http://localhost:8022/webhooks", "type": "string"}, "type": "array"}}, "type": "object"}, "UpgradeResult": {"properties": {}, "type": "object"}, "V10CredentialBoundOfferRequest": {"properties": {"counter_proposal": {"allOf": [{"$ref": "#/definitions/CredentialProposal"}], "description": "Optional counter-proposal"}}, "type": "object"}, "V10CredentialConnFreeOfferRequest": {"properties": {"auto_issue": {"description": "Whether to respond automatically to credential requests, creating and issuing requested credentials", "type": "boolean"}, "auto_remove": {"description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "credential_preview": {"$ref": "#/definitions/CredentialPreview"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}}, "required": ["cred_def_id", "credential_preview"], "type": "object"}, "V10CredentialCreate": {"properties": {"auto_remove": {"description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "credential_proposal": {"$ref": "#/definitions/CredentialPreview"}, "issuer_did": {"description": "Credential issuer DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "schema_issuer_did": {"description": "Schema issuer DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "schema_name": {"description": "Schema name", "example": "preferences", "type": "string"}, "schema_version": {"description": "Schema version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}}, "required": ["credential_proposal"], "type": "object"}, "V10CredentialExchange": {"properties": {"auto_issue": {"description": "Issuer choice to issue to request in this credential exchange", "example": false, "type": "boolean"}, "auto_offer": {"description": "Holder choice to accept offer in this credential exchange", "example": false, "type": "boolean"}, "auto_remove": {"description": "Issuer choice to remove this credential exchange record when complete", "example": false, "type": "boolean"}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "credential": {"allOf": [{"$ref": "#/definitions/IndyCredInfo"}], "description": "Credential as stored"}, "credential_definition_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "credential_exchange_id": {"description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "credential_id": {"description": "Credential identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "credential_offer": {"allOf": [{"$ref": "#/definitions/IndyCredAbstract"}], "description": "(Indy) credential offer"}, "credential_offer_dict": {"allOf": [{"$ref": "#/definitions/CredentialOffer"}], "description": "Credential offer message"}, "credential_proposal_dict": {"allOf": [{"$ref": "#/definitions/CredentialProposal"}], "description": "Credential proposal message"}, "credential_request": {"allOf": [{"$ref": "#/definitions/IndyCredRequest"}], "description": "(Indy) credential request"}, "credential_request_metadata": {"description": "(Indy) credential request metadata", "type": "object"}, "error_msg": {"description": "Error message", "example": "Credential definition identifier is not set in proposal", "type": "string"}, "initiator": {"description": "Issue-credential exchange initiator: self or external", "enum": ["self", "external"], "example": "self", "type": "string"}, "parent_thread_id": {"description": "Parent thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "raw_credential": {"allOf": [{"$ref": "#/definitions/IndyCredential"}], "description": "Credential as received, prior to storage in holder wallet"}, "revoc_reg_id": {"description": "Revocation registry identifier", "type": "string"}, "revocation_id": {"description": "Credential identifier within revocation registry", "type": "string"}, "role": {"description": "Issue-credential exchange role: holder or issuer", "enum": ["holder", "issuer"], "example": "issuer", "type": "string"}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "state": {"description": "Issue-credential exchange state", "example": "credential_acked", "type": "string"}, "thread_id": {"description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "type": "object"}, "V10CredentialExchangeAutoRemoveRequest": {"properties": {"auto_remove": {"description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}}, "type": "object"}, "V10CredentialExchangeListResult": {"properties": {"results": {"description": "Aries#0036 v1.0 credential exchange records", "items": {"$ref": "#/definitions/V10CredentialExchange"}, "type": "array"}}, "type": "object"}, "V10CredentialFreeOfferRequest": {"properties": {"auto_issue": {"description": "Whether to respond automatically to credential requests, creating and issuing requested credentials", "type": "boolean"}, "auto_remove": {"description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "credential_preview": {"$ref": "#/definitions/CredentialPreview"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}}, "required": ["connection_id", "cred_def_id", "credential_preview"], "type": "object"}, "V10CredentialIssueRequest": {"properties": {"comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}}, "type": "object"}, "V10CredentialProblemReportRequest": {"properties": {"description": {"type": "string"}}, "required": ["description"], "type": "object"}, "V10CredentialProposalRequestMand": {"properties": {"auto_remove": {"description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "credential_proposal": {"$ref": "#/definitions/CredentialPreview"}, "issuer_did": {"description": "Credential issuer DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "schema_issuer_did": {"description": "Schema issuer DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "schema_name": {"description": "Schema name", "example": "preferences", "type": "string"}, "schema_version": {"description": "Schema version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}}, "required": ["connection_id", "credential_proposal"], "type": "object"}, "V10CredentialProposalRequestOpt": {"properties": {"auto_remove": {"description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "credential_proposal": {"$ref": "#/definitions/CredentialPreview"}, "issuer_did": {"description": "Credential issuer DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "schema_issuer_did": {"description": "Schema issuer DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "schema_name": {"description": "Schema name", "example": "preferences", "type": "string"}, "schema_version": {"description": "Schema version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}}, "required": ["connection_id"], "type": "object"}, "V10CredentialStoreRequest": {"properties": {"credential_id": {"type": "string"}}, "type": "object"}, "V10DiscoveryExchangeListResult": {"properties": {"results": {"items": {"allOf": [{"$ref": "#/definitions/V10DiscoveryRecord"}], "description": "Discover Features v1.0 exchange record"}, "type": "array"}}, "type": "object"}, "V10DiscoveryRecord": {"properties": {"connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "disclose": {"allOf": [{"$ref": "#/definitions/Disclose"}], "description": "Disclose message"}, "discovery_exchange_id": {"description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "query_msg": {"allOf": [{"$ref": "#/definitions/Query"}], "description": "Query message"}, "state": {"description": "Current record state", "example": "active", "type": "string"}, "thread_id": {"description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "type": "object"}, "V10PresentProofModuleResponse": {"properties": {}, "type": "object"}, "V10PresentationCreateRequestRequest": {"properties": {"auto_remove": {"description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "auto_verify": {"description": "Verifier choice to auto-verify proof presentation", "example": false, "type": "boolean"}, "comment": {"type": "string", "x-nullable": true}, "proof_request": {"$ref": "#/definitions/IndyProofRequest"}, "trace": {"description": "Whether to trace event (default false)", "example": false, "type": "boolean"}}, "required": ["proof_request"], "type": "object"}, "V10PresentationExchange": {"properties": {"auto_present": {"description": "Prover choice to auto-present proof as verifier requests", "example": false, "type": "boolean"}, "auto_remove": {"description": "Verifier choice to remove this presentation exchange record when complete", "example": false, "type": "boolean"}, "auto_verify": {"description": "Verifier choice to auto-verify proof presentation", "type": "boolean"}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "error_msg": {"description": "Error message", "example": "Invalid structure", "type": "string"}, "initiator": {"description": "Present-proof exchange initiator: self or external", "enum": ["self", "external"], "example": "self", "type": "string"}, "presentation": {"allOf": [{"$ref": "#/definitions/IndyProof"}], "description": "(Indy) presentation (also known as proof)"}, "presentation_exchange_id": {"description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "presentation_proposal_dict": {"allOf": [{"$ref": "#/definitions/PresentationProposal"}], "description": "Presentation proposal message"}, "presentation_request": {"allOf": [{"$ref": "#/definitions/IndyProofRequest"}], "description": "(Indy) presentation request (also known as proof request)"}, "presentation_request_dict": {"allOf": [{"$ref": "#/definitions/PresentationRequest"}], "description": "Presentation request message"}, "role": {"description": "Present-proof exchange role: prover or verifier", "enum": ["prover", "verifier"], "example": "prover", "type": "string"}, "state": {"description": "Present-proof exchange state", "example": "verified", "type": "string"}, "thread_id": {"description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "verified": {"description": "Whether presentation is verified: true or false", "enum": ["true", "false"], "example": "true", "type": "string"}, "verified_msgs": {"items": {"description": "Proof verification warning or error information", "type": "string"}, "type": "array"}}, "type": "object"}, "V10PresentationExchangeList": {"properties": {"results": {"description": "Aries RFC 37 v1.0 presentation exchange records", "items": {"$ref": "#/definitions/V10PresentationExchange"}, "type": "array"}}, "type": "object"}, "V10PresentationProblemReportRequest": {"properties": {"description": {"type": "string"}}, "required": ["description"], "type": "object"}, "V10PresentationProposalRequest": {"properties": {"auto_present": {"description": "Whether to respond automatically to presentation requests, building and presenting requested proof", "type": "boolean"}, "auto_remove": {"description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "presentation_proposal": {"$ref": "#/definitions/IndyPresPreview"}, "trace": {"description": "Whether to trace event (default false)", "example": false, "type": "boolean"}}, "required": ["connection_id", "presentation_proposal"], "type": "object"}, "V10PresentationSendRequest": {"properties": {"auto_remove": {"description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "requested_attributes": {"additionalProperties": {"$ref": "#/definitions/IndyRequestedCredsRequestedAttr"}, "description": "Nested object mapping proof request attribute referents to requested-attribute specifiers", "type": "object"}, "requested_predicates": {"additionalProperties": {"$ref": "#/definitions/IndyRequestedCredsRequestedPred"}, "description": "Nested object mapping proof request predicate referents to requested-predicate specifiers", "type": "object"}, "self_attested_attributes": {"additionalProperties": {"description": "Self-attested attribute values to use in requested-credentials structure for proof construction", "example": "self_attested_value", "type": "string"}, "description": "Self-attested attributes to build into proof", "type": "object"}, "trace": {"description": "Whether to trace event (default false)", "example": false, "type": "boolean"}}, "required": ["requested_attributes", "requested_predicates", "self_attested_attributes"], "type": "object"}, "V10PresentationSendRequestRequest": {"properties": {"auto_remove": {"description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "auto_verify": {"description": "Verifier choice to auto-verify proof presentation", "example": false, "type": "boolean"}, "comment": {"type": "string", "x-nullable": true}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "proof_request": {"$ref": "#/definitions/IndyProofRequest"}, "trace": {"description": "Whether to trace event (default false)", "example": false, "type": "boolean"}}, "required": ["connection_id", "proof_request"], "type": "object"}, "V10PresentationSendRequestToProposal": {"properties": {"auto_remove": {"description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "auto_verify": {"description": "Verifier choice to auto-verify proof presentation", "example": false, "type": "boolean"}, "trace": {"description": "Whether to trace event (default false)", "example": false, "type": "boolean"}}, "type": "object"}, "V20CredAttrSpec": {"properties": {"mime-type": {"description": "MIME type: omit for (null) default", "example": "image/jpeg", "type": "string", "x-nullable": true}, "name": {"description": "Attribute name", "example": "favourite_drink", "type": "string"}, "value": {"description": "Attribute value: base64-encode if MIME type is present", "example": "martini", "type": "string"}}, "required": ["name", "value"], "type": "object"}, "V20CredBoundOfferRequest": {"properties": {"counter_preview": {"allOf": [{"$ref": "#/definitions/V20CredPreview"}], "description": "Optional content for counter-proposal"}, "filter": {"allOf": [{"$ref": "#/definitions/V20CredFilter"}], "description": "Credential specification criteria by format"}}, "type": "object"}, "V20CredExFree": {"properties": {"auto_remove": {"description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "credential_preview": {"$ref": "#/definitions/V20CredPreview"}, "filter": {"allOf": [{"$ref": "#/definitions/V20CredFilter"}], "description": "Credential specification criteria by format"}, "replacement_id": {"description": "Optional identifier used to manage credential replacement", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string", "x-nullable": true}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}, "verification_method": {"description": "For ld-proofs. Verification method for signing.", "type": "string", "x-nullable": true}}, "required": ["connection_id", "filter"], "type": "object"}, "V20CredExRecord": {"properties": {"auto_issue": {"description": "Issuer choice to issue to request in this credential exchange", "example": false, "type": "boolean"}, "auto_offer": {"description": "Holder choice to accept offer in this credential exchange", "example": false, "type": "boolean"}, "auto_remove": {"description": "Issuer choice to remove this credential exchange record when complete", "example": false, "type": "boolean"}, "by_format": {"allOf": [{"$ref": "#/definitions/V20CredExRecordByFormat"}], "description": "Attachment content by format for proposal, offer, request, and issue", "readOnly": true}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "cred_ex_id": {"description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "cred_issue": {"allOf": [{"$ref": "#/definitions/V20CredIssue"}], "description": "Serialized credential issue message"}, "cred_offer": {"allOf": [{"$ref": "#/definitions/V20CredOffer"}], "description": "Credential offer message"}, "cred_preview": {"allOf": [{"$ref": "#/definitions/V20CredPreview"}], "description": "Credential preview from credential proposal", "readOnly": true}, "cred_proposal": {"allOf": [{"$ref": "#/definitions/V20CredProposal"}], "description": "Credential proposal message"}, "cred_request": {"allOf": [{"$ref": "#/definitions/V20CredRequest"}], "description": "Serialized credential request message"}, "error_msg": {"description": "Error message", "example": "The front fell off", "type": "string"}, "initiator": {"description": "Issue-credential exchange initiator: self or external", "enum": ["self", "external"], "example": "self", "type": "string"}, "parent_thread_id": {"description": "Parent thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "role": {"description": "Issue-credential exchange role: holder or issuer", "enum": ["issuer", "holder"], "example": "issuer", "type": "string"}, "state": {"description": "Issue-credential exchange state", "enum": ["proposal-sent", "proposal-received", "offer-sent", "offer-received", "request-sent", "request-received", "credential-issued", "credential-received", "done", "credential-revoked", "abandoned", "deleted"], "example": "done", "type": "string"}, "thread_id": {"description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "type": "object"}, "V20CredExRecordByFormat": {"properties": {"cred_issue": {"type": "object"}, "cred_offer": {"type": "object"}, "cred_proposal": {"type": "object"}, "cred_request": {"type": "object"}}, "type": "object"}, "V20CredExRecordDetail": {"properties": {"cred_ex_record": {"allOf": [{"$ref": "#/definitions/V20CredExRecord"}], "description": "Credential exchange record"}, "indy": {"$ref": "#/definitions/V20CredExRecordIndy"}, "ld_proof": {"$ref": "#/definitions/V20CredExRecordLDProof"}, "vc_di": {"$ref": "#/definitions/V20CredExRecord"}}, "type": "object"}, "V20CredExRecordIndy": {"properties": {"created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "cred_ex_id": {"description": "Corresponding v2.0 credential exchange record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "cred_ex_indy_id": {"description": "Record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "cred_id_stored": {"description": "Credential identifier stored in wallet", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "cred_request_metadata": {"description": "Credential request metadata for indy holder", "type": "object"}, "cred_rev_id": {"description": "Credential revocation identifier within revocation registry", "example": "12345", "pattern": "^[1-9][0-9]*$", "type": "string"}, "rev_reg_id": {"description": "Revocation registry identifier", "example": "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", "type": "string"}, "state": {"description": "Current record state", "example": "active", "type": "string"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "type": "object"}, "V20CredExRecordLDProof": {"properties": {"created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "cred_ex_id": {"description": "Corresponding v2.0 credential exchange record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "cred_ex_ld_proof_id": {"description": "Record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "cred_id_stored": {"description": "Credential identifier stored in wallet", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "state": {"description": "Current record state", "example": "active", "type": "string"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "type": "object"}, "V20CredExRecordListResult": {"properties": {"results": {"description": "Credential exchange records and corresponding detail records", "items": {"$ref": "#/definitions/V20CredExRecordDetail"}, "type": "array"}}, "type": "object"}, "V20CredFilter": {"properties": {"indy": {"allOf": [{"$ref": "#/definitions/V20CredFilterIndy"}], "description": "Credential filter for indy"}, "ld_proof": {"allOf": [{"$ref": "#/definitions/LDProofVCDetail"}], "description": "Credential filter for linked data proof"}, "vc_di": {"allOf": [{"$ref": "#/definitions/V20CredFilterVCDI"}], "description": "Credential filter for vc_di"}}, "type": "object"}, "V20CredFilterIndy": {"properties": {"cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "issuer_did": {"description": "Credential issuer DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "schema_issuer_did": {"description": "Schema issuer DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "schema_name": {"description": "Schema name", "example": "preferences", "type": "string"}, "schema_version": {"description": "Schema version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "type": "object"}, "V20CredFilterLDProof": {"properties": {"ld_proof": {"allOf": [{"$ref": "#/definitions/LDProofVCDetail"}], "description": "Credential filter for linked data proof"}}, "required": ["ld_proof"], "type": "object"}, "V20CredFilterVCDI": {"properties": {"cred_def_id": {"description": "Credential definition identifier", "example": "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", "pattern": "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", "type": "string"}, "issuer_did": {"description": "Credential issuer DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "schema_id": {"description": "Schema identifier", "example": "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", "pattern": "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", "type": "string"}, "schema_issuer_did": {"description": "Schema issuer DID", "example": "WgWxqztrNooG92RXvxSTWv", "pattern": "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", "type": "string"}, "schema_name": {"description": "Schema name", "example": "preferences", "type": "string"}, "schema_version": {"description": "Schema version", "example": "1.0", "pattern": "^[0-9.]+$", "type": "string"}}, "type": "object"}, "V20CredFormat": {"properties": {"attach_id": {"description": "Attachment identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "format": {"description": "Attachment format specifier", "example": "aries/ld-proof-vc-detail@v1.0", "type": "string"}}, "required": ["attach_id", "format"], "type": "object"}, "V20CredIssue": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "credentials~attach": {"description": "Credential attachments", "items": {"$ref": "#/definitions/AttachDecorator"}, "type": "array"}, "formats": {"description": "Acceptable attachment formats", "items": {"$ref": "#/definitions/V20CredFormat"}, "type": "array"}, "replacement_id": {"description": "Issuer-unique identifier to coordinate credential replacement", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}}, "required": ["credentials~attach", "formats"], "type": "object"}, "V20CredIssueProblemReportRequest": {"properties": {"description": {"type": "string"}}, "required": ["description"], "type": "object"}, "V20CredIssueRequest": {"properties": {"comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}}, "type": "object"}, "V20CredOffer": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "credential_preview": {"$ref": "#/definitions/V20CredPreview"}, "formats": {"description": "Acceptable credential formats", "items": {"$ref": "#/definitions/V20CredFormat"}, "type": "array"}, "offers~attach": {"description": "Offer attachments", "items": {"$ref": "#/definitions/AttachDecorator"}, "type": "array"}, "replacement_id": {"description": "Issuer-unique identifier to coordinate credential replacement", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}}, "required": ["formats", "offers~attach"], "type": "object"}, "V20CredOfferConnFreeRequest": {"properties": {"auto_issue": {"description": "Whether to respond automatically to credential requests, creating and issuing requested credentials", "type": "boolean"}, "auto_remove": {"description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "credential_preview": {"$ref": "#/definitions/V20CredPreview"}, "filter": {"allOf": [{"$ref": "#/definitions/V20CredFilter"}], "description": "Credential specification criteria by format"}, "replacement_id": {"description": "Optional identifier used to manage credential replacement", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string", "x-nullable": true}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}}, "required": ["filter"], "type": "object"}, "V20CredOfferRequest": {"properties": {"auto_issue": {"description": "Whether to respond automatically to credential requests, creating and issuing requested credentials", "type": "boolean"}, "auto_remove": {"description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "credential_preview": {"$ref": "#/definitions/V20CredPreview"}, "filter": {"allOf": [{"$ref": "#/definitions/V20CredFilter"}], "description": "Credential specification criteria by format"}, "replacement_id": {"description": "Optional identifier used to manage credential replacement", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string", "x-nullable": true}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}}, "required": ["connection_id", "filter"], "type": "object"}, "V20CredPreview": {"properties": {"@type": {"description": "Message type identifier", "example": "issue-credential/2.0/credential-preview", "type": "string"}, "attributes": {"items": {"$ref": "#/definitions/V20CredAttrSpec"}, "type": "array"}}, "required": ["attributes"], "type": "object"}, "V20CredProposal": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "credential_preview": {"allOf": [{"$ref": "#/definitions/V20CredPreview"}], "description": "Credential preview"}, "filters~attach": {"description": "Credential filter per acceptable format on corresponding identifier", "items": {"$ref": "#/definitions/AttachDecorator"}, "type": "array"}, "formats": {"description": "Attachment formats", "items": {"$ref": "#/definitions/V20CredFormat"}, "type": "array"}}, "required": ["filters~attach", "formats"], "type": "object"}, "V20CredRequest": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "formats": {"description": "Acceptable attachment formats", "items": {"$ref": "#/definitions/V20CredFormat"}, "type": "array"}, "requests~attach": {"description": "Request attachments", "items": {"$ref": "#/definitions/AttachDecorator"}, "type": "array"}}, "required": ["formats", "requests~attach"], "type": "object"}, "V20CredRequestFree": {"properties": {"auto_remove": {"description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "filter": {"allOf": [{"$ref": "#/definitions/V20CredFilterLDProof"}], "description": "Credential specification criteria by format"}, "holder_did": {"description": "Holder DID to substitute for the credentialSubject.id", "example": "did:key:ahsdkjahsdkjhaskjdhakjshdkajhsdkjahs", "type": "string", "x-nullable": true}, "trace": {"description": "Whether to trace event (default false)", "example": false, "type": "boolean"}}, "required": ["connection_id", "filter"], "type": "object"}, "V20CredRequestRequest": {"properties": {"auto_remove": {"description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "holder_did": {"description": "Holder DID to substitute for the credentialSubject.id", "example": "did:key:ahsdkjahsdkjhaskjdhakjshdkajhsdkjahs", "type": "string", "x-nullable": true}}, "type": "object"}, "V20CredStoreRequest": {"properties": {"credential_id": {"type": "string"}}, "type": "object"}, "V20DiscoveryExchangeListResult": {"properties": {"results": {"items": {"allOf": [{"$ref": "#/definitions/V20DiscoveryRecord"}], "description": "Discover Features v2.0 exchange record"}, "type": "array"}}, "type": "object"}, "V20DiscoveryExchangeResult": {"properties": {"results": {"allOf": [{"$ref": "#/definitions/V20DiscoveryRecord"}], "description": "Discover Features v2.0 exchange record"}}, "type": "object"}, "V20DiscoveryRecord": {"properties": {"connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "disclosures": {"allOf": [{"$ref": "#/definitions/Disclosures"}], "description": "Disclosures message"}, "discovery_exchange_id": {"description": "Credential exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "queries_msg": {"allOf": [{"$ref": "#/definitions/Queries"}], "description": "Queries message"}, "state": {"description": "Current record state", "example": "active", "type": "string"}, "thread_id": {"description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}}, "type": "object"}, "V20IssueCredSchemaCore": {"properties": {"auto_remove": {"description": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "credential_preview": {"$ref": "#/definitions/V20CredPreview"}, "filter": {"allOf": [{"$ref": "#/definitions/V20CredFilter"}], "description": "Credential specification criteria by format"}, "replacement_id": {"description": "Optional identifier used to manage credential replacement", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string", "x-nullable": true}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}}, "required": ["filter"], "type": "object"}, "V20IssueCredentialModuleResponse": {"properties": {}, "type": "object"}, "V20Pres": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "formats": {"description": "Acceptable attachment formats", "items": {"$ref": "#/definitions/V20PresFormat"}, "type": "array"}, "presentations~attach": {"items": {"$ref": "#/definitions/AttachDecorator"}, "type": "array"}}, "required": ["formats", "presentations~attach"], "type": "object"}, "V20PresCreateRequestRequest": {"properties": {"auto_remove": {"description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "auto_verify": {"description": "Verifier choice to auto-verify proof presentation", "example": false, "type": "boolean"}, "comment": {"type": "string", "x-nullable": true}, "presentation_request": {"$ref": "#/definitions/V20PresRequestByFormat"}, "trace": {"description": "Whether to trace event (default false)", "example": false, "type": "boolean"}}, "required": ["presentation_request"], "type": "object"}, "V20PresExRecord": {"properties": {"auto_present": {"description": "Prover choice to auto-present proof as verifier requests", "example": false, "type": "boolean"}, "auto_remove": {"description": "Verifier choice to remove this presentation exchange record when complete", "example": false, "type": "boolean"}, "auto_verify": {"description": "Verifier choice to auto-verify proof presentation", "type": "boolean"}, "by_format": {"allOf": [{"$ref": "#/definitions/V20PresExRecordByFormat"}], "description": "Attachment content by format for proposal, request, and presentation", "readOnly": true}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "error_msg": {"description": "Error message", "example": "Invalid structure", "type": "string"}, "initiator": {"description": "Present-proof exchange initiator: self or external", "enum": ["self", "external"], "example": "self", "type": "string"}, "pres": {"allOf": [{"$ref": "#/definitions/V20Pres"}], "description": "Presentation message"}, "pres_ex_id": {"description": "Presentation exchange identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "pres_proposal": {"allOf": [{"$ref": "#/definitions/V20PresProposal"}], "description": "Presentation proposal message"}, "pres_request": {"allOf": [{"$ref": "#/definitions/V20PresRequest"}], "description": "Presentation request message"}, "role": {"description": "Present-proof exchange role: prover or verifier", "enum": ["prover", "verifier"], "example": "prover", "type": "string"}, "state": {"description": "Present-proof exchange state", "enum": ["proposal-sent", "proposal-received", "request-sent", "request-received", "presentation-sent", "presentation-received", "done", "abandoned", "deleted"], "type": "string"}, "thread_id": {"description": "Thread identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "verified": {"description": "Whether presentation is verified: 'true' or 'false'", "enum": ["true", "false"], "example": "true", "type": "string"}, "verified_msgs": {"items": {"description": "Proof verification warning or error information", "type": "string"}, "type": "array"}}, "type": "object"}, "V20PresExRecordByFormat": {"properties": {"pres": {"type": "object"}, "pres_proposal": {"type": "object"}, "pres_request": {"type": "object"}}, "type": "object"}, "V20PresExRecordList": {"properties": {"results": {"description": "Presentation exchange records", "items": {"$ref": "#/definitions/V20PresExRecord"}, "type": "array"}}, "type": "object"}, "V20PresFormat": {"properties": {"attach_id": {"description": "Attachment identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "format": {"description": "Attachment format specifier", "example": "dif/presentation-exchange/submission@v1.0", "type": "string"}}, "required": ["attach_id", "format"], "type": "object"}, "V20PresProblemReportRequest": {"properties": {"description": {"type": "string"}}, "required": ["description"], "type": "object"}, "V20PresProposal": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string"}, "formats": {"description": "Acceptable attachment formats", "items": {"$ref": "#/definitions/V20PresFormat"}, "type": "array"}, "proposals~attach": {"description": "Attachment per acceptable format on corresponding identifier", "items": {"$ref": "#/definitions/AttachDecorator"}, "type": "array"}}, "required": ["formats", "proposals~attach"], "type": "object"}, "V20PresProposalByFormat": {"properties": {"dif": {"allOf": [{"$ref": "#/definitions/DIFProofProposal"}], "description": "Presentation proposal for DIF"}, "indy": {"allOf": [{"$ref": "#/definitions/IndyProofRequest"}], "description": "Presentation proposal for indy"}}, "type": "object"}, "V20PresProposalRequest": {"properties": {"auto_present": {"description": "Whether to respond automatically to presentation requests, building and presenting requested proof", "type": "boolean"}, "auto_remove": {"description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "comment": {"description": "Human-readable comment", "type": "string", "x-nullable": true}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "presentation_proposal": {"$ref": "#/definitions/V20PresProposalByFormat"}, "trace": {"description": "Whether to trace event (default false)", "example": false, "type": "boolean"}}, "required": ["connection_id", "presentation_proposal"], "type": "object"}, "V20PresRequest": {"properties": {"@id": {"description": "Message identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "@type": {"description": "Message type", "example": "https://didcomm.org/my-family/1.0/my-message-type", "type": "string"}, "comment": {"description": "Human-readable comment", "type": "string"}, "formats": {"description": "Acceptable attachment formats", "items": {"$ref": "#/definitions/V20PresFormat"}, "type": "array"}, "request_presentations~attach": {"description": "Attachment per acceptable format on corresponding identifier", "items": {"$ref": "#/definitions/AttachDecorator"}, "type": "array"}, "will_confirm": {"description": "Whether verifier will send confirmation ack", "type": "boolean"}}, "required": ["formats", "request_presentations~attach"], "type": "object"}, "V20PresRequestByFormat": {"properties": {"dif": {"allOf": [{"$ref": "#/definitions/DIFProofRequest"}], "description": "Presentation request for DIF"}, "indy": {"allOf": [{"$ref": "#/definitions/IndyProofRequest"}], "description": "Presentation request for indy"}}, "type": "object"}, "V20PresSendRequestRequest": {"properties": {"auto_remove": {"description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "auto_verify": {"description": "Verifier choice to auto-verify proof presentation", "example": false, "type": "boolean"}, "comment": {"type": "string", "x-nullable": true}, "connection_id": {"description": "Connection identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "presentation_request": {"$ref": "#/definitions/V20PresRequestByFormat"}, "trace": {"description": "Whether to trace event (default false)", "example": false, "type": "boolean"}}, "required": ["connection_id", "presentation_request"], "type": "object"}, "V20PresSpecByFormatRequest": {"properties": {"auto_remove": {"description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "dif": {"allOf": [{"$ref": "#/definitions/DIFPresSpec"}], "description": "Optional Presentation specification for DIF, overrides the PresentationExchange record's PresRequest"}, "indy": {"allOf": [{"$ref": "#/definitions/IndyPresSpec"}], "description": "Presentation specification for indy"}, "trace": {"description": "Record trace information, based on agent configuration", "type": "boolean"}}, "type": "object"}, "V20PresentProofModuleResponse": {"properties": {}, "type": "object"}, "V20PresentationSendRequestToProposal": {"properties": {"auto_remove": {"description": "Whether to remove the presentation exchange record on completion (overrides --preserve-exchange-records configuration setting)", "type": "boolean"}, "auto_verify": {"description": "Verifier choice to auto-verify proof presentation", "example": false, "type": "boolean"}, "trace": {"description": "Whether to trace event (default false)", "example": false, "type": "boolean"}}, "type": "object"}, "VCRecord": {"properties": {"contexts": {"items": {"description": "Context", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "type": "array"}, "cred_tags": {"additionalProperties": {"description": "Retrieval tag value", "type": "string"}, "type": "object"}, "cred_value": {"description": "(JSON-serializable) credential value", "type": "object"}, "expanded_types": {"items": {"description": "JSON-LD expanded type extracted from type and context", "example": "https://w3id.org/citizenship#PermanentResidentCard", "type": "string"}, "type": "array"}, "given_id": {"description": "Credential identifier", "example": "http://example.edu/credentials/3732", "type": "string"}, "issuer_id": {"description": "Issuer identifier", "example": "https://example.edu/issuers/14", "type": "string"}, "proof_types": {"items": {"description": "Signature suite used for proof", "example": "Ed25519Signature2018", "type": "string"}, "type": "array"}, "record_id": {"description": "Record identifier", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}, "schema_ids": {"items": {"description": "Schema identifier", "example": "https://example.org/examples/degree.json", "type": "string"}, "type": "array"}, "subject_ids": {"items": {"description": "Subject identifier", "example": "did:example:ebfeb1f712ebc6f1c276e12ec21", "type": "string"}, "type": "array"}}, "type": "object"}, "VCRecordList": {"properties": {"results": {"items": {"$ref": "#/definitions/VCRecord"}, "type": "array"}}, "type": "object"}, "VerifiableCredential": {"additionalProperties": true, "properties": {"@context": {"description": "The JSON-LD context of the credential", "example": ["https://www.w3.org/2018/credentials/v1", "https://www.w3.org/2018/credentials/examples/v1"], "items": {}, "type": "array"}, "credentialStatus": {"example": {"id": "https://example.com/credentials/status/3#94567", "statusListCredential": "https://example.com/credentials/status/3", "statusListIndex": "94567", "statusPurpose": "revocation", "type": "BitstringStatusListEntry"}}, "credentialSubject": {"example": {"alumniOf": {"id": "did:example:c276e12ec21ebfeb1f712ebc6f1"}, "id": "did:example:ebfeb1f712ebc6f1c276e12ec21"}}, "expirationDate": {"description": "The expiration date", "example": "2010-01-01T19:23:24Z", "pattern": "^([0-9]{4})-([0-9]{2})-([0-9]{2})([Tt ]([0-9]{2}):([0-9]{2}):([0-9]{2})(\\.[0-9]+)?)?(([Zz]|([+-])([0-9]{2}):([0-9]{2})))?$", "type": "string"}, "id": {"description": "The ID of the credential", "example": "http://example.edu/credentials/1872", "pattern": "\\w+:(\\/?\\/?)[^\\s]+", "type": "string"}, "issuanceDate": {"description": "The issuance date", "example": "2010-01-01T19:23:24Z", "pattern": "^([0-9]{4})-([0-9]{2})-([0-9]{2})([Tt ]([0-9]{2}):([0-9]{2}):([0-9]{2})(\\.[0-9]+)?)?(([Zz]|([+-])([0-9]{2}):([0-9]{2})))?$", "type": "string"}, "issuer": {"description": "The JSON-LD Verifiable Credential Issuer. Either string of object with id field.", "example": "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH"}, "proof": {"allOf": [{"$ref": "#/definitions/LinkedDataProof"}], "description": "The proof of the credential", "example": {"created": "2019-12-11T03:50:55", "jws": "eyJhbGciOiAiRWREU0EiLCAiYjY0IjogZmFsc2UsICJjcml0JiNjQiXX0..lKJU0Df_keblRKhZAS9Qq6zybm-HqUXNVZ8vgEPNTAjQKBhQDxvXNo7nvtUBb_Eq1Ch6YBKY5qBQ", "proofPurpose": "assertionMethod", "type": "Ed25519Signature2018", "verificationMethod": "did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL"}}, "type": {"description": "The JSON-LD type of the credential", "example": ["VerifiableCredential", "AlumniCredential"], "items": {"type": "string"}, "type": "array"}}, "required": ["@context", "credentialSubject", "issuanceDate", "issuer", "proof", "type"], "type": "object"}, "VerifiablePresentation": {"additionalProperties": true, "properties": {"@context": {"description": "The JSON-LD context of the presentation", "example": ["https://www.w3.org/2018/credentials/v1"], "items": {}, "type": "array"}, "holder": {"description": "The JSON-LD Verifiable Credential Holder. Either string of object with id field.", "example": "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH"}, "id": {"description": "The ID of the presentation", "example": "http://example.edu/presentations/1872", "pattern": "\\w+:(\\/?\\/?)[^\\s]+", "type": "string"}, "proof": {"allOf": [{"$ref": "#/definitions/LinkedDataProof"}], "description": "The proof of the presentation", "example": {"created": "2019-12-11T03:50:55", "jws": "eyJhbGciOiAiRWREU0EiLCAiYjY0IjogZmFsc2UsICJjcml0JiNjQiXX0..lKJU0Df_keblRKhZAS9Qq6zybm-HqUXNVZ8vgEPNTAjQKBhQDxvXNo7nvtUBb_Eq1Ch6YBKY5qBQ", "proofPurpose": "assertionMethod", "type": "Ed25519Signature2018", "verificationMethod": "did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL"}}, "type": {"description": "The JSON-LD type of the presentation", "example": ["VerifiablePresentation"], "items": {"type": "string"}, "type": "array"}, "verifiableCredential": {"items": {"type": "object"}, "type": "array"}}, "required": ["@context", "proof", "type"], "type": "object"}, "VerifyCredentialRequest": {"properties": {"options": {"$ref": "#/definitions/LDProofVCOptions"}, "verifiableCredential": {"$ref": "#/definitions/VerifiableCredential"}}, "type": "object"}, "VerifyCredentialResponse": {"properties": {"results": {"$ref": "#/definitions/PresentationVerificationResult"}}, "type": "object"}, "VerifyDiRequest": {"properties": {"securedDocument": {"example": {"hello": "world", "proof": [{"cryptosuite": "eddsa-jcs-2022", "proofPurpose": "assertionMethod", "type": "DataIntegrityProof", "verificationMethod": "did:key: z6MksxraKwH8GR7NKeQ4HVZAeRKvD76kfd6G7jm8MscbDmy8# z6MksxraKwH8GR7NKeQ4HVZAeRKvD76kfd6G7jm8MscbDmy8", "proofValue": "zHtda8vV7kJQUPfSKiTGSQDhZfhkgtpnVziT7cdEzhu fjPjbeRmysHvizMJEox1eHR7xUGzNUj1V4yaKiLw7UA6E"}]}, "type": "object"}}, "required": ["securedDocument"], "type": "object"}, "VerifyDiResponse": {"properties": {"verified": {"description": "Verified", "example": true, "type": "boolean"}}, "type": "object"}, "VerifyPresentationRequest": {"properties": {"options": {"$ref": "#/definitions/LDProofVCOptions"}, "verifiablePresentation": {"$ref": "#/definitions/VerifiablePresentation"}}, "type": "object"}, "VerifyPresentationResponse": {"properties": {"results": {"$ref": "#/definitions/PresentationVerificationResult"}}, "type": "object"}, "VerifyRequest": {"properties": {"doc": {"allOf": [{"$ref": "#/definitions/SignedDoc"}], "description": "Signed document"}, "verkey": {"description": "Verkey to use for doc verification", "type": "string"}}, "required": ["doc"], "type": "object"}, "VerifyResponse": {"properties": {"error": {"description": "Error text", "type": "string"}, "valid": {"type": "boolean"}}, "required": ["valid"], "type": "object"}, "W3CCredentialsListRequest": {"properties": {"contexts": {"items": {"description": "Credential context to match", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "type": "array"}, "given_id": {"description": "Given credential id to match", "type": "string"}, "issuer_id": {"description": "Credential issuer identifier to match", "type": "string"}, "max_results": {"description": "Maximum number of results to return", "type": "integer"}, "proof_types": {"items": {"description": "Signature suite used for proof", "example": "Ed25519Signature2018", "type": "string"}, "type": "array"}, "schema_ids": {"description": "Schema identifiers, all of which to match", "items": {"description": "Credential schema identifier", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "type": "array"}, "subject_ids": {"description": "Subject identifiers, all of which to match", "items": {"description": "Subject identifier", "type": "string"}, "type": "array"}, "tag_query": {"additionalProperties": {"description": "Tag value", "type": "string"}, "description": "Tag filter", "type": "object"}, "types": {"items": {"description": "Credential type to match", "example": "https://myhost:8021", "pattern": "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", "type": "string"}, "type": "array"}}, "type": "object"}, "WalletList": {"properties": {"results": {"description": "List of wallet records", "items": {"$ref": "#/definitions/WalletRecord"}, "type": "array"}}, "type": "object"}, "WalletModuleResponse": {"properties": {}, "type": "object"}, "WalletRecord": {"properties": {"created_at": {"description": "Time of record creation", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "key_management_mode": {"description": "Mode regarding management of wallet key", "enum": ["managed", "unmanaged"], "type": "string"}, "settings": {"description": "Settings for this wallet.", "type": "object"}, "state": {"description": "Current record state", "example": "active", "type": "string"}, "updated_at": {"description": "Time of last record update", "example": "2021-12-31T23:59:59Z", "pattern": "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", "type": "string"}, "wallet_id": {"description": "Wallet record ID", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string"}}, "required": ["key_management_mode", "wallet_id"], "type": "object"}, "WriteLedger": {"properties": {"ledger_id": {"type": "string"}}, "type": "object"}}, "securityDefinitions": {"AuthorizationHeader": {"type": "apiKey", "in": "header", "name": "Authorization", "description": "Bearer token. Be sure to prepend token with 'Bearer '"}}, "security": [{"AuthorizationHeader": []}], "tags": [{"name": "action-menu", "description": "Menu interaction over connection"}, {"name": "anoncreds - credential definitions", "description": "Anoncreds credential definition management", "externalDocs": {"description": "Specification", "url": "https://hyperledger.github.io/anoncreds-spec"}}, {"name": "anoncreds - revocation", "description": "Revocation registry management", "externalDocs": {"description": "Overview", "url": "https://github.com/hyperledger/indy-hipe/tree/master/text/0011-cred-revocation"}}, {"name": "anoncreds - schemas", "description": "Anoncreds schema management", "externalDocs": {"description": "Specification", "url": "https://hyperledger.github.io/anoncreds-spec"}}, {"name": "anoncreds - wallet upgrade", "description": "Anoncreds wallet upgrade", "externalDocs": {"description": "Specification", "url": "https://hyperledger.github.io/anoncreds-spec"}}, {"name": "basicmessage", "description": "Simple messaging", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/527849ec3aa2a8fd47a7bb6c57f918ff8bcb5e8c/features/0095-basic-message"}}, {"name": "connection", "description": "Connection management", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/9b0aaa39df7e8bd434126c4b33c097aae78d65bf/features/0160-connection-protocol"}}, {"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": "credentials", "description": "Holder credential management", "externalDocs": {"description": "Overview", "url": "https://w3c.github.io/vc-data-model/#credentials"}}, {"name": "did-exchange", "description": "Connection management via DID exchange", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/25464a5c8f8a17b14edaa4310393df6094ace7b0/features/0023-did-exchange"}}, {"name": "did-rotate", "description": "Rotate a DID", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/main/features/0794-did-rotate"}}, {"name": "discover-features", "description": "Feature discovery", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/b3a3942ef052039e73cd23d847f42947f8287da2/features/0031-discover-features"}}, {"name": "discover-features v2.0", "description": "Feature discovery v2", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/b3a3942ef052039e73cd23d847f42947f8287da2/features/0557-discover-features-v2"}}, {"name": "endorse-transaction", "description": "Endorse a Transaction"}, {"name": "introduction", "description": "Introduction of known parties"}, {"name": "issue-credential v1.0", "description": "Credential issue v1.0", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/bb42a6c35e0d5543718fb36dd099551ab192f7b0/features/0036-issue-credential"}}, {"name": "issue-credential v2.0", "description": "Credential issue v2.0", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/cd27fc64aa2805f756a118043d7c880354353047/features/0453-issue-credential-v2"}}, {"name": "jsonld", "description": "Sign and verify json-ld data", "externalDocs": {"description": "Specification", "url": "https://tools.ietf.org/html/rfc7515"}}, {"name": "ledger", "description": "Interaction with ledger", "externalDocs": {"description": "Overview", "url": "https://hyperledger-indy.readthedocs.io/projects/plenum/en/latest/storage.html#ledger"}}, {"name": "mediation", "description": "Mediation management", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/fa8dc4ea1e667eb07db8f9ffeaf074a4455697c0/features/0211-route-coordination"}}, {"name": "multitenancy", "description": "Multitenant wallet management"}, {"name": "out-of-band", "description": "Out-of-band connections", "externalDocs": {"description": "Design", "url": "https://github.com/hyperledger/aries-rfcs/tree/2da7fc4ee043effa3a9960150e7ba8c9a4628b68/features/0434-outofband"}}, {"name": "present-proof v1.0", "description": "Proof presentation v1.0", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/4fae574c03f9f1013db30bf2c0c676b1122f7149/features/0037-present-proof"}}, {"name": "present-proof v2.0", "description": "Proof presentation v2.0", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/eace815c3e8598d4a8dd7881d8c731fdb2bcc0aa/features/0454-present-proof-v2"}}, {"name": "resolver", "description": "did resolver interface.", "externalDocs": {"description": "DID Resolution Specification", "url": "https://www.w3.org/TR/did-core/#resolution"}}, {"name": "revocation", "description": "Revocation registry management", "externalDocs": {"description": "Overview", "url": "https://github.com/hyperledger/indy-hipe/tree/master/text/0011-cred-revocation"}}, {"name": "schema", "description": "Schema operations", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/indy-node/blob/master/design/anoncreds.md#schema"}}, {"name": "settings", "description": "Agent settings interface."}, {"name": "trustping", "description": "Trust-ping over connection", "externalDocs": {"description": "Specification", "url": "https://github.com/hyperledger/aries-rfcs/tree/527849ec3aa2a8fd47a7bb6c57f918ff8bcb5e8c/features/0048-trust-ping"}}, {"name": "vc-api", "description": "Endpoints for managing w3c credentials and presentations", "externalDocs": {"description": "Specification", "url": "https://w3c-ccg.github.io/vc-api/"}}, {"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"}}]} \ No newline at end of file