Person API Operations

Full Loads—Large Updates to Data

Occasionally, the Person API will perform a "full load". This is a large update that refreshes all the data in the Person API from upstream data sources. This typically occurs when a new attribute or relationship is added to the Person API.

This can result in a large number of webhook events being sent to webhook subscribers.

Notification Policy: We will provide a minimum of 5-day notice to the Person API consumers email list before any full load or the addition of new data elements performed by the EI API team. The email list is automatically populated with anyone who has access to the Person API in the Developer Portal.

SSN Key Rotation—Pauses to Person API Updates

The Person API encrypts Social Security Numbers at rest. This encryption key is rotated on midnight of the first day of every third month (January, April, July, October). This is an internal encryption key, and does not affect SSN consumer's keys.

During the key rotation, updates to the Person API are paused for about 6 hours. The Person API will continue to serve requests, but any changes to person data in upstream systems will not be reflected in the Person API until the key rotation is complete. This may result in a slightly higher number of webhook events being sent to webhook subscribers after the key rotation is complete.