IDocument – GBG IDscan Documentation

IDocument

A document description returned from the services

Signature:

export interface IDocument 

Properties

PropertyTypeDescription
categorystringThe category of the document
expirationDatestringThe expiration data of the document
imagesIDocumentImage[]The images contained within the document
isRecognisedbooleanHas the document been recognised as valid by the services?
issueDatestringThe issue date of the document
issueNumberstringThe issue number of the document
namestringThe name on the document
numberstringThe number on the document
sidestringThe side of the document
typeIdDocuments | NonIdDocumentsThe type of the document as determined by the services

IDocument.category property

The category of the document

Signature:

readonly category?: string;

IDocument.expirationDate property

The expiration data of the document

Signature:

readonly expirationDate?: string;

IDocument.images property

The images contained within the document

Signature:

readonly images?: IDocumentImage[];

IDocument.isRecognised property

Has the document been recognised as valid by the services?

Signature:

readonly isRecognised?: boolean;

IDocument.issueDate property

The issue date of the document

Signature:

readonly issueDate?: string;

IDocument.issueNumber property

The issue number of the document

Signature:

readonly issueNumber?: string;

IDocument.name property

The name on the document

Signature:

readonly name?: string;

IDocument.number property

The number on the document

Signature:

readonly number?: string;

IDocument.side property

The side of the document

Signature:

readonly side?: string;

IDocument.type property

The type of the document as determined by the services

Signature:

readonly type?: IdDocuments | NonIdDocuments;

Was this page helpful?