mirror of
https://github.com/LukeHagar/clerk-sdk-java.git
synced 2025-12-06 12:27:45 +00:00
12 lines
6.0 KiB
Markdown
12 lines
6.0 KiB
Markdown
# CreatePhoneNumberRequestBody
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description |
|
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `userId` | *Optional<? extends String>* | :heavy_minus_sign: | The ID representing the user |
|
|
| `phoneNumber` | *Optional<? extends String>* | :heavy_minus_sign: | The new phone number. Must adhere to the E.164 standard for phone number format. |
|
|
| `verified` | *JsonNullable<? extends Boolean>* | :heavy_minus_sign: | When created, the phone number will be marked as verified. |
|
|
| `primary` | *JsonNullable<? extends Boolean>* | :heavy_minus_sign: | Create this phone number as the primary phone number for the user.<br/>Default: false, unless it is the first phone number. |
|
|
| `reservedForSecondFactor` | *JsonNullable<? extends Boolean>* | :heavy_minus_sign: | Create this phone number as reserved for multi-factor authentication.<br/>The phone number must also be verified.<br/>If there are no other reserved second factors, the phone number will be set as the default second factor. | |