Data Quality user documentation
home/Address validation/Pro Web/API reference (REST)/Format

Format

The /format endpoint is used in the Singleline, Typedown, Verification, Keyfinder and Intuitive search types.

Headers

Name Type Description
Monikers
(Optional)		 string This is the moniker that will have the action performed upon it.
Timeout-Seconds
(Optional)		 integer Maximum time you are prepared to wait for a response, expressed in seconds.
Acceptable values: 1-60. If a timeout occurs, an HTTP status code of 408 - Request Timeout will be returned.

The default value of this setting is 15.
Diagnostics
(Optional)		 boolean Enable diagnostic info

The default value of this setting is False.

Body parameters

In the request body you can specify:

Name Type Description
layout string This contains the set of layouts that are valid.

Headers

Name Type Description
Monikers
(Optional)		 string This is the moniker that will have the action performed upon it.
Timeout-Seconds
(Optional)		 integer Maximum time you are prepared to wait for a response, expressed in seconds.
Acceptable values: 1-60. If a timeout occurs, an HTTP status code of 408 - Request Timeout will be returned.

The default value of this setting is 15.
Diagnostics
(Optional)		 boolean Enable diagnostic info

The default value of this setting is False.

Body

The response from the API returns the below fields within a result object. Should an error occur, an error object is returned instead.

Address

The address elements of the Format result are:

Name Type Description
address_lines collection Collection of address lines.
label string This defines a text label for the line, which will describe the contents of the line.
line string This defines the final formatted address line, as described by the layout that was used to format the address result.
has_overflown_to_other_line boolean This element signifies that some address elements could not be formatted upon this line, and so had to overflow onto other lines.
line_content string This describes the elements that are found upon the address line. For example "Name". The following values may be returned:
  • none: There was no content specified for this line.
  • address: There are address elements specified upon this line.
  • name: There is name information specified upon this line.
  • ancillary: There is ancillary data specified upon this line.
  • dataplus: There is DataPlus information specified on this line.
is_truncated boolean This element signifies that some address elements were truncated.
has_overflow_lines boolean This element signifies that at least one line in the layout has overflown onto other lines.
has_truncated_lines boolean This element signifies that at least one line in the layout was truncated.
dpv_status string The dpv status of the Search result are:
  • DPVNotConfigured: DPV is not configured for this combination of data mapping/engine/layout.
  • DPVConfirmed: All address components (primary and secondary) are DPV confirmed.
  • DPVConfirmedMissingSec: Primary number was DPV confirmed but secondary is incorrect or missing.
  • DPVNotConfirmed: Primary number was not DPV confirmed.
  • DPVLocked: DPV retrieval has been locked by a previous search on a seed address.
  • DPVSeedHit: This address is a seed address. DPV retrieval has been locked an an unlock code must be supplied to reactivate it.
has_missing_sub_premise boolean This attribute indicates that the address is a large volume receiver and may be missing subpremises information.

The following response codes can be returned by the API:

Status Code Reason phrase Description
200 Success Request processed successfully.
400 Bad Request Request failed due to malformed syntax.
408 Request Timeout Response was not returned within the timeout allowance.
500 Internal Server Error The server has encountered an error.
Pro Web

API reference (REST)