Skip to main content

Identification Types

EntityDatastoreDatastore.KindOffIdentification

Identification types classify identity documents for persons (e.g., passport, ID card, driver license).

Use the Datastore_KindOffIdentification endpoint to query identification types.

Endpoints

List Identification Types

GET/v1/odata/Datastore_KindOffIdentification

Single Identification Type

GET/v1/odata/Datastore_KindOffIdentification({id})

Fields

Datastore Fields (inherited)

FieldTypeDescription
NameStringDisplay name
CodeStringUnique code identifier
LocalizedNameStringLocalized display name
IsDefaultBooleanWhether this is the default value

Relationships

RelationshipTarget EntityCardinalityDescription
PersonRelation_Person1:NPerson

Expanding Relationships

GET/v1/odata/Datastore_KindOffIdentification({id})?$expand=Person
GET/v1/odata/Datastore_KindOffIdentification({id})/Person

Filtering Examples

GET/v1/odata/Datastore_KindOffIdentification?$filter=Name eq '{Name}'&$top={top}
GET/v1/odata/Datastore_KindOffIdentification?$filter=contains(Name, '{Name}')&$top={top}
GET/v1/odata/Datastore_KindOffIdentification?$filter=Code eq '{Code}'&$top={top}
GET/v1/odata/Datastore_KindOffIdentification?$filter=IsDefault eq {IsDefault}&$top={top}