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

Number of records to skip for pagination.

limit integerrequired

Default value: 10

Maximum number of records to return per page.

lifecycle string

Filtering data agreements by draft/completed status

target stringrequired

Possible values: [digital_wallet]

Data exchange target

Responses

200

Data agreements (based on ISO 27560) listed successfully

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": "65471222e8c7c3bb3c2c8492",
      "version": "1.0.0",
      "controllerId": "string",
      "controllerUrl": "string",
      "controllerName": "string",
      "policy": {
        "id": "65471222e8c7c3bb3c2c7701",
        "name": "Default data policy",
        "version": "1.0.0",
        "url": "https://example.com/privacy-policy",
        "jurisdiction": "EU",
        "industrySector": "Healthcare",
        "dataRetentionPeriodDays": 365,
        "geographicRestriction": "EU",
        "storageLocation": "EU",
        "thirdPartyDataSharing": true
      },
      "dataAttributes": [
        {
          "id": "65471222e8c7c3bb3c2c8501",
          "name": "Name",
          "description": "Full name of the individual",
          "sensitivity": false,
          "category": "Personal",
          "scope": "read",
          "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": "65471222e8c7c3bb3c2c5501",
        "payload": "{...}",
        "signature": "eyJhbGciOiJFZERTQSJ9...",
        "verificationMethod": "Ed25519Signature2020",
        "verificationPayload": "{...}",
        "verificationPayloadHash": "a1b2c3d4e5f6...",
        "verificationArtifact": "",
        "verificationSignedBy": "did:key:z6Mkf...",
        "verificationSignedAs": "individual",
        "verificationJwsHeader": "",
        "timestamp": "2024-01-15T10:30:00Z",
        "signedWithoutObjectReference": false,
        "objectType": "revision",
        "objectReference": "65471222e8c7c3bb3c2c6601"
      },
      "active": "",
      "forgettable": "",
      "compatibleWithVersionId": "string",
      "lifecycle": "draft",
      "dataUsingServices": [
        null
      ],
      "openApiSpecification": {},
      "dataSources": [
        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": 1,
    "totalItems": 25,
    "totalPages": 3,
    "limit": 10,
    "hasPrevious": false,
    "hasNext": true
  }
}

400

bad input parameter

Response Headers

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

500

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Loading...