Service provider domain

Within Linckr a service provider is an organisation that offers services to consumers. A service provider organisation must be a legal entity/company.

Examples of service providers are:

• notary organisations
• lawyer organisations
• realtor organisations
• insurance companies
• bank companies
• many more

Organisation

In the provider domain, we just speak about an organisation and we omit the service provider prefix.

Member

A member is a person that works for an organisation and performs actions (API calls) in the name of that organisation. A member has a member profile and this allows you to obtain a list of all the organisations linked to the member.

info

Note that a member can be part of many organisations. Checkout the member profile query to check all the organisations a member is part of.

Folder

When a member is logged in they can create a folder in the name of an organisation. In ERP systems this concept folder relates often to a case or dossier.

Within an organisation a folder is uniquely identified by its journey type and journey reference.

Journey type and reference

When creating a folder the first step is to select a journey type. The journey type dictates the customer journey.

info

For example, the RESIDENCE_JOURNEY must be selected when a consumer wants to buy or sell a residential property. Residential property is identified by an address. Therefore the journey reference for this journey type is the combination of a postal code, house number and addition.

Currently, Linckr supports two. See Journey Type Enum.

The journey type and the journey reference allow Linckr to aggregate infomediations sent by different organisations in the same consumer plan.

Consumer connection

Before any info mediation can be sent a connection between the organisation and the consumer must be established. We call this a consumer connection with a status ACCEPTED.

Note that a consumer connection can only be created within the context of an existing folder.

info

At Linckr legal intent is an important concept. Therefore an organisation is not allowed to invite a consumer connection outside the context of a folder. The folder together with its journey type and journey reference give a legal intent why a consumer connection is needed.

When creating for the first time a consumer connection all you need is the email address of the consumer and the consumer role in the folder. Linckr will then email the consumer to onboard on Linckr and accept the connection.

Infomediation

Once you have invited a consumer connection you are allowed to request or send one or more infomediations. An infomediation always has a type, called an infomediation template type. Currently, we support three types:

type	description	example
INFORMATION_MESSAGE_WITH_READ _RECEIPT_TEMPLATE	Send a text message to the consumer, and receive a read confirmation	Can be used as an alternative to email
INFORMATION_REQUEST_TEMPLATE	Request structured and unstructured data from the consumer	UBO, WWFT, Personal Information Data
DOCUMENT_REQUEST_TEMPLATE	Request the consumer to upload an unstructured document. A document type must be choosen by the provider and added to the infomediation request.	Examples of document types are passport, divorce agreement, proof of dividends. Execute the query documentTypes to explore the full list
SEND_DOCUMENT_WITH _READ_RECEIPT_TEMPLATE	Send a document to the consumer, and receive a read confirmation	Examples of document types are purchase agreement, assignment realtor services, other

In progress

Once an infomediation is sent the infomediation status is IN_PROGRESS.

info

Note that infomediations are buffered by Linckr until the consumer connection is in status the ACCEPTED. This allows the member to create a folder, invite consumers and send infomediations in one go, without having to wait until the consumer has accepted the connection.

Completed

Once the consumer has finished the tasks in the consumer domain, the status of the infomediation will be set to COMPLETED. Now you can download one or more structured and/or unstructured resources.

Failure

A technical failure may happen and then the status is FAILURE. It is possible to retry an infomediation. See the following mutation.

Expired

caution

Not implemented yet, but soon infomediations will expire when the deadline for having access is overdue. The result will be that you are not able anymore to download the resources. Therefore, it is important to download the resources as soon as the status is completed.

Journey type configuration

During the onboarding of your organisation a Linckr admin configured journey type configurations. The latter states what type of infomediation templates your organisation is allowed to send or request for a selected journey type and consumer role.