PrecheckAddressPayload

Response for the precheckAddress mutation. Indicates whether the provided address can be successfully geocoded.

type PrecheckAddressPayload {
  address: Address
  success: Boolean!
}

Fields

PrecheckAddressPayload.address ● Address scalar

The address object if it is valid.

PrecheckAddressPayload.success ● Boolean! non-null scalar

True if the address was successfully geocoded (latitude and longitude found). False if geocoding failed or the address could not be resolved.

Returned By

precheckAddress mutation