light-mode-image
Learn
API ReferencePresentation sessions

Retrieve presentation session result

Analytics Events

CREDENTIAL_PRESENTATION_SESSION_RESULT_RETRIEVE_STARTCREDENTIAL_PRESENTATION_SESSION_RESULT_RETRIEVE_SUCCESSCREDENTIAL_PRESENTATION_SESSION_RESULT_RETRIEVE_FAIL
GET/v2/presentations/sessions/{sessionId}/result

Retrieves the result of an online presentation session by providing the session's ID.

When a holder responds to a verification request, the result indicates whether the presentation succeeded and whether the credentials were verified. The response can be a PresentationSuccessResult (holder completed the presentation workflow) or a PresentationFailureResult (holder was unable to complete the workflow).

A successful presentation may include verified credentials, credential errors (requested credentials not provided), claim errors (specific claims that failed verification), or a combination of these outcomes.

Your backend should validate that the returned challenge matches the challenge generated before starting the session to protect against session replay attacks.

For detailed information about result structures, error types, and complete examples, see the handling verification results guide.

Analytic events

  • CREDENTIAL_PRESENTATION_SESSION_RESULT_RETRIEVE_START
  • CREDENTIAL_PRESENTATION_SESSION_RESULT_RETRIEVE_SUCCESS
  • CREDENTIAL_PRESENTATION_SESSION_RESULT_RETRIEVE_FAIL

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

sessionId*string

Session ID

Formatuuid

Response Body

application/json

application/json

curl -X GET "https://example.vii.au01.mattr.global/v2/presentations/sessions/497f6eca-6276-4993-bfeb-53cbbbba6f08/result"

Holder successfully presented a valid mDL with all requested claims verified

{
  "sessionId": "550e8400-e29b-41d4-a716-446655440000",
  "challenge": "c5a27e4c-85b6-4b3c-9f1a-2d8e5f3a4b7c",
  "credentialQuery": [
    {
      "profile": "mobile",
      "docType": "org.iso.18013.5.1.mDL",
      "nameSpaces": {
        "org.iso.18013.5.1": {
          "family_name": {
            "intentToRetain": false
          },
          "given_name": {
            "intentToRetain": false
          },
          "birth_date": {
            "intentToRetain": false
          },
          "address": {
            "intentToRetain": false
          }
        }
      }
    }
  ],
  "credentials": [
    {
      "docType": "org.iso.18013.5.1.mDL",
      "claims": {
        "org.iso.18013.5.1": {
          "family_name": {
            "value": "Smith"
          },
          "given_name": {
            "value": "Jane"
          },
          "birth_date": {
            "value": "1990-05-15"
          },
          "address": {
            "value": "123 Main Street, Springfield"
          }
        }
      },
      "validityInfo": {
        "signed": "2024-01-15T10:00:00Z",
        "validFrom": "2024-01-15T10:00:00Z",
        "validUntil": "2027-01-15T10:00:00Z",
        "expectedUpdate": "2028-01-15T10:00:00Z"
      },
      "verificationResult": {
        "verified": true
      },
      "issuerInfo": {
        "commonName": "State Department of Motor Vehicles",
        "trustedIssuerId": "d4a6e9f2-3b1c-4d8e-a5f7-9c2b0e8d1a3f"
      },
      "branding": {
        "name": "Driver License",
        "description": "State-issued driver license",
        "backgroundColor": "#1E3A8A"
      }
    }
  ]
}

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

How would you rate this page?

Delete a wallet provider DELETE

Deletes an existing wallet provider that can present mDocs for online verification. ### **Analytic events** * PRESENTATION_WALLET_PROVIDER_DELETE_START * PRESENTATION_WALLET_PROVIDER_DELETE_SUCCESS * PRESENTATION_WALLET_PROVIDER_DELETE_FAIL

Verify a CWT credential POST

Verify a CWT credential by providing the encoded payload and specifying verification options. You can provide a valid CWT credential as either an encoded string or a QR code in a PDF document or an image file. Standard checks performed on all verification requests: - Conformance of the string and encoded data. All string representations of CWT credentials must be prefixed with `CSC/1`. - Decoded payload structure is a valid CWT credential. - Issuer DID can be used to resolve its `did.json` document. - Public key from issuer's `did.json` document validates the proof signature, confirming the credential has not been tampered with. Optional parameter checks: - Credential was issued by a trusted issuer. - Current time is after the beginning of the credential validity period. - Current time is not after the end of the credential validity period. - Credential has not been revoked. ### **Analytic events** * CREDENTIAL_COMPACT_VERIFY_START * CREDENTIAL_COMPACT_VERIFY_SUCCESS * CREDENTIAL_COMPACT_VERIFY_FAIL