Skip to main content

@idpass/data-collect-core / DetailEntityDoc

Interface: DetailEntityDoc

Defined in: interfaces/types.ts:182

Detailed entity document with additional metadata for UI display.

Extends​

Properties​

guid​

guid: string

Defined in: interfaces/types.ts:60

Global unique identifier (user-provided or generated)

Inherited from​

EntityDoc.guid

externalId?​

optional externalId: string

Defined in: interfaces/types.ts:62

Optional external system identifier for sync

Inherited from​

EntityDoc.externalId

name?​

optional name: string

Defined in: interfaces/types.ts:64

Optional display name for the entity

Inherited from​

EntityDoc.name

type​

type: EntityType

Defined in: interfaces/types.ts:66

Type of entity (Individual or Group)

Inherited from​

EntityDoc.type

version​

version: number

Defined in: interfaces/types.ts:68

Version number for optimistic concurrency control

Inherited from​

EntityDoc.version

data​

data: Record<string, any>

Defined in: interfaces/types.ts:71

Flexible data payload containing entity-specific fields

Inherited from​

EntityDoc.data

lastUpdated​

lastUpdated: string

Defined in: interfaces/types.ts:73

ISO timestamp of last modification

Inherited from​

EntityDoc.lastUpdated

identifiers?​

optional identifiers: IdentifierRecord[]

Defined in: interfaces/types.ts:75

Multiple typed identifiers per entity (national ID, UNHCR ID, etc.)

Inherited from​

EntityDoc.identifiers

id​

id: string

Defined in: interfaces/types.ts:184

Internal database ID

Overrides​

EntityDoc.id

missing?​

optional missing: true

Defined in: interfaces/types.ts:186

Indicates if the entity is missing/not found