Registry Technical Overview Table of Contents 1 Prerequisites .............................................................................................................................3 2 Overview ...................................................................................................................................4 Usage Options for the EIDR Registry ............................................................................................................................... 5 User Interfaces ................................................................................................................................................................................ 6 Command-line Tools .................................................................................................................................................................... 6 SDK ....................................................................................................................................................................................................... 7 3 Catalog Matching and Registration .............................................................................................8 Data Model Alignment Process .......................................................................................................................................... 8 Record Matching Process ..................................................................................................................................................... 9 Bulk Registration Process .................................................................................................................................................... 9 Bulk Modification Process ................................................................................................................................................... 9 4 Record Types ........................................................................................................................... 10 Content ID Records ............................................................................................................................................................... 10 Categorization of Objects ....................................................................................................................................................... 10 Content Record Creation and Modification ................................................................................................................... 13 Alternate ID .................................................................................................................................................................................. 15 Aliases and Deletion Model .................................................................................................................................................... 15 Parties ........................................................................................................................................................................................ 16 Permissions Model ..................................................................................................................................................................... 17 Access Control Lists ................................................................................................................................................................... 18 5 Content Read Operations ......................................................................................................... 19 Resolution ................................................................................................................................................................................. 19 Traversals ................................................................................................................................................................................. 19 Queries ....................................................................................................................................................................................... 20 6 Using Parties ............................................................................................................................ 21 7 De-Duplication ......................................................................................................................... 22 Overview ................................................................................................................................................................................... 22 Matching API ........................................................................................................................................................................... 23 Tokens and Batches .............................................................................................................................................................. 23 Single/Batch ................................................................................................................................................................................. 24 Immediate/Asynchronous ...................................................................................................................................................... 24 Tokens ............................................................................................................................................................................................. 24 Scores ............................................................................................................................................................................................... 26 Polling .............................................................................................................................................................................................. 26 8 Content Create and Modify Operations .................................................................................... 27 Registration Workflows ...................................................................................................................................................... 27 Synchronous Workflow ........................................................................................................................................................... 27 Asynchronous Workflow Tools and API ........................................................................................................................... 27 API-based Asynchronous Workflow .................................................................................................................................. 27 User Interface Handling .......................................................................................................................................................... 28 Modifying Records ................................................................................................................................................................ 29 9 Registry Operation Status Codes .............................................................................................. 31 Appendix A: Text Processing and Queries ......................................................................................... 33 Field Rules ................................................................................................................................................................................ 33 Simple Queries ........................................................................................................................................................................ 34 Search Expressions .................................................................................................................................................................... 35 Example Queries ......................................................................................................................................................................... 38 Language-specific Filtering ............................................................................................................................................... 40 Glossary........................................................................................................................................... 43 1 Prerequisites This document is primarily intended for developers who are undertaking an EIDR system integration directly via the EIDR HTTP API, using one of the provided EIDR SDKs, or by leveraging the EIDR Command-Line Tools. Other EIDR users with a technical background may also find it helpful in orienting them to the EIDR registry. EIDR recommends that you also read the following documents, which contain more detailed information about the topics covered in this guide: Introduction to the EIDR Data Model Programmers Guide Best Practices and Use Cases for Abstraction Records Data Fields Reference REST API Reference Schema Documents EIDR: ID Format See https://members.eidr.org/ for additional documentation. Registry Technical Overview 3 v1.0a 2020-07-12 2 Overview This document describes the usage of the EIDR Registry for technical users and developers, including how to read, create, and modify Content ID records, how to perform operations on Parties, and how to perform operations on Video