Phone Number

What is a Phone Field

The Phone Number field data type enables users to extract phone number from their documents using the API Builder. This is done by selecting the Phone field when creating and defining your data model.

Set Up an Phone Field

After you've set up your custom API

  • Go to the define your model page.
  • Set up the phone field by choosing Phone from the right side menu. 
    phone number model fieldphone number model field
  • Enter the Field name and API Response Key according to the data you want to extract.
    phone field name and API response filledphone field name and API response filled

Note: The API Response Key is automatically filled for you but you can change that to something most suitable for you according to your needs.

Additional Parameters

If you have additional context about this specific field and how the information is usually displayed in your documents, you can specify it during the field set up by enabling the checkbox that suits your demand.
phone field additional parametersphone field additional parameters

  • Can be handwritten: by checking this, the API will be able to detect handwritten words more accurately. This doesn’t stop the API from detecting non-handwritten words.

Training and Predictions

By specifying the data type as Phone, you will enable the API to only consider words and series of words that can be interpreted as phone number as eligible candidates.

This means that, the API will not extract any information in your document that cannot be interpreted as a phone number for this specific field.

 

Questions?

Slack Logo IconSlack Logo Icon  Join our Slack


Did this page help you?