Skip to main content
European CommissionEBSI European Blockchain
Get Help
Select the Environment you want to work withEnvironment:
warning icon

This API is being released as part of an upcoming version.

The upcoming version is not backward compatible with the current stable version. You can find the details of the upcoming release and affected endpoints in the change log. Please contact eu-ebsi@ec.europa.eu if this upcoming release might cause a high impact on either an ongoing development or a piloting demonstration.

Presentation definition requirements

GET 
/authorisation/v4/presentation-definitions

Retrieves the presentation definition requirements associated with various OpenID Connect (OIDC) scopes.

Request​

Query Parameters
    scope string

    Possible values: [openid didr_write, openid didr_invite, openid tir_write, openid tir_invite, openid timestamp_write, openid tnt_authorise, openid tnt_create, openid tnt_write, openid tpr_write, openid tsr_write]

    OIDC scope

    Examples:

    Write to DID Registry

    Example: openid didr_write

Responses​

Success

Schema
    id stringrequired

    A UUID or some other unique ID to identify this Presentation Definition

    name string

    A name property is a human-friendly string intended to constitute a distinctive designation of the Presentation Definition.

    purpose string

    It describes the purpose for which the Presentation Definition's inputs are being requested.

    format object

    What claim variants Verifiers and Holders support.

    jwt_vc object

    Which JWT Algorithm is supported

    alg string[]required

    Possible values: >= 1

    List of names of the the JWT Algorithms

    jwt_vc_json object

    Which JWT Algorithm is supported

    alg string[]required

    Possible values: >= 1

    List of names of the the JWT Algorithms

    jwt_vp object

    Which JWT Algorithm is supported

    alg string[]required

    Possible values: >= 1

    List of names of the the JWT Algorithms

    jwt_vp_json object

    Which JWT Algorithm is supported

    alg string[]required

    Possible values: >= 1

    List of names of the the JWT Algorithms

    submission_requirements object[]

    List of requirements for described inputs in input descriptors.

  • Array [
    • name string

    what verifiable credential is demanded in order for the presentation to be sensible.

    purpose string

    Why this verifiable credentials is requested.

    rule rulesrequired

    Possible values: [all, pick]

    Whether all the requirements are mandatory or holder has multiple options to select verifiable credentials from

    count integer

    Possible values: >= 1

    How many of the credentials are demanded for the presentation to be sensible.

    min integer

    Minimum of the credentials are demanded for the presentation to be sensible.

    max integer

    Maximum of the credentials are demanded for the presentation to be sensible.

    from string

    One of the group strings specified for one or more [[ref:Input Descriptor Objects].

    from_nested undefined[]

    Possible values: >= 1

    nested submission_requirement and is a way to organize the requirements. For example requirements mentioned in the flat list will also be able to provide same information but will be less organized.

  • ]
    • input_descriptors object[]required

    List of descriptions of the required inputs.

  • Array [
    • id stringrequired

    The verifiable credentials that is acceptable from the holder. e.g. wa_driver_license

    name string

    The verifiable credentials that is acceptable from the holder in a human readibly string form. i.e. an alternative for the humans to the id

    purpose string

    It describes the purpose for which the Presentation Definition's inputs are being requested.

    format object

    What claim variants Verifiers and Holders support.

    jwt_vc object

    Which JWT Algorithm is supported

    alg string[]required

    Possible values: >= 1

    List of names of the the JWT Algorithms

    jwt_vc_json object

    Which JWT Algorithm is supported

    alg string[]required

    Possible values: >= 1

    List of names of the the JWT Algorithms

    jwt_vp object

    Which JWT Algorithm is supported

    alg string[]required

    Possible values: >= 1

    List of names of the the JWT Algorithms

    jwt_vp_json object

    Which JWT Algorithm is supported

    alg string[]required

    Possible values: >= 1

    List of names of the the JWT Algorithms

    group string[]

    A group from which the specific credential is required.

    constraints objectrequired

    Describes the constraints from Verifier that should be followed by Holder.

    limit_disclosure optionality

    Possible values: [required, preferred]

    Whether an item is optional or not in the presentation. E.g. if an item is required presentation can not be accepted without it.

    statuses object

    statuses which are acceptable

    active object

    This is a requirement to show what directive is to be followed for this status.

    directive directives

    Possible values: [required, allowed, disallowed]

    A directive is an instruction to the holder about what significance to give to the element it refers to.

    • required
      - The item 'must' be presented
    • allowed
      - The item 'can' be presented
    • disallowed
      - The item 'must NOT' be presented
    suspended object

    This is a requirement to show what directive is to be followed for this status.

    directive directives

    Possible values: [required, allowed, disallowed]

    A directive is an instruction to the holder about what significance to give to the element it refers to.

    • required
      - The item 'must' be presented
    • allowed
      - The item 'can' be presented
    • disallowed
      - The item 'must NOT' be presented
    revoked object

    This is a requirement to show what directive is to be followed for this status.

    directive directives

    Possible values: [required, allowed, disallowed]

    A directive is an instruction to the holder about what significance to give to the element it refers to.

    • required
      - The item 'must' be presented
    • allowed
      - The item 'can' be presented
    • disallowed
      - The item 'must NOT' be presented
    fields object[]

    It's a list of Fields.

  • Array [
    • id string

    Must be a unique identifier between all the fields in the Presentation Definition.

    path string[]required

    List of JSon paths where the field is expected to be found.

    purpose string

    purpose for which the Claim's data is being requested.

    filter object

    This is the filter that can be applied on the field's value to know if the available credential with a specific field is acceptable or not.

    const object
    oneOf
    number
    enum object[]

    Fixed listed values which are acceptable in this variable.

  • Array [
  • ]
    • exclusiveMinimum object
    oneOf
    number
    exclusiveMaximum object
    oneOf
    number
    format string

    format in which the item is expected. e.g. date time format of some sort.

    formatMaximum string

    When this keyword are added, they also add comparison functions to formats "date", "time" and "date-time"

    formatMinimum string

    When this keyword are added, they also add comparison functions to formats "date", "time" and "date-time"

    formatExclusiveMaximum string

    When this keyword are added, they also add comparison functions to formats "date", "time" and "date-time"

    formatExclusiveMinimum string

    When this keyword are added, they also add comparison functions to formats "date", "time" and "date-time"

    minLength integer

    acceptable minimum length (e.g. of string) that is acceptable

    maxLength integer

    acceptable maximum length (e.g. of string) that is acceptable

    minimum object
    oneOf
    number
    maximum object
    oneOf
    number
    not object

    The values which will make the item unacceptable

    pattern string

    The regular expression that can help filter the target object.

    type stringrequired

    Object type of the acceptable field.

    contains
    items object
    anyOf
  • Array [
    • 0
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
  • ]
    • predicate optionality

    Possible values: [required, preferred]

    Whether an item is optional or not in the presentation. E.g. if an item is required presentation can not be accepted without it.

    name string

    human-friendly name that describes what the target field represents

  • ]
    • subject_is_issuer optionality

    Possible values: [required, preferred]

    Whether an item is optional or not in the presentation. E.g. if an item is required presentation can not be accepted without it.

    is_holder object[]

    It's a list of holder_subjects.

  • Array [
    • field_id string[]required

    The value of this property MUST be an array of strings, with each string matching the string value from a field object’s id property.

    directive optionalityrequired

    Possible values: [required, preferred]

    Whether an item is optional or not in the presentation. E.g. if an item is required presentation can not be accepted without it.

  • ]
    • same_subject object[]

    It's a list of holder_subjects.

  • Array [
    • field_id string[]required

    The value of this property MUST be an array of strings, with each string matching the string value from a field object’s id property.

    directive optionalityrequired

    Possible values: [required, preferred]

    Whether an item is optional or not in the presentation. E.g. if an item is required presentation can not be accepted without it.

  • ]
  • ]
    • frame object

    a JSON LD Framing Document object.

Loading...