ConnectID realtime events

Introduction

The payload of an event will consist of two parts:

General fields, common to all events

Event specific fields, nested within the data field

General payload fields

Field	Type	Description
type	String	Type of the event. Possible values are listed below.
time	Integer	Epoch timestamp in milliseconds of the event.
source	String	Source of the event. Is equal to the Connect client schema name.
status	String	Status of the resource associated to the event.
data	Object	Data for the resource associated to the event.

Event types

profileName

profileAddress

profileCredential

ProfileName

This event is generated by ConnectID when there is any changes on name regarding a profile. I.e. when a profile name is added, updated or deleted.

A user can have one or more profiles associated with them, but only one per source. This means that the profileKey should only exist once.

General fields

Field	Description
type	The field will contain the value 'profileName'.
status	The status of the changes. Possible values: 'new': This is a new name instance associated with the profile. 'change': This is a change of an existing name instance. 'delete': The name instance is deleted.

Event specific fields

Field	Type	Description	Nullable
profileKey	object	Key object regarding the profile.	No
uniqueId	Integer	External id representing the user.	No
profileSource	String	Source of this profile. Possible values that might change: - ConnectID - AID - Facebook - GooglePlus - Apple - Vipps - Unknown	No
profileNameId	Integer	Id identifying the instance.	No
companyName	String	Company name associated with this profile.	Yes
lastName	String	Last name associated with this profile.	Yes
middleName	String	Company name associated with this profile.	Yes
firstName	String	First name associated with this profile.	Yes
birthdate	Integer<Date>	Date of birth associated with this profile. Unix Epoch timestamps in milliseconds since 1st January 1970 UTC.	Yes
gender	String	Gender associated with this profile. Possible values that might change: - male - female - unknown	Yes

Example payload

{
  "type": "profileName",
  "time": 1679399455,
  "source": "MY_SCHEMA",
  "status": "new",
  "data": {
    "profileKey": {
      "uniqueId": "dummyId",
      "profileSource": "Vipps"
    },
    "profileNameId": 1,
    "companyName": "Magic Company AS",
    "lastName": "Doe",
    "middleName": "Jane",
    "firstName": "John",
    "birthdate": 1761955200000,
    "gender": "male"
  }
}

ProfileAddress

This event is generated by ConnectID when there is any changes on address regarding a profile. I.e. when a profile address is added, updated or deleted.

A user can have one or more profiles associated with them, but only one per source. This means that the profileKey should only exist once.

General fields

Field	Description
type	The field will contain the value 'profileAddress'.
status	The status of the changes. Possible values: 'new': This is a new address instance associated with the profile.. 'change': This is a change of an existing address instance. 'delete': The address instance is deleted.

Event specific fields

Field	Type	Description	Nullable
profileKey	object	Key object regarding the user profile.	No
uniqueId	Integer	External id representing the user.	No
profileSource	String	Source of this profile. Possible values that might change: - ConnectID - AID - Facebook - GooglePlus - Apple - Vipps - Unknown	No
profileAddressId	Integer	Id identifying the instance.	No
careOfAddress	String	Care of address associated with this profile.	Yes
streetAddress	String	Street address associated with this profile.	Yes
streetNumber	Integer	Street number associated with this profile.	Yes
entrance	String	Entrance associated with this profile.	Yes
postalCode	String	Postal code associated with this profile.	Yes
postalPlace	String	Postal place associated with this profile.	Yes
countryCode	String	Country code, ISO 3166 - alpha-2, associated with this profile.	Yes

Example payload

{
  "type": "profileAddress",
  "time": 1679399455,
  "source": "MY_SCHEMA",
  "status": "new",
  "data": {
    "profileKey": {
      "uniqueId": "dummyId",
      "profileSource": "Vipps"
    },
    "profileAddressId": 1,
    "careOfAddress": "Magic Company AS",
    "streetAddress": "Main road",
    "streetNumber": 1,
    "entrance": "A",
    "postalCode": "12345",
    "postalPlace": "Oslo",
    "countryCode": "NO"
  }
}

ProfileCredential

This event is generated by ConnectID when there is any changes on credential regarding a profile. I.e. when a profile credential is added, updated or deleted.

A user can have one or more profiles associated with them, but only one per source. This means that the profileKey should only exist once.

General fields

Field	Description
type	The field will contain the value 'profileCredential'.
status	The status of the changes. Possible values: 'new': This is a new credential instance associated with the profile.. 'change': This is a change of an existing credential instance. 'delete': The credential instance is deleted.

Event specific fields

Field	Type	Description	Nullable
profileKey	object	Key object regarding the user profile.	No
uniqueId	Integer	External id representing the user.	No
profileSource	String	Source of this profile. Possible values that might change: - ConnectID - AID - Facebook - GooglePlus - Apple - Vipps - Unknown	No
profileCredentialId	Integer	Id identifying the instance.	No
credential	String	Credential associated with this profile.	Yes

Example payload

{
  "type": "profileCredential",
  "time": 1679399455,
  "source": "MY_SCHEMA",
  "status": "new",
  "data": {
    "profileKey": {
      "uniqueId": "dummyId",
      "profileSource": "Vipps"
    },
    "profileCredentialId": 1,
    "credential": "jane.doe@unite.as"
  }
}

ConnectID realtime events

Introduction#

General payload fields#

Event types#

ProfileName#

General fields#

Event specific fields#

Example payload#

ProfileAddress#

General fields#

Event specific fields#

Example payload#

ProfileCredential#

General fields#

Event specific fields#

Example payload#

Introduction

General payload fields

Event types

ProfileName

General fields

Event specific fields

Example payload

ProfileAddress

General fields

Event specific fields

Example payload

ProfileCredential

General fields

Event specific fields

Example payload