Search
K
Identity API

PhoneType

string

The type of phone

Allowed values:CELLBUSINESSRESIDENTFAX

Example

PhoneV2

object

A phone record returned by V2 phone endpoints.

idstring(uuid)requiredread-only

Phone identifier.

Example:550e8400-e29b-41d4-a716-446655440000

typestringrequired

The type of phone

Allowed values:CELLBUSINESSRESIDENTFAX

Example:CELL

numberstringrequired

10-digit phone number.

Example:3035551234

extensionstring

Optional phone extension.

Example:1234

preferredbooleanrequired

Whether this is the preferred phone number.

Example:true

createdAtstring(date-time)requiredread-only

RFC3339 UTC timestamp when the phone was created.

Example:2024-01-15T10:30:00Z

updatedAtstring(date-time)read-only

RFC3339 UTC timestamp when the phone was last updated.

Example:2024-01-15T14:45:00Z

Example

UpdatePhoneRequest

object
typestringrequired

The type of phone

Allowed values:CELLBUSINESSRESIDENTFAX

Example:CELL

numberstringrequired

Phone number (exactly 10 digits)

Match pattern:^[0-9]{10}$

Example:3035551234

extensionstring

Optional phone extension (max 6 characters)

<= 6 characters

Example:1234

preferredbooleanrequired

Whether this is the preferred phone number

Example:true

Example

CreatePhoneRequest

object
typestringrequired

The type of phone

Allowed values:CELLBUSINESSRESIDENTFAX

Example:CELL

numberstringrequired

Phone number (exactly 10 digits)

Match pattern:^[0-9]{10}$

Example:3035551234

extensionstring

Optional phone extension (max 6 characters)

<= 6 characters

Example:1234

preferredbooleanrequired

Whether this is the preferred phone number

Example:true

Example