Sign in

v57

latestOpenAPI 3.0.0W3C Software and Document Licenseraw.githubusercontent.com2026-08-01233665.9 KB
Interactions
Credentials
Exchanges

Retrieve available interaction protocols from the interaction originator.

Retrieve available interaction protocols from the interaction originator.

get/interactions/{interactionId}

Path parameters

string required
OR
integer required

The unique interaction identifier for the current interaction.

Query parameters

iuv'1' required

Informs a reader of the Interaction URL of the Interaction API version, and allows for quick disambiguation of the URL when scanned from a QR Code.

Request body

OR

Example request

{
  "inviteRequest": "https://website.example/invitation/87654321/invite-request/response",
  "vcapi": "https://vcapi.example/workflows/z1A1FjMfnG/exchanges/z19mxakBFecZ",
  "otherFutureAPI": "https://otherFutureAPI.example/collection/0987"
}

Response

The protocols object with the advertised interaction protocol options.

OR

Example response

{
  "inviteRequest": "https://website.example/invitation/87654321/invite-request/response",
  "vcapi": "https://vcapi.example/workflows/z1A1FjMfnG/exchanges/z19mxakBFecZ",
  "otherFutureAPI": "https://otherFutureAPI.example/collection/0987"
}