Skip to main content

CustomerDataVerificationEvent

A webhook event sent when a new customer data verifications process has been initiated.

    id stringrequired

    Unique identifier.

    timestamp date-timerequired

    Represents RFC 3339, section 5.6 date-time.

    verificationProcess

    object

    id stringrequired

    A unique identifier for the verification process.

    attribute

    object

    required

    The customer attribute being attached to the particular verification process.

    type Customer Data Verification Attribute Type (string)required

    Possible values: [EMAIL, MOBILE]

    The type of the customer attribute that will be verified through an additional secure mechanism, such as an OTP code sent via email.

    • EMAIL - The email address connected to the customer’s profile.
    • MOBILE - The phone number registered with the customer’s account.
    value stringrequired

    The value of the customer attribute that will be verified through an additional secure mechanism, such as an OTP code sent via email.

    notificationType

    object

    required

    The mechanism used to deliver the customer attribute verification information.

    method Customer Data Verification Notification Method (string)required

    Possible values: [OTP]

    The notification method used for verifying the customer attribute.

    • OTP - One-Time Password sent via email or SMS to the user's registered device.
    channel Customer Data Verification Notification Channel (string)

    Possible values: [EMAIL, SMS]

    The notification channel used to send the verification method to the user.

    • EMAIL - Verification method sent via email to the user's registered email address.
    • SMS - Verification method sent via SMS to the user's registered phone.
    value string

    The value transmitted through the secure notification method and channel to confirm the specific customer attribute.

    flow Customer Data Verification Flow (string)required

    Possible values: [WALLET_SETUP, WALLET_UPDATE, PASSWORD_RESET]

    The type of verification flow initiated for a specific customer attribute.

    • WALLET_SETUP - Verification process initiated for setting up the customer's wallet.
    • WALLET_UPDATE - Verification process initiated for updating the customer's wallet.
    • PASSWORD_RESET - Verification process initiated for resetting the customer's password.
    errorCode string

    Possible values: [EMAIL_ALREADY_IN_USE, EMAIL_NOT_FOUND, MOBILE_ALREADY_IN_USE]

    Error code present only when the verification process failed.

    creationTime date-timerequired

    Represents RFC 3339, section 5.6 date-time.

    expirationTime date-timerequired

    Represents RFC 3339, section 5.6 date-time.