Support for individual fields in the entity object
-
New
individualobject on entities-
Applicable when
type: "individual". -
Fields added under
individual:-
national_identification_number(object)type(string; supported values:passport,driving_license,national_id_card,tax_id_number,residence_permit,other)number(string)
-
date_of_birth(string; ISO 8601 date formatYYYY-MM-DD) -
nationality(string; ISO 3166-1 alpha-2 country code)
-
-
-
Webhook payload expansion
-
Entity webhooks now include
individualobject indatawhentype: "individual". -
Events affected:
entity.createdentity.updatedentity.submittedentity.approved
-
Changed
-
Entity Management endpoints accept and return
individualfields-
Updated request/response schemas for:
POST /v3/entityGET /v3/entity/{id}PUT /v3/entity/{id}POST /v3/entity/{id}/submit
-
Responses include
individualobject whentype: "individual".
-
-
Entity submission requirements for individual entities
-
On full entity submission (
POST /v3/entity/{id}/submit), the following are required fortype: "individual":individual.national_identification_number.typeindividual.national_identification_number.numberindividual.date_of_birthindividual.nationality
-
For simplified entity creation/update, these fields remain optional.
-
Validation Rules
individual.date_of_birthmust matchYYYY-MM-DD.individual.nationalitymust be a 2-letter ISO country code.individual.national_identification_number.typeand.numbermust be provided together.
Compatibility
- No breaking changes; additions are backward-compatible and ignorable by existing clients.
