Customer Credentials Event

idstringrequired

Unique identifier.

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

timestampstring<date-time>required

Represents RFC 3339, section 5.6 date-time.

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

customer objectrequired

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

credentialsDetails objectrequired

customerIdentifiers objectrequired

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.

valuestringrequired

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

verificationIdstringrequired

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

Example: 06bdcd2c-0cce-4b36-97ec-281c8f5d743c

mobile object

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

valuestringrequired

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

verificationIdstringrequired

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

Example: 06bdcd2c-0cce-4b36-97ec-281c8f5d743c

typeCustomer Credentials Change Type (string)required

The type of the customer credentials change:

• PASSWORD_RECOVERY - User initiated password recovery.

Possible values: [PASSWORD_RECOVERY]

Customer Credentials Event

{
  "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"
  },
  "credentialsDetails": {
    "customerIdentifiers": {
      "email": {
        "value": "string",
        "verificationId": "06bdcd2c-0cce-4b36-97ec-281c8f5d743c"
      },
      "mobile": {
        "value": "string",
        "verificationId": "06bdcd2c-0cce-4b36-97ec-281c8f5d743c"
      }
    },
    "type": "PASSWORD_RECOVERY"
  }
}