API reference / Reference

get/v1/geo/location

Coarse location from the request

Operation
getGeoLocation
Authentication
API key

Used for exactly two things: defaulting the currency selector and seeding the payment-method ranking. Deliberately NOT used as an eligibility input — IP geolocation is not identity, and a diaspora applicant on a VPN must not be told they are exempt from something they are not, or sold a product they do not need.

Request

Parameters

countryquerystring

Responses

200The detected country and a default currency, or nulls when unknown.
country_iso2stringnullrequired
currencystringrequired
sourcestringrequired

one of: clientedgeunknown

notestringrequired
400The request body or query failed validation.
errorobjectrequired
401No key, an unknown key, a revoked key, or a key whose tenant is not active. All four return an identical body on purpose: distinguishing them would let a caller discover which partners we have.
errorobjectrequired
403The key is valid but does not hold the scope this route requires.
errorobjectrequired
404Not found, or not yours. A resource belonging to another tenant answers 404 rather than 403, because 403 would confirm the record exists.
errorobjectrequired

Example

curl
curl -X GET https://api.haavisa.com/v1/geo/location \
  -H "Authorization: Bearer $HAAVISA_API_KEY"

More in Reference

Something unclear? The eligibility guide explains the model behind the answers; the errors guide covers the envelope.