Consent Requests

Get Consent Request

Retrieves consent request with {id} if the authenticated data producer is assigned to it.

get/api/agreement/v1/consent-requests/{id}

Path parameters

idstring uuid required

Response

idstring uuid required

dataProducerUidstring

UID of the data producer

dataProducerBurstring

BUR of the data producer; null for UID-based consent requests

stateCode'GRANTED' | 'OPENED' | 'DECLINED' | 'LEGALLY_PERMITTED' | 'NOT_CREATED'

Possible states of a consent request:

GRANTED: Consent has been granted
OPENED: Consent request is open and awaiting response
DECLINED: Consent has been declined
NOT_CREATED: Placeholder to indicate that no consent request exists yet for a given UID.

showStateAsMigratedboolean

If the state should be shown as migrated

lastStateChangeDatestring date

Date and time when the state was changed last

requestDatestring date

Example response

{
  "dataProducerUid": "CHE123456789",
  "dataProducerBur": "99910003",
  "showStateAsMigrated": true,
  "lastStateChangeDate": "2025-06-16T11:04:51.823889",
  "requestDate": "2022-03-10",
  "dataRequest": {
    "dataSourceSystem": {
      "code": "AGIS",
      "dataProvider": {
        "code": "BLW",
        "uid": "CHE123456789"
      }
    },
    "humanFriendlyId": "GL56",
    "submissionDate": "2025-06-16T11:04:51.823889",
    "title": {
      "de": "Anfrage zu Bodentypen und Bodenqualitätsdaten",
      "fr": "Demande sur les types de sols et les données de qualité du sol",
      "it": "Richiesta sui tipi di suolo e sui dati sulla qualità del suolo"
    },
    "description": {
      "de": "Ziel der Anfrage ist es, Informationen über Bodentypen und deren Qualität zu erhalten, um fundierte Entscheidungen zur Fruchtfolge, Düngung und nachhaltigen Bewirtschaftung treffen zu können.",
      "fr": "L'objectif de la demande est d'obtenir des informations sur les types de sols et leur qualité afin de prendre des décisions éclairées concernant la rotation des cultures, la fertilisation et la gestion durable.",
      "it": "L'obiettivo della richiesta è ottenere informazioni sui tipi di suolo e sulla loro qualità per prendere decisioni informate sulla rotazione delle colture, la fertilizzazione e la gestione sostenibile."
    },
    "purpose": {
      "de": "Bewertung der Bodenqualität",
      "fr": "Évaluation de la qualité du sol",
      "it": "Valutazione della qualità del suolo"
    },
    "dataConsumerLegalName": "Bio Suisse, Vereinigung Schweizer Biolandbau-Organisationen",
    "dataConsumerDisplayName": "Bio Suisse",
    "dataConsumerUid": "CHE101708094",
    "dataConsumerCity": "Basel",
    "dataConsumerZip": "4052",
    "dataConsumerStreet": "Peter Merian-Str. 34",
    "dataConsumerCountry": "CH",
    "contactPhoneNumber": "+41 79 123 45 67",
    "contactEmailAddress": "example@labelorganisation.ch",
    "dataConsumerLogoBase64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
    "validRedirectUriRegex": "^https:\\/\\/www\\.dummy-label-organisation\\/.*$",
    "advantages": [
      {
        "de": "Vermeiden von Mehreingaben",
        "fr": "Éviter les saisies multiples",
        "it": "Evitare inserimenti multipli"
      }
    ]
  }
}

Changes

Changed in 23 of the 56 revisions of this API.92719

Aug 31, 20265760204210ed1See the full diff
- ●
  added the new LEGALLY_PERMITTED enum value to the stateCode response property for the response status 200
  response-property-enum-value-added
Aug 13, 2026a0609096db651See the full diff
- ○
  endpoint deprecated
  endpoint-deprecated
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 11, 202652c1637abca01See the full diff
- ○
  added the optional property dataProducerBur to the response with the 200 status
  response-optional-property-added
Jun 19, 2026a3a5891898921See the full diff
- ○
  added the required property dataRequest/advantages to the response with the 200 status
  response-required-property-added
Jun 4, 2026d1729646b7662See the full diff
- ●
  added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 404
  response-property-enum-value-added
- ●
  added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 500
  response-property-enum-value-added
May 29, 2026a598446f80932See the full diff
- ○
  removed the DATA_PROVIDER_ERROR enum value from the type response property for the response status 404
  response-property-enum-value-removed
- ○
  removed the DATA_PROVIDER_ERROR enum value from the type response property for the response status 500
  response-property-enum-value-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 26, 20267cee7b14bf6f2See the full diff
- ●
  added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 404
  response-property-enum-value-added
- ●
  added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 500
  response-property-enum-value-added
May 12, 20265b038eea902d8See the full diff
- ●
  added the new OTP_EXPIRED enum value to the type response property for the response status 404
  response-property-enum-value-added
- ●
  added the new OTP_EXPIRED enum value to the type response property for the response status 500
  response-property-enum-value-added
- ●
  added the new OTP_INVALID enum value to the type response property for the response status 404
  response-property-enum-value-added
- ●
  added the new OTP_INVALID enum value to the type response property for the response status 500
  response-property-enum-value-added
- ●
  added the new OTP_LOCKED enum value to the type response property for the response status 404
  response-property-enum-value-added
- ●
  added the new OTP_LOCKED enum value to the type response property for the response status 500
  response-property-enum-value-added
- ●
  added the new OTP_RESEND_COOLDOWN enum value to the type response property for the response status 404
  response-property-enum-value-added
- ●
  added the new OTP_RESEND_COOLDOWN enum value to the type response property for the response status 500
  response-property-enum-value-added
May 4, 2026b2698fe1c30a2See the full diff
- ○
  added the optional property dataRequest/consumerSignatureType to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property dataRequest/providerSignatureType to the response with the 200 status
  response-optional-property-added
Apr 8, 202636609d47a3a721See the full diff
- ●
  added the new TO_BE_ACTIVATED enum value to the dataRequest/stateCode response property for the response status 200
  response-property-enum-value-added
- ●
  added the new TO_BE_RELEASED_BY_PROVIDER enum value to the dataRequest/stateCode response property for the response status 200
  response-property-enum-value-added
- ○
  added the optional property dataRequest/dataSourceSystem/dataProvider/uid to the response with the 200 status
  response-optional-property-added

Full history (23 revisions)