Interface ParseFailure

A failed parseIdInfo() call and why it failed.

interface ParseFailure {
    countryCode: string;
    errorMessage?: string;
    idNumber: string;
    ok: false;
    reason: ValidationFailureReason;
}

Index

Properties

countryCode errorMessage? idNumber ok reason

Properties

countryCode

countryCode: string

The resolved alpha-3 code, or the code as given when it is not supported.

`Optional`errorMessage

errorMessage?: string

idNumber

idNumber: string

ok

ok: false

reason

reason: ValidationFailureReason

Machine-readable cause, as in ValidationResult.reason, plus NOT_PARSABLE for a valid ID the country cannot parse.