Skip to main content

CustomerDataVerificationEvent

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

idstringrequired

Unique identifier.

Example: 07c3bcf5-1b6c-494e-9a29-776cfc54b4db
timestampdate-timerequired

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z
customer object
idstringrequired

Possible values: <= 20 characters

Example: 500000334204
externalIdExternalId (string)

External identifier in merchant system. Must be passed during onboarding.

Possible values: non-empty and <= 40 characters

Example: a2322550-af91-417f-867e-681efad44b9d
titlestring

Personal title, Mr., Dr., etc.

Possible values: <= 15 characters

Example: Mr.
firstNamestringrequired

First name.

Possible values: <= 50 characters

Example: John
lastNamestringrequired

Last name.

Possible values: <= 50 characters

Example: Doe
verificationProcess objectrequired
idstringrequired

A unique identifier for the verification process.

Example: 07c3bcf5-1b6c-494e-9a29-776cfc54b4db
attribute objectrequired

The customer attribute being attached to the particular verification process.

typeCustomer Data Verification Attribute Type (string)required

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.

Possible values: [EMAIL, MOBILE]

Example: EMAIL
valuestringrequired

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

Example: john.doe@example.com
notificationType object

The enhanced mechanism used to deliver the customer attribute verification information.

methodCustomer Data Verification Notification Method (string)required

The notification method used for verifying the customer attribute.

  • OTP - One-Time Password sent via email or SMS to the user's registered device.

Possible values: [OTP]

Example: OTP
channelCustomer Data Verification Notification Channel (string)

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.

Possible values: [EMAIL, SMS]

Example: EMAIL
targetstring

The destination for the verification mechanism (when available), such as the phone number or email address where the verification value will be delivered.

Example: jo***@example.com
valuestring

The value transmitted through the secure notification mechanism to confirm the specific customer attribute.

Example: 123456
flowCustomer Data Verification Flow (string)required

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.

Possible values: [WALLET_SETUP, WALLET_UPDATE, PASSWORD_RESET]

Example: WALLET_SETUP
errorCodestring

Error code present only when the verification process failed.

Possible values: [EMAIL_ALREADY_IN_USE, EMAIL_NOT_FOUND, MOBILE_ALREADY_IN_USE]

creationTimedate-timerequired

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z
expirationTimedate-timerequired

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z
CustomerDataVerificationEvent
{
  "id": "07c3bcf5-1b6c-494e-9a29-776cfc54b4db",
  "timestamp": "2021-07-15T17:54:12Z",
  "customer": {
    "id": "500000334204",
    "externalId": "a2322550-af91-417f-867e-681efad44b9d",
    "title": "Mr.",
    "firstName": "John",
    "lastName": "Doe"
  },
  "verificationProcess": {
    "id": "07c3bcf5-1b6c-494e-9a29-776cfc54b4db",
    "attribute": {
      "type": "EMAIL",
      "value": "john.doe@example.com"
    },
    "notificationType": {
      "method": "OTP",
      "channel": "EMAIL",
      "target": "jo***@example.com"
    },
    "value": "123456",
    "flow": "WALLET_SETUP",
    "errorCode": "EMAIL_ALREADY_IN_USE",
    "creationTime": "2021-07-15T17:54:12Z",
    "expirationTime": "2021-07-15T17:54:12Z"
  }
}