2025-10-07
5 days ago by ReadMe API
Summary: Accounts, Events, Persons
Accounts
- Added a new
person_customerquery parameter to theGET /accounts/{account_id}endpoint. When set totrue, it returns a simplified person customer object containing only the type and person ID, instead of the full customer details. - Deprecation Warning: The
person_customerparameter will be deprecated in a future version of this API. Once deprecated, all responses will behave as ifperson_customer=true.
Events
- We added support for person data update events with three new event types:
update.created,update.succeeded, andupdate.failed. - We added a new
context.updatequery parameter to the GET/eventsendpoint to filter events by person data update request identifier. - We introduced the
PersonDataUpdateEventContextto provide context for person data update events, containing both the person identifier and the update request identifier.
Persons
- We introduce new endpoints for managing person data updates, allowing users to update their personal information after account creation:
POST /persons/{person_id}/updates- Create a person data update request (supports email, phone number, registered address, and employment updates)GET /persons/{person_id}/updates- List all person data update requests with pagination supportGET /persons/{person_id}/updates/{update_id}- Get details of a specific person data update request
- Person data update requests track status changes through a history, providing visibility into the update lifecycle (created, processing, success, failure).