Geolocation
/
Check Geolocation

Check Geolocation

POST
https://api.vivamo.co/v1/operators/check-geolocation

Check whether an IP address is in an allowed geolocation for your operator account. Use this to pre-check a customer's location before presenting payment UI, avoiding a poor experience where the customer fills out a form only to be denied at transaction time.

If your operator has no location rules configured, the response will always be allowed: true (no IP lookup is performed).

Request body

    ip
    string
    Required
    The IPv4 or IPv6 address to check.
    Examples:8.8.8.8

Response

Geolocation check result.
    allowed
    boolean
    Whether the IP address is in an allowed location for this operator.
    country
    string or null
    Full country name. Omitted when no location rules are configured.
    countryCode
    string or null
    ISO 3166-1 alpha-2 country code. Omitted when no location rules are configured.
    state
    string or null
    Full state or region name.
    stateCode
    string or null
    ISO 3166-2 state or region code.
Built with