Authorisation Server

Get verification request

POST/v4/service/consent/data-space/{organisationId}/get-verification-request

Starts the signing of a data disclosure agreement record at a data source (the get_verification_request_endpoint of its access point configuration). The data source makes the record for a published template revision, signs it with its organisation wallet, and answers with an OpenID4VP verification request that has the record as transaction data. The wallet of the data using service answers that request to sign the record as the data using service.

Send an access token from the token endpoint of the same organisation (POST .../token) as Authorization: Bearer <token>. No API key.

Without dataDisclosureAgreementRecordId the data source makes a new record, and optIn must be true. With the canonicalId of an existing record, the parties sign that record again, for example with optIn: false to opt out.

With autoSend: true and the token of a connected organisation, the data source sends the request to the post_verification_request_endpoint of that organisation itself, and the answer is 200 with an empty body. With the token of an OAuth 2.0 client, autoSend has no effect: give the request to the data using service yourself, for example with POST .../post-verification-request of the data using service.

Errors:

400: the organisation does not exist, a field is missing or not valid, optIn is false for a new record, or the template revision is not published.
401: the access token is missing, unknown or expired (Bearer access token is not valid).
403: the organisation is suspended (organisation_suspended).
404: the template revision does not exist (Data Disclosure Agreement not found).

Get verification request

Language of the request sample

curl -X POST 'https://demo-api.igrant.io/v4/service/consent/data-space/{organisationId}/get-verification-request' \
  -H 'Content-Type: application/json' \
  -d '{
  "dataDisclosureAgreementTemplateRevisionId": "6af081832d6fb7b6ac6efc66",
  "optIn": true,
  "autoSend": false
}'

{
  "verificationRequest": "openid4vp://?client_id=x509_hash%3AC3P2NdnE_I-TP7eLZ7Vgqcppm4wK7QvfeogSEmnaK3Y&request_uri=https%3A%2F%2Fdemo-api.igrant.io%2Forganisation%2F60905277-d953-4ef7-aa4c-cec413d00d93%2Fservice%2Fverification%2F5bdac5aa-e77a-4181-8f8d-65507990bef3&request_uri_method=post"
}

Authorizations

Public. The operation takes no credentials.

Path parameters

organisationIdstringrequired
The ID of the organisation

Body

application/json

dataDisclosureAgreementTemplateRevisionIdstringrequired
ID of the published template revision to sign a record for.
dataDisclosureAgreementRecordIdstring
The canonicalId of an existing record to sign again. Leave it out to make a new record.
optInbooleanrequired
true to opt in to the agreement, false to opt out. A new record needs true.
autoSendbooleanrequired
true asks the data source to send the request to a connected data using service itself. It works only with the access token of a connected organisation.
urlPrefixstring
Prefix of the verification request URL.
Default:openid4vp://

Response

application/json

The verification request. With autoSend: true and the token of a connected organisation, the body is empty.

verificationRequeststring
The OpenID4VP verification request URL for the wallet of the data using service.