> For the complete documentation index, see [llms.txt](https://docs.tracr.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tracr.com/tracr-articles/updated-provenance-structure.md).

# Updated Provenance Structure

To better and more accurately support a diamond’s provenance and additional metadata we need to make some changes to the way we return provenance information. Below is a table that summarises the key use cases and shows the current data structure, and how the data will be structured in the future.

<table><thead><tr><th width="132.984375">Producer</th><th>Lifecycle</th><th>Locked</th><th>Country</th><th>PI</th><th>JSON</th></tr></thead><tbody><tr><td>De Beers</td><td>Rough</td><td>-</td><td>Single</td><td>True</td><td><a href="#single-country-with-pi-1">Example</a></td></tr><tr><td>De Beers</td><td>Rough</td><td>-</td><td>Single</td><td>False</td><td><a href="#single-country-without-pi-1">Example</a></td></tr><tr><td>De Beers</td><td>Rough</td><td>-</td><td>Multi</td><td>True</td><td><a href="#multi-country-with-pi-1">Example</a></td></tr><tr><td>De Beers</td><td>Rough</td><td>-</td><td>Multi</td><td>False</td><td><a href="#multi-country-without-pi-1">Example</a></td></tr><tr><td>De Beers</td><td>Polished</td><td>Yes</td><td>Single</td><td>True</td><td><a href="#locked-single-country-with-pi-1">Example</a></td></tr><tr><td>De Beers</td><td>Polished</td><td>Yes</td><td>Single</td><td>False</td><td><a href="#locked-single-country-without-pi-1">Example</a></td></tr><tr><td>De Beers</td><td>Polished</td><td>Yes</td><td>Multi</td><td>True</td><td><a href="#locked-multi-country-with-pi-1">Example</a></td></tr><tr><td>De Beers</td><td>Polished</td><td>Yes</td><td>Multi</td><td>False</td><td><a href="#locked-multi-country-without-pi-1">Example</a></td></tr><tr><td>De Beers</td><td>Polished</td><td>No</td><td>Single</td><td>True</td><td><a href="#unlocked-single-country-with-pi-1">Example</a></td></tr><tr><td>De Beers</td><td>Polished</td><td>No</td><td>Single</td><td>False</td><td><a href="#unlocked-single-country-without-pi-1">Example</a></td></tr><tr><td>De Beers</td><td>Polished</td><td>No</td><td>Multi</td><td>True</td><td><a href="#unlocked-multi-country-with-pi-1">Example</a></td></tr><tr><td>De Beers</td><td>Polished</td><td>No</td><td>Multi</td><td>False</td><td><a href="#unlocked-multi-country-without-pi-1">Example</a></td></tr><tr><td>Non De Beers</td><td>Rough</td><td>-</td><td>Single</td><td>-</td><td><a href="#single-country-1">Example</a></td></tr><tr><td>Non De Beers</td><td>Polished</td><td>Yes</td><td>Single</td><td>-</td><td><a href="#locked-single-country-1">Example</a></td></tr><tr><td>Non De Beers</td><td>Polished</td><td>No</td><td>Single</td><td>-</td><td><a href="#unlocked-single-country-1">Example</a></td></tr></tbody></table>

#### Current Response, De Beers Rough

{% tabs %}
{% tab title="Single Country, With PI" %}
{% code title="" overflow="wrap" %}

```json
{
  "provenance": {
    "provenance_type": "Country",
    "provenance_name": "",
    "country_code": None,
    "mine_name": None,
    "is_locked": True,
    "is_country_code_available": True
  }
}
```

{% endcode %}
{% endtab %}

{% tab title="Single Country, Without PI" %}
{% code title="" overflow="wrap" %}

```json
{
  "provenance": {
    "provenance_type": "Country",
    "provenance_name": "",
    "country_code": None,
    "mine_name": None,
    "is_locked": True,
    "is_country_code_available": True
  }
}
```

{% endcode %}
{% endtab %}

{% tab title="Multi Country With PI" %}
{% code title="" overflow="wrap" %}

```json
{
  "provenance": {
    "provenance_type": "Entity",
    "provenance_name": "",
    "country_code": None,
    "mine_name": None,
    "is_locked": True,
    "is_country_code_available": False
  }
}
```

{% endcode %}
{% endtab %}

{% tab title="Multi Country Without PI" %}
{% code title="" overflow="wrap" %}

```json
{
  "provenance": {
    "provenance_type": "Entity",
    "provenance_name": "",
    "country_code": None,
    "mine_name": None,
    "is_locked": True,
    "is_country_code_available": False
  }
}
```

{% endcode %}
{% endtab %}
{% endtabs %}

#### New Response, De Beers Rough

{% tabs %}
{% tab title="Single Country, With PI" %}
{% code title="" overflow="wrap" %}

```json
{
  "display_provenance": {
    "provenance_type": "country",
    "country_codes": [],
    "mine_name": None,
    "is_locked": True
  },
  "compliance": []
}
```

{% endcode %}
{% endtab %}

{% tab title="Single Country, Without PI" %}
{% code title="" overflow="wrap" %}

```json
{
  "display_provenance": {
    "provenance_type": "country",
    "country_codes": [],
    "mine_name": None,
    "is_locked": True
  },
  "compliance": []
}
```

{% endcode %}
{% endtab %}

{% tab title="Multi Country With PI" %}
{% code title="" overflow="wrap" %}

```json
{
  "display_provenance": {
    "provenance_type": "multi_country",
    "country_codes": [],
    "mine_name": None,
    "is_locked": True
  },
  "compliance": []
}
```

{% endcode %}
{% endtab %}

{% tab title="Multi Country Without PI" %}
{% code title="" overflow="wrap" %}

```json
{
  "display_provenance": {
    "provenance_type": "multi_country",
    "country_codes": [],
    "mine_name": None,
    "is_locked": True
  },
  "compliance": []
}
```

{% endcode %}
{% endtab %}
{% endtabs %}

#### Current Response, De Beers Polished

{% tabs %}
{% tab title="Locked, Single Country, With PI" %}
{% code title="Locked, Single Country, With PI" overflow="wrap" %}

```json
{
  "provenance": {
    "provenance_type": "Country",
    "provenance_name": "",
    "country_code": None,
    "mine_name": None,
    "is_locked": True,
    "is_country_code_available": True
  }
}
```

{% endcode %}
{% endtab %}

{% tab title="Locked, Single Country, Without PI" %}
{% code title="Locked, Single Country, Without PI" overflow="wrap" %}

```json
{
  "provenance": {
    "provenance_type": "Country",
    "provenance_name": "",
    "country_code": None,
    "mine_name": None,
    "is_locked": True,
    "is_country_code_available": True
  }
}
```

{% endcode %}
{% endtab %}

{% tab title="Locked, Multi Country, With PI" %}
{% code title="Locked, Multi Country, With PI" overflow="wrap" %}

```json
{
  "provenance": {
    "provenance_type": "Entity",
    "provenance_name": "",
    "country_code": None,
    "mine_name": None,
    "is_locked": True,
    "is_country_code_available": False
  }
}
```

{% endcode %}
{% endtab %}

{% tab title="Locked, Multi Country, Without PI" %}
{% code title="Locked, Multi Country, Without PI" overflow="wrap" %}

```json
{
  "provenance": {
    "provenance_type": "Entity",
    "provenance_name": "",
    "country_code": None,
    "mine_name": None,
    "is_locked": True,
    "is_country_code_available": False
  }
}
```

{% endcode %}
{% endtab %}

{% tab title="Unlocked, Single Country, With PI" %}
{% code title="Unlocked, Single Country, With PI" overflow="wrap" %}

```json
{
  "provenance": {
    "provenance_type": "Country",
    "provenance_name": "BW",
    "country_code": None,
    "mine_name": None,
    "is_locked": False,
    "is_country_code_available": True
  }
}
```

{% endcode %}
{% endtab %}

{% tab title="Unlocked, Single Country, Without PI, " %}
{% code title="Unlocked, Single Country, Without PI" overflow="wrap" %}

```json
{
  "provenance": {
    "provenance_type": "Country",
    "provenance_name": "BW",
    "country_code": None,
    "mine_name": None,
    "is_locked": False,
    "is_country_code_available": True
  }
}
```

{% endcode %}
{% endtab %}

{% tab title="Unlocked, Multi Country, With PI" %}
{% code title="Unlocked, Multi Country, With PI" overflow="wrap" %}

```json
{
  "provenance": {
    "provenance_type": "Entity",
    "provenance_name": "DTC",
    "country_code": None,
    "mine_name": None,
    "is_locked": False,
    "is_country_code_available": False
  }
}
```

{% endcode %}
{% endtab %}

{% tab title="Unlocked, Multi Country, Without PI" %}
{% code title="Unlocked, Multi Country, Without PI" overflow="wrap" %}

```json
{
  "provenance": {
    "provenance_type": "Country",
    "provenance_name": "BW",
    "country_code": None,
    "mine_name": None,
    "is_locked": False,
    "is_country_code_available": True
  }
}
```

{% endcode %}
{% endtab %}
{% endtabs %}

#### New Response, De Beers Polished

{% tabs %}
{% tab title="Locked, Single Country, With PI" %}
{% code title="Locked, Single Country, With PI" overflow="wrap" %}

```json
{
  "display_provenance": {
    "provenance_type": "country",
    "country_codes": [],
    "mine_name": None,
    "is_locked": True
  },
  "compliance": []
}
```

{% endcode %}
{% endtab %}

{% tab title="Locked, Single Country, Without PI" %}
{% code title="Locked, Single Country, Without PI" overflow="wrap" %}

```json
{
  "display_provenance": {
    "provenance_type": "country",
    "country_codes": [],
    "mine_name": None,
    "is_locked": True
  },
  "compliance": []
}
```

{% endcode %}
{% endtab %}

{% tab title="Locked, Multi Country, With PI" %}
{% code title="Locked, Multi Country, With PI" overflow="wrap" %}

```json
{
  "display_provenance": {
    "provenance_type": "multi_country",
    "country_codes": [],
    "mine_name": None,
    "is_locked": True
  },
  "compliance": []
}
```

{% endcode %}
{% endtab %}

{% tab title="Locked, Multi Country, Without PI" %}
{% code title="Locked, Multi Country, Without PI" overflow="wrap" %}

```json
{
  "display_provenance": {
    "provenance_type": "multi_country",
    "country_codes": [],
    "mine_name": None,
    "is_locked": True
  },
  "compliance": []
}
```

{% endcode %}
{% endtab %}

{% tab title="Unlocked, Single Country, With PI" %}
{% code title="Unlocked, Single Country, With PI" overflow="wrap" %}

```json
{
  "display_provenance": {
    "provenance_type": "country",
    "country_codes": ["BW"],
    "mine_name": None,
    "is_locked": False
  },
  "compliance": [
    {
      "name": "DTC",
      "description": "This diamond was manufactured by a party who held Pipeline Integrity status through the entire process",
      "metadata": {}
    }
  ]
}
```

{% endcode %}
{% endtab %}

{% tab title="Unlocked, Single Country, Without PI" %}
{% code title="Unlocked, Single Country, Without PI" overflow="wrap" %}

```json
{
  "display_provenance": {
    "provenance_type": "country",
    "country_codes": ["BW"],
    "mine_name": None,
    "is_locked": False
  },
  "compliance": []
}
```

{% endcode %}
{% endtab %}

{% tab title="Unlocked, Multi Country, With PI" %}
{% code title="Unlocked, Multi Country, With PI" overflow="wrap" %}

```json
{
  "display_provenance": {
    "provenance_type": "multi_country",
    "country_codes": ["BW", "CA", "NA", "ZA"],
    "mine_name": None,
    "is_locked": False
  },
  "compliance": [
    {
      "name": "DTC",
      "description": "This diamond was manufactured by a party who held Pipeline Integrity status through the entire process",
      "metadata": {}
    }
  ]
}
```

{% endcode %}
{% endtab %}

{% tab title="Unlocked, Multi Country, Without PI" %}
{% code title="Unlocked, Multi Country, Without PI" overflow="wrap" %}

```json
{
  "display_provenance": {
    "provenance_type": "multi_country",
    "country_codes": ["BW", "CA", "NA", "ZA"],
    "mine_name": None,
    "is_locked": False
  },
  "compliance": []
}
```

{% endcode %}
{% endtab %}
{% endtabs %}

#### Current Response, Non-De Beers Rough

{% tabs %}
{% tab title="Single Country" %}
{% code title="" overflow="wrap" %}

```json
{
  "provenance": {
    "provenance_type": "Country",
    "provenance_name": "",
    "country_code": None,
    "mine_name": None,
    "is_locked": True,
    "is_country_code_available": True
  }
}
```

{% endcode %}
{% endtab %}
{% endtabs %}

#### New Response, Non-De Beers Rough

{% tabs %}
{% tab title="Single Country" %}
{% code title="Single Country" overflow="wrap" %}

```json
{
  "display_provenance": {
    "provenance_type": "country",
    "country_codes": [],
    "mine_name": None,
    "is_locked": True
  },
  "compliance": []
}
```

{% endcode %}
{% endtab %}
{% endtabs %}

#### Current Response, Non-De Beers Polished

{% tabs %}
{% tab title="Locked, Single Country" %}
{% code title="Locked, Single Country" overflow="wrap" %}

```json
{
  "provenance": {
    "provenance_type": "Country",
    "provenance_name": "",
    "country_code": None,
    "mine_name": None,
    "is_locked": True,
    "is_country_code_available": True
  }
}
```

{% endcode %}
{% endtab %}

{% tab title="Unlocked, Single Country" %}
{% code title="Unlocked, Single Country" overflow="wrap" %}

```json
{
  "provenance": {
    "provenance_type": "Country",
    "provenance_name": "CA",
    "country_code": None,
    "mine_name": None,
    "is_locked": False,
    "is_country_code_available": True
  }
}
```

{% endcode %}
{% endtab %}
{% endtabs %}

#### New Response, Non-De Beers Polished

{% tabs %}
{% tab title="Locked, Single Country" %}
{% code title="Locked, Single Country" overflow="wrap" %}

```json
{
  "display_provenance": {
    "provenance_type": "country",
    "country_codes": [],
    "mine_name": None,
    "is_locked": True
  },
  "compliance": []
}
```

{% endcode %}
{% endtab %}

{% tab title="Unlocked, Single Country" %}
{% code title="Unlocked, Single Country" overflow="wrap" %}

```json
{
  "display_provenance": {
    "provenance_type": "country",
    "country_codes": ["CA"],
    "mine_name": None,
    "is_locked": False
  },
  "compliance": []
}
```

{% endcode %}
{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.tracr.com/tracr-articles/updated-provenance-structure.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.