IDataStoreFormat

The data stored in the DataStore. This can be extended by other entities, so be sure to check the documentation for those too.

Signature:

export interface IDataStoreFormat

Properties

Property	Type	Description
currentResult	CurrentResult	The current result state of the journey.
documents	Array<IExtendedDocument>	The documents which have been uploaded and processed
hasError	boolean	Does the current journey have any errors?
highLevelResult	HighLevelResult	The current result of the journey. This will change as the journey progresses and will only be finalised at the end of the journey process.
isFinished	boolean	Has the current journey finished?
journeyId	string	The identification number for the current journey
journeyReference	string	The reference assigned by the services for this journey
lastUpdate	Date	The time of the last change to the data store. This is automatically updated when new data is placed into the store.
person	IPerson	The data about the person which has been extrapolated from the provided identity documents.

IDataStoreFormat.currentResult property

The current result state of the journey.

Signature:

currentResult: CurrentResult;

IDataStoreFormat.documents property

The documents which have been uploaded and processed

Signature:

documents: Array<IExtendedDocument>;

IDataStoreFormat.hasError property

Does the current journey have any errors?

Signature:

hasError: boolean;

IDataStoreFormat.highLevelResult property

The current result of the journey. This will change as the journey progresses and will only be finalised at the end of the journey process.

Signature:

highLevelResult?: HighLevelResult;

IDataStoreFormat.isFinished property

Has the current journey finished?

Signature:

isFinished: boolean;

IDataStoreFormat.journeyId property

The identification number for the current journey

Signature:

journeyId: string;

IDataStoreFormat.journeyReference property

The reference assigned by the services for this journey

Signature:

journeyReference: string;

IDataStoreFormat.lastUpdate property

The time of the last change to the data store. This is automatically updated when new data is placed into the store.

Signature:

lastUpdate: Date;

IDataStoreFormat.person property

The data about the person which has been extrapolated from the provided identity documents.

Signature:

person: IPerson;