Customer Data Verification Event
POST/customers/data-verifications/events
This webhook will be sent when a customer data verification process has been successfully initiated. It contains:
- The customer attribute being validated in the particular verification process.
- The mechanism used to deliver the customer attribute verification information.
- The value transmitted through the secure notification method and channel to confirm the specific customer attribute.
- Creation and expiration time for the verification process.
This event is sent at least once for every initiated customer data verification process.
Request
Header Parameters
HMAC signature of the request
Default value: application/json
application/json
- application/json
Body
EMAIL
- The email address connected to the customer’s profile.MOBILE
- The phone number registered with the customer’s account.OTP
- One-Time Password sent via email or SMS to the user's registered device.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.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.
Unique identifier.
Represents RFC 3339, section 5.6 date-time.
verificationProcess
object
A unique identifier for the verification process.
attribute
object
required
The customer attribute being attached to the particular verification process.
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.
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.
Possible values: [OTP
]
The notification method used for verifying the customer attribute.
Possible values: [EMAIL
, SMS
]
The notification channel used to send the verification method to the user.
The value transmitted through the secure notification method and channel to confirm the specific customer attribute.
Possible values: [WALLET_SETUP
, WALLET_UPDATE
, PASSWORD_RESET
]
The type of verification flow initiated for a specific customer attribute.
Possible values: [EMAIL_ALREADY_IN_USE
, EMAIL_NOT_FOUND
, MOBILE_ALREADY_IN_USE
]
Error code present only when the verification process failed.
Represents RFC 3339, section 5.6 date-time.
Represents RFC 3339, section 5.6 date-time.
Responses
- 200
- 202
- 400
OK
Accepted
Bad Request