Skip to main content
GET
Check Customer's IP address

Authorizations

apiKey
string
query
required

Your publishable API key, passed as the apiKey query parameter. Publishable keys are prefixed with pk_test_ (sandbox) or pk_live_ (production) and are safe to use in client-side code. Find your keys on the API keys page of the dashboard. See Authentication.

Query Parameters

query
object
required

Response

Successful response. IP Address details

alpha2
string

The country's ISO 3166-1 alpha-2 code.

Example:

"GB"

alpha3
string

The country's ISO 3166-1 alpha-3 code.

Example:

"GBR"

country
string

The IP address country.

Example:

"United Kingdom"

state
string

The IP address state or region or empty if not applicable.

Example:

""

ipAddress
string

The IPv4 or IPv6 address of the caller

Example:

"81.152.178.191"

isAllowed
boolean

Whether residents of this country can use the service.

Example:

true

isBuyAllowed
boolean

Whether residents of this country can buy cryptocurrencies.

Example:

true

isSellAllowed
boolean

Whether residents of this country can sell cryptocurrencies.

Example:

true

isNftAllowed
boolean

Whether residents of this country can buy NFTs.

Example:

true