Field | Type | Required | Description | Example |
---|---|---|---|---|
UserId |
string | ➖ | The ID representing the user | usr_12345 |
PhoneNumber |
string | ➖ | The new phone number. Must adhere to the E.164 standard for phone number format. | +11234567890 |
Verified |
bool | ➖ | When created, the phone number will be marked as verified. | true |
Primary |
bool | ➖ | Create this phone number as the primary phone number for the user. Default: false, unless it is the first phone number. |
false |
ReservedForSecondFactor |
bool | ➖ | Create this phone number as reserved for multi-factor authentication. The phone number must also be verified. If there are no other reserved second factors, the phone number will be set as the default second factor. |
false |