List all data agreements

GET 
/config/data-agreements

This endpoint allows the admin to read all data agreements and their revisions defined earlier in an organisation.

Request

Query Parameters

revisionId stringrequired

An object with id revisionId

offset integerrequired

Requested index for start of resources to be provided in response requested by client

limit integerrequired

Default value: 10

Number of items returned per page. Requested number of resources to be provided in response requested by client

lifecycle string

Filtering data agreements by draft/completed status

target stringrequired

Possible values: [digital_wallet]

Data exchange target

Responses

200

Response Headers

application/json

Schema

Schema

dataAgreements object[]
pagination object

currentPage integer

Current page number

totalItems integer

Total number of items available

totalPages integer

Total number of pages based on limit

limit integer

Number of items per page

hasPrevious boolean

Indicates if there's a previous page

hasNext boolean

Indicates if there's a next page

Example (from schema)

{
  "dataAgreements": [
    {
      "id": "",
      "version": "",
      "controllerId": "string",
      "controllerUrl": "string",
      "controllerName": "string",
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": "",
        "thirdPartyDataSharing": true
      },
      "dataAttributes": [
        {
          "id": "",
          "name": "",
          "description": "",
          "sensitivity": "",
          "category": "",
          "restrictions": [
            {
              "credDefId": "H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default",
              "schemaId": "H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0"
            }
          ]
        }
      ],
      "purpose": "string",
      "purposeDescription": "string",
      "lawfulBasis": "",
      "methodOfUse": "",
      "dpiaDate": "",
      "dpiaSummaryUrl": "string",
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      },
      "active": "",
      "forgettable": "",
      "compatibleWithVersionId": "string",
      "lifecycle": "draft",
      "dataUsingServices": [
        null
      ],
      "dataExchange": {
        "dataExchangeProfile": "AIP10",
        "id": "string",
        "credentialDefinitionId": "string",
        "schemaId": "string",
        "isExistingSchema": true,
        "qrId": "string",
        "firebaseDynamicLink": "string",
        "presentationRequest": {
          "name": "string",
          "version": "string",
          "requestedAttributes": {
            "name": "string",
            "restrictions": [
              {
                "schemaId": "string",
                "credDefId": "string"
              }
            ]
          }
        }
      }
    }
  ],
  "pagination": {
    "currentPage": 0,
    "totalItems": 0,
    "totalPages": 0,
    "limit": 0,
    "hasPrevious": true,
    "hasNext": true
  }
}

400

bad input parameter

Response Headers

Loading...