{ "openapi": "3.1.0", "info": { "title": "12id Platform API", "version": "1.0.0", "description": "Issue and verify AnonCreds credentials with holders running the 12id SDK. Commands are asynchronous: they return the exchange record immediately and progress arrives through signed webhooks (or polling). Ids are stable per tenant." }, "components": { "securitySchemes": { "apiKey": { "type": "http", "scheme": "bearer", "description": "API key `12id_sk_…` issued per tenant" }, "walletToken": { "type": "http", "scheme": "bearer", "description": "Wallet token `12id_wt_…` returned by POST /v1/wallets" } }, "schemas": {} }, "paths": { "/v1/ledger": { "get": { "summary": "Ledger configuration", "tags": [ "ledger" ], "description": "What an SDK needs to open the pool: the versioned, immutable genesis file (fetch it once and cache it to a file), its sha256, a minisign signature and the public key to verify it with, and the read-only HTTPS ledger proxy for networks that block Indy client ports.", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "indyNamespace": { "type": "string" }, "genesis": { "type": "object", "properties": { "url": { "type": "string" }, "sha256": { "type": "string" }, "signatureUrl": { "type": "string" }, "signingPublicKey": { "type": "string" } }, "required": [ "url", "sha256", "signatureUrl", "signingPublicKey" ], "additionalProperties": false }, "vdrProxyUrl": { "type": [ "string", "null" ] } }, "required": [ "indyNamespace", "genesis", "vdrProxyUrl" ], "additionalProperties": false } } } } } } }, "/v1/health": { "get": { "summary": "Service health", "tags": [ "ledger" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ok" ] } }, "required": [ "status" ], "additionalProperties": false } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "degraded" ] } }, "required": [ "status" ], "additionalProperties": false } } } } } } }, "/v1/schemas": { "get": { "summary": "List schemas", "tags": [ "catalogue" ], "description": "Newest first, paged with `page` and `pageSize`. `q` matches the schema name.", "parameters": [ { "schema": { "default": 1, "type": "integer", "minimum": 1, "maximum": 100000 }, "in": "query", "name": "page", "required": false }, { "schema": { "default": 25, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "in": "query", "name": "pageSize", "required": false, "description": "25, 50 or 100." }, { "schema": { "type": "string", "minLength": 1, "maxLength": 100 }, "in": "query", "name": "q", "required": false, "description": "Case-insensitive contains match." }, { "schema": { "type": "string", "enum": [ "pending", "awaiting_endorsement", "endorsed", "published", "deprecated", "failed" ] }, "in": "query", "name": "status", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "version": { "type": "string" }, "attributes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "status": { "type": "string" }, "schemaId": { "type": [ "string", "null" ] }, "qualifiedId": { "type": [ "string", "null" ] }, "lastError": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "version", "attributes", "status", "schemaId", "qualifiedId", "lastError" ], "additionalProperties": false } }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "items", "total", "page", "pageSize" ], "additionalProperties": false } } } } } } }, "/v1/credential-definitions": { "get": { "summary": "List credential definitions", "tags": [ "catalogue" ], "description": "Newest first, paged with `page` and `pageSize`. `q` matches the schema name or the tag.", "parameters": [ { "schema": { "default": 1, "type": "integer", "minimum": 1, "maximum": 100000 }, "in": "query", "name": "page", "required": false }, { "schema": { "default": 25, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "in": "query", "name": "pageSize", "required": false, "description": "25, 50 or 100." }, { "schema": { "type": "string", "minLength": 1, "maxLength": 100 }, "in": "query", "name": "q", "required": false, "description": "Case-insensitive contains match." }, { "schema": { "type": "string", "enum": [ "pending", "awaiting_endorsement", "endorsed", "published", "deprecated", "failed" ] }, "in": "query", "name": "status", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "schemaId": { "type": [ "string", "null" ] }, "schemaName": { "type": "string" }, "schemaVersion": { "type": "string" }, "tag": { "type": "string" }, "status": { "type": "string" }, "credentialDefinitionId": { "type": [ "string", "null" ] }, "qualifiedId": { "type": [ "string", "null" ] }, "lastError": { "type": [ "string", "null" ] } }, "required": [ "id", "schemaId", "schemaName", "schemaVersion", "tag", "status", "credentialDefinitionId", "qualifiedId", "lastError" ], "additionalProperties": false } }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "items", "total", "page", "pageSize" ], "additionalProperties": false } } } } } } }, "/v1/connections/invitations": { "post": { "summary": "Create a connection invitation", "tags": [ "connections" ], "description": "Returns an out-of-band invitation URL for the holder app to open or scan (encode the URL in a QR code). `multiUse: true` serves kiosk and web-embed cases where many wallets connect through one invitation.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "multiUse": { "default": false, "type": "boolean" }, "alias": { "type": "string", "maxLength": 200 }, "externalId": { "type": "string", "minLength": 1, "maxLength": 200 } } } } } }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "invitationId": { "type": "string" }, "invitationUrl": { "type": "string" }, "multiUse": { "type": "boolean" } }, "required": [ "invitationId", "invitationUrl", "multiUse" ], "additionalProperties": false } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } } } } }, "/v1/connections": { "get": { "summary": "List connections", "tags": [ "connections" ], "description": "Newest first (`createdAt` descending), paged with `page` and `pageSize`. `q` matches the external id or the holder's label.", "parameters": [ { "schema": { "default": 1, "type": "integer", "minimum": 1, "maximum": 100000 }, "in": "query", "name": "page", "required": false }, { "schema": { "default": 25, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "in": "query", "name": "pageSize", "required": false, "description": "25, 50 or 100." }, { "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "in": "query", "name": "from", "required": false, "description": "Created at or after this instant (ISO 8601)." }, { "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "in": "query", "name": "to", "required": false, "description": "Created before this instant (ISO 8601)." }, { "schema": { "type": "string", "minLength": 1, "maxLength": 100 }, "in": "query", "name": "q", "required": false, "description": "Case-insensitive contains match." }, { "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 50 }, { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 50 } } ] }, "in": "query", "name": "state", "required": false, "description": "One or more states; repeat the parameter for several." }, { "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "in": "query", "name": "externalId", "required": false, "description": "Case-insensitive contains match on the external id." }, { "schema": { "type": "string" }, "in": "query", "name": "invitationId", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "state": { "type": "string" }, "invitationId": { "type": [ "string", "null" ] }, "theirLabel": { "type": [ "string", "null" ] }, "externalId": { "type": [ "string", "null" ] }, "erasedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "state", "invitationId", "theirLabel", "externalId", "erasedAt", "createdAt", "updatedAt" ], "additionalProperties": false } }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "items", "total", "page", "pageSize" ], "additionalProperties": false } } } } } } }, "/v1/connections/{id}": { "get": { "summary": "Get a connection", "tags": [ "connections" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 100 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "state": { "type": "string" }, "invitationId": { "type": [ "string", "null" ] }, "theirLabel": { "type": [ "string", "null" ] }, "externalId": { "type": [ "string", "null" ] }, "erasedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "state", "invitationId", "theirLabel", "externalId", "erasedAt", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } } } } }, "/v1/credentials/offer": { "post": { "summary": "Offer a credential", "tags": [ "credentials" ], "description": "Asynchronous. Returns the exchange immediately in state `offer-sent`; `credential-issued` means the holder received it, `done` that it acknowledged. Attribute values are strings; `expiresAt` is epoch seconds as a string, in the future and at most 2147483647 (2038-01-19; predicates compare 32-bit integers). At most 125 attributes, names up to 100 characters, values up to 4 KB, and 64 KB in all. `credentialDefinitionId` accepts the catalogue id or the ledger id.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "connectionId": { "type": "string", "minLength": 1, "maxLength": 100 }, "credentialDefinitionId": { "type": "string", "minLength": 1, "maxLength": 300 }, "attributes": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 100 }, "additionalProperties": { "type": "string" } }, "externalId": { "type": "string", "minLength": 1, "maxLength": 200 }, "biometric": { "description": "Required when the biometric policy for this credential definition or proof template applies; ignored otherwise.", "type": "object", "properties": { "referenceImage": { "type": "string", "minLength": 100, "maxLength": 7000000, "description": "Base64 JPEG or PNG, at most 5 MB decoded, one face." } }, "required": [ "referenceImage" ] } }, "required": [ "connectionId", "credentialDefinitionId", "attributes" ] } } } }, "responses": { "202": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "state": { "type": "string" }, "connectionId": { "type": [ "string", "null" ] }, "threadId": { "type": [ "string", "null" ] }, "externalId": { "type": [ "string", "null" ] }, "credentialDefinitionId": { "type": [ "string", "null" ] }, "attributes": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, { "type": "null" } ] }, "errorMessage": { "type": [ "string", "null" ] }, "biometric": { "anyOf": [ { "type": "object", "properties": { "required": { "type": "boolean", "enum": [ true ] }, "status": { "type": "string", "enum": [ "pending", "passed", "failed", "expired", "cancelled" ] }, "attempts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "attemptsRemaining": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "livenessScore": { "type": [ "number", "null" ] }, "matchScore": { "type": [ "number", "null" ] }, "reason": { "type": [ "string", "null" ] }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "decidedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "required", "status", "attempts", "attemptsRemaining", "livenessScore", "matchScore", "reason", "expiresAt", "decidedAt" ], "additionalProperties": false }, { "type": "null" } ] }, "erasedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "state", "connectionId", "threadId", "externalId", "credentialDefinitionId", "attributes", "errorMessage", "biometric", "erasedAt", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } } } } }, "/v1/credentials": { "get": { "summary": "List credential exchanges", "tags": [ "credentials" ], "description": "Newest first (`createdAt` descending), paged with `page` and `pageSize`. `q` matches the external id.", "parameters": [ { "schema": { "default": 1, "type": "integer", "minimum": 1, "maximum": 100000 }, "in": "query", "name": "page", "required": false }, { "schema": { "default": 25, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "in": "query", "name": "pageSize", "required": false, "description": "25, 50 or 100." }, { "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "in": "query", "name": "from", "required": false, "description": "Created at or after this instant (ISO 8601)." }, { "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "in": "query", "name": "to", "required": false, "description": "Created before this instant (ISO 8601)." }, { "schema": { "type": "string", "minLength": 1, "maxLength": 100 }, "in": "query", "name": "q", "required": false, "description": "Case-insensitive contains match." }, { "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 50 }, { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 50 } } ] }, "in": "query", "name": "state", "required": false, "description": "One or more states; repeat the parameter for several." }, { "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "in": "query", "name": "externalId", "required": false, "description": "Case-insensitive contains match on the external id." }, { "schema": { "type": "string" }, "in": "query", "name": "connectionId", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "state": { "type": "string" }, "connectionId": { "type": [ "string", "null" ] }, "threadId": { "type": [ "string", "null" ] }, "externalId": { "type": [ "string", "null" ] }, "credentialDefinitionId": { "type": [ "string", "null" ] }, "attributes": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, { "type": "null" } ] }, "errorMessage": { "type": [ "string", "null" ] }, "biometric": { "anyOf": [ { "type": "object", "properties": { "required": { "type": "boolean", "enum": [ true ] }, "status": { "type": "string", "enum": [ "pending", "passed", "failed", "expired", "cancelled" ] }, "attempts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "attemptsRemaining": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "livenessScore": { "type": [ "number", "null" ] }, "matchScore": { "type": [ "number", "null" ] }, "reason": { "type": [ "string", "null" ] }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "decidedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "required", "status", "attempts", "attemptsRemaining", "livenessScore", "matchScore", "reason", "expiresAt", "decidedAt" ], "additionalProperties": false }, { "type": "null" } ] }, "erasedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "state", "connectionId", "threadId", "externalId", "credentialDefinitionId", "attributes", "errorMessage", "biometric", "erasedAt", "createdAt", "updatedAt" ], "additionalProperties": false } }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "items", "total", "page", "pageSize" ], "additionalProperties": false } } } } } } }, "/v1/credentials/{id}": { "get": { "summary": "Get a credential exchange", "tags": [ "credentials" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 100 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "state": { "type": "string" }, "connectionId": { "type": [ "string", "null" ] }, "threadId": { "type": [ "string", "null" ] }, "externalId": { "type": [ "string", "null" ] }, "credentialDefinitionId": { "type": [ "string", "null" ] }, "attributes": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, { "type": "null" } ] }, "errorMessage": { "type": [ "string", "null" ] }, "biometric": { "anyOf": [ { "type": "object", "properties": { "required": { "type": "boolean", "enum": [ true ] }, "status": { "type": "string", "enum": [ "pending", "passed", "failed", "expired", "cancelled" ] }, "attempts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "attemptsRemaining": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "livenessScore": { "type": [ "number", "null" ] }, "matchScore": { "type": [ "number", "null" ] }, "reason": { "type": [ "string", "null" ] }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "decidedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "required", "status", "attempts", "attemptsRemaining", "livenessScore", "matchScore", "reason", "expiresAt", "decidedAt" ], "additionalProperties": false }, { "type": "null" } ] }, "erasedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "state", "connectionId", "threadId", "externalId", "credentialDefinitionId", "attributes", "errorMessage", "biometric", "erasedAt", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } } } } }, "/v1/proofs/request": { "post": { "summary": "Request a proof", "tags": [ "proofs" ], "description": "Asynchronous. Either a stored `templateId` or an inline `request` in the template shape. Every group automatically checks `expiresAt >= now`. When the exchange reaches `done`, `verified` and the `disclosed` attributes are available.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "connectionId": { "type": "string", "minLength": 1, "maxLength": 100 }, "templateId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "request": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "groups": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, "attributes": { "default": [], "maxItems": 50, "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z0-9_.-]{1,100}$" } }, "credentials": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "schemaName": { "type": "string", "minLength": 1, "maxLength": 200 }, "versions": { "default": "all", "type": "string", "enum": [ "active", "all" ] } }, "required": [ "schemaName" ] }, { "type": "object", "properties": { "credentialDefinitionId": { "type": "string", "minLength": 1, "maxLength": 300 } }, "required": [ "credentialDefinitionId" ] } ] } }, "predicates": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[A-Za-z0-9_.-]{1,100}$" }, "type": { "type": "string", "enum": [ ">=", ">", "<=", "<" ] }, "value": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "name", "type", "value" ] } } }, "required": [ "key", "credentials" ] } } }, "required": [ "name", "groups" ] }, "externalId": { "type": "string", "minLength": 1, "maxLength": 200 }, "biometric": { "description": "Required when the biometric policy for this credential definition or proof template applies; ignored otherwise.", "type": "object", "properties": { "referenceImage": { "type": "string", "minLength": 100, "maxLength": 7000000, "description": "Base64 JPEG or PNG, at most 5 MB decoded, one face." } }, "required": [ "referenceImage" ] } }, "required": [ "connectionId" ] } } } }, "responses": { "202": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "state": { "type": "string" }, "connectionId": { "type": [ "string", "null" ] }, "threadId": { "type": [ "string", "null" ] }, "externalId": { "type": [ "string", "null" ] }, "templateId": { "type": [ "string", "null" ] }, "verified": { "type": [ "boolean", "null" ] }, "disclosed": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, { "type": "null" } ] }, "errorMessage": { "type": [ "string", "null" ] }, "biometric": { "anyOf": [ { "type": "object", "properties": { "required": { "type": "boolean", "enum": [ true ] }, "status": { "type": "string", "enum": [ "pending", "passed", "failed", "expired", "cancelled" ] }, "attempts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "attemptsRemaining": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "livenessScore": { "type": [ "number", "null" ] }, "matchScore": { "type": [ "number", "null" ] }, "reason": { "type": [ "string", "null" ] }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "decidedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "required", "status", "attempts", "attemptsRemaining", "livenessScore", "matchScore", "reason", "expiresAt", "decidedAt" ], "additionalProperties": false }, { "type": "null" } ] }, "erasedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "state", "connectionId", "threadId", "externalId", "templateId", "verified", "disclosed", "errorMessage", "biometric", "erasedAt", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } } } } }, "/v1/proofs": { "get": { "summary": "List proof exchanges", "tags": [ "proofs" ], "description": "Newest first (`createdAt` descending), paged with `page` and `pageSize`. `q` matches the external id.", "parameters": [ { "schema": { "default": 1, "type": "integer", "minimum": 1, "maximum": 100000 }, "in": "query", "name": "page", "required": false }, { "schema": { "default": 25, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "in": "query", "name": "pageSize", "required": false, "description": "25, 50 or 100." }, { "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "in": "query", "name": "from", "required": false, "description": "Created at or after this instant (ISO 8601)." }, { "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "in": "query", "name": "to", "required": false, "description": "Created before this instant (ISO 8601)." }, { "schema": { "type": "string", "minLength": 1, "maxLength": 100 }, "in": "query", "name": "q", "required": false, "description": "Case-insensitive contains match." }, { "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 50 }, { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 50 } } ] }, "in": "query", "name": "state", "required": false, "description": "One or more states; repeat the parameter for several." }, { "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "in": "query", "name": "externalId", "required": false, "description": "Case-insensitive contains match on the external id." }, { "schema": { "type": "string" }, "in": "query", "name": "connectionId", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "state": { "type": "string" }, "connectionId": { "type": [ "string", "null" ] }, "threadId": { "type": [ "string", "null" ] }, "externalId": { "type": [ "string", "null" ] }, "templateId": { "type": [ "string", "null" ] }, "verified": { "type": [ "boolean", "null" ] }, "disclosed": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, { "type": "null" } ] }, "errorMessage": { "type": [ "string", "null" ] }, "biometric": { "anyOf": [ { "type": "object", "properties": { "required": { "type": "boolean", "enum": [ true ] }, "status": { "type": "string", "enum": [ "pending", "passed", "failed", "expired", "cancelled" ] }, "attempts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "attemptsRemaining": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "livenessScore": { "type": [ "number", "null" ] }, "matchScore": { "type": [ "number", "null" ] }, "reason": { "type": [ "string", "null" ] }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "decidedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "required", "status", "attempts", "attemptsRemaining", "livenessScore", "matchScore", "reason", "expiresAt", "decidedAt" ], "additionalProperties": false }, { "type": "null" } ] }, "erasedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "state", "connectionId", "threadId", "externalId", "templateId", "verified", "disclosed", "errorMessage", "biometric", "erasedAt", "createdAt", "updatedAt" ], "additionalProperties": false } }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "items", "total", "page", "pageSize" ], "additionalProperties": false } } } } } } }, "/v1/proofs/{id}": { "get": { "summary": "Get a proof exchange", "tags": [ "proofs" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 100 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "state": { "type": "string" }, "connectionId": { "type": [ "string", "null" ] }, "threadId": { "type": [ "string", "null" ] }, "externalId": { "type": [ "string", "null" ] }, "templateId": { "type": [ "string", "null" ] }, "verified": { "type": [ "boolean", "null" ] }, "disclosed": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, { "type": "null" } ] }, "errorMessage": { "type": [ "string", "null" ] }, "biometric": { "anyOf": [ { "type": "object", "properties": { "required": { "type": "boolean", "enum": [ true ] }, "status": { "type": "string", "enum": [ "pending", "passed", "failed", "expired", "cancelled" ] }, "attempts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "attemptsRemaining": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "livenessScore": { "type": [ "number", "null" ] }, "matchScore": { "type": [ "number", "null" ] }, "reason": { "type": [ "string", "null" ] }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "decidedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "required", "status", "attempts", "attemptsRemaining", "livenessScore", "matchScore", "reason", "expiresAt", "decidedAt" ], "additionalProperties": false }, { "type": "null" } ] }, "erasedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "state", "connectionId", "threadId", "externalId", "templateId", "verified", "disclosed", "errorMessage", "biometric", "erasedAt", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } } } } }, "/v1/credentials/{id}/erase": { "post": { "summary": "Erase the personal data of a credential exchange", "tags": [ "credentials" ], "description": "Removes the personal data of this credential exchange (its attribute values) everywhere the platform holds it (the exchange record in the agent, webhook delivery bodies, biometric scores) and keeps the record itself with its ids, state and timestamps, so lists and history stay whole. Only finished exchanges (`done`, `abandoned`, `declined`) can be erased; a running one answers 409. Repeating the call is harmless. A `record.erased` webhook follows. The credential in the holder's wallet is not affected.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "reason": { "description": "Why the data is erased; recorded in the audit log. Required from operators.", "type": "string", "maxLength": 500 } } }, { "type": "null" } ] } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 100 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "state": { "type": "string" }, "connectionId": { "type": [ "string", "null" ] }, "threadId": { "type": [ "string", "null" ] }, "externalId": { "type": [ "string", "null" ] }, "credentialDefinitionId": { "type": [ "string", "null" ] }, "attributes": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, { "type": "null" } ] }, "errorMessage": { "type": [ "string", "null" ] }, "biometric": { "anyOf": [ { "type": "object", "properties": { "required": { "type": "boolean", "enum": [ true ] }, "status": { "type": "string", "enum": [ "pending", "passed", "failed", "expired", "cancelled" ] }, "attempts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "attemptsRemaining": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "livenessScore": { "type": [ "number", "null" ] }, "matchScore": { "type": [ "number", "null" ] }, "reason": { "type": [ "string", "null" ] }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "decidedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "required", "status", "attempts", "attemptsRemaining", "livenessScore", "matchScore", "reason", "expiresAt", "decidedAt" ], "additionalProperties": false }, { "type": "null" } ] }, "erasedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "state", "connectionId", "threadId", "externalId", "credentialDefinitionId", "attributes", "errorMessage", "biometric", "erasedAt", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } } } } }, "/v1/proofs/{id}/erase": { "post": { "summary": "Erase the personal data of a proof exchange", "tags": [ "proofs" ], "description": "Removes the personal data of this proof exchange (its disclosed values) everywhere the platform holds it (the exchange record in the agent, webhook delivery bodies, biometric scores) and keeps the record itself with its ids, state and timestamps, so lists and history stay whole. Only finished exchanges (`done`, `abandoned`, `declined`) can be erased; a running one answers 409. Repeating the call is harmless. A `record.erased` webhook follows. The credential in the holder's wallet is not affected.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "reason": { "description": "Why the data is erased; recorded in the audit log. Required from operators.", "type": "string", "maxLength": 500 } } }, { "type": "null" } ] } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 100 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "state": { "type": "string" }, "connectionId": { "type": [ "string", "null" ] }, "threadId": { "type": [ "string", "null" ] }, "externalId": { "type": [ "string", "null" ] }, "templateId": { "type": [ "string", "null" ] }, "verified": { "type": [ "boolean", "null" ] }, "disclosed": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, { "type": "null" } ] }, "errorMessage": { "type": [ "string", "null" ] }, "biometric": { "anyOf": [ { "type": "object", "properties": { "required": { "type": "boolean", "enum": [ true ] }, "status": { "type": "string", "enum": [ "pending", "passed", "failed", "expired", "cancelled" ] }, "attempts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "attemptsRemaining": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "livenessScore": { "type": [ "number", "null" ] }, "matchScore": { "type": [ "number", "null" ] }, "reason": { "type": [ "string", "null" ] }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "decidedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "required", "status", "attempts", "attemptsRemaining", "livenessScore", "matchScore", "reason", "expiresAt", "decidedAt" ], "additionalProperties": false }, { "type": "null" } ] }, "erasedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "state", "connectionId", "threadId", "externalId", "templateId", "verified", "disclosed", "errorMessage", "biometric", "erasedAt", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } } } } }, "/v1/connections/{id}/erase": { "post": { "summary": "Erase a connection and every exchange on it", "tags": [ "connections" ], "description": "Removes the personal data of this connection (the holder's label) and of every credential and proof exchange on it everywhere the platform holds it (the exchange record in the agent, webhook delivery bodies, biometric scores) and keeps the record itself with its ids, state and timestamps, so lists and history stay whole. Only finished exchanges (`done`, `abandoned`, `declined`) can be erased; a running one answers 409. Repeating the call is harmless. A `record.erased` webhook follows. The credential in the holder's wallet is not affected. The agent drops the connection, so the holder can no longer reach this tenant through it. `erasedExchanges` lists the exchanges erased along with it.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "reason": { "description": "Why the data is erased; recorded in the audit log. Required from operators.", "type": "string", "maxLength": 500 } } }, { "type": "null" } ] } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 100 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "state": { "type": "string" }, "invitationId": { "type": [ "string", "null" ] }, "theirLabel": { "type": [ "string", "null" ] }, "externalId": { "type": [ "string", "null" ] }, "erasedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "erasedExchanges": { "type": "object", "properties": { "credentials": { "type": "array", "items": { "type": "string" } }, "proofs": { "type": "array", "items": { "type": "string" } } }, "required": [ "credentials", "proofs" ], "additionalProperties": false } }, "required": [ "id", "state", "invitationId", "theirLabel", "externalId", "erasedAt", "createdAt", "updatedAt", "erasedExchanges" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } } } } }, "/v1/credentials/{id}/biometric-log": { "get": { "summary": "Biometric log of a credential exchange", "tags": [ "credentials" ], "description": "Every step of the biometric gate for this exchange, oldest first: attempts with liveness and match scores against the thresholds, decisions, and what the platform did with the exchange. Never contains images. `biometric` is null when the exchange was not gated.", "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 100 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "biometric": { "anyOf": [ { "type": "object", "properties": { "required": { "type": "boolean", "enum": [ true ] }, "status": { "type": "string", "enum": [ "pending", "passed", "failed", "expired", "cancelled" ] }, "attempts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "attemptsRemaining": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "livenessScore": { "type": [ "number", "null" ] }, "matchScore": { "type": [ "number", "null" ] }, "reason": { "type": [ "string", "null" ] }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "decidedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "required", "status", "attempts", "attemptsRemaining", "livenessScore", "matchScore", "reason", "expiresAt", "decidedAt" ], "additionalProperties": false }, { "type": "null" } ] }, "events": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "type": { "type": "string" }, "attempt": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "providerId": { "type": [ "string", "null" ] }, "vendorSessionId": { "type": [ "string", "null" ] }, "livenessScore": { "type": [ "number", "null" ] }, "matchScore": { "type": [ "number", "null" ] }, "thresholds": { "anyOf": [ { "type": "object", "properties": { "minLivenessScore": { "type": "number" }, "minMatchScore": { "type": "number" } }, "required": [ "minLivenessScore", "minMatchScore" ], "additionalProperties": false }, { "type": "null" } ] }, "decision": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "required": [ "id", "at", "type", "attempt", "providerId", "vendorSessionId", "livenessScore", "matchScore", "thresholds", "decision", "reason" ], "additionalProperties": false } } }, "required": [ "biometric", "events" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } } } } }, "/v1/proofs/{id}/biometric-log": { "get": { "summary": "Biometric log of a proof exchange", "tags": [ "proofs" ], "description": "Every step of the biometric gate for this exchange, oldest first: attempts with liveness and match scores against the thresholds, decisions, and what the platform did with the exchange. Never contains images. `biometric` is null when the exchange was not gated.", "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 100 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "biometric": { "anyOf": [ { "type": "object", "properties": { "required": { "type": "boolean", "enum": [ true ] }, "status": { "type": "string", "enum": [ "pending", "passed", "failed", "expired", "cancelled" ] }, "attempts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "attemptsRemaining": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "livenessScore": { "type": [ "number", "null" ] }, "matchScore": { "type": [ "number", "null" ] }, "reason": { "type": [ "string", "null" ] }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "decidedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "required", "status", "attempts", "attemptsRemaining", "livenessScore", "matchScore", "reason", "expiresAt", "decidedAt" ], "additionalProperties": false }, { "type": "null" } ] }, "events": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "type": { "type": "string" }, "attempt": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "providerId": { "type": [ "string", "null" ] }, "vendorSessionId": { "type": [ "string", "null" ] }, "livenessScore": { "type": [ "number", "null" ] }, "matchScore": { "type": [ "number", "null" ] }, "thresholds": { "anyOf": [ { "type": "object", "properties": { "minLivenessScore": { "type": "number" }, "minMatchScore": { "type": "number" } }, "required": [ "minLivenessScore", "minMatchScore" ], "additionalProperties": false }, { "type": "null" } ] }, "decision": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "required": [ "id", "at", "type", "attempt", "providerId", "vendorSessionId", "livenessScore", "matchScore", "thresholds", "decision", "reason" ], "additionalProperties": false } } }, "required": [ "biometric", "events" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } } } } }, "/v1/data-retention": { "get": { "summary": "Get the retention period", "tags": [ "data protection" ], "description": "How long the personal data of a finished exchange is kept before it is scrubbed: credential attribute values, disclosed proof values, webhook delivery bodies and biometric scores. The exchange records themselves stay. Changed in the console.", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "retentionDays": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "The period in force, in days; 0 = kept until erased on request." }, "tenantSetting": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ], "description": "The tenant's own setting; null = the platform default applies." }, "platformDefault": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "retentionDays", "tenantSetting", "platformDefault" ], "additionalProperties": false } } } } } } }, "/v1/erasures": { "get": { "summary": "List erasures", "tags": [ "data protection" ], "description": "Erasures made on request, newest first, paged. Scrubs made by the retention period are not listed; the exchange shows `erasedAt`.", "parameters": [ { "schema": { "default": 1, "type": "integer", "minimum": 1, "maximum": 100000 }, "in": "query", "name": "page", "required": false }, { "schema": { "default": 25, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "in": "query", "name": "pageSize", "required": false, "description": "25, 50 or 100." } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "recordType": { "type": "string", "enum": [ "connection", "credential", "proof" ] }, "recordId": { "type": "string" }, "via": { "type": "string", "description": "`api_key` or `console`." }, "actor": { "type": "string", "description": "The API key id, or the console user id." }, "role": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] }, "at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "recordType", "recordId", "via", "actor", "role", "reason", "at" ], "additionalProperties": false } }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "items", "total", "page", "pageSize" ], "additionalProperties": false } } } } } } }, "/v1/credential-definitions/{id}/biometric-policy": { "get": { "summary": "Biometric policy of a credential definition", "tags": [ "catalogue" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 300 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "credentialDefinitionId": { "type": "string" }, "biometricPolicy": { "oneOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "inherit" ] } }, "required": [ "mode" ], "additionalProperties": false }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "off" ] } }, "required": [ "mode" ], "additionalProperties": false }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "required" ] }, "minMatchScore": { "type": "number", "minimum": 0, "maximum": 100 }, "minLivenessScore": { "type": "number", "minimum": 0, "maximum": 100 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "ttlMinutes": { "type": "integer", "minimum": 5, "maximum": 1440 } }, "required": [ "mode" ], "additionalProperties": false } ] } }, "required": [ "credentialDefinitionId", "biometricPolicy" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } } } } }, "/v1/proof-templates": { "get": { "summary": "List proof templates", "tags": [ "proofs" ], "description": "Newest first (`createdAt` descending), paged with `page` and `pageSize`. `q` matches the name.", "parameters": [ { "schema": { "default": 1, "type": "integer", "minimum": 1, "maximum": 100000 }, "in": "query", "name": "page", "required": false }, { "schema": { "default": 25, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "in": "query", "name": "pageSize", "required": false, "description": "25, 50 or 100." }, { "schema": { "type": "string", "minLength": 1, "maxLength": 100 }, "in": "query", "name": "q", "required": false, "description": "Case-insensitive contains match." } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "definition": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "groups": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, "attributes": { "default": [], "maxItems": 50, "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z0-9_.-]{1,100}$" } }, "credentials": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "schemaName": { "type": "string", "minLength": 1, "maxLength": 200 }, "versions": { "default": "all", "type": "string", "enum": [ "active", "all" ] } }, "required": [ "schemaName", "versions" ], "additionalProperties": false }, { "type": "object", "properties": { "credentialDefinitionId": { "type": "string", "minLength": 1, "maxLength": 300 } }, "required": [ "credentialDefinitionId" ], "additionalProperties": false } ] } }, "predicates": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[A-Za-z0-9_.-]{1,100}$" }, "type": { "type": "string", "enum": [ ">=", ">", "<=", "<" ] }, "value": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "name", "type", "value" ], "additionalProperties": false } } }, "required": [ "key", "attributes", "credentials" ], "additionalProperties": false } } }, "required": [ "name", "groups" ], "additionalProperties": false }, "biometricPolicy": { "oneOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "inherit" ] } }, "required": [ "mode" ], "additionalProperties": false }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "off" ] } }, "required": [ "mode" ], "additionalProperties": false }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "required" ] }, "minMatchScore": { "type": "number", "minimum": 0, "maximum": 100 }, "minLivenessScore": { "type": "number", "minimum": 0, "maximum": 100 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "ttlMinutes": { "type": "integer", "minimum": 5, "maximum": 1440 } }, "required": [ "mode" ], "additionalProperties": false } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "name", "definition", "biometricPolicy", "createdAt", "updatedAt" ], "additionalProperties": false } }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "items", "total", "page", "pageSize" ], "additionalProperties": false } } } } } } }, "/v1/proof-templates/{id}": { "get": { "summary": "Get a proof template", "tags": [ "proofs" ], "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "definition": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "groups": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, "attributes": { "default": [], "maxItems": 50, "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z0-9_.-]{1,100}$" } }, "credentials": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "schemaName": { "type": "string", "minLength": 1, "maxLength": 200 }, "versions": { "default": "all", "type": "string", "enum": [ "active", "all" ] } }, "required": [ "schemaName", "versions" ], "additionalProperties": false }, { "type": "object", "properties": { "credentialDefinitionId": { "type": "string", "minLength": 1, "maxLength": 300 } }, "required": [ "credentialDefinitionId" ], "additionalProperties": false } ] } }, "predicates": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[A-Za-z0-9_.-]{1,100}$" }, "type": { "type": "string", "enum": [ ">=", ">", "<=", "<" ] }, "value": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "name", "type", "value" ], "additionalProperties": false } } }, "required": [ "key", "attributes", "credentials" ], "additionalProperties": false } } }, "required": [ "name", "groups" ], "additionalProperties": false }, "biometricPolicy": { "oneOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "inherit" ] } }, "required": [ "mode" ], "additionalProperties": false }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "off" ] } }, "required": [ "mode" ], "additionalProperties": false }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "required" ] }, "minMatchScore": { "type": "number", "minimum": 0, "maximum": 100 }, "minLivenessScore": { "type": "number", "minimum": 0, "maximum": 100 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "ttlMinutes": { "type": "integer", "minimum": 5, "maximum": 1440 } }, "required": [ "mode" ], "additionalProperties": false } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "name", "definition", "biometricPolicy", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } } } } }, "/v1/proof-templates/{id}/biometric-policy": { "get": { "summary": "Biometric policy of a proof template", "tags": [ "proofs" ], "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "string" }, "biometricPolicy": { "oneOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "inherit" ] } }, "required": [ "mode" ], "additionalProperties": false }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "off" ] } }, "required": [ "mode" ], "additionalProperties": false }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "required" ] }, "minMatchScore": { "type": "number", "minimum": 0, "maximum": 100 }, "minLivenessScore": { "type": "number", "minimum": 0, "maximum": 100 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 5 }, "ttlMinutes": { "type": "integer", "minimum": 5, "maximum": 1440 } }, "required": [ "mode" ], "additionalProperties": false } ] } }, "required": [ "templateId", "biometricPolicy" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } } } } }, "/v1/wallets": { "post": { "summary": "Create a wallet", "tags": [ "wallets" ], "description": "One wallet per SDK installation. The returned `walletToken` is shown once; pass it to your app, which gives it to the SDK. The platform never learns who the end user is; `externalId` is your own reference (for example your user id, shared by that user's devices) and is echoed in `wallet.sync_requested` webhooks.\n\nRetries: send your app's installation id (a UUID the app generates once and keeps) as `Idempotency-Key`. A retry with the same key and body returns the **same wallet with a new `walletToken`**, and earlier tokens for that wallet stop working, so always give the app the most recent token. Tokens are never stored. While the first request is still running, a retry answers 409 `idempotency_in_progress`; retry after `Retry-After` seconds. If that wallet was revoked, a retry answers 409 `wallet_revoked`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "default": {}, "type": "object", "properties": { "externalId": { "type": "string", "minLength": 1, "maxLength": 200 } } } } } }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "externalId": { "type": [ "string", "null" ] }, "hasMediatorInvitation": { "type": "boolean" }, "lastSyncRequestedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "connectedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "revokedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "revokedReason": { "type": [ "string", "null" ] }, "walletToken": { "type": "string" } }, "required": [ "id", "externalId", "hasMediatorInvitation", "lastSyncRequestedAt", "createdAt", "connectedAt", "revokedAt", "revokedReason", "walletToken" ], "additionalProperties": false } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } } } }, "get": { "summary": "List wallets", "tags": [ "wallets" ], "description": "Newest first (`createdAt` descending), paged with `page` and `pageSize`. `q` matches the external id.", "parameters": [ { "schema": { "default": 1, "type": "integer", "minimum": 1, "maximum": 100000 }, "in": "query", "name": "page", "required": false }, { "schema": { "default": 25, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "in": "query", "name": "pageSize", "required": false, "description": "25, 50 or 100." }, { "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "in": "query", "name": "from", "required": false, "description": "Created at or after this instant (ISO 8601)." }, { "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "in": "query", "name": "to", "required": false, "description": "Created before this instant (ISO 8601)." }, { "schema": { "type": "string", "minLength": 1, "maxLength": 100 }, "in": "query", "name": "q", "required": false, "description": "Case-insensitive contains match." }, { "schema": { "type": "string", "enum": [ "active", "revoked" ] }, "in": "query", "name": "status", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "externalId": { "type": [ "string", "null" ] }, "hasMediatorInvitation": { "type": "boolean" }, "lastSyncRequestedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "connectedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "revokedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "revokedReason": { "type": [ "string", "null" ] } }, "required": [ "id", "externalId", "hasMediatorInvitation", "lastSyncRequestedAt", "createdAt", "connectedAt", "revokedAt", "revokedReason" ], "additionalProperties": false } }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "items", "total", "page", "pageSize" ], "additionalProperties": false } } } } } } }, "/v1/wallets/{id}": { "get": { "summary": "Get a wallet", "tags": [ "wallets" ], "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "externalId": { "type": [ "string", "null" ] }, "hasMediatorInvitation": { "type": "boolean" }, "lastSyncRequestedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "connectedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "revokedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "revokedReason": { "type": [ "string", "null" ] } }, "required": [ "id", "externalId", "hasMediatorInvitation", "lastSyncRequestedAt", "createdAt", "connectedAt", "revokedAt", "revokedReason" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } } } }, "delete": { "summary": "Revoke a wallet", "tags": [ "wallets" ], "description": "Revokes the wallet token at once: the app gets 401 and the platform stops mapping mediator webhooks to it. The device keeps its local data. 30 days later the platform also removes its mediator connection, so the app can no longer receive messages; it must call reset() and credentials are issued again. Wallets that never connected to the mediator are revoked by the platform after 7 days (revokedReason never_connected).", "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "externalId": { "type": [ "string", "null" ] }, "hasMediatorInvitation": { "type": "boolean" }, "lastSyncRequestedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "connectedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "revokedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "revokedReason": { "type": [ "string", "null" ] } }, "required": [ "id", "externalId", "hasMediatorInvitation", "lastSyncRequestedAt", "createdAt", "connectedAt", "revokedAt", "revokedReason" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } } } } }, "/v1/webhook": { "get": { "summary": "Get the webhook endpoint", "tags": [ "webhooks" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" }, "events": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "connection.state_changed", "credential.state_changed", "proof.state_changed", "wallet.sync_requested", "biometric.check_completed", "record.erased" ] } }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "url", "events", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } } } } }, "/v1/webhook/deliveries": { "get": { "summary": "List deliveries", "tags": [ "webhooks" ], "description": "Newest first (`createdAt` descending), paged with `page` and `pageSize`.", "parameters": [ { "schema": { "default": 1, "type": "integer", "minimum": 1, "maximum": 100000 }, "in": "query", "name": "page", "required": false }, { "schema": { "default": 25, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "in": "query", "name": "pageSize", "required": false, "description": "25, 50 or 100." }, { "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "in": "query", "name": "from", "required": false, "description": "Created at or after this instant (ISO 8601)." }, { "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "in": "query", "name": "to", "required": false, "description": "Created before this instant (ISO 8601)." }, { "schema": { "type": "string", "enum": [ "pending", "sending", "delivered", "dead" ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string", "enum": [ "connection.state_changed", "credential.state_changed", "proof.state_changed", "wallet.sync_requested", "biometric.check_completed", "record.erased" ] }, "in": "query", "name": "eventType", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "eventId": { "type": "string" }, "eventType": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "sending", "delivered", "dead" ] }, "attempts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "nextAttemptAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "lastStatusCode": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "lastError": { "type": [ "string", "null" ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deliveredAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "erasedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "eventId", "eventType", "status", "attempts", "nextAttemptAt", "lastStatusCode", "lastError", "createdAt", "deliveredAt", "erasedAt" ], "additionalProperties": false } }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "page": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "items", "total", "page", "pageSize" ], "additionalProperties": false } } } } } } }, "/v1/webhook/deliveries/{id}": { "get": { "summary": "Get a delivery, including its body", "tags": [ "webhooks" ], "parameters": [ { "schema": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "eventId": { "type": "string" }, "eventType": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "sending", "delivered", "dead" ] }, "attempts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "nextAttemptAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "lastStatusCode": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "lastError": { "type": [ "string", "null" ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "deliveredAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "erasedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "body": { "type": "string" } }, "required": [ "id", "eventId", "eventType", "status", "attempts", "nextAttemptAt", "lastStatusCode", "lastError", "createdAt", "deliveredAt", "erasedAt", "body" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } } } } }, "/v1/wallet": { "get": { "summary": "This wallet", "tags": [ "wallet (SDK)" ], "security": [ { "walletToken": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "externalId": { "type": [ "string", "null" ] }, "hasMediatorInvitation": { "type": "boolean" }, "lastSyncRequestedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "connectedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "revokedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "revokedReason": { "type": [ "string", "null" ] } }, "required": [ "id", "externalId", "hasMediatorInvitation", "lastSyncRequestedAt", "createdAt", "connectedAt", "revokedAt", "revokedReason" ], "additionalProperties": false } } } } } } }, "/v1/wallet/mediator-invitation": { "get": { "summary": "Mediator invitation for this wallet", "tags": [ "wallet (SDK)" ], "description": "Mints a single-use out-of-band invitation for the platform mediator. Call once at first launch and connect immediately; calling again replaces the previous invitation.", "security": [ { "walletToken": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "invitationUrl": { "type": "string" } }, "required": [ "invitationUrl" ], "additionalProperties": false } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } }, "502": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } } } } }, "/v1/wallet/biometric-requirements": { "get": { "summary": "Biometric checks for exchanges this wallet holds", "tags": [ "wallet (SDK)" ], "description": "The SDK asks by DIDComm thread id when an offer or proof request arrives. Threads without a check are omitted.", "parameters": [ { "schema": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } } ] }, "in": "query", "name": "threadId", "required": true } ], "security": [ { "walletToken": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "requirements": { "type": "array", "items": { "type": "object", "properties": { "threadId": { "type": "string" }, "recordType": { "type": "string", "enum": [ "credential", "proof" ] }, "status": { "type": "string" }, "attemptsRemaining": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "captureProvider": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "threadId", "recordType", "status", "attemptsRemaining", "captureProvider", "expiresAt" ], "additionalProperties": false } } }, "required": [ "requirements" ], "additionalProperties": false } } } } } } }, "/v1/wallet/biometric-sessions": { "post": { "summary": "Start a biometric capture session", "tags": [ "wallet (SDK)" ], "description": "Uses one attempt. `captureModules` lists the capture add-ons the app includes; `clientConfig` is for that add-on only.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "threadId": { "type": "string", "minLength": 1, "maxLength": 200 }, "captureModules": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "provider": { "type": "string", "minLength": 1, "maxLength": 100 }, "version": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } }, "required": [ "provider", "version" ] } } }, "required": [ "threadId", "captureModules" ] } } } }, "security": [ { "walletToken": [] } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "sessionId": { "type": "string" }, "provider": { "type": "string" }, "clientConfig": {}, "attempt": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "attemptsRemaining": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "sessionId", "provider", "clientConfig", "attempt", "attemptsRemaining" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } } } } }, "/v1/wallet/biometric-sessions/{id}/complete": { "post": { "summary": "Complete a biometric capture session", "tags": [ "wallet (SDK)" ], "description": "The platform fetches the result from the vendor itself; `clientOutput` is only what the add-on returned. 409 `result_not_ready` means the vendor is still processing: retry after a second.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "clientOutput": {} }, "required": [ "clientOutput" ] } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "id", "required": true } ], "security": [ { "walletToken": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "outcome": { "type": "string", "enum": [ "passed", "failed", "locked" ] }, "attemptsRemaining": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "outcome", "attemptsRemaining" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "additionalProperties": false } } } } } } } }, "servers": [ { "url": "https://api.12id.naziharitsolution.com" } ], "security": [ { "apiKey": [] } ], "tags": [ { "name": "ledger", "description": "Public configuration" }, { "name": "catalogue", "description": "Schemas and credential definitions" }, { "name": "connections" }, { "name": "credentials" }, { "name": "proofs" }, { "name": "wallets", "description": "Wallets (customer backend)" }, { "name": "wallet (SDK)", "description": "Wallet endpoints called by the app with its wallet token" }, { "name": "webhooks" }, { "name": "data protection", "description": "Retention period and erasure log" }, { "name": "biometrics", "description": "Biometric gate settings (console)" } ] }