Skip to main content
GET
/
api
/
v1
/
device_pings
/
latest_geo_check
curl -X GET 'https://api-sandbox.paywithsoap.com/api/v1/device_pings/latest_geo_check?customer_id=cus_vi57KegYgcRqcGHqip8q6UZiqtrwMT870' \
--header 'Authorization: YOUR_API_KEY'

{
  "id": "gc_8HpqVXHQ7672sFi38yLN9kCMJN1LtiMw",
  "passed": true,
  "municipality": "San Francisco",
  "region": "CA",
  "country": "USA",
  "latitude": 37.785834,
  "longitude": -122.406417,
  "checked_at": "2024-01-15T14:30:22Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.paywithsoap.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Get Latest Geo Check

Use this endpoint to retrieve the latest geolocation check for a customer. This endpoint returns the most recent location verification data for a given customer, including whether the location check passed or failed. This is useful for checking a customer’s current geo-compliance status before processing transactions or granting access to location-restricted features. Returns null if no geo check has been performed for the customer. 
curl -X GET 'https://api-sandbox.paywithsoap.com/api/v1/device_pings/latest_geo_check?customer_id=cus_vi57KegYgcRqcGHqip8q6UZiqtrwMT870' \
--header 'Authorization: YOUR_API_KEY'

{
  "id": "gc_8HpqVXHQ7672sFi38yLN9kCMJN1LtiMw",
  "passed": true,
  "municipality": "San Francisco",
  "region": "CA",
  "country": "USA",
  "latitude": 37.785834,
  "longitude": -122.406417,
  "checked_at": "2024-01-15T14:30:22Z"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication using your API key

Query Parameters

​
customer_id
string
required

Unique identifier for the customer

Example:

"cus_vi57KegYgcRqcGHqip8q6UZiqtrwMT870"

Response

200 - application/json

Latest geo check retrieved successfully

​
id
string
Example:

"gc_8HpqVXHQ7672sFi38yLN9kCMJN1LtiMw"

​
passed
boolean

Whether the location is in a state that you support.

Example:

true

​
municipality
string
Example:

"San Francisco"

​
region
string
Example:

"CA"

​
country
string
Example:

"USA"

​
latitude
number
Example:

37.785834

​
longitude
number
Example:

-122.406417

​
checked_at
string<date-time>

ISO 8601 timestamp of when the check was performed

Example:

"2024-01-15T14:30:22Z"