Each entity that takes out an DDEX Implementation Licence will be allocated a DDEX Party Identifier (DPID) in accordance with the DPID standard. Therefore, each entity that sends or receives DDEX messages will have been allocated a DPID which means that it is always possible to identify sender and recipient of a DDEX message through their DPID.
Entities that do not send or receive DDEX messages themselves may also be allocated DPIDs if that entity contracts with a technical service provider to carry out the exchange of DDEX messages on its behalf. It is thus also possible to identify the “endpoints” or the “on behalf of” of any data flow facilitated by a DDEX message.
Some entities may be allocated more than one DPID. More information on this can be found here.
When including a DPID into a DDEX message it should not include any hyphens. When hyphens are used in the representation of a DPID this is solely for human readability. More information on the DPID syntax can be found here.
The allocation of DPIDs is undertaken through an automated system at dpid.ddex.net.
This is achieved by each entity seeking a DPID, the “applicant”, to complete and submit the application form. The application form requires the applicant seeking a DPID to accept the terms of the DDEX Implementation Licence. The system will then automatically allocate a DPID and send this data to the applicant.
Also, as part of the registration the applicant will receive, in the same email that includes the DPID data, credentials to enable the applicant to access the DPID Registry. This access will enable the applicant to:
- Update the reference metadata for the DPID or DPIDs allocated to the applicant;
- Apply for additional DPIDs, for example for different divisions within an applicant’s organisation, using the web interface or API;
- Look up DPIDs and browse the DPID registry;
- Download a copy of the public data contained in the DPID registry using the web interface or API; and
- Generate tokens for accessing the API.
When logging into dpid.ddex.net with the username and password provided, the applicant can view the complete DPID registry or search for a specific company or DPID. It is also possible to export the complete registry in PDF or XML format.
The only information shown to users are:
- Individual DPIDs;
- The name of the entity to whom the DPID has been allocated; and
- The street address of the entity to whom the DPID has been allocated.
When searching for a DPID, please use the human readable syntax, e.g. “PA-DPIDA-2014122301-Q” and not the form used in DDEX messages, “PADPIDA2014122301Q” (or just the string between “PADPIDA-“ and the last two characters (here: “-Q”).
Downloading DPID data using the API
The information available through the look up service is also available as XML data and can be downloaded by accessing the registry’s API at the following URLs:
- https://dpid.ddex.net/api/v2/xml-download?token=XXX to receive a list of the DPID records allocated to the applicant; and
- https://dpid.ddex.net/api/v2/xml-download/all?token=XXX to receive a list of all DPID records in the DPID registry.
The token is user-specific and details on how to generate them can be found at the bottom of this page. The system replies automatically with the XML formatted copy of the DPID registry. The XSD defining the syntax of the file is provided at http://ddex-standards.net/xml/dpid/20/dpid.xsd.
Updating DPID reference metadata using the web interface
Applicants that have been allocated one or more DPIDs must keep their record(s) up to date by logging into the system and changing any relevant information. This can be done using the web interface.
Requesting Additional DPIDs using the web interface
Applicants that have been allocated a DPID can request additional DPIDs.
When doing so, the applicant must choose a different “entity name” in order to distinguish that entity from any other existing entities associated with the applicant and thus distinguish the various DPIDs allocated to such entities. For example:
- “Company X (Video Service)”; and
- “Company X (Audio Service)”.
Requesting Additional DPIDs using the API
Some companies offer DDEX messaging services to their clients. This includes, or example, aggregators who send and receive DDEX messages on behalf of record companies.
Entities that wish to allocate DPIDs on behalf of their clients must contact the DDEX Secretariat at firstname.lastname@example.org so that it can be determined if that entity can be authorised to benefit from this feature of the DPID registry.
Managing tokens for API access
For any applicant to be able to access any features of the API, the applicant must have a valid token. This is generated by the user interface at the point at which the applicant logs in. Please navigate to “My Profile”.
Tokens will expire after 60 days. Please click “generate token” and then “update user details”.