Skip to main content
POST
Start my contact change

Body

application/json

The properties required to start a customer contact change.

type
enum<string>
required

The contact destination being changed.

Available options:
email,
phone

Response

Created.

A customer contact change awaiting verification.

id
string
required

The unique identifier of the customer contact change.

type
enum<string>
required

The contact destination being changed.

Available options:
email,
phone
currentChallenge
object
required

The challenge delivered to the customer's current contact destination.

expiresAt
string<date-time>
required

The expiration date-time for the contact change, in [RFC 3339] date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.

newChallenge
object

The challenge delivered to the customer's new contact destination after the current destination verifies.