Triveria Wallet API (1.0.0)

Download OpenAPI specification:Download

Triveria Wallet API allows to manage credentials inside a specific wallet and interactions between wallets as specified by the OIDC4VC specification.

HealthCheck

Responses

Response samples

200
500

Content type

application/json

{"status": "ok",
"subsystems": [{"subsystem": "string",
"status": "ok",
"message": "string"
}
]
}

DidDocumentGet

Gets the DID Document of the wallet.

path Parameters

wallet_id

required

string

Responses

Response samples

200
404
500

Content type

application/json

{ }

WalletIdentifierGet

Authorizations:

accessToken

header Parameters

wallet-id

required

string

Responses

Response samples

200
500

Content type

application/json

{"identifier": "string"
}

WalletIdentifierUpdate

Authorizations:

accessToken

header Parameters

wallet-id

required

string

Request Body schema: application/json

The new wallet identifier

identifier

required

string

Responses

Request samples

Payload

Content type

application/json

{"identifier": "string"
}

Response samples

200
500

Content type

application/json

{"identifier": "string"
}

CredentialList

Retrieves a list of credentials.

Authorizations:

accessToken

query Parameters

interaction	string Enum: "issuance" "receive" "statusList" "taoCredentials" The interaction that is the origin of the credential. This parameter is mutually exclusive with the "type" parameter.
type	string The credential type as comma delimited list representing a single type. This parameter is mutually exclusive with the "interaction" parameter. I.e. VerifiableCredential,VerifiableAttestation,Europass.
valid	boolean The credential validity flag. If not provided credentials with any validity will be returned.
limit	integer The number of items
nextMarker	string Marking the next set of items
sort	string (ListSort) Enum: "asc" "desc" Sort flag controls the sort direction by the time updated or issued
searchPath	string JSON path specification for the filter to apply
filter	string <byte> JSON schema filter used to select the credentials (base64 encoded)

header Parameters

wallet-id

required

string

Responses

Response samples

200
400
500

Content type

application/json

{"list": [{"id": "string",
"walletId": "string",
"ownerId": "string",
"name": "string",
"interaction": "issuance",
"message": "string",
"type": "VerifiableCredential,VerifiableAttestation",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"issuanceDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"status": "draft",
"disclosableFields": ["string"
],
"issuerIdentifier": "string",
"issuerDisplay": [{"name": "string",
"locale": "string",
"logo": {"uri": "string",
"alt_text": "string"
}
}
]
}
],
"next": "http://example.com"
}

CredentialCreate

Creates a new draft credential.

Authorizations:

accessToken

header Parameters

wallet-id

required

string

Request Body schema: application/json

A Verifiable Credential payload in JSON format.

required	Credential Subject Item (object) or Array of Credential Subject (objects) (Credential Subject) Set of objects that MUST contain one or more claims that are each related to a subject of the verifiable credential https://www.w3.org/TR/vc-data-model-2.0/#defn-credentialSubject. Currently we support only one subject in the verifiable credential because there is no consensus about "vc-jwt" encoding of multi-subject verifiable credentials
required	object (Verifiable Credential Draft metadata) Accompanying information about the verifiable credential draft - schema, type, format etc.
validateSchema	boolean Default: true If true, the credential draft is checked against its schema. Defaults to true.
property name* additional property	any (Credential metadata) Any additional key, value pairs used for internal purposes of an issuer or holder.

Responses

Request samples

Payload

Content type

application/json

{"credentialSubject": {"id": "string"
},
"credentialDraftMetadata": {"id": "string",
"name": "string",
"type": "VerifiableCredential,VerifiableAttestation",
"expirationDate": "2019-08-24T14:15:22Z",
"format": "sd_jwt_vc",
"credentialSchema": "string"
},
"validateSchema": true,
"property1": null,
"property2": null
}

Response samples

200
400
500

Content type

application/json

{"id": "string"
}

CredentialImport

Import pre-signed credential into wallet

Authorizations:

accessToken

header Parameters

wallet-id

required

string

Request Body schema: application/json

A Verifiable Credential payload in JSON format.

credential required	string
name required	string

Responses

Request samples

Payload

Content type

application/json

{"credential": "string",
"name": "string"
}

Response samples

200
400
500

Content type

application/json

{"metadata": {"id": "string",
"walletId": "string",
"ownerId": "string",
"name": "string",
"interaction": "issuance",
"message": "string",
"type": "VerifiableCredential,VerifiableAttestation",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"issuanceDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"status": "draft",
"disclosableFields": ["string"
],
"issuerIdentifier": "string",
"issuerDisplay": [{"name": "string",
"locale": "string",
"logo": {"uri": "string",
"alt_text": "string"
}
}
]
},
"vcSubject": {"id": "string"
},
"signedVc": "string"
}

CredentialRequestInit

Requests a credential issuance from the issuer and retrieves requirements for holder authorization.

Authorizations:

accessToken

header Parameters

wallet-id

required

string

Request Body schema: application/json

A Verifiable Credential request: types and URL of the issuer

types required	string
format required	string (Verifiable credential format) Enum: "sd_jwt_vc" "jwt_vc_vcdm" jwt_vc_vcdm - VC using W3C VC Data Model as jwt sd_jwt_vc - VC using sd_jwt_vc data model as jwt
url required	string <url>
state	string

Responses

Request samples

Payload

Content type

application/json

{"types": "string",
"format": "sd_jwt_vc",
"url": "string",
"state": "string"
}

Response samples

200
400
500

Content type

application/json

["string"
]

CredentialGet

Retrieves a specific verifiable credential based on the provided identifier. Upon retrieval the status of the credential is checked on the fly and therefore guaranteed.

Authorizations:

accessToken

path Parameters

credential_id

required

string (Verifiable Credential ID)

Verifiable Credential Identifier

header Parameters

wallet-id

required

string

Responses

Response samples

200
400
404
500

Content type

application/json

{"metadata": {"id": "string",
"walletId": "string",
"ownerId": "string",
"name": "string",
"interaction": "issuance",
"message": "string",
"type": "VerifiableCredential,VerifiableAttestation",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"issuanceDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"status": "draft",
"disclosableFields": ["string"
],
"issuerIdentifier": "string",
"issuerDisplay": [{"name": "string",
"locale": "string",
"logo": {"uri": "string",
"alt_text": "string"
}
}
]
},
"vcSubject": {"id": "string"
},
"signedVc": "string"
}

CredentialPatch

Endpoint used to update an existing Credential in draft state. Can be used for additional updates before the Credential is issued. After credential is issued it may not be changed in any way.

Authorizations:

accessToken

path Parameters

credential_id

required

string (Verifiable Credential ID)

Verifiable Credential Identifier

header Parameters

wallet-id

required

string

Request Body schema: application/json

required	Credential Subject Item (object) or Array of Credential Subject (objects) (Credential Subject) Set of objects that MUST contain one or more claims that are each related to a subject of the verifiable credential https://www.w3.org/TR/vc-data-model-2.0/#defn-credentialSubject. Currently we support only one subject in the verifiable credential because there is no consensus about "vc-jwt" encoding of multi-subject verifiable credentials
name required	string (Credential name)
validateSchema	boolean Default: true If true, the credential draft is checked against its schema. Defaults to true.
property name* additional property	any (Any additional key, value pairs used to categorize or denote the Credential)

Responses

Request samples

Payload

Content type

application/json

{"credentialSubject": {"id": "string"
},
"name": "string",
"validateSchema": true,
"property1": {"focus": "education",
"type": "diploma",
"origin": "SK"
},
"property2": {"focus": "education",
"type": "diploma",
"origin": "SK"
}
}

Response samples

200
400
404
500

Content type

application/json

{"id": "string"
}

PdfCredentialTwinUpload

Uploads a PDF that will be signed and embedded with the verifiable credential when it will be issued. Can be used only for credentials in Draft state. Maximal size of the PDF document is 50 MB.

Authorizations:

accessToken

path Parameters

credential_id

required

string (Verifiable Credential ID)

Verifiable Credential Identifier

header Parameters

wallet-id

required

string

Request Body schema: multipart/form-data

pdf	string <binary>

Responses

Response samples

400
404
500

Content type

application/json

{"error": "string",
"message": "string"
}

PdfCredentialTwinDelete

Deletes the PDF associated with the verifiable credential. Can be used only for credentials in Draft state.

Authorizations:

accessToken

path Parameters

credential_id

required

string (Verifiable Credential ID)

Verifiable Credential Identifier

header Parameters

wallet-id

required

string

Responses

Response samples

400
404
500

Content type

application/json

{"error": "string",
"message": "string"
}

PdfCredentialTwinGet

Returns either an unsigned PDF that was uploaded to be signed and embedded into a verifiable credential in case of credential in Draft state, or a signed PDF embedded in an issued VC.

Authorizations:

accessToken

path Parameters

credential_id

required

string (Verifiable Credential ID)

Verifiable Credential Identifier

header Parameters

wallet-id

required

string

Responses

Response samples

400
404
500

Content type

application/json

{"error": "string",
"message": "string"
}

PdfCredentialMakeVp

Returns a signed PDF contained in the verifiable credential containing the credential VP added as an attachment in incremental update.

Authorizations:

accessToken

path Parameters

credential_id

required

string (Verifiable Credential ID)

Verifiable Credential Identifier

query Parameters

sign_pdf

required

boolean

Whether to sign the PDF with holder's X509 certificate or not

header Parameters

wallet-id

required

string

Responses

Response samples

400
404
500

Content type

application/json

{"error": "string",
"message": "string"
}

CredentialMetadataPatch

Verifiable Credential metadata may be updated even after the credential was issued. It is available as a key value storage for a client to store any additional data for the credential.

Authorizations:

accessToken

path Parameters

credential_id

required

string (Verifiable Credential ID)

Verifiable Credential Identifier

header Parameters

wallet-id

required

string

Request Body schema: application/json

Verifiable Credential metadata in JSON

name	string (Verifiable Credential name)
property name* additional property	any

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": "string"
}

CredentialIssuanceInit

Prepares created Verifiable Credential draft for its issuance for a specific client.

Authorizations:

accessToken

path Parameters

credential_id

required

string

header Parameters

wallet-id

required

string

Request Body schema: application/json

issuerId required	string (Issuer ID) Identifier used by the wallet to decide which issuer to use to issue the credential.
clientId	string (Client ID) The future holder identifier. Usually this is the DID of the holder wallet.
idTokenRequestId	string (ID Token request identifier) If ID Token was used to identify the holder's wallet.
	object (IssuanceRequirementsToVerify)

Responses

Request samples

Payload

Content type

application/json

{"issuerId": "string",
"clientId": "string",
"idTokenRequestId": "string",
"issuanceRequirementsToVerify": {"verifiedFields": [{"path": "string",
"value": "string"
}
]
}
}

Response samples

200
400
404
500

Content type

application/json

{"issuanceQueueItemId": "string"
}

CredentialRevoke

Revoke a specific Verifiable Credential

Authorizations:

accessToken

path Parameters

credential_id

required

string (Verifiable Credential ID)

Verifiable Credential Identifier

header Parameters

wallet-id

required

string

Responses

Response samples

400
404
500

Content type

application/json

{"error": "string",
"message": "string"
}

DeferredStatus

Authorizations:

accessToken

path Parameters

deferred_id

required

string

Deferred token

header Parameters

wallet-id

required

string

Responses

Response samples

200
404
500

Content type

application/json

{"Status": "in_progress",
"Id": "string"
}

IdTokenRequestCreate

Creates an ID token request.

Authorizations:

accessToken

header Parameters

wallet-id

required

string

Responses

Response samples

200
400
500

Content type

application/json

{"requestUrl": "string",
"id": "string"
}

HolderCreateAuthOffer

Creates an authorized credential offer (deferred or instant) for holder-initiated credential request using provided parameters. The offer is an URL that the creator should provide to the client via a redirect, link, or QR code.

Authorizations:

accessToken

header Parameters

wallet-id

required

string

Request Body schema: application/json

issuerUrl required	string
types required	string
format required	string (Verifiable credential format) Enum: "sd_jwt_vc" "jwt_vc_vcdm" jwt_vc_vcdm - VC using W3C VC Data Model as jwt sd_jwt_vc - VC using sd_jwt_vc data model as jwt
state required	string
deferred required	boolean

Responses

Request samples

Payload

Content type

application/json

{"issuerUrl": "string",
"types": "string",
"format": "sd_jwt_vc",
"state": "string",
"deferred": true
}

Response samples

400
500

Content type

application/json

{"error": "string",
"message": "string"
}

VerifierInitUrlCreate

Returns an url where verifier accepts presentations from a holder.

Authorizations:

accessToken

header Parameters

wallet-id

required

string

Request Body schema: application/json

verifierId required	string
createUrl	boolean Default: false
holderEntityId	string
wmpEntityId	string ID of an WMP entity with which a WMP connection has already been established. If provided, WMP is used to send the credential offer to the specified recipient.

Responses

Request samples

Payload

Content type

application/json

{"verifierId": "string",
"createUrl": false,
"holderEntityId": "string",
"wmpEntityId": "string"
}

Response samples

200
400
500

Content type

application/json

{"verifierUrl": "string",
"verifierState": "string"
}

VerifierLinkedVpVerify

Fetches linked presentations from DID document and verifies them.

Authorizations:

accessToken

query Parameters

did

required

string

header Parameters

wallet-id

required

string

Responses

Response samples

200
400
404
500

Content type

application/json

[{"linkedVpId": "string",
"credentials": [{"metadata": {"id": "string",
"walletId": "string",
"ownerId": "string",
"name": "string",
"interaction": "issuance",
"message": "string",
"type": "VerifiableCredential,VerifiableAttestation",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"issuanceDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"status": "draft",
"disclosableFields": ["string"
],
"issuerIdentifier": "string",
"issuerDisplay": [{"name": "string",
"locale": "string",
"logo": {"uri": "string",
"alt_text": "string"
}
}
]
},
"vcSubject": {"id": "string"
},
"signedVc": "string"
}
]
}
]

VerifierPdfVerify

Verifies the signatures of uploaded PDF and extracts and verifies VP in the PDF document Maximum size of the PDF document is 50 MB.

Authorizations:

accessToken

header Parameters

wallet-id

required

string

Request Body schema: multipart/form-data

pdf	string <binary>
extractVp required	boolean Whether to extract VP attachment from the PDF
trustedCertificates	Array of strings Base64 encoded x509 certificates with which the PDF may be signed.
trustedListsUrl	Array of strings URLs of ETSI trusted lists that will be used for verification purposes. If not provided, ETSI trust list configured for the wallet will be used.
trustedListSigningCertificates	Array of strings Base64 encoded x509 certificates with which the ETSI trusted lists may be signed. If not provided, values from wallet config will be used.

Responses

Response samples

200
400
404
500

Content type

application/json

{"vpValid": true,
"verifiedCredentials": {"credentials": [{"metadata": {"id": "string",
"walletId": "string",
"ownerId": "string",
"name": "string",
"interaction": "issuance",
"message": "string",
"type": "VerifiableCredential,VerifiableAttestation",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"issuanceDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"status": "draft",
"disclosableFields": ["string"
],
"issuerIdentifier": "string",
"issuerDisplay": [{"name": "string",
"locale": "string",
"logo": {"uri": "string",
"alt_text": "string"
}
}
]
},
"vcSubject": {"id": "string"
},
"signedVc": "string"
}
],
"vp": "string",
"holder": "string"
},
"signatures": [{"verificationResult": "valid",
"details": ["string"
],
"signingCertificateQualification": "string",
"signingCertificate": "string"
}
]
}

IssuerCredentialTypesList

Returns verifiable credential format and types that are supported by the issuer.

format: the verifiable credential format (for example "jwt_vc")
type: a list of strings that define supported verifiable credential type(s)

Authorizations:

accessToken

query Parameters

url

required

string

Responses

Response samples

200
400
500

Content type

application/json

[{"format": "sd_jwt_vc",
"type": ["string"
],
"doctype": "string"
}
]

IssuerInitiatePreauthOffer

Initiates issuing of Verifiable Credentials using pre-authorized flow.

Authorizations:

accessToken

header Parameters

wallet-id

required

string

Request Body schema: application/json

clientId	string DID of holder for which the offer is created.
idTokenRequestId	string ID of ID token request issued to the holder.
issuerId required	string ID of the issuer used to issue the credential.
offerEndpoint	string Default: "openid-credential-offer://"
deferred	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"clientId": "string",
"idTokenRequestId": "string",
"issuerId": "string",
"offerEndpoint": "openid-credential-offer://",
"deferred": false
}

Response samples

200
400
500

Content type

application/json

{"preauthCode": "string",
"pin": "string",
"issuerUrl": "string",
"offer": "string",
"validUntil": "2019-08-24T14:15:22Z",
"offerId": "string"
}

IssuerInitiateAuthOffer

Initiates issuing of Verifiable Credentials using authorized flow.

Authorizations:

accessToken

header Parameters

wallet-id

required

string

Request Body schema: application/json

issuerId required	string ID of the issuer used to issue the credential.
offerEndpoint	string Default: "openid-credential-offer://"
deferred	boolean Default: false
issuanceQueueItemId	string Id of issuance queue item. Required when issuer type is CredentialQueue type and no clientId was provided when adding credential to queue.
wmpEntityId	string ID of an WMP entity with which a WMP connection has already been established. If provided, WMP is used to send the credential offer to the specified recipient.

Responses

Request samples

Payload

Content type

application/json

{"issuerId": "string",
"offerEndpoint": "openid-credential-offer://",
"deferred": false,
"issuanceQueueItemId": "string",
"wmpEntityId": "string"
}

Response samples

200
400
500

Content type

application/json

{"state": "string",
"issuerUrl": "string",
"offer": "string",
"validUntil": "2019-08-24T14:15:22Z",
"offerId": "string"
}

IssuerXadesSign

Signs an XML document with XAdES signature

Authorizations:

accessToken

header Parameters

wallet-id

required

string

Request Body schema: multipart/form-data

xml	string <binary>
xadesSignatureType required	string (XadesSignatureType) Value: "tsl"

Responses

Response samples

400
500

Content type

application/json

{"error": "string",
"message": "string"
}

HolderOfferPassAuthInfo

Issue the Verifiable Credential using OIDC4VCI offer acceptance

Authorizations:

accessToken

header Parameters

wallet-id

required

string

Request Body schema: application/json

Verifiable Credential offer

Url

required

string <url>

The Verifiable Credential offer URL provided by the issuer

Responses

Request samples

Payload

Content type

application/json

{"Url": "string"
}

Response samples

200
400
500

Content type

application/json

{"requirementType": "none",
"presentationDefinition": {"id": "string",
"format": {"jwt_vc": {"alg": ["string"
]
},
"jwt_vp": {"alg": ["string"
]
},
"sd_jwt": {"alg": ["string"
]
},
"dc+sd-jwt-vc": {"alg": ["string"
]
},
"mso_mdoc": {"alg": ["string"
]
}
},
"input_descriptors": [{"id": "string",
"format": {"jwt_vc": {"alg": ["string"
]
},
"jwt_vp": {"alg": ["string"
]
},
"sd_jwt": {"alg": ["string"
]
},
"dc+sd-jwt-vc": {"alg": ["string"
]
},
"mso_mdoc": {"alg": ["string"
]
}
},
"constraints": {"fields": [{"id": "string",
"name": "string",
"purpose": "string",
"filter": { },
"path": ["string"
]
}
]
},
"group": ["string"
]
}
],
"submission_requirements": [{"rule": "all",
"count": 0,
"min": 0,
"max": 0,
"from": "string",
"from_nested": [{ }
],
"name": "string"
}
]
},
"dcqlQuery": {"credentials": [{"id": "string",
"format": "string",
"meta": {"vct_values": ["string"
]
},
"claims": [{"id": "string",
"path": ["string"
],
"values": ["string"
]
}
]
}
]
},
"presentationCandidates": [{"descriptorId": "string",
"credentials": [{"credential": {"id": "string",
"walletId": "string",
"ownerId": "string",
"name": "string",
"interaction": "issuance",
"message": "string",
"type": "VerifiableCredential,VerifiableAttestation",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"issuanceDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"status": "draft",
"disclosableFields": ["string"
],
"issuerIdentifier": "string",
"issuerDisplay": [{"name": "string",
"locale": "string",
"logo": {"uri": "string",
"alt_text": "string"
}
}
]
},
"fieldsToDisclose": ["string"
]
}
]
}
],
"interactionId": "string",
"offeredCredentialsTypes": ["string"
],
"issuerUrl": "string",
"issuerDisplay": [{"name": "string",
"locale": "string",
"logo": {"uri": "string",
"alt_text": "string"
}
}
]
}

HolderOfferProcessAfterConsent

Gives consent to process credential offer specified by interaction_id

Authorizations:

accessToken

path Parameters

interaction_id

required

string

header Parameters

wallet-id

required

string

Request Body schema: application/json

pin	string Pin code needed for pre-authorized credential offers. Required when authorization requirement type is `pin`
	Array of objects (InputDescriptorSuitableCredentials) Array of IDs of credentials that will be presented in the interaction. Must be a subset of authorization requirements presentation candidates. Required when authorization requirement type is `vp_token`.

Responses

Request samples

Payload

Content type

application/json

{"pin": "string",
"credentialsToPresent": [{"descriptorId": "string",
"credentials": [{"credential": {"id": "string",
"walletId": "string",
"ownerId": "string",
"name": "string",
"interaction": "issuance",
"message": "string",
"type": "VerifiableCredential,VerifiableAttestation",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"issuanceDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"status": "draft",
"disclosableFields": ["string"
],
"issuerIdentifier": "string",
"issuerDisplay": [{"name": "string",
"locale": "string",
"logo": {"uri": "string",
"alt_text": "string"
}
}
]
},
"fieldsToDisclose": ["string"
]
}
]
}
]
}

Response samples

200
400
404
500

Content type

application/json

["string"
]

HolderIdTokenSend

Responds to an ID token request

Authorizations:

accessToken

header Parameters

wallet-id

required

string

Request Body schema: application/json

requestUrl

required

string

Responses

Request samples

Payload

Content type

application/json

{"requestUrl": "string"
}

Response samples

400
500

Content type

application/json

{"error": "string",
"message": "string"
}

HolderPresentPassAuthInfo

Initiates a presentation of credentials to a verifier.

Authorizations:

accessToken

header Parameters

wallet-id

required

string

Request Body schema: application/json

verifierUrl required	string URL of verifier or vp_token request url
verifierScope	string Custom authorization scope, used when `verifierUrl` is the URL of verifier

Responses

Request samples

Payload

Content type

application/json

{"verifierUrl": "string",
"verifierScope": "string"
}

Response samples

200
400
500

Content type

application/json

{"requirementType": "none",
"presentationDefinition": {"id": "string",
"format": {"jwt_vc": {"alg": ["string"
]
},
"jwt_vp": {"alg": ["string"
]
},
"sd_jwt": {"alg": ["string"
]
},
"dc+sd-jwt-vc": {"alg": ["string"
]
},
"mso_mdoc": {"alg": ["string"
]
}
},
"input_descriptors": [{"id": "string",
"format": {"jwt_vc": {"alg": ["string"
]
},
"jwt_vp": {"alg": ["string"
]
},
"sd_jwt": {"alg": ["string"
]
},
"dc+sd-jwt-vc": {"alg": ["string"
]
},
"mso_mdoc": {"alg": ["string"
]
}
},
"constraints": {"fields": [{"id": "string",
"name": "string",
"purpose": "string",
"filter": { },
"path": ["string"
]
}
]
},
"group": ["string"
]
}
],
"submission_requirements": [{"rule": "all",
"count": 0,
"min": 0,
"max": 0,
"from": "string",
"from_nested": [{ }
],
"name": "string"
}
]
},
"dcqlQuery": {"credentials": [{"id": "string",
"format": "string",
"meta": {"vct_values": ["string"
]
},
"claims": [{"id": "string",
"path": ["string"
],
"values": ["string"
]
}
]
}
]
},
"presentationCandidates": [{"descriptorId": "string",
"credentials": [{"credential": {"id": "string",
"walletId": "string",
"ownerId": "string",
"name": "string",
"interaction": "issuance",
"message": "string",
"type": "VerifiableCredential,VerifiableAttestation",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"issuanceDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"status": "draft",
"disclosableFields": ["string"
],
"issuerIdentifier": "string",
"issuerDisplay": [{"name": "string",
"locale": "string",
"logo": {"uri": "string",
"alt_text": "string"
}
}
]
},
"fieldsToDisclose": ["string"
]
}
]
}
],
"interactionId": "string",
"offeredCredentialsTypes": ["string"
],
"issuerUrl": "string",
"issuerDisplay": [{"name": "string",
"locale": "string",
"logo": {"uri": "string",
"alt_text": "string"
}
}
]
}

HolderCredentialsPresentAfterConsent

Presenting Verifiable Credentials after holder's consent.

Authorizations:

accessToken

path Parameters

interaction_id

required

string

header Parameters

wallet-id

required

string

Request Body schema: application/json

pin	string Pin code needed for pre-authorized credential offers. Required when authorization requirement type is `pin`
	Array of objects (InputDescriptorSuitableCredentials) Array of IDs of credentials that will be presented in the interaction. Must be a subset of authorization requirements presentation candidates. Required when authorization requirement type is `vp_token`.

Responses

Request samples

Payload

Content type

application/json

{"pin": "string",
"credentialsToPresent": [{"descriptorId": "string",
"credentials": [{"credential": {"id": "string",
"walletId": "string",
"ownerId": "string",
"name": "string",
"interaction": "issuance",
"message": "string",
"type": "VerifiableCredential,VerifiableAttestation",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"issuanceDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"status": "draft",
"disclosableFields": ["string"
],
"issuerIdentifier": "string",
"issuerDisplay": [{"name": "string",
"locale": "string",
"logo": {"uri": "string",
"alt_text": "string"
}
}
]
},
"fieldsToDisclose": ["string"
]
}
]
}
]
}

Response samples

400
404
500

Content type

application/json

{"error": "string",
"message": "string"
}

HolderLinkedVpList

Authorizations:

accessToken

header Parameters

wallet-id

required

string

Responses

Response samples

200
500

Content type

application/json

[{"linkedVpId": "string",
"linkedVpUrl": "string"
}
]

HolderLinkedVpCreate

Creates a new public Linked VP of specified credentials and adds it to the wallet's DID document

Authorizations:

accessToken

header Parameters

wallet-id

required

string

Request Body schema: application/json

required	object (PresentationDefinition)
required	Array of objects (InputDescriptorSuitableCredentials)
expirationDate	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"presentationDefinition": {"id": "string",
"format": {"jwt_vc": {"alg": ["string"
]
},
"jwt_vp": {"alg": ["string"
]
},
"sd_jwt": {"alg": ["string"
]
},
"dc+sd-jwt-vc": {"alg": ["string"
]
},
"mso_mdoc": {"alg": ["string"
]
}
},
"input_descriptors": [{"id": "string",
"format": {"jwt_vc": {"alg": ["string"
]
},
"jwt_vp": {"alg": ["string"
]
},
"sd_jwt": {"alg": ["string"
]
},
"dc+sd-jwt-vc": {"alg": ["string"
]
},
"mso_mdoc": {"alg": ["string"
]
}
},
"constraints": {"fields": [{"id": "string",
"name": "string",
"purpose": "string",
"filter": { },
"path": ["string"
]
}
]
},
"group": ["string"
]
}
],
"submission_requirements": [{"rule": "all",
"count": 0,
"min": 0,
"max": 0,
"from": "string",
"from_nested": [{ }
],
"name": "string"
}
]
},
"credentialsToPresent": [{"descriptorId": "string",
"credentials": [{"credential": {"id": "string",
"walletId": "string",
"ownerId": "string",
"name": "string",
"interaction": "issuance",
"message": "string",
"type": "VerifiableCredential,VerifiableAttestation",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"issuanceDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"status": "draft",
"disclosableFields": ["string"
],
"issuerIdentifier": "string",
"issuerDisplay": [{"name": "string",
"locale": "string",
"logo": {"uri": "string",
"alt_text": "string"
}
}
]
},
"fieldsToDisclose": ["string"
]
}
]
}
],
"expirationDate": "2019-08-24T14:15:22Z"
}

Response samples

200
400
500

Content type

application/json

{"linkedVpId": "string",
"linkedVpUrl": "string"
}

HolderLinkedVpGetDetails

Authorizations:

accessToken

path Parameters

linked_vp_id

required

string

header Parameters

wallet-id

required

string

Responses

Response samples

200
400
404
500

Content type

application/json

{"linkedVpId": "string",
"linkedVpUrl": "string"
}

HolderLinkedVpDelete

Deletes a linked VP

Authorizations:

accessToken

path Parameters

linked_vp_id

required

string

header Parameters

wallet-id

required

string

Responses

Response samples

404
500

Content type

application/json

{"error": "string",
"message": "string"
}

WalletList

Provides list of wallets owned by the authenticated client.

Authorizations:

accessToken

query Parameters

ownerId	string
searchName	string Wallet name to search using "begins-with" filter

Responses

Response samples

200
400
500

Content type

application/json

[{"walletId": "string",
"name": "string",
"capabilities": ["holder"
]
}
]

WalletCreate

Creates a new wallet for the authenticated client.

Authorizations:

accessToken

Request Body schema: application/json

name required	string (Wallet name)
required	object (Wallet config) Wallet specific configuration.
	object (Wallet Metadata) Custom key value pairs associated with the wallet. The key must not exceed 64 characters and the value must not exceed 256 characters.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"config": {"credentialIssuers": [{"name": "string",
"description": "string",
"id": "string",
"credentialType": "string",
"credentialIssuer": "CtWalletSame",
"issuerConfiguration": {"credentialVerifierId": "string",
"mapping": { }
},
"credentialFormat": "sd_jwt_vc",
"signingKeyIdentifier": "did",
"disclosableClaims": ["string"
]
}
],
"credentialVerifiers": [{"name": "string",
"description": "string",
"id": "string",
"scope": "string",
"presentationDefinition": {"id": "string",
"format": {"jwt_vc": {"alg": ["string"
]
},
"jwt_vp": {"alg": ["string"
]
},
"sd_jwt": {"alg": ["string"
]
},
"dc+sd-jwt-vc": {"alg": ["string"
]
},
"mso_mdoc": {"alg": ["string"
]
}
},
"input_descriptors": [{"id": "string",
"format": {"jwt_vc": {"alg": [null
]
},
"jwt_vp": {"alg": [null
]
},
"sd_jwt": {"alg": [null
]
},
"dc+sd-jwt-vc": {"alg": [null
]
},
"mso_mdoc": {"alg": [null
]
}
},
"constraints": {"fields": [{"id": null,
"name": null,
"purpose": null,
"filter": { },
"path": [ ]
}
]
},
"group": ["string"
]
}
],
"submission_requirements": [{"rule": "all",
"count": 0,
"min": 0,
"max": 0,
"from": "string",
"from_nested": [{ }
],
"name": "string"
}
]
},
"dcqlQuery": {"credentials": [{"id": "string",
"format": "string",
"meta": {"vct_values": ["string"
]
},
"claims": [{"id": "string",
"path": [null
],
"values": [null
]
}
]
}
]
}
}
],
"oidcRevision": {"oidc4vci": "Draft11",
"oidc4vp": "Draft16"
},
"trustFramework": "EBSI",
"legalEntity": false,
"EBSI": {"requiredDid": "string",
"isOnboarded": false,
"attributeId": "string",
"proxyUrl": "string",
"configuration": {"conformanceClientId": "https://api-conformance.ebsi.eu/conformance/v3/issuer-mock",
"authorization": "https://api-conformance.ebsi.eu/authorisation/v4",
"didRegistry": "https://api-conformance.ebsi.eu/did-registry/v5",
"trustedIssuersRegistry": "https://api-conformance.ebsi.eu/trusted-issuers-registry/v5",
"trustedSchemasRegistry": "https://api-conformance.ebsi.eu/trusted-schemas-registry/v3",
"mainSchema": "https://api-pilot.ebsi.eu/trusted-schemas-registry/v3/schemas/z3MgUFUkb722uq4x3dv5yAJmnNmzDFeK5UC8x83QoeLJM",
"statusListSchema": "https://api-pilot.ebsi.eu/trusted-schemas-registry/v3/schemas/z6HkKUAhWgMQqGQEcc1kewTWJrY4nrtadncmid7hsfGV8"
}
},
"EUDI": {"etsiTslUrl": "string",
"trustedTslCertificates": ["string"
],
"didTrustFramework": "EBSI"
},
"IDTL": {"isOnboarded": true,
"etsiTslUrl": "string",
"trustedTslCertificates": ["string"
]
},
"walletKeyIdentifier": "did",
"statusListExpiration": 31556952
},
"metadata": { }
}

Response samples

200
400
500

Content type

application/json

{"id": "string"
}

WalletGet

Provides wallet details

Authorizations:

accessToken

path Parameters

wallet_id

required

string

Responses

Response samples

200
400
404
500

Content type

application/json

{"walletId": "string",
"name": "string",
"capabilities": ["holder"
],
"config": {"credentialIssuers": [{"name": "string",
"description": "string",
"id": "string",
"credentialType": "string",
"credentialIssuer": "CtWalletSame",
"issuerConfiguration": {"credentialVerifierId": "string",
"mapping": { }
},
"credentialFormat": "sd_jwt_vc",
"signingKeyIdentifier": "did",
"disclosableClaims": ["string"
]
}
],
"credentialVerifiers": [{"name": "string",
"description": "string",
"id": "string",
"scope": "string",
"presentationDefinition": {"id": "string",
"format": {"jwt_vc": {"alg": ["string"
]
},
"jwt_vp": {"alg": ["string"
]
},
"sd_jwt": {"alg": ["string"
]
},
"dc+sd-jwt-vc": {"alg": ["string"
]
},
"mso_mdoc": {"alg": ["string"
]
}
},
"input_descriptors": [{"id": "string",
"format": {"jwt_vc": {"alg": [null
]
},
"jwt_vp": {"alg": [null
]
},
"sd_jwt": {"alg": [null
]
},
"dc+sd-jwt-vc": {"alg": [null
]
},
"mso_mdoc": {"alg": [null
]
}
},
"constraints": {"fields": [{"id": null,
"name": null,
"purpose": null,
"filter": { },
"path": [ ]
}
]
},
"group": ["string"
]
}
],
"submission_requirements": [{"rule": "all",
"count": 0,
"min": 0,
"max": 0,
"from": "string",
"from_nested": [{ }
],
"name": "string"
}
]
},
"dcqlQuery": {"credentials": [{"id": "string",
"format": "string",
"meta": {"vct_values": ["string"
]
},
"claims": [{"id": "string",
"path": [null
],
"values": [null
]
}
]
}
]
}
}
],
"oidcRevision": {"oidc4vci": "Draft11",
"oidc4vp": "Draft16"
},
"trustFramework": "EBSI",
"legalEntity": false,
"EBSI": {"requiredDid": "string",
"isOnboarded": false,
"attributeId": "string",
"proxyUrl": "string",
"configuration": {"conformanceClientId": "https://api-conformance.ebsi.eu/conformance/v3/issuer-mock",
"authorization": "https://api-conformance.ebsi.eu/authorisation/v4",
"didRegistry": "https://api-conformance.ebsi.eu/did-registry/v5",
"trustedIssuersRegistry": "https://api-conformance.ebsi.eu/trusted-issuers-registry/v5",
"trustedSchemasRegistry": "https://api-conformance.ebsi.eu/trusted-schemas-registry/v3",
"mainSchema": "https://api-pilot.ebsi.eu/trusted-schemas-registry/v3/schemas/z3MgUFUkb722uq4x3dv5yAJmnNmzDFeK5UC8x83QoeLJM",
"statusListSchema": "https://api-pilot.ebsi.eu/trusted-schemas-registry/v3/schemas/z6HkKUAhWgMQqGQEcc1kewTWJrY4nrtadncmid7hsfGV8"
}
},
"EUDI": {"etsiTslUrl": "string",
"trustedTslCertificates": ["string"
],
"didTrustFramework": "EBSI"
},
"IDTL": {"isOnboarded": true,
"etsiTslUrl": "string",
"trustedTslCertificates": ["string"
]
},
"walletKeyIdentifier": "did",
"statusListExpiration": 31556952
},
"metadata": { }
}

WalletPatch

Update wallet metadata and configuration.

Authorizations:

accessToken

path Parameters

wallet_id

required

string

Request Body schema: application/json

name	string (Wallet name)
	object (Wallet config) Wallet specific configuration.
	object (Wallet Metadata) Custom key value pairs associated with the wallet. The key must not exceed 64 characters and the value must not exceed 256 characters.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"config": {"credentialIssuers": [{"name": "string",
"description": "string",
"id": "string",
"credentialType": "string",
"credentialIssuer": "CtWalletSame",
"issuerConfiguration": {"credentialVerifierId": "string",
"mapping": { }
},
"credentialFormat": "sd_jwt_vc",
"signingKeyIdentifier": "did",
"disclosableClaims": ["string"
]
}
],
"credentialVerifiers": [{"name": "string",
"description": "string",
"id": "string",
"scope": "string",
"presentationDefinition": {"id": "string",
"format": {"jwt_vc": {"alg": ["string"
]
},
"jwt_vp": {"alg": ["string"
]
},
"sd_jwt": {"alg": ["string"
]
},
"dc+sd-jwt-vc": {"alg": ["string"
]
},
"mso_mdoc": {"alg": ["string"
]
}
},
"input_descriptors": [{"id": "string",
"format": {"jwt_vc": {"alg": [null
]
},
"jwt_vp": {"alg": [null
]
},
"sd_jwt": {"alg": [null
]
},
"dc+sd-jwt-vc": {"alg": [null
]
},
"mso_mdoc": {"alg": [null
]
}
},
"constraints": {"fields": [{"id": null,
"name": null,
"purpose": null,
"filter": { },
"path": [ ]
}
]
},
"group": ["string"
]
}
],
"submission_requirements": [{"rule": "all",
"count": 0,
"min": 0,
"max": 0,
"from": "string",
"from_nested": [{ }
],
"name": "string"
}
]
},
"dcqlQuery": {"credentials": [{"id": "string",
"format": "string",
"meta": {"vct_values": ["string"
]
},
"claims": [{"id": "string",
"path": [null
],
"values": [null
]
}
]
}
]
}
}
],
"oidcRevision": {"oidc4vci": "Draft11",
"oidc4vp": "Draft16"
},
"trustFramework": "EBSI",
"legalEntity": false,
"EBSI": {"requiredDid": "string",
"isOnboarded": false,
"attributeId": "string",
"proxyUrl": "string",
"configuration": {"conformanceClientId": "https://api-conformance.ebsi.eu/conformance/v3/issuer-mock",
"authorization": "https://api-conformance.ebsi.eu/authorisation/v4",
"didRegistry": "https://api-conformance.ebsi.eu/did-registry/v5",
"trustedIssuersRegistry": "https://api-conformance.ebsi.eu/trusted-issuers-registry/v5",
"trustedSchemasRegistry": "https://api-conformance.ebsi.eu/trusted-schemas-registry/v3",
"mainSchema": "https://api-pilot.ebsi.eu/trusted-schemas-registry/v3/schemas/z3MgUFUkb722uq4x3dv5yAJmnNmzDFeK5UC8x83QoeLJM",
"statusListSchema": "https://api-pilot.ebsi.eu/trusted-schemas-registry/v3/schemas/z6HkKUAhWgMQqGQEcc1kewTWJrY4nrtadncmid7hsfGV8"
}
},
"EUDI": {"etsiTslUrl": "string",
"trustedTslCertificates": ["string"
],
"didTrustFramework": "EBSI"
},
"IDTL": {"isOnboarded": true,
"etsiTslUrl": "string",
"trustedTslCertificates": ["string"
]
},
"walletKeyIdentifier": "did",
"statusListExpiration": 31556952
},
"metadata": { }
}

Response samples

200
400
404
500

Content type

application/json

{"id": "string"
}

WalletDelete

Permanently deletes the wallet with all credentials and keys. Make sure you know what you are doing before hitting this endpoint.

Authorizations:

accessToken

path Parameters

wallet_id

required

string

Responses

Response samples

404
500

Content type

application/json

{"error": "string",
"message": "string"
}

WalletKeys

Provides wallet keys used for signing.

Authorizations:

accessToken

path Parameters

wallet_id

required

string

Wallet ID

Responses

Response samples

200
404
500

Content type

application/json

{"property1": null,
"property2": null
}

WalletX509CSRCreate

Creates a X509 certificate signing request for signing key.

Authorizations:

accessToken

path Parameters

wallet_id

required

string

Wallet ID

Request Body schema: application/json

organizationName required	string (Organization name)
tradeName	string (Trade name)
did	string (DID) DID identifier that will be added among Subject Alternative Names
organizationWebsite required	string (Organization website)
email required	string (Organization email)
streetAddress required	string (Organization address)
locality required	string (Town, city, village, etc. name where the organization is located)
postalCode required	string (Organization address postal code)
province	string (Province/state where the organization is located)
country required	string (Two letter ISO code for the country where the organization is located)

Responses

Request samples

Payload

Content type

application/json

{"organizationName": "string",
"tradeName": "string",
"did": "string",
"organizationWebsite": "string",
"email": "string",
"streetAddress": "string",
"locality": "string",
"postalCode": "string",
"province": "string",
"country": "string"
}

Response samples

200
404
500

Content type

application/json

{"csr": "string"
}

WalletX509CertificateGet

Returns an X509 certificate in PEM format

path Parameters

wallet_id

required

string

Wallet ID

Responses

WalletX509CertificateImport

Imports an X509 certificate to be used when signing credentials

Authorizations:

accessToken

path Parameters

wallet_id

required

string

Wallet ID

Request Body schema: application/json

certificate

required

string (X509 certificate in PEM format)

Responses

Request samples

Payload

Content type

application/json

{"certificate": "string"
}

Response samples

400
404
500

Content type

application/json

{"error": "string",
"message": "string"
}

WalletNotifications

Provides first-in-first-out queue of notifications for a specific wallet.

Authorizations:

accessToken

path Parameters

wallet_id

required

string

Wallet ID

Responses

Response samples

200
404
500

Content type

application/json

[{"subjectDid": "string",
"eventType": "vp.verified",
"eventDetails": {"verifierId": "string"
},
"time": "2019-08-24T14:15:22Z"
}
]

WalletNotificationHistory

Provides wallet notifications that can be used to audit the wallet activity.

Authorizations:

accessToken

path Parameters

wallet_id

required

string

Wallet ID

query Parameters

limit	integer The number of items
nextMarker	string Marking the next set of items
type	Array of strings (Wallet notification event type) Items Enum: "vp.verified" "vp.invalid" "idToken.received" "offer.processed" "offer.initiated" "credential.created" "credential.issued" "credential.received" "credential.revoked" "wmp.invitation_accepted" "wmp.credential_offer" "wmp.credential_verification_request" "wmp.error" Notification types
sort	string (ListSort) Enum: "asc" "desc" Sort flag controls the sort direction by the time created

Responses

Response samples

200
404
500

Content type

application/json

{"list": [{"subjectDid": "string",
"eventType": "vp.verified",
"eventDetails": {"verifierId": "string"
},
"time": "2019-08-24T14:15:22Z"
}
],
"next": "http://example.com"
}

WalletNotificationGetByState

Gets a specific notification by state

Authorizations:

accessToken

path Parameters

wallet_id required	string Wallet ID
event_type required	string Event type
state required	string Event identifier

Responses

Response samples

200
404
500

Content type

application/json

{"subjectDid": "string",
"eventType": "vp.verified",
"eventDetails": {"verifierId": "string"
},
"time": "2019-08-24T14:15:22Z"
}

WalletVerifiedCredentialsByState

Gets a specific verified credentials by state

Authorizations:

accessToken

path Parameters

wallet_id required	string Wallet ID
state required	string Verifier state

Responses

Response samples

200
404
500

Content type

application/json

{"credentials": [{"metadata": {"id": "string",
"walletId": "string",
"ownerId": "string",
"name": "string",
"interaction": "issuance",
"message": "string",
"type": "VerifiableCredential,VerifiableAttestation",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"issuanceDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"status": "draft",
"disclosableFields": ["string"
],
"issuerIdentifier": "string",
"issuerDisplay": [{"name": "string",
"locale": "string",
"logo": {"uri": "string",
"alt_text": "string"
}
}
]
},
"vcSubject": {"id": "string"
},
"signedVc": "string"
}
],
"vp": "string",
"holder": "string"
}

WalletVerifiedCredentialsDeleteByState

Deletes a specific verified credentials by state

Authorizations:

accessToken

path Parameters

wallet_id required	string Wallet ID
state required	string Verifier state

Responses

Response samples

404
500

Content type

application/json

{"error": "string",
"message": "string"
}

TfOnboardRequest

Processes a request to onboard another legal entity.

Authorizations:

accessToken

path Parameters

wallet_id

required

string

Request Body schema: application/json

did required	string DID which will be onboarded
validUntil required	string <date-time> Specifies when the authorization to onboard credential will expire

Responses

Request samples

Payload

Content type

application/json

{"did": "string",
"validUntil": "2019-08-24T14:15:22Z"
}

Response samples

400
404
500

Content type

application/json

{"error": "string",
"message": "string"
}

TfOnboard

Onboards legal entity to the trust framework based on the wallet configuration.

Authorizations:

accessToken

path Parameters

wallet_id

required

string

Responses

Response samples

200
400
404
500

Content type

application/json

{"did": "string"
}

TfAccreditAs

Accredits a legal entity as RTAO, TAO or TI.

Authorizations:

accessToken

path Parameters

wallet_id

required

string

Request Body schema: application/json

type

required

string

Enum: "TrustedIssuer" "TrustedAccreditationOrganisation" "RootTrustedAccreditationOrganisation"

Responses

Request samples

Payload

Content type

application/json

{"type": "TrustedIssuer"
}

Response samples

400
404
500

Content type

application/json

{"error": "string",
"message": "string"
}

TfAccreditRequest

Processes a request to accredit another legal entity.

Authorizations:

accessToken

path Parameters

wallet_id

required

string

Request Body schema: application/json

did required	string
type required	string Enum: "TrustedIssuer" "TrustedAccreditationOrganisation"
accreditedFor required	string Base64 encoded json to be used for the `accreditedFor` property of the credential
validUntil required	string <date-time> Specifies when will the accreditation credential expire

Responses

Request samples

Payload

Content type

application/json

{"did": "string",
"type": "TrustedIssuer",
"accreditedFor": "string",
"validUntil": "2019-08-24T14:15:22Z"
}

Response samples

400
404
500

Content type

application/json

{"error": "string",
"message": "string"
}

TfRevokeAccreditation

Revokes another legal entity's wallet DID accreditation.

Authorizations:

accessToken

path Parameters

wallet_id

required

string

Request Body schema: application/json

did required	string
type required	string Enum: "TrustedIssuer" "TrustedAccreditationOrganisation"

Responses

Request samples

Payload

Content type

application/json

{"did": "string",
"type": "TrustedIssuer"
}

Response samples

400
404
500

Content type

application/json

{"error": "string",
"message": "string"
}

TfX509CertificateIssue

Issues a certificate based on the provided certificate request

Authorizations:

accessToken

path Parameters

wallet_id

required

string

Request Body schema: application/json

csr required	string (Certificate signing request in PEM format)
expirationDate required	string <date-time> (Certificate expiration date)
ca	boolean (Whether the issued certificate is CA or not) Default: false

Responses

Request samples

Payload

Content type

application/json

{"csr": "string",
"expirationDate": "2019-08-24T14:15:22Z",
"ca": false
}

Response samples

200
400
404
500

Content type

application/json

{"certificate": "string"
}

WmpCreateNewInvitation

Creates a new WMP invitation

Authorizations:

accessToken

header Parameters

walletId

required

string

Responses

Response samples

200
400
404
500

Content type

application/json

{"invitationUrl": "string"
}

WmpAcceptInvitation

Accepts a WMP invitation

Authorizations:

accessToken

header Parameters

walletId

required

string

Request Body schema: application/json

invitationUrl

required

string

URL of the invitation JWT

Responses

Request samples

Payload

Content type

application/json

{"invitationUrl": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": "string",
"name": "string",
"roles": ["holder"
],
"identifiers": [{"type": "did",
"identifier": ["string"
]
}
]
}

WmpEntityList

Get all clients that have established WMP connection.

Authorizations:

accessToken

query Parameters

entityType

required

string

Enum: "server" "client"

header Parameters

walletId

required

string

Responses

Response samples

200
400
404
500

Content type

application/json

[{"id": "string",
"name": "string",
"roles": ["holder"
],
"identifiers": [{"type": "did",
"identifier": ["string"
]
}
]
}
]

WmpEntityGet

Get entity based on the entity ID

Authorizations:

accessToken

path Parameters

entity_id

required

string

header Parameters

walletId

required

string

Responses

Response samples

200
400
404
500

Content type

application/json

{"id": "string",
"name": "string",
"roles": ["holder"
],
"identifiers": [{"type": "did",
"identifier": ["string"
]
}
]
}

WmpEntityDelete

Delete entity based on the entity ID

Authorizations:

accessToken

path Parameters

entity_id

required

string

header Parameters

walletId

required

string

Responses

Response samples

400
404
500

Content type

application/json

{"error": "string",
"message": "string"
}

WmpEntityConnectionGet

Get entity connection status

Authorizations:

accessToken

path Parameters

entity_id

required

string

header Parameters

walletId

required

string

Responses

Response samples

200
400
404
500

Content type

application/json

{"connected": true
}

WmpEntityServerConnect

Connect to a WMP server entity

Authorizations:

accessToken

path Parameters

entity_id

required

string

header Parameters

walletId

required

string

Responses

Response samples

400
404
500

Content type

application/json

{"error": "string",
"message": "string"
}

WmpClientGetPendingRequests

Get pending WMP requests (credential offers or credential verification requests)

Authorizations:

accessToken

header Parameters

walletId

required

string

Responses

Response samples

200
400
404
500

Content type

application/json

[{"type": "credentialOffer",
"requestUrl": "string"
}
]

WmpClientProcessRequest

Process WMP request

Authorizations:

accessToken

path Parameters

request_id

required

string

header Parameters

walletId

required

string

Responses

Response samples

200
400
404
500

Content type

application/json

{"requirementType": "none",
"presentationDefinition": {"id": "string",
"format": {"jwt_vc": {"alg": ["string"
]
},
"jwt_vp": {"alg": ["string"
]
},
"sd_jwt": {"alg": ["string"
]
},
"dc+sd-jwt-vc": {"alg": ["string"
]
},
"mso_mdoc": {"alg": ["string"
]
}
},
"input_descriptors": [{"id": "string",
"format": {"jwt_vc": {"alg": ["string"
]
},
"jwt_vp": {"alg": ["string"
]
},
"sd_jwt": {"alg": ["string"
]
},
"dc+sd-jwt-vc": {"alg": ["string"
]
},
"mso_mdoc": {"alg": ["string"
]
}
},
"constraints": {"fields": [{"id": "string",
"name": "string",
"purpose": "string",
"filter": { },
"path": ["string"
]
}
]
},
"group": ["string"
]
}
],
"submission_requirements": [{"rule": "all",
"count": 0,
"min": 0,
"max": 0,
"from": "string",
"from_nested": [{ }
],
"name": "string"
}
]
},
"dcqlQuery": {"credentials": [{"id": "string",
"format": "string",
"meta": {"vct_values": ["string"
]
},
"claims": [{"id": "string",
"path": ["string"
],
"values": ["string"
]
}
]
}
]
},
"presentationCandidates": [{"descriptorId": "string",
"credentials": [{"credential": {"id": "string",
"walletId": "string",
"ownerId": "string",
"name": "string",
"interaction": "issuance",
"message": "string",
"type": "VerifiableCredential,VerifiableAttestation",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"issuanceDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"status": "draft",
"disclosableFields": ["string"
],
"issuerIdentifier": "string",
"issuerDisplay": [{"name": "string",
"locale": "string",
"logo": {"uri": "string",
"alt_text": "string"
}
}
]
},
"fieldsToDisclose": ["string"
]
}
]
}
],
"interactionId": "string",
"offeredCredentialsTypes": ["string"
],
"issuerUrl": "string",
"issuerDisplay": [{"name": "string",
"locale": "string",
"logo": {"uri": "string",
"alt_text": "string"
}
}
]
}