Get the status of a verification session between Verification Service and external wallet.

GET

/verification-session/status/{verificationSessionId}

• Verification Server (Control API)

Returns the status of a verification session between Verification Service and external wallet. The status can be one of the following:

• IN_PROGRESS — denoting that the verification protocol is still ongoing.
• VERIFICATION_FAILED — denoting that the verification protocol has terminated, and Verification Service was unable to verify the credential. Additionally, a description field will be present with this variant containing some additional information.
• VERIFICATION_SUCCEEDED — denoting that the verification protocol has terminated, and Verification Service was able to cryptographically verify the credential, and validate the issuer authenticity according to the trust policy valid for this session. Additionally, a presentedClaims field will be present containing the claims that were disclosed during presentation. This allows the caller to perform any business-logic checks they wish.

The session will be removed from the external verifier after the session timeout expires no matter its status. The session timeout is controlled by the verification_session_timeout_secs configuration parameter. After the session is removed this call will return a 404 - Session not found error.

Parameters

Path Parameters

verificationSessionId

required

string format: uuid

A unique ID of the verification session

Responses

200

Verification session status retrieved successfully.

object

verificationSessionStatus

required

Status of the verification session, either IN_PROGRESS, VERIFICATION_FAILED, or VERIFICATION_SUCCEEDED.

string format: uuid

VERIFICATION_SUCCEEDED

presentedClaims

JSON object containing claims that were disclosed during presentation.

object

{
  "name": "John",
  "age": 27,
  "address": {
    "street": "Baker Street",
    "postalCode": "NW1"
  },
  "nationalities": [
    "UK"
  ]
}

description

Additional information about the failure of the verification in the given session.

string

Invalid signature.

{
  "verificationSessionStatus": "VERIFICATION_SUCCEEDED",
  "presentedClaims": {
    "name": "John",
    "age": 27,
    "address": {
      "street": "Baker Street",
      "postalCode": "NW1"
    },
    "nationalities": [
      "UK"
    ]
  }
}

400

Bad request (e.g. invalid UUID).

object

message

Error message

string

Session ID is not a valid UUID.

404

Verification Session not found.

object

message

Error message

string

Verification Session not found

500

Internal Server Error

object

message

Error message

string

Internal Server Error