Skip to main content

KycSessionEvent

Significant events during the KYC session. They will reflect what providers the user has interacted with, or other user interactions.

namestringrequired

Name of the session event.
BIOMETRIC_CONSENT - Customer has given consent to use biometric data for verification.
PROVIDER_SESSION_INITIATED - Customer has started the verification process with a provider.
PROVIDER_SESSION_END - Customer has completed the verification process with a provider.
SSN_ATTESTATION - The attestation is collected during the verification process and customer has certified that all the information they have entered, including, without limitation, their social security number, is current, accurate, and complete, and it may be relied upon.

Possible values: [BIOMETRIC_CONSENT, PROVIDER_SESSION_INITIATED, PROVIDER_SESSION_END, SSN_ATTESTATION]

kycProviderDetails object

Details on the kyc provider

kycProviderstring

name of the provider

KycSessionEvent
{
  "name": "BIOMETRIC_CONSENT",
  "kycProviderDetails": {
    "kycProvider": "string"
  }
}