partners

Retrieve a partner

Changed on

Returns a single partner with the given ID

get/metadata/partners/{id}

Request

  • Base URL
    https://api.didomi.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.didomi.io/metadata/partners/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The ID of the partner to retrieve

Response

A Partner object

idstring required

Partner ID

namestring required

Name of the partner

tagsstring[]

Extra classification items for the partner

contactstring

Contact information for someone from the partner

websitestring uri

Website URL of the partner

website_optoutstring uri

URL for consumers to opt-out from data collection and processing from the partner

hostsstring[]

List of hosts (DNS names) that belong to the partner

url_patternsstring[]

List of URL patterns (regular expressions) that uniquely identify the partner

urlsstring[]

If partners were queried from URLs (with the url query-string parameter), this property contains a list of all URLs that were matched to this partner

taxonomy_idstring

The ID of the taxonomy item for classifying this partner

organization_idstring

The organization ID that owns the partner

category_idstring required

The category ID of the partner

countrystring

The ISO Alpha-2 code of the country where the partner is located

created_atstring date-time

Creation date of the partner

updated_atstring date-time

Last update date of the partner

versionnumber

Revision number of the partner object

default_purposes_idstring[]

Purposes of the partner with consent legal basis

legitimate_interest_purposes_idstring[]

Purposes of the partner with legitimate interest legal basis

spi_purposes_idstring[]

Purposes of the partner with sensitive personal information

essential_purposes_idstring[]

Purposes the partner declares as essential: disclosed, but never consented to nor objected to. For IAB partners this covers both special purposes and features, which stay distinguishable through each purpose namespaces. Writable only with client type auth

flexible_purposes_idstring[]

Purposes whose declared processing rule may be overridden by a publisher restriction. Always a subset of the purposes the partner already declares. Writable only with client type auth

cookie_max_durationnumber

The duration of time for which the cookies are stored

cookie_max_duration_unit'months' | 'days' | 'seconds'

The unit of the cookie max duration

uses_non_cookie_accessboolean

Whether the vendor uses other means of storage than cookies

deprecatedboolean

Whether a partner is deprecated or not. Deprecated partners cannot be added to privacy centers or consent notices but are not immediately removed to not break entities that already use them. Deprecated partners will eventually be removed.

notesstring

Free-form field to keep various notes on a vendor

Changes

  • 70997bf7efc9Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status