Skip to main content
Verification

Send data agreement verification request

POST/v4/config/ows/verifier/data-agreement-verifications

Sends an OpenID4VP Authorization Request for a data agreement (ISO/IEC TS 27560) of the organisation and starts a verification. The latest revision of the data agreement must have the data exchange profile OID4VC and the method of use data_using_service (see Create data agreement). The request uses the presentation definition of its dataExchange.id, and it carries the data agreement, so the holder sees its terms with the request.

The response is the verification history of the request, as for Send verification request; its dataAgreementId and dataAgreement hold the data agreement. Follow the result in the same way.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:verifications:request

Body

application/json

The data agreement and the options of this request.

  • dataAgreementIdstringrequired

    The ID of a data agreement of the organisation, from the consent API. Required. Its latest revision must have the data exchange profile OID4VC and the method of use data_using_service; the request uses the presentation definition of its dataExchange.id, and carries the data agreement.

    Example:"6af0821c2d6fb7b6ac6efc78"

  • presentationDefinitionIdstring

    Not used: the presentation definition comes from the data agreement.

  • requestByReferenceboolean

    true: requestUrl has a request_uri, and the wallet fetches the request from it, which keeps the QR code small. A signed request always goes by reference, so the value changes only an unsigned redirect_uri request. Default false.

    Default:false

    Example:true

  • transactionDataobject

    The transaction data that the holder approves with the presentation. Required when the presentation definition of the data agreement has a transactionDataDefinitionType, and refused when it has none. It must follow the JSON Schema of that type (List transaction data templates).

  • noncestring

    The nonce of the request, which the presentation must contain. Default: a new random value.

    Example:"z4cVLRsq9pKx0NgQ7E3hJg"

  • urlPrefixstring

    The start of requestUrl, before ?. Use it to open a given wallet app, for example its universal link. Default openid4vp://.

    Example:"openid4vp://"

  • individualIdstring

    The ID of an individual of the organisation. The wallet also sends the request as a push notification to the device of the individual, which needs a push notification token. Do not send it with mapperId.

  • mapperIdstring

    Your own ID of an individual of the organisation (the mapper ID). As individualId, but the individual is found by this ID. Do not send it with individualId.

  • hasSignatureStampboolean

    For a document signing request (qes_data): true puts a visible signature stamp on the signed PDF. Default false.

    Default:false

  • signatureCoordinateinteger[]

    For a document signing request: where the signature goes on the PDF page, as [x1, y1, x2, y2] in points. Exactly four integers.

    4 items.

Response

application/json

The verification history of the new request, with status request_sent.

  • verificationHistoryobject

    The verification history of one OpenID4VP verification request: the request, the response of the wallet and the result of the checks.

    Each member is always in the answer, except dcApiRequest, dcApiProtocol, cryptographicKeyFormat, cryptographicKeyIdentifier and presentationDefinitionSnapshot, which are left out when they have no value. A member without a value has the empty value of its type: "" for a string, 0 for a number, false for a boolean, null for an object or an array.

    A request has no expiry flag. It expires presentationRequestLifetimeSeconds of the verifier configuration after createdAt; the verification status stream reports it as expired.