Interface DocumentInfo

Resolved catalog entry.

country and confidence are sourced from the underlying DocumentSpec to guarantee a single source of truth.

interface DocumentInfo {
    code: DocumentTypeCode;
    confidence: Confidence;
    country: CountryCode;
    description: string;
    displayName: string;
    knownAs: readonly string[];
    longName: string;
    purpose: DocumentPurpose;
}

Index

Properties

code confidence country description displayName knownAs longName purpose

Properties

`Readonly`code

code: DocumentTypeCode

`Readonly`confidence

confidence: Confidence

`Readonly`country

country: CountryCode

`Readonly`description

description: string

One-sentence localized description.

`Readonly`displayName

displayName: string

Short, recognizable name. e.g. "CURP", "RFC (Persona Física)", "Cédula de Ciudadanía".

`Readonly`knownAs

knownAs: readonly string[]

Alternative known names, abbreviations. e.g. ["CURP"], ["INE", "IFE"].

`Readonly`longName

longName: string

Full official name. e.g. "Clave Única de Registro de Población".

`Readonly`purpose

purpose: DocumentPurpose

Interface DocumentInfo

Index

Properties

Properties

`Readonly`code

`Readonly`confidence

`Readonly`country

`Readonly`description

`Readonly`displayName

`Readonly`knownAs

`Readonly`longName

`Readonly`purpose

Settings

On This Page

Interface DocumentInfo

Index

Properties

Properties

Readonlycode

Readonlyconfidence

Readonlycountry

Readonlydescription

ReadonlydisplayName

ReadonlyknownAs

ReadonlylongName

Readonlypurpose

Settings

On This Page

`Readonly`code

`Readonly`confidence

`Readonly`country

`Readonly`description

`Readonly`displayName

`Readonly`knownAs

`Readonly`longName

`Readonly`purpose