Phone Number

ID

aluma.phone_number

Description

UK or US format phone number.

Fields

Phone Number

Remarks

Multiple phone numbers are returned if they are found. Numbers are returned as they appear on the document and are not reformatted.

Parameters

locale

Locale of phone numbers to find. Valid values are en-GB and en-US. Multiple locales are not supported for a single instance of this module.

Type: string
Required: True
Accepted values: en-GB, en-US


exclude_business_numbers

Currently applies only when locale is 'en-US'. If true, excludes toll-free numbers such as those beginning 1-800, 1-888 from the results.

Type: boolean
Required: False