Skip to main content

ID Verification Events

Overview​

1Kosmos allows community administrators to track each stage of a user’s session activities through ID Verification events in the AdminX interface. Administrators can access the Verifications list page to view a comprehensive list of all sessions, regardless of their status. End users can verify their identity by uploading the relevant supported documents based on their region.

1Kosmos offers a ready-to-use (OOTB) template for ID verification, covering documents like passports, driving licenses, and ID cards. The template outlines the various stages of verification, and as users progress through each stage, the corresponding events are captured. These events are displayed on the ID Verifications page and are pre-defined, with no customization options.

note

If the internet is unavailable at any stage of the verification process, the UI notifies users that the servers are down and prompts them to log in later. No events are triggered.

ID Verification Events​

E_IDV_INITIALIZATION​

The E_IDV_INITIALIZATION event is created when users begin their ID verification process in the Initialization screen.

Event Parameters:

  • eventCategory
  • type
  • event_name
  • version
  • event_ts
  • ip_address
  • user_agent
  • sessionId
  • screen_name
  • status
  • eventCategory
  • event_name
  • type
  • version
  • event_ts
  • ip_address
  • user_agent
  • sessionId
  • SessionInfo
  • _id
  • id
  • dvcID
  • tenantDNS
  • tenantId
  • communityName
  • communityId
  • documentType
  • status
  • expiryTS
  • createdTS
  • user
  • username
  • firstname
  • Lastname
  • expiryTS
  • request_id
  • app_id
  • event_id
  • timestamp
  • epoch_time
  • tenant_id
  • community_id
  • eventName

This event is triggered when users give their consent for sharing their information. When users are reading the consent notice, their verification status is “In Progress”. After giving consent, the verification status becomes “Completed”.

note

If users decline the Consent notice, the UI prompts them to reinitiate the verification. The E_IDV_USER_CONSENT event is triggered with the status Declined.

Event Parameters:

  • eventCategory
  • type
  • event_name
  • version
  • event_ts
  • ip_address
  • user_agent
  • sessionId
  • screen_name
  • status
  • eventCategory
  • event_name
  • type
  • version
  • event_ts
  • ip_address
  • user_agent
  • sessionId
  • SessionInfo
  • _id
  • id
  • dvcID
  • tenantDNS
  • tenantId
  • communityName
  • communityId
  • documentType
  • status
  • expiryTS
  • createdTS
  • user
  • username
  • firstname
  • Lastname
  • expiryTS
  • request_id
  • app_id
  • event_id
  • timestamp
  • epoch_time
  • tenant_id
  • community_id
  • eventName

E_IDV_DOCUMENTINSTRUCTION​

This event is triggered when users review the instructions before starting the document scan.

Event Parameters:

  • screen_name
  • status
  • eventCategory
  • event_name
  • type
  • version
  • event_ts
  • ip_address
  • user_agent
  • sessionId
  • sessionInfo
  • _id
  • id
  • dvcID
  • tenantDNS
  • tenantId
  • communityName
  • communityId
  • documentType
  • status
  • expiryTS
  • createdTS
  • user
  • firstname
  • lastname
  • startedTS
  • expiryTS
  • request_id
  • app_id
  • event_id
  • timestamp
  • epoch_time
  • tenant_id
  • community_id
  • eventName

E_IDV_DOCUMENTPREVIEW​

This event is triggered when users preview their document before capturing it.

Event Parameters:

  • screen_name
  • status
  • eventCategory
  • event_name
  • type
  • version
  • event_ts
  • ip_address
  • user_agent
  • sessionId
  • SessionInfo
  • _id
  • id
  • dvcID
  • tenantDNS
  • TenantId
  • communityName
  • communityId
  • documentType
  • status
  • expiryTS
  • createdTS
  • username
  • lastname
  • startedTS
  • expiryTS
  • request_id
  • app_id
  • event_id
  • timestamp
  • epoch_time
  • tenant_id
  • community_id
  • eventName

E_IDV_DOCUMENTCAPTURE​

This event is triggered when users scan their documents for capture. When users display their documents for capture, the verification status is In Progress while after capture, it becomes Completed.

note

If an unsupported document is presented for verification, the UI triggers the E_IDV_DOCUMENT_CAPTURE event during validation. The verification status is set to Verification Not Performed, indicating the reason code and specifying that the failure occurred due to one of the following reasons:

  • “Unsupported document”, if camera does not recognize the document
  • “No document was presented”
  • “Document scan not completed. Please try again”

Event Parameters:

  • eventCategory
  • type
  • event_name
  • version
  • event_ts
  • ip_address
  • user_agent
  • sessionId
  • screen_name
  • status
  • eventCategory
  • event_name
  • type
  • version
  • event_ts
  • ip_address
  • user_agent
  • sessionId
  • SessionInfo
  • _id
  • id
  • dvcID
  • tenantDNS
  • tenantId
  • communityName
  • communityId
  • documentType
  • status
  • expiryTS
  • createdTS
  • user
  • username
  • firstname
  • Lastname
  • document_liveness_front_classInfo
  • classInfo
  • country
  • region
  • countryName
  • isoNumericCountryCode
  • isoAlpha2CountryCode
  • isoAlpha3CountryCode
  • backProcessingStatus
  • type
  • documentType
  • Category
  • documentName
  • imageAnalysisResult
  • blurDetected
  • glareDetected
  • cardOrientation
  • documentImageColorStatus
  • documentImageMoireStatus
  • faceDetectionStatus
  • mrzDetectionStatus
  • barcodeDetectionStatus
  • realIDDetectionStatus
  • cardRotation
  • document_liveness_back_classInfo
  • classInfo
  • country
  • region
  • documentType
  • countryName
  • isoNumericCountryCode
  • isoAlpha2CountryCode
  • isoAlpha3CountryCode
  • backProcessingStatus
  • type
  • documentType
  • category
  • documentName
  • imageAnalysisResult
  • blurDetected
  • glareDetected
  • cardOrientation
  • documentImageColorStatus
  • documentImageMoireStatus
  • faceDetectionStatus
  • mrzDetectionStatus
  • barcodeDetectionStatus
  • realIDDetectionStatus
  • cardRotation
  • document_liveness_front
  • type
  • authority
  • ts
  • verified
  • reason
  • document_liveness_back
  • type
  • authority
  • ts
  • verified
  • reason
  • expiryTS
  • request_id
  • app_id
  • event_id
  • timestamp
  • epoch_time
  • tenant_id
  • community_id
  • EventName

E_IDV_SELFIEINSTRUCTION​

This event is triggered when users review the instructions before taking their selfie.

Event Parameters:

  • screen_name
  • status
  • eventCategory
  • event_name
  • type
  • version
  • event_ts
  • ip_address
  • user_agent
  • sessionId
  • sessionInfo
  • _id
  • id
  • dvcID
  • tenantDNS
  • tenantId
  • communityName
  • communityId
  • documentType
  • status
  • expiryTS
  • createdTS
  • user
  • firstname
  • lastname
  • startedTS
  • expiryTS
  • request_id
  • app_id
  • event_id
  • timestamp
  • epoch_time
  • tenant_id
  • community_id
  • eventName

E_IDV_SELFIEPREVIEW​

This event is triggered when users preview their selfie before tapping the capture button.

Event Parameters:

  • screen_name
  • status
  • eventCategory
  • event_name
  • type
  • version
  • event_ts
  • ip_address
  • user_agent
  • sessionId
  • sessionInfo
  • _id
  • id
  • dvcID
  • tenantDNS
  • tenantId
  • communityName
  • communityId
  • documentType
  • status
  • expiryTS
  • createdTS
  • user
  • firstname
  • lastname
  • startedTS
  • expiryTS
  • request_id
  • app_id
  • event_id
  • timestamp
  • epoch_time
  • tenant_id
  • community_id:
  • EventName

E_IDV_SELFIECAPTURE​

This event is triggered when users capture their selfie.

Event Parameters:

  • eventCategory
  • type
  • event_name
  • version
  • event_ts
  • ip_address
  • user_agent
  • sessionId
  • screen_name
  • status
  • sessionInfo
  • _id
  • id
  • dvcID
  • tenantDNS
  • tenantId
  • communityName
  • communityId
  • documentType
  • status
  • expiryTS
  • createdTS
  • user
  • firstname
  • lastname
  • startedTS
  • selfie_liveness
  • docType
  • docId
  • type
  • authority
  • proofedBy
  • ts
  • verified
  • result
  • Confidence
  • quality
  • metadata
  • score
  • quality
  • probability
  • token
  • expiryTS
  • request_id
  • app_id
  • event_id
  • timestamp
  • epoch_time
  • tenant_id
  • community_id
  • eventName

E_IDV_DOCUMENT_SUBMISSION​

This event is triggered when users submit their scanned document.

Event Parameters:

  • eventCategory
  • type
  • event_name
  • version
  • event_ts
  • ip_address
  • user_agent
  • sessionId
  • screen_name
  • status
  • eventCategory
  • event_name
  • type
  • version
  • event_ts
  • ip_address
  • user_agent
  • sessionId
  • SessionInfo
  • _id
  • id
  • dvcID
  • tenantDNS
  • tenantId
  • communityName
  • communityId
  • documentType
  • status
  • expiryTS
  • createdTS
  • user
  • username
  • firstname
  • Lastname
  • expiryTS
  • request_id
  • app_id
  • event_id
  • timestamp
  • epoch_time
  • tenant_id
  • community_id
  • EventName

E_IDV_DOCUMENT_VALIDATE​

This event is triggered when the submitted users' documents are validated.

note

If an unsupported document is presented for verification, the UI triggers the E_IDV_DOCUMENT_VALIDATE event during validation. The verification status is set to Verification Not Performed, indicating the reason code and specifying that the failure occurred due to an unsupported document being presented.

Event Parameters:

  • eventCategory
  • type
  • event_name
  • version
  • event_ts
  • ip_address
  • user_agent
  • sessionId
  • screen_name
  • status
  • eventCategory
  • event_name
  • type
  • version
  • event_ts
  • ip_address
  • user_agent
  • sessionId
  • SessionInfo
  • _id
  • id
  • dvcID
  • tenantDNS
  • tenantId
  • communityName
  • communityId
  • documentType
  • status
  • expiryTS
  • createdTS
  • user
  • username
  • firstname
  • Lastname
  • startedTS
  • completedTS
  • resultStatus
  • document_firstname
  • document_lastname
  • document_id
  • document_expiry
  • expiryTS
  • request_id
  • app_id
  • event_id
  • timestamp
  • epoch_time
  • tenant_id
  • community_id
  • EventName

Was this page helpful?