Search
K
New Business - Annuity

PhoneNumber

object
* Additional properties are NOT allowed.
phoneIdstring(uuid)required

Unique identifier for the phone number record.

typestringrequired

Type or classification of the phone number.

Allowed values:BEEPERNUMBERMOBILEFACSIMILEHOMETELEPHONEWORKPHONENUMBERBUSINESSFAXUNKNOWNCLAIMCENTERCUSTOMERSERVICECORPORATEOFFICE

countryCodestring

Country dialing code for the phone number.

areaCodestringrequired

Area code associated with the phone number.

dialNumberstringrequired

Primary phone number excluding country and area codes.

extensionstring

Phone extension, if applicable.

bestTimestring

Preferred time to contact using this phone number.

timezonestring

Time zone associated with the phone number location.

zipstring

ZIP code associated with the phone number.

zipSuffixstring

ZIP+4 suffix associated with the phone number, if applicable.

Example

SuccessResponseV3

object
statusCodeinteger(int32)

Example:202

timestampstring(date-time)
messagestring

Example:Request Submitted Successfully

Example

ValidationResponseV3

object
statusstring

Example:FAILED

timestampstring(date-time)
messagestring

Example:Bad Request

errorarray[string]

Example:Mandatory attribute label missing

Example

AccessDeniedResponseV3

object
timestampstring(date-time)
messagestring

Example:User is not authorized for the carrier : CarrierName_1

Example

ServerErrorResponseV3

object
timestampstring(date-time)
messagestring

Example:Failed to process request

Example