/
v3.0.11Get access

geoComplyGeolocationCheck

Checks whether the user’s location is allowed based on GeoComply data. It receives a GeoComply location token from the client and verifies it on the backend. It is used after login to enforce geographic rules, to block users in restricted regions, and to meet licensing and compliance requirements.

Request parameters:

NameDescriptionTypeValuesDefault
locationToken
A secure token from the GeoComply SDK containing user location infostring--
This method is usually used with these methods:

Call example:

geoComplyGeolocationCheck({
  locationToken: 'VeYAA8rlc5AHo5+ljdKJmVRaWpM0vQNaSSZ1osUNPYzdT6khvDVYulIccpEFFlVjlrwMtJT2e2nmQTp/FO6sFFMURMbvmCCMBmLYbYKu9g74cmGz5yV+MKTy1eMsz6KO8MOPDdz8thzdvZ82Z8GuNeptKnTThpEbJumi55uWdjIaavmBW2JWqupRhUbxLivPzjFZhWJfKbjcDuMvA3cd+n01q39r/7sbaQXPaxey5XovlVcvrgkjyyE427IMy2z8D5jou+aeUEnjnnuEjv7qZ/f1HKdvlay0fSMsBaSc/D1S8ZnXbaR34rjOILB0Gr81tgQqmn1ouK0k6alH3hZLpQ2jHWTmTBLThjqauVjgqXSFXkANyBz2LWtJmQ2u8RuPbGhQu4zGR68mypkcGXVwJIgvIDL7IQeUc8nMiAqNmapwYnA0LJ6I5Jz1GhL8X5vxcrEm7Yjb8QsK8DfFksezNFhOJl/MLM4iXRH13uyeVBg4jnSnz5fimoU/AoUYwn5kLoPtyEWhWKYigjVx88CGfw6ldI5RFcA1LKkvcA5ZbB4Xf/9nFe7gRhgB99l4vt1jhOeOj+N+LiRJfVxVYy3j4duKk5EhX19TStLJ+WWjhfncPNcoJPXsCr0ycangiWweiC9rmTxyZe/WgUBAT3Vr5ECXlxGo8QE3GXNpEHdlOmnwYc8AZzFeoKM4Y8uXzBUG9XFmdZgN4ntIng/8AM3f0lJnHsjjR0v7B27JGKAvTJJ387GPe0fhfql2yIaNAd8WjfjBgJ6yUHLNto9sDL5YFpGbXa+GBZKo7jmv8/yS+v9o6BhP4zU9UJtXoMt5QxSF0rH6xIyIoxGZBLqJdlaAwz1pRHa+bgK76JB0RS0vu/BCSBazRMyeLuToBCFSrMKV/W7PqqJ0TmQtRu0v/F9Ir4v4nO2YildmUXaWVZpil6QfI3y4wIwqSDGSn+L5IlnyfZyrzKN2VRkuNvXporUazxSNwl/2E8Cswdsr3umfphLWIvEhwRAk6iqDxOVMgUQg9CSU3HkUzU7UJLKWf7X+FeWw2HG80zoORwUztIQPlnHcfwWH9jonSdPTUzBkOqPs7M45W1RAs2/7CJyjNhbYcnR35eKeajXojB+5wdiuP8eKseDiYhn7w2pB9zhfJTzQs6JzFATaLxPrOjCM+YgOHl/gh0E3cU92soXEDYxH7MEGoQRJLdaNU+ZdXkFZCO+2w3kSUdDKssV7wroxQ4n7/hyowmRmSblwrNmLEyhQ40EZQnEg5KstHb8UAgxFDVpWvNkNhuZMSdCaKNg2fCuPQIZyXX5FxWX29CHP+Ts2VFUM7/3hjEw12luIabjVPaekBOO3UU8Nr84l+0HI61ZDdQVQfEXJIY7UlMibxnMheByF4i5YSAd+DvbwId+UFmnmbsonhGcS7ySv38DtlOGpLfCKxHjq+Ao3ilX6hxGGK9vZDIRFt6TF4IX7qKR1W79rQ5zpJiifYpJOjdkDMR1D+3FpabcpeyBccO09lUBA/qUZGzjijzaqUrLdTrwFfr4sfzUFd4YfP3CvHDrhgDv69x/9F7gxElWNCDANu/sHj/jxN+3yejQhEAs45hptb96yV41t3JRWFVk4ftLIpj4mzZPoyHRvf5wCJ4PrGvwqM3u5Tp7D71k9olO+7ceGFf2Bk/vf1mHHmtptlfo0bXHd7F9SGYvDRkVjdO77Mkb2yrj4oc+wfwu9sHQZKMXlHRnGJttkLZBjQERAbpp8y569jTPYVaCVhoqjpgc3WZaoAZ+f1HsKQMXP5x6jdqaUUsprXSEwB7h//PTIWniLE0Exj+FRdjVhUYT5bH9q48aA5zTiKHYm3q1jhc/V7UCAf1L/2NF+xhpUQOJhyMTQKAWrvw=='
})

Response examples:

{
  code: 0,
  rid: 1592432466,
  data: {
    result: 0,
    result_text: null,
    details: {
      IsSuccess: true,
      ErrorCode: 0
    }
  }
}

Response parameters:

NameDescriptionTypeValues
IsSuccess
Whether the geolocation check passed (true: allowed, false: blocked)booleantrue / false
ErrorCode
Error code if the check failed (0 = no error)number-