CINXE.COM

<!DOCTYPE html> <html> <head> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <title>Reconciliation API | ICIJ Offshore Leaks Database</title> <meta name="description" content="The Reconciliation API is a service designed to help users match their data against the Offshore Leaks Database. This document provides an overview of the API's capabilities, structure, and usage."> <meta name="twitter:card" content="summary"> <meta name="twitter:site" content="ICIJorg"> <meta property="og:type" content="article"> <meta property="og:url" content="https://offshoreleaks.icij.org/docs/reconciliation"> <meta property="og:title" content="Reconciliation API"> <meta property="og:image" content="https://offshoreleaks.icij.org/vite/assets/offshoreleaks_db-a0e39c24.jpg"> <meta property="og:description" content="The Reconciliation API is a service designed to help users match their data against the Offshore Leaks Database. This document provides an overview of the API's capabilities, structure, and usage."> <script src="https://offshoreleaks.icij.org/sigma/sigma.min.js"></script> <script src="https://offshoreleaks.icij.org/sigma/plugins.min.js"></script> <script src="https://offshoreleaks.icij.org/vite/assets/application-c6d72dd7.js" crossorigin="anonymous" type="module"></script><link rel="stylesheet" href="https://offshoreleaks.icij.org/vite/assets/application-9605dc3e.css" media="screen" /> <meta name="description" content="The Reconciliation API is a service designed to help users match their data against the Offshore Leaks Database. This document provides an overview of the API's capabilities, structure, and usage."> <link rel="apple-touch-icon" sizes="57x57" href="/apple-touch-icon-57x57.png"> <link rel="apple-touch-icon" sizes="60x60" href="/apple-touch-icon-60x60.png"> <link rel="apple-touch-icon" sizes="72x72" href="/apple-touch-icon-72x72.png"> <link rel="apple-touch-icon" sizes="76x76" href="/apple-touch-icon-76x76.png"> <link rel="apple-touch-icon" sizes="114x114" href="/apple-touch-icon-114x114.png"> <link rel="apple-touch-icon" sizes="120x120" href="/apple-touch-icon-120x120.png"> <link rel="apple-touch-icon" sizes="144x144" href="/apple-touch-icon-144x144.png"> <link rel="apple-touch-icon" sizes="152x152" href="/apple-touch-icon-152x152.png"> <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon-180x180.png"> <link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32"> <link rel="icon" type="image/png" href="/android-chrome-192x192.png" sizes="192x192"> <link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96"> <link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16"> <link rel="manifest" href="/manifest.json"> <link rel="mask-icon" href="/safari-pinned-tab.svg" color="#ff0000"> <meta name="msapplication-TileColor" content="#000000"> <meta name="msapplication-TileImage" content="/mstile-144x144.png"> <meta name="theme-color" content="#000000"> <script src="https://offshoreleaks.icij.org/vite/assets/application-c6d72dd7.js" crossorigin="anonymous" type="module"></script><link rel="stylesheet" href="https://offshoreleaks.icij.org/vite/assets/application-9605dc3e.css" media="screen" /> </head> <body class="controller--docs action--show " > <header class="header vue-context"> <div class="header__container"> <a class="header__container__icij" href="/"> <brand-expansion mode="long" dark :size="45" /> <span class="sr-only">The International Consortium of Investigative Journalists</span> </a> <menu class="header__container__menu d-none d-lg-flex"> <a class="header__container__menu__item" href="/"> Home </a> <div class="header__container__menu__dropdown"> <span class="header__container__menu__dropdown__toggler"> About </span> <div class="header__container__menu__dropdown__nav"> <a class="header__container__menu__dropdown__nav__item" href="/pages/about"> About the database </a> <a class="header__container__menu__dropdown__nav__item" href="/pages/data"> Data sources </a> <a class="header__container__menu__dropdown__nav__item" href="/pages/howtouse"> How to use this database </a> <a class="header__container__menu__dropdown__nav__item" href="/pages/database"> Download </a> <a class="header__container__menu__dropdown__nav__item" href="/schema/oldb"> Rest API Schema </a> <a class="header__container__menu__dropdown__nav__item" href="/docs/reconciliation"> Reconciliation API </a> <a class="header__container__menu__dropdown__nav__item" href="/pages/credits"> Credits </a> <a class="header__container__menu__dropdown__nav__item" href="/tips/new"> Contact us </a> </div> </div> <a class="header__container__menu__item" href="/pages/database"> Download </a> <a class="header__container__menu__item" href="https://www.icij.org/donate/" target="_blank"> Support Us </a> </menu> <a class="header__container__toggler d-inline-block d-lg-none open_mobile_menu" href="#" v-b-modal.mobile-menu> <i class="fa fa-bars"></i> </a> </div> <b-modal hide-footer id="mobile-menu" v-cloak body-class="pt-0"> <template #modal-title> <a class="header__logo" href="/"> <brand-expansion mode="long" :size="45" /> <span class="sr-only">The International Consortium of Investigative Journalists</span> </a> </template> <div class="header--mobile"> <menu class="header__nav"> <a class="header__nav__item" href="/"> Home </a> <a class="header__nav__item" href="/pages/about"> About the database </a> <a class="header__nav__item" href="/pages/data"> Data sources </a> <a class="header__nav__item" href="/pages/howtouse"> How to use this database </a> <a class="header__nav__item" href="/pages/database"> Download </a> <a class="header__nav__item" href="/pages/credits"> Credits </a> <a class="header__nav__item" href="/tips/new"> Contact us </a> <a class="header__nav__item text-white btn btn-primary" href="https://www.icij.org/donate/" target="_blank" class="support" data-track-event="Modal|Open Donate|From Mobule Menu"> Support Us </a> </menu> </div> </b-modal> </header> <div class="sub-header vue-context"> <div class="container py-5 sub-header__container"> <div class="row align-items-center"> <h1 class="col-12 col-lg pb-3 text-uppercase font-weight-bold h2 sub-header__container__title"> Offshore Leaks Database </h1> <div class="col-12 col-lg-4 pr-lg-3 sub-header__container__search"> <label for="sub-header-search-input sub-header__container__search__label " class="d-none d-lg-inline-block"> Find out who鈥檚 behind more than 810,000 offshore companies, foundations and trusts. </label> <search-form-control action="/search" submit-button-class="btn btn-dark sub-header__container__search__submit"> <template #footer> <input type="hidden" name="c" id="c" autocomplete="off" /> <input type="hidden" name="j" id="j" autocomplete="off" /> <input type="hidden" name="d" id="d" autocomplete="off" /> </template> </search-form-control> </div> </div> </div> </div> <div class="container my-5"><div class="vue-context"> <donate-banner></donate-banner> </div></div> <div class="vue-context"> <donate-timebomb></donate-timebomb> </div> <div class="container docs"> <div class="row"> <div class="main_column main_column--page col-12 col-lg-8"> <main itemscope itemtype="http://schema.org/CollectionPage" class=""> <header class="main_column__heading"> <h1 itemprop="title" class="main_column__heading__title"> Reconciliation API </h1> <p class="main_column__heading__lead lead" itemprop="description"> The Reconciliation API is a service designed to help users match their data against the Offshore Leaks Database. This document provides an overview of the API's capabilities, structure, and usage. </p> </header> <div class="main_column__content" itemprop="mainContentOfPage"> <p>A reconciliation API is a web service designed to match and link data entities from different datasets. It helps in identifying and merging duplicate or related entities by providing mechanisms to compare and align data from disparate sources. This process is particularly useful for integrating and enriching data, ensuring consistency, and improving the quality of information in databases.</p> <p>In the context of the Offshore Leaks Database, the reconciliation API allows users to match their own data entities鈥攕uch as addresses, entities, intermediaries, officers, and other types鈥攁gainst the entities in the Offshore Leaks Database. This facilitates the identification of potential matches and the integration of external data with the rich, investigative data provided by the Offshore Leaks Database.</p> <p>By using this reconciliation API, users can:</p> <ul> <li>Automate the matching process to save time and reduce manual effort.</li> <li>Ensure that their data aligns with the verified information in the Offshore Leaks Database.</li> <li>Enhance their datasets with additional context and details from the Offshore Leaks Database.</li> </ul> <p>This document provides an overview of how to use the Offshore Leaks Database Reconciliation API, including supported types, authentication methods, and example usage scenarios.</p> <table><thead> <tr> <th>Name</th> <th>Value</th> </tr> </thead><tbody> <tr> <td>Spec version</td> <td>v0.2</td> </tr> <tr> <td>Identifier Space</td> <td><a href="https://schema.org/identifier">https://schema.org/identifier</a></td> </tr> <tr> <td>Schema Space</td> <td><a href="https://offshoreleaks.icij.org/schema/oldb">https://offshoreleaks.icij.org/schema/oldb</a></td> </tr> <tr> <td>Documentation</td> <td><a href="https://offshoreleaks.icij.org/docs/reconciliation">https://offshoreleaks.icij.org/docs/reconciliation</a></td> </tr> <tr> <td>Formats</td> <td><code>JSON</code> (default) or <code>JSONP</code></td> </tr> <tr> <td>Batch Size</td> <td>25</td> </tr> </tbody></table> <h2 id="supported-types">Supported Types</h2> <p>The Offshore Leaks Database API supports reconciliation for the following types:</p> <table><thead> <tr> <th>Name</th> <th>ID</th> </tr> </thead><tbody> <tr> <td><a href="/schema/oldb/address">Address</a></td> <td><code>https://offshoreleaks.icij.org/schema/oldb/address</code></td> </tr> <tr> <td><a href="/schema/oldb/entity">Entity</a></td> <td><code>https://offshoreleaks.icij.org/schema/oldb/entity</code></td> </tr> <tr> <td><a href="/schema/oldb/intermediary">Intermediary</a></td> <td><code>https://offshoreleaks.icij.org/schema/oldb/intermediary</code></td> </tr> <tr> <td><a href="/schema/oldb/node">Node</a></td> <td><code>https://offshoreleaks.icij.org/schema/oldb/node</code></td> </tr> <tr> <td><a href="/schema/oldb/officer">Officer</a></td> <td><code>https://offshoreleaks.icij.org/schema/oldb/officer</code></td> </tr> <tr> <td><a href="/schema/oldb/other">Other</a></td> <td><code>https://offshoreleaks.icij.org/schema/oldb/other</code></td> </tr> </tbody></table> <h2 id="general-api">General API</h2> <p>When the reconciliation service endpoint is queried with a HTTP <strong>GET</strong> request without parameters, the <strong>service manifest</strong> is returned. The manifest provides a comprehensive overview of its structure and capabilities. It includes details on supported versions, namespaces, default types, and authentication methods. The manifest also outlines the endpoints for entity viewing, preview, property proposals, and suggestions, along with configuration settings such as batch size and property settings.</p> <ul> <li><strong>Service URL</strong>: <code>https://offshoreleaks.icij.org/api/v1/reconcile</code></li> <li><strong>Method</strong>: <code>GET</code></li> <li><strong>Spec</strong>: <a href="https://www.w3.org/community/reports/reconciliation/CG-FINAL-specs-0.2-20230410/#service-manifest">CG-FINAL-specs-0.2#service-manifest</a></li> </ul> <p>For instance:</p> <div class="highlight"><pre class="highlight shell"><code>curl <span class="nt">-XGET</span> https://offshoreleaks.icij.org/api/v1/reconcile </code></pre></div> <h2 id="query-api">Query API</h2> <p>When the reconciliation service endpoint is queried with a HTTP <strong>POST</strong> request, a <strong>reconciliation query</strong> is performed. A reconciliation query consists of several fields, designed to help clients search for and identify matching entities within the Offshore Leaks Database. At least one of <code>query</code> or <code>queries</code> must be supplied. All other fields are optional. </p> <ul> <li><strong>Service URL</strong>: <code>https://offshoreleaks.icij.org/api/v1/reconcile</code></li> <li><strong>Method</strong>: <code>POST</code></li> <li><strong>Required Params</strong>: <code>query</code> or <code>queries</code></li> <li><strong>Spec</strong>: <a href="https://www.w3.org/community/reports/reconciliation/CG-FINAL-specs-0.2-20230410/#reconciliation-queries">CG-FINAL-specs-0.2#reconciliation-queries</a></li> </ul> <p>For instance, a query for "foo" on the Officer type:</p> <div class="highlight"><pre class="highlight shell"><code>curl <span class="nt">-XPOST</span> https://offshoreleaks.icij.org/api/v1/reconcile <span class="nt">--header</span> <span class="s2">"Content-Type: application/json"</span> <span class="nt">-d</span> <span class="s1">'{ "query": "foo", "type": "Officer" }'</span> </code></pre></div> <p>A reconciliation query batch can be a set of reconciliation queries indexed by string identifiers. This allows clients to perform multiple reconciliation queries in a single request, each with its own unique identifier.</p> <p>This comprehensive structure ensures that users can efficiently and accurately find matching entities in the Offshore Leaks Database, enhancing the quality and consistency of their datasets.</p> <p>For instance queries on the <code>Address</code> type, for "paris" in France (FRA) and "fin" in Monaco (MCO):</p> <div class="highlight"><pre class="highlight shell"><code>curl <span class="nt">-XPOST</span> https://offshoreleaks.icij.org/api/v1/reconcile <span class="nt">--header</span> <span class="s2">"Content-Type: application/json"</span> <span class="nt">-d</span> <span class="s1">'{ "type": "Address", "queries": { "q0": { "query": "paris", "properties": [ { "pid": "country_codes", "v": "FRA" } ] }, "q1": { "query": "fin", "properties": [ { "pid": "country_codes", "v": "MCO" } ] } } }'</span> </code></pre></div> <h2 id="data-extension-api">Data extension API</h2> <p>When the reconciliation service endpoint is queried with a HTTP <strong>GET</strong> request and the <code>extend</code> query parameter, clients can request additional information for entities by specifying the properties they are interested in. To use the <strong>extend API</strong>, clients should specify the entities and the properties they want to fetch values for. The service will then return the values for those properties.</p> <ul> <li><strong>Service URL</strong>: <code>https://offshoreleaks.icij.org/api/v1/reconcile/properties</code></li> <li><strong>Method</strong>: <code>GET</code>, <code>POST</code></li> <li><strong>Required Params</strong>: <code>extend</code></li> <li><strong>Spec</strong>: <a href="https://www.w3.org/community/reports/reconciliation/CG-FINAL-specs-0.2-20230410/#data-extension-service">CG-FINAL-specs-0.2#data-extension-service</a></li> </ul> <p>For instance, to get the country codes of two nodes, the following JSON is URL encoded:</p> <div class="highlight"><pre class="highlight json"><code><span class="p">{</span><span class="w"> </span><span class="nl">"ids"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="mi">20131544</span><span class="p">,</span><span class="w"> </span><span class="mi">24000001</span><span class="p">],</span><span class="w"> </span><span class="nl">"properties"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"country_codes"</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="p">]</span><span class="w"> </span><span class="p">}</span><span class="w"> </span></code></pre></div> <p>Which translates to:</p> <div class="highlight"><pre class="highlight shell"><code>curl <span class="nt">-XGET</span> <span class="s1">'https://offshoreleaks.icij.org/api/v1/reconcile?extend=%7B%22ids%22%3A%5B20131544%2C24000001%5D%2C%22properties%22%3A%5B%7B%22id%22%3A%22country_codes%22%7D%5D%7D'</span> </code></pre></div> <p>And results to:</p> <div class="highlight"><pre class="highlight json"><code><span class="p">{</span><span class="w"> </span><span class="nl">"meta"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"country_codes"</span><span class="p">,</span><span class="w"> </span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Country Codes"</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="p">],</span><span class="w"> </span><span class="nl">"rows"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nl">"20131544"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nl">"country_codes"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w"> </span><span class="nl">"schema"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nl">"str"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://offshoreleaks.icij.org/schema/oldb/entity"</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="p">]</span><span class="w"> </span><span class="p">},</span><span class="w"> </span><span class="nl">"24000001"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nl">"country_codes"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nl">"str"</span><span class="p">:</span><span class="w"> </span><span class="s2">"BS"</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="p">],</span><span class="w"> </span><span class="nl">"schema"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nl">"str"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://offshoreleaks.icij.org/schema/oldb/address"</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="p">]</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="p">}</span><span class="w"> </span></code></pre></div> <h2 id="suggest-api">Suggest API</h2> <p>To get suggestions for properties, entities, or types, send a HTTP <strong>GET</strong> request to the respective suggestion URL with a required <code>prefix</code> query parameter.</p> <ul> <li>Property Suggestion: <ul> <li><strong>Service URL</strong>: <code>https://offshoreleaks.icij.org/api/v1/reconcile/suggest/property</code></li> <li><strong>Method</strong>: <code>GET</code></li> <li><strong>Spec</strong>: <a href="https://www.w3.org/community/reports/reconciliation/CG-FINAL-specs-0.2-20230410/#dfn-property">CG-FINAL-specs-0.2#dfn-property</a></li> </ul></li> <li>Entity Suggestion: <ul> <li><strong>Service URL</strong>: <code>https://offshoreleaks.icij.org/api/v1/reconcile/suggest/entity</code></li> <li><strong>Method</strong>: <code>GET</code></li> <li><strong>Spec</strong>: <a href="https://www.w3.org/community/reports/reconciliation/CG-FINAL-specs-0.2-20230410/#dfn-entity">CG-FINAL-specs-0.2#dfn-entity</a></li> </ul></li> <li>Type Suggestion: <ul> <li><strong>Service URL</strong>: <code>https://offshoreleaks.icij.org/api/v1/reconcile/suggest/type</code></li> <li><strong>Method</strong>: <code>GET</code></li> <li><strong>Spec</strong>: <a href="https://www.w3.org/community/reports/reconciliation/CG-FINAL-specs-0.2-20230410/#dfn-type">CG-FINAL-specs-0.2#dfn-type</a></li> </ul></li> </ul> <p>For instance, for property suggestions:</p> <div class="highlight"><pre class="highlight shell"><code>curl <span class="nt">-XGET</span> https://offshoreleaks.icij.org/api/v1/reconcile/suggest/property?prefix<span class="o">=</span>cou </code></pre></div> <p>Which will results to:</p> <div class="highlight"><pre class="highlight json"><code><span class="p">{</span><span class="w"> </span><span class="nl">"result"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"country_codes"</span><span class="p">,</span><span class="w"> </span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Country"</span><span class="p">,</span><span class="w"> </span><span class="nl">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"The country code of the node (</span><span class="se">\"</span><span class="s2">FRA</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">HKG</span><span class="se">\"</span><span class="s2">, etc)."</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="p">]</span><span class="w"> </span><span class="p">}</span><span class="w"> </span></code></pre></div> <p>Or for type suggestion:</p> <div class="highlight"><pre class="highlight shell"><code>curl <span class="nt">-XGET</span> https://offshoreleaks.icij.org/api/v1/reconcile/suggest/type?prefix<span class="o">=</span>off </code></pre></div> <p>Which will results to:</p> <div class="highlight"><pre class="highlight json"><code><span class="p">{</span><span class="w"> </span><span class="nl">"result"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://offshoreleaks.icij.org/schema/oldb/officer"</span><span class="p">,</span><span class="w"> </span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Officer"</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="p">]</span><span class="w"> </span><span class="p">}</span><span class="w"> </span></code></pre></div> <h2 id="view-api">View API</h2> <p>To view detailed information about an entity, clients should use the provided URL template, replacing <code>{{id}}</code> with the entity's unique identifier. The resulting URL can then be used to fetch and display the entity's detailed information.</p> <ul> <li><strong>Service URL</strong> : <a href="https://offshoreleaks.icij.org/api/v1/rest/nodes/%7B%7Bid%7D%7D">https://offshoreleaks.icij.org/api/v1/rest/nodes/{{id}}</a></li> <li><strong>Method</strong>: <code>GET</code></li> <li><strong>Spec</strong>: <a href="https://www.w3.org/community/reports/reconciliation/CG-FINAL-specs-0.2-20230410/#dfn-view-template">CG-FINAL-specs-0.2#dfn-view-template</a></li> </ul> <p>For instance: </p> <div class="highlight"><pre class="highlight shell"><code>curl <span class="nt">-XGET</span> https://offshoreleaks.icij.org/api/v1/rest/nodes/10067217 </code></pre></div> <h2 id="preview-api">Preview API</h2> <p>To display a preview of an entity, clients should use the provided URL template, replacing <code>{{id}}</code> with the entity's unique identifier. The resulting URL can then be embedded as an HTML iframe or in any other suitable manner to show the entity's detailed information.</p> <ul> <li><strong>Service URL</strong>: <code>https://offshoreleaks.icij.org/nodes/{{id}}?embed=1</code></li> <li><strong>Method</strong>: <code>GET</code></li> <li><strong>Spec</strong>: <a href="https://www.w3.org/community/reports/reconciliation/CG-FINAL-specs-0.2-20230410/#preview-service">CG-FINAL-specs-0.2#preview-service</a></li> </ul> <p>For instance, within an iframe (using the recommended size):</p> <div class="highlight"><pre class="highlight html"><code><span class="nt"><iframe</span> <span class="na">src=</span><span class="s">"https://offshoreleaks.icij.org/nodes/10067217?embed=1"</span> <span class="na">width=</span><span class="s">"575"</span> <span class="na">height=</span><span class="s">"575"</span><span class="nt">></iframe></span> </code></pre></div> <h2 id="namespaced-api">Namespaced API</h2> <p>The Offshore Leaks Database Reconciliation API is designed to support various investigations, each accessible through a specific, namespaced endpoint. This design ensures that users can also target their reconciliation efforts to a specific dataset that best fits their needs.</p> <p>When using the API, you can specify the appropriate namespace for the investigation you are working with. Below are the endpoints, with their own manifest, for each available investigation:</p> <ul> <li><code>https://offshoreleaks.icij.org/api/v1/reconcile/bahamas-leaks</code></li> <li><code>https://offshoreleaks.icij.org/api/v1/reconcile/offshore-leaks</code></li> <li><code>https://offshoreleaks.icij.org/api/v1/reconcile/panama-papers</code></li> <li><code>https://offshoreleaks.icij.org/api/v1/reconcile/pandora-papers</code></li> <li><code>https://offshoreleaks.icij.org/api/v1/reconcile/paradise-papers</code></li> </ul> <p>For instance, a query for "foo" on the Officer type in the <strong>Pandora Papers</strong>:</p> <div class="highlight"><pre class="highlight shell"><code>curl <span class="nt">-XPOST</span> https://offshoreleaks.icij.org/api/v1/reconcile/pandora-papers <span class="nt">--header</span> <span class="s2">"Content-Type: application/json"</span> <span class="nt">-d</span> <span class="s1">'{ "query": "foo", "type": "Officer" }'</span> </code></pre></div> <h2 id="community-tools">Community & Tools</h2> <p>This API adheres to <a href="https://w3c.github.io/cg-reports/reconciliation/CG-FINAL-specs-0.2-20230410/">the Reconciliation Service API specification v0.2</a>, enabling seamless integration with various tools and platforms. This standardization facilitates collaboration within the community by providing a common framework for data matching and linking. Users can leverage existing tools and libraries designed for reconciliation, enhancing their workflows and ensuring compatibility with other data sources and services.</p> <ul> <li><a href="https://www.w3.org/community/reconciliation/">W3C entity reconciliation community group</a></li> <li><a href="https://reconciliation-api.github.io/testbench/#/client/https%3A%2F%2Foffshoreleaks.icij.org%2Fapi%2Fv1%2Freconcile">Reconciliation service test bench</a></li> <li><a href="https://openrefine.org/">OpenRefine</a></li> <li><a href="https://openrefine.org/docs/manual/reconciling">OpenRefine Reconciling</a></li> </ul> </div> </main> </div> <div class="sidebar col-12 col-lg-4"> <div class="sidebar__section sidebar__section--toc-card sticky-lg-top"> <div class="doc-toc-card px-5 py-3 bg-light vue-context"> <h3 class="doc-toc-card__heading">On this page</h3> <active-anchors> <ul> <li> <a href="#supported-types">Supported Types</a> </li> <li> <a href="#general-api">General API</a> </li> <li> <a href="#query-api">Query API</a> </li> <li> <a href="#data-extension-api">Data extension API</a> </li> <li> <a href="#suggest-api">Suggest API</a> </li> <li> <a href="#view-api">View API</a> </li> <li> <a href="#preview-api">Preview API</a> </li> <li> <a href="#namespaced-api">Namespaced API</a> </li> <li> <a href="#community-tools">Community & Tools</a> </li> </ul> </active-anchors> </div> </div> <div class="sidebar"> <div class="sidebar__section mb-5"> <div class="pages-links-card pt-5 px-5"> <ul class="list-unstyled m-0"> <li> <a target="_blank" class="pages-links-card__link" href="https://www.icij.org/about"> About ICIJ <i class="fa fa-external-link text-light"></i> </a> </li> <li> <a class="pages-links-card__link" href="/pages/about">About this data</a> </li> <li> <a class="pages-links-card__link" href="/pages/faq">FAQ</a> </li> <li> <a class="pages-links-card__link" href="/pages/howtouse">How to use this database</a> </li> <li> <a class="pages-links-card__link" href="/pages/data">Data sources</a> </li> <li> <a class="pages-links-card__link" href="/pages/credits">Credits</a> </li> <li> <a class="pages-links-card__link" href="/tips/new">Contact us</a> </li> </ul> </div> </div> <div class="sidebar__section mb-5"> <div class="signup-card vue-context bg-primary text-white p-5"> <h3 class="h4 text-uppercase signup-card__header"> Get our stories in your inbox </h3> <sign-up-form class="signup-card__form" no-label horizontal variant="dark"></sign-up-form> </div> </div> <div class="sidebar__section mb-5"> <div class="p-5 bg-light"> <h3 class="h4"> About the data in the ICIJ Offshore Leaks database </h3> <p> This ICIJ database contains information on more than 810,000 offshore entities that are part of the Pandora Papers, Paradise Papers, Bahamas Leaks, Panama Papers and Offshore Leaks investigations. The records cover more than 80 years up to 2020 and link to people and companies in more than 200 countries and territories. </p> <a class="btn btn-primary font-weight-bold text-uppercase" href="/pages/about">Read more</a> </div> </div> <div class="sidebar__section mb-5"> <div class="p-5 bg-dark text-white vue-context"> <h3 class="h4 text-uppercase"> Support us </h3> <p> We depend on the generous support of readers like you to help us expose corruption and hold the powerful to account </p> <a href="https://www.icij.org/donate/" target="_blank" class="btn btn-primary text-uppercase font-weight-bold"> Donate </a> </div> </div> </div> </div> </div> </div> <div class="disclaimer-card bg-light py-3 vue-context"> <div class="container"> <h3 class="sr-only"> Disclaimer </h3> <collapsable-disclaimer> <template> <div class="disclaimer-card__content"> <p>There are legitimate uses for offshore companies and trusts. The inclusion of a person or entity in the ICIJ Offshore Leaks Database is not intended to suggest or imply that they have engaged in illegal or improper conduct. Many people and entities have the same or similar names. We suggest you confirm the identities of any individuals or entities included in the database based on addresses or other identifiable information. The data comes directly from the leaked files ICIJ has received in connection with various investigations and each dataset encompasses a defined time period specified in the database. Some information may have changed over time. <a class="font-weight-bold" href="/tips/new">Please contact us</a> if you find an error in the database.</p> </div> </template> <template #reduced> <div class="disclaimer-card__content"> <p>There are legitimate uses for offshore companies and trusts. <a href="/pages/disclaimer">Read more</a></p> </div> </template> <template #toggler="{ toggle, collapsed }"> <button class="disclaimer-card__toggler btn btn-light" @click="toggle"> <i class="fa" :class="{ 'fa-angle-up': collapsed, 'fa-angle-down': !collapsed, }"></i> <span class="sr-only">Toggle disclaimer</span> </button> </template> </collapsable-disclaimer> </div> </div> <footer class="footer vue-context" v-cloak> <generic-footer> <template #address> 1730 Rhode Island Ave NW, Suite 317<br /> Washington, D.C. 20036 USA </template> </generic-footer> </footer> <div class="vue-context"> <terms-modal></terms-modal> </div> <script type="text/javascript"> </script> <script> window.i18n = {"en":{"schema":{"oldb":{"label":"Offshore Leaks Database","description":"A data models of offshore entities and their beneficiaries, officers, and intermediaries.","abbr":"OLDB","models":{"address":{"label":"Address","description":"Represents physical locations associated with entities or individuals."},"entity":{"label":"Entity","description":"Represents legal entities such as companies, trusts, or foundations."},"intermediary":{"label":"Intermediary","description":"Represents individuals or firms facilitating the creation and management of offshore entities."},"node":{"label":"Node","description":"A fundamental element representing various components of offshore financial activities."},"officer":{"label":"Officer","description":"Represents individuals associated with entities, detailing their roles and connections."},"other":{"label":"Other","description":"Encompasses roles such as beneficiaries, trustees, nominees, and agents."}}},"ftm":{"label":"FollowTheMoney","description":"A data model for anti-corruption investigations, including entities, companies and individuals.","abbr":"FtM","models":{"address":{"label":"Address","description":"Represents physical locations associated with entities or individuals."},"representation":{"label":"Representation","description":"Represents individuals or firms acting as agents for entities."},"company":{"label":"Company","description":"Represents a registered business entity."},"legal-entity":{"label":"Legal Entity","description":"Represents a legally recognized entity."},"thing":{"label":"Thing","description":"Represents an object or item."}}}}}} </script> <script async src="https://www.googletagmanager.com/gtag/js?id=G-PJ4Y19JL7T"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-PJ4Y19JL7T'); gtag('config', 'UA-3383794-9'); </script> </body> </html>