Relation types
Each item in the relations[] array of a PEP record carries a relationship naming the link, oriented from this person to the person at targetId, so you can tell a spouse or a child apart from a wider associate.
These are the relationship values currently in use. relationship is a plain string in the contract, not a closed enum, so a new value can appear without a schema version change. Records may also carry historical relationship values retained for existing data.
The grouping below is an editorial arrangement for these docs, and the API carries no grouping of its own.
Direct relations
Section titled “Direct relations”| Relation |
|---|
| Spouse |
| Registered partner |
| Cohabitant |
| Partner |
| Son |
| Daughter |
| Mother |
| Father |
Secondary relations
Section titled “Secondary relations”| Relation |
|---|
| Son's spouse |
| Son's registered partner |
| Son's cohabitant |
| Daughter's spouse |
| Daughter's registered partner |
| Daughter's cohabitant |
| Mother-in-law |
| Father-in-law |
| Cohabitant's mother |
| Cohabitant's father |
Associates
Section titled “Associates”| Relation |
|---|
| Known associate |