Skip to main content

Credentials Change Event

POST 
/credentials/events

This webhook will be sent when change of the customer credentials has occurred. It contains the type of the credentials change, customer information and customer identifiers (e.g. email, mobile, etc.).

It will be sent at least once.

Request​

Header Parameters

    Signature string

    HMAC signature of the request

    Content-Type stringrequired

    Default value: application/json

    application/json

Body

    id stringrequired

    Unique identifier.

    timestamp date-timerequired

    Represents RFC 3339, section 5.6 date-time.

    credentialsDetails

    object

    required

    customer

    object

    required

    id stringrequired

    Customer id.

    externalId ExternalId (string)

    Possible values: non-empty and <= 40 characters

    Customer identifier used in Partner system.

    customerIdentifiers

    object

    required

    Customer identifiers used in processes where verified identifier is required. Based on brand configurations, at least one identifier must be provided in the request.

    Email example: value - john.doe@paysafe.com verificationId - 06bdcd2c-0cce-4b36-97ec-281c8f5d743c

    Mobile example: value - +359897765463 verificationId - 06bdcd2c-0cce-4b36-97ec-281c8f5d743c

    email

    object

    Unique customer identifier used for processes requiring verified identifier, such as email, mobile number, etc.

    value stringrequired

    Identifier's value, such as email, mobile number etc.

    verificationId stringrequired

    A unique identifier for the verification process associated with the customer attribute.

    mobile

    object

    Unique customer identifier used for processes requiring verified identifier, such as email, mobile number, etc.

    value stringrequired

    Identifier's value, such as email, mobile number etc.

    verificationId stringrequired

    A unique identifier for the verification process associated with the customer attribute.

    type CustomerCredentialsChangeType (string)required

    Possible values: [PASSWORD_RECOVERY]

    The type of the customer credentials change:

    • PASSWORD_RECOVERY - User initiated password recovery.

Responses​

OK

Loading...