Verifier Management API

Creates a new verification process with the given attributes

Changed on
post/management/api/verifications

Request

  • Base URL
    https://astra-vz-verifier-service-d.apps.p-szb-ros-shrd-npr-01.cloud.admin.ch
  • Auth
    none declared

Request body

accepted_issuer_didsstring[]

List of dids from issuers whose credentials are accepted for this verification. Will be evaluated before trust anchor. If not specified and no trust anchor specified all dids 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

Example request

{
  "accepted_issuer_dids": [
    "did:example:12345"
  ],
  "trust_anchors": [
    {
      "did": "did:example:12345",
      "trust_registry_uri": "https://trust-reg.trust-infra.swiyu-int.admin.ch"
    }
  ],
  "presentation_definition": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Test Verification",
    "purpose": "We want to test a new Verifier",
    "format": {
      "vc+sd-jwt": {
        "sd-jwt_alg_values": [
          "ES256"
        ],
        "kb-jwt_alg_values": [
          "ES256"
        ]
      }
    },
    "input_descriptors": [
      {
        "id": "11111111-1111-1111-1111-111111111111",
        "name": "Example Data Request",
        "purpose": "We collect this data to test our verifier",
        "format": {
          "vc+sd-jwt": {
            "sd-jwt_alg_values": [
              "ES256"
            ],
            "kb-jwt_alg_values": [
              "ES256"
            ]
          }
        },
        "constraints": {
          "fields": [
            {
              "path": [
                "$.vct"
              ],
              "filter": {
                "type": "string",
                "const": "test-sdjwt"
              }
            },
            {
              "path": [
                "$.dateOfBirth"
              ]
            }
          ]
        }
      }
    ]
  },
  "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"
  },
  "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"
            ]
          }
        ]
      }
    ],
    "credential_sets": [
      {
        "options": [
          [
            "identity_credential_dcql"
          ],
          [
            "university_degree_dcql"
          ]
        ],
        "required": true
      }
    ]
  }
}

Response

Verification created

idstring uuid
request_noncestring
state'PENDING' | 'SUCCESS' | 'FAILED'
verification_urlstring
verification_deeplinkstring

Example response

{
  "presentation_definition": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Test Verification",
    "purpose": "We want to test a new Verifier",
    "format": {
      "vc+sd-jwt": {
        "sd-jwt_alg_values": [
          "ES256"
        ],
        "kb-jwt_alg_values": [
          "ES256"
        ]
      }
    },
    "input_descriptors": [
      {
        "id": "11111111-1111-1111-1111-111111111111",
        "name": "Example Data Request",
        "purpose": "We collect this data to test our verifier",
        "format": {
          "vc+sd-jwt": {
            "sd-jwt_alg_values": [
              "ES256"
            ],
            "kb-jwt_alg_values": [
              "ES256"
            ]
          }
        },
        "constraints": {
          "fields": [
            {
              "path": [
                "$.vct"
              ],
              "filter": {
                "type": "string",
                "const": "test-sdjwt"
              }
            },
            {
              "path": [
                "$.dateOfBirth"
              ]
            }
          ]
        }
      }
    ]
  },
  "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"
            ]
          }
        ]
      }
    ],
    "credential_sets": [
      {
        "options": [
          [
            "identity_credential_dcql"
          ],
          [
            "university_degree_dcql"
          ]
        ],
        "required": true
      }
    ]
  }
}

Changes

    • warning

      added the new invalid_token_status_list enum value to the / response property for the response status

    • breaking

      request property was restricted to a list of enum values

    • breaking

      the /// request property's minItems was increased to 1

    • breaking

      the /// request property's minItems was increased to 1

    • breaking

      the //// request property's minItems was increased to 1

    • breaking

      the ////// request property's minItems was increased to 1

    • breaking

      the ////// request property's minItems was increased to 1

    • breaking

      the ////// request property's minItems was increased to 1

    • breaking

      the ///// request property's minItems was increased to 1

    • breaking

      the ///// request property's minItems was increased to 1

    • breaking

      the /// request property's minLength was increased from 0 to 1

    • breaking

      the // request property's minLength was increased from 0 to 1

    • breaking

      the // request property's minLength was increased from 0 to 1

    • breaking

      the response property became optional for the status

    • breaking

      the // response's property type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      the request property default value direct_post was removed

    • info

      added the new direct_post enum value to the request property

    • info

      added the new direct_post.jwt enum value to the request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status