Skip to main content
Release Type: Enhancement

​
Summary

The Entity API now supports a person_id field in the representatives object. This field uniquely identifies each representative and must be included when updating existing representatives to maintain identity consistency for ongoing sanction screening.

​
What Changed

  • New person_id field on representatives
    • A person_id (string) field has been added to the representatives object across all Entity API endpoints.
    • Example value: psn_d3iv85v58tg9dlpipu3g
  • Affected endpoints
    • POST /v3/entity — response now includes person_id for each representative
    • GET /v3/entity/{id} — response now includes person_id for each representative
    • PUT /v3/entity/{id} — accepts person_id in the request body; response includes it
    • POST /v3/entity/{id}/submit — response now includes person_id for each representative
  • Update Entity now accepts full representative details
    • The PUT /v3/entity/{id} endpoint now accepts the complete representatives array in the request body, including person_id, personal details, address, phone, roles, and documents.
Action Required for Entity UpdatesWhen updating an entity with existing representatives, you must include the person_id of each existing representative in the request payload. This ensures the representative’s identity is preserved for ongoing sanction screening. The person_id can be retrieved from the Fetch Entity (GET /v3/entity/{id}) response.

​
Compatibility

  • No breaking changes for existing integrations.
  • The person_id field is additive and can be safely ignored by clients that do not use it.
  • Existing representatives without person_id in update requests will be treated as new representatives, which may trigger a new sanction screening cycle.
  1. Entity API Documentation