Important terms

Words you will meet in every response.

proposal

result.proposal tells you what to do with the answer.

proposalWhat to do in your form
validAccept the value. Show the valid state.
validWithSuggestionAccept it, and ask “Did you mean …?”
invalidMark the field invalid.
invalidWithSuggestionMark invalid and offer the suggestion.
invalidWithCorrectionReplace the value with resultCorrected, show valid.
invalidWithCorrectionWithSuggestionCorrect it, and offer the other options.
invalidWithPartialCorrectionApply the format fix, but keep the field invalid.
unknownShow no validation state at all.

result, resultCorrected, suggestions

FieldMeaning
resultYour value, evaluated as you sent it.
resultCorrectedThe corrected value, or null if nothing could be corrected.
suggestionsOther likely values to offer the user.

client

Optional data about your end user: IP address, country or GPS. It makes search results more relevant.

json
"client": { "country": "CZ", "location": { "lat": 50.0628, "lon": 13.9271 } }

dataScope

How much data comes back. basic is the default, extended and full return more and cost more.

What each scope returns: Company, Location, Name.