Detail the properties under which this organisation operates

GET /settings

This endpoint details the prerequisites for Data Request API operation. Additionally, some of the parameters supplied in this call are designed to make it easier for citizens to understand their rights and possibilities of enforcing them. Organisations must implement all of the parameters.

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • forgotPasswordLink string(url)

      A URL that points to the human-readable privacy policy that covers the processed data

    • legalEntity string

      The organisation that bears legal responsibility for all data processing

    • maxNumberOfRequests number

      The maximum amount of requests that can be made concurrently

    • oAuthClientId string

      The client identifier that can be used to authenticate a user against the OAuth server. This identifier may be rotated periodically, but must be made public using this API.

    • oAuthUrl string(url)

      Either describes a RFC8414 compliant OAuth metadata endpoint (also known as OpenID Discovery), or the

    • organisationName string

      The human-friendly name for the organisation processing the data

    • privacyPolicy string(url)

      A URL that points to the human-readable privacy policy that covers the processed data

    • privacyContactEmail string(email)

      An email address to which any issues arising with or from the retrieved data can be addressed to

    • supportedLanaguages array[string]

      A ISO 639-1 language code identifier

    • termsOfService string(url)

      A URL that points to the human-readable terms of service that covers the processed data
GET /settings 
curl \
 -X GET http://api.example.com/settings
Response examples (200) 
{
  "forgotPasswordLink": "https://acme-corp.com/forgot-password",
  "legalEntity": "ACME Corp Inc.",
  "maxNumberOfRequests": 5,
  "oAuthClientId": "6779ef20e75817b79602",
  "oAuthUrl": "https://oauth.acmecorp.com/",
  "organisationName": "ACME Corp",
  "privacyPolicy": "https://acme-corp.com/privacy-policy",
  "privacyContactEmail": "privacy@acme-corp.com",
  "supportedLanaguages": [
    "en"
  ],
  "termsOfService": "https://acme-corp.com/privacy-policy"
}
Response examples (200) 
{
  "forgotPasswordLink": "https://acme-corp.com/forgot-password",
  "legalEntity": "ACME Corp Inc.",
  "maxNumberOfRequests": 5,
  "oAuthClientId": "6779ef20e75817b79602",
  "oAuthUrl": "https://oauth.acmecorp.com/",
  "organisationName": "ACME Corp",
  "privacyPolicy": "https://acme-corp.com/privacy-policy",
  "privacyContactEmail": "privacy@acme-corp.com",
  "supportedLanaguages": [
    "en"
  ],
  "termsOfService": "https://acme-corp.com/privacy-policy"
}