> ## Documentation Index
> Fetch the complete documentation index at: https://docs.peopledatalabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Person Changelog

To read more about our persistent Person ID logic, please consult our [Persistent IDs](https://docs.peopledatalabs.com/docs/persistent-ids) page.

## Person Changelog

We also provide an additional changelog as a flat file in [this public AWS bucket](https://s3.console.aws.amazon.com/s3/buckets/pdl-prod-id-changelog?region=us-west-2\&prefix=34.1/\&showversions=false). Each part of the changelog is capped to a file size of approximately 100MB. Changelogs are separated by update cadence with the following paths:

* Monthly: `s3://pdl-prod-id-changelog/version_number/monthly/`
* Quarterly: `s3://pdl-prod-id-changelog/version_number/quarterly/`

Here is a description of each possible record status:

| Status              | Description                                                                                     |
| :------------------ | :---------------------------------------------------------------------------------------------- |
| `added `            | Newly added records                                                                             |
| `deleted `          | Records that have been deleted                                                                  |
| `merged `           | Records merged into other records, including metadata of the merged records                     |
| `opted_out `        | Records that have opted out through our website                                                 |
| `updated `          | Records where a value in any field has changed and/or a profile has been merged into the record |

### Additional Metadata

Some of the statuses listed in the table above will also contain the following metadata:

| Metadata Field   | Corresponding Version Status | Description                                                                                                                                                                                                                         |
| :--------------- | :--------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `contains`       | `updated`                    | The persistent IDs of any records that existed in a previous version and have been merged before or during the current version.                                                                                                     |
| `fields_updated` | `updated`                    | The specific fields of the record that have changed. Changes for child fields will be limited to their parents. For example, if a record’s `experience.end_date` changes, that will be shown as `“fields_updated”: [“experience”]`. |
| `to`             | `merged`                     | The persistent ID that this record has been assigned in the current version.                                                                                                                                                        |

### Sample Changelogs

```json Added
{
  "id": "123",
  "previous_version": "24.1",
  "current_version": "24.2",
  "status": "added",
  "additional_metadata": null
}
```

```json Deleted
{
  "id": "123",
  "previous_version": "24.1",
  "current_version": "24.2",
  "status": "deleted",
  "additional_metadata": null
}

```

```json Merged
{
  "id": "123",
  "previous_version": "24.1",
  "current_version": "24.2",
  "status": "merged",
  "additional_metadata": {
    "to": ["abcabc", ...]
  }
}
```

```json Opted Out
{
  "id": "123",
  "previous_version": "24.1",
  "current_version": "24.2",
  "status": "opted_out",
  "additional_metadata": null
}

```

```json Updated
{
  "id": "123",
  "previous_version": "24.1",
  "current_version": "24.2",
  "status": "updated",
  "additional_metadata": {
    "contains": ["123123", ...],
    "fields_updated": ["work_email", "job_company_type", ...]
  }
}

```