Verifier Management API

Creates a new verification process with the given attributes

Changed on
post/management/api/verifications

Request

  • Base URL
    http://localhost:8080
  • Auth
    none declared

Request body

accepted_issuer_didsstring[] nullable

List of dids from issuers whose credentials are accepted for this verification. Will be evaluated before trust anchor. If not specified and trust anchor specified in environment variables no presentations are trusted.

jwt_secured_authorization_requestboolean

Toggle whether the request-object is available as plain object oras jwt object signed by the verifier as additional security measure

response_mode'direct_post' | 'direct_post.jwt'

Supported response_mode as defined in OID4VP

redirect_uristring uri

[EXPERIMENTAL] Optional absolute URI to redirect the user after the verification process. Must contain a session_nonce parameter.

Example request

{
  "accepted_issuer_dids": [
    "did:example:12345"
  ],
  "configuration_override": {
    "external_url": "https://www.example.com/verifier",
    "verifier_did": "did:webvh:mySCID12345213:identifier-reg.trust-infra.swiyu.admin.ch:api:v1:did:00000000-0000-0000-0000-000000000000",
    "verification_method": "did:webvh:mySCID12345213:identifier-reg.trust-infra.swiyu.admin.ch:api:v1:did:00000000-0000-0000-0000-000000000000#myVerificationMethod-xx",
    "key_id": "myOverrideHSMKeyId01",
    "key_pin": "11111",
    "client_metadata": {
      "client_name": "My Client Name",
      "client_name#en": "My Client Name",
      "client_name#de-CH": "Mein Kundenname",
      "logo_uri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAAC0lEQVQI12NgAAIABQAABjE+ibYAAAAASUVORK5CYII="
    }
  },
  "dcql_query": {
    "credentials": [
      {
        "id": "identity_credential_dcql",
        "format": "dc+sd-jwt",
        "meta": {
          "vct_values": [
            "https://credentials.example.com/identity_credential"
          ]
        },
        "claims": [
          {
            "path": [
              "given_name"
            ]
          },
          {
            "path": [
              "family_name"
            ]
          },
          {
            "path": [
              "address",
              "street_address"
            ]
          }
        ],
        "require_cryptographic_holder_binding": true
      },
      {
        "id": "university_degree_dcql",
        "format": "dc+sd-jwt",
        "meta": {
          "vct_values": [
            "https://credentials.example.com/university_degree"
          ]
        },
        "claims": [
          {
            "path": [
              "degree_name"
            ]
          },
          {
            "path": [
              "graduation_year"
            ]
          }
        ]
      }
    ]
  },
  "verification_purpose": {
    "scope": "com.example.age_verification",
    "purpose_name": {
      "default": "Age Verification",
      "de-ch": "Altersverifikation"
    },
    "purpose_description": {
      "default": "Age Verification required for xyz"
    }
  },
  "redirect_uri": "https://example.com/redirect?session_nonce=12345"
}

Response

Verification created

idstring uuid
request_noncestring
state'PENDING' | 'SUCCESS' | 'FAILED'
credential_evaluationobject

Object of Evaluations, where the key is the id of the dcql_query credential. Only present if application.additional-audit-information.credential-evaluation-enabled is set to true (default: false).

verification_urlstring
verification_deeplinkstring

Example response

{
  "dcql_query": {
    "credentials": [
      {
        "id": "identity_credential_dcql",
        "format": "dc+sd-jwt",
        "meta": {
          "vct_values": [
            "https://credentials.example.com/identity_credential"
          ]
        },
        "claims": [
          {
            "path": [
              "given_name"
            ]
          },
          {
            "path": [
              "family_name"
            ]
          },
          {
            "path": [
              "address",
              "street_address"
            ]
          }
        ],
        "require_cryptographic_holder_binding": true
      },
      {
        "id": "university_degree_dcql",
        "format": "dc+sd-jwt",
        "meta": {
          "vct_values": [
            "https://credentials.example.com/university_degree"
          ]
        },
        "claims": [
          {
            "path": [
              "degree_name"
            ]
          },
          {
            "path": [
              "graduation_year"
            ]
          }
        ]
      }
    ]
  },
  "wallet_response": {
    "dcql_response": {
      "my_hitchhiker_request": {
        "name": [
          "Arthur Dent"
        ],
        "address.street_address": [
          "42 Market Street"
        ],
        "education": [
          "Bachelor of Science",
          "Master of Science"
        ]
      }
    }
  }
}

Changes

    • info

      added the optional property / to the response with the status

    • info

      response property wallet_response/credential_subject_data deprecated

    • info

      response property wallet_response/credential_subject_data/additionalProperties/ deprecated

    • warning

      removed the request property