Ockto

Collection of Ockto functions, to get personal data from validated external sources.

Methods

startSession

startSession(sessionId: string, ocktoOptions: { testCaseId?: string, consentCode: string, ocktoType: string, odmVersion: string, requestDocuments: string[], disablePartner: boolean, psd2InfoIncluded: boolean, psd2AmountOfMonths: number }) 

Starts an Ockto session. To be able to use Ockto, an applicable license must be configured for the Tenant.

Parameters

sessionId string

The sessionId used in Ockto.

ocktoOptions { testCaseId?: string, consentCode: string, ocktoType: string, odmVersion: string, requestDocuments: string[], disablePartner: boolean, psd2InfoIncluded: boolean, psd2AmountOfMonths: number }

The Ockto options you want to use.

consentCode	Consent provided in the app to the user. View the Ockto support portal for more information.
ocktoType	Provides the combination of datasources that needs to be collected by the consumer.
odmVersion	The version of ODM returned. When left empty or null is used, the latest ODM version will be returned. (V#_#).
requestDocuments	Per specified document a link is returned in the ODM. Using this link the receiver can download the document. Documents are available for 10 minutes and will be deleted when downloaded. By default Ockto does not return documents. Possible values: UPO, UWV, PSD2, PDF
disablePartner	If true, Ockto will not show the add partner data pop-up within the app. It is recommended to have consumers complete seperate journeys on their own device, and merge the ODMs afterwards with MergeClientData.
psd2InfoIncluded	If set to true, Ockto will return PSD2 data.
psd2AmountOfMonths	Number of months to be collected (up to 12 moths)

Return type

{ sessionId: string, qrCode: string }

Examples

Ockto.startSession("ac1b098c-928b-4db2-8f47-ca1bec360eba", {
  consentCode: "001",
  ocktoType: "P",
  odmVersion: "v4_3",
  requestDocuments: [],
  disablePartner: true,
  psd2InfoIncluded: true,
  psd2AmountOfMonths: 3
})

getStatus

getStatus(sessionId: string) 

Gets the status of an Ockto session.

Parameters

sessionId string

The sessionId used in Ockto.

Return type

string

Examples

Ockto.getStatus("ac1b098c-928b-4db2-8f47-ca1bec360eba")

getResult

getResult(sessionId: string) 

Gets the result of an Ockto session.

Parameters

sessionId string

The sessionId used in Ockto.

Return type

{ [key: string]: any; }

Examples

Ockto.getResult("ac1b098c-928b-4db2-8f47-ca1bec360eba")