Entities¶
Per-schema input classes used to construct match() queries. One class per
FtM schema (Person, Company, Vessel, Organization, LegalEntity, …).
Use yente-cli ref schemas to discover the full set, and
yente-cli ref schema NAME to see which properties each
schema accepts.
EntityInput¶
EntityInput
module-attribute
¶
Public type alias for any input entity. Any per-schema class (Person,
Company, ...) is an EntityInput.
Representative schemas¶
The classes themselves carry their FtM properties as Pydantic fields
(camelCase, matching the wire format). See ref schema NAME for the
full property list per schema.
Person ¶
Bases: _EntityBase
A natural person, as opposed to a corporation of some type.
Company ¶
Bases: _EntityBase
A corporation, usually for profit. Does not distinguish between private and public companies, and can also be used to model more specific constructs like trusts and funds. Companies are assets, so they can be owned by other legal entities.
Organization ¶
Bases: _EntityBase
Any type of incorporated entity that cannot be owned by another (see Company). This might include charities, foundations or state-owned enterprises, depending on their jurisdiction.
LegalEntity ¶
Bases: _EntityBase
Any party to legal proceedings, such as asset ownership, corporate governance or social interactions. Often used when raw data does not specify if something is a person, organization or company.
Vessel ¶
Bases: _EntityBase
A boat or ship. Typically flying some sort of national flag.