API Reference
Get Geocoverage
API Reference
Get Geocoverage
Get list of regions where Sardine is supported, separated by county and state regions
GET
/
geo-coverage
curl --request GET \
--url https://api.sandbox.sardine.ai/v1/geo-coverage \
--header 'Authorization: Basic <encoded-value>'
{
"data": [
{
"countryCode": "US",
"isAllowed": true,
"isBasicKycAllowed": true,
"name": "United States of America",
"supportedDocuments": [
"passport",
"drivers license",
"identity card"
],
"currencyCode": "USD",
"paymentMethods": [
{
"name": "ach",
"type": "bank",
"isAllowed": true
}
],
"states": [
{
"code": "US-AL",
"name": "Alabama",
"isAllowed": true
},
{
"code": "US-AK",
"name": "Alaska",
"isAllowed": true
},
{
"code": "US-AZ",
"name": "Arizona",
"isAllowed": true
},
{
"code": "US-AR",
"name": "Arkansas",
"isAllowed": true
},
{
"code": "US-CA",
"name": "California",
"isAllowed": true
},
{
"code": "US-CO",
"name": "Colorado",
"isAllowed": true
},
{
"code": "US-CT",
"name": "Connecticut",
"isAllowed": true
},
{
"code": "US-DE",
"name": "Delaware",
"isAllowed": true
},
{
"code": "US-DC",
"name": "District of Columbia",
"isAllowed": true
},
{
"code": "US-FL",
"name": "Florida",
"isAllowed": true
},
{
"code": "US-GA",
"name": "Georgia",
"isAllowed": true
},
{
"code": "US-HI",
"name": "Hawaii",
"isAllowed": false
},
{
"code": "US-ID",
"name": "Idaho",
"isAllowed": true
},
{
"code": "US-IL",
"name": "Illinois",
"isAllowed": true
},
{
"code": "US-IN",
"name": "Indiana",
"isAllowed": true
},
{
"code": "US-IA",
"name": "Iowa",
"isAllowed": true
},
{
"code": "US-KS",
"name": "Kansas",
"isAllowed": true
},
{
"code": "US-KY",
"name": "Kentucky",
"isAllowed": true
},
{
"code": "US-LA",
"name": "Louisiana",
"isAllowed": true
},
{
"code": "US-ME",
"name": "Maine",
"isAllowed": true
},
{
"code": "US-MD",
"name": "Maryland",
"isAllowed": true
},
{
"code": "US-MA",
"name": "Massachusetts",
"isAllowed": true
},
{
"code": "US-MI",
"name": "Michigan",
"isAllowed": true
},
{
"code": "US-MN",
"name": "Minnesota",
"isAllowed": true
},
{
"code": "US-MS",
"name": "Mississippi",
"isAllowed": true
},
{
"code": "US-MO",
"name": "Missouri",
"isAllowed": true
},
{
"code": "US-MT",
"name": "Montana",
"isAllowed": true
},
{
"code": "US-NE",
"name": "Nebraska",
"isAllowed": true
},
{
"code": "US-NV",
"name": "Nevada",
"isAllowed": true
},
{
"code": "US-NH",
"name": "New Hampshire",
"isAllowed": true
},
{
"code": "US-NJ",
"name": "New Jersey",
"isAllowed": true
},
{
"code": "US-NM",
"name": "New Mexico",
"isAllowed": true
},
{
"code": "US-NY",
"name": "New York",
"isAllowed": false
},
{
"code": "US-NC",
"name": "North Carolina",
"isAllowed": true
},
{
"code": "US-ND",
"name": "North Dakota",
"isAllowed": true
},
{
"code": "US-OH",
"name": "Ohio",
"isAllowed": true
},
{
"code": "US-OK",
"name": "Oklahoma",
"isAllowed": true
},
{
"code": "US-OR",
"name": "Oregon",
"isAllowed": true
},
{
"code": "US-PA",
"name": "Pennsylvania",
"isAllowed": true
},
{
"code": "US-PR",
"name": "Puerto Rico",
"isAllowed": true
},
{
"code": "US-RI",
"name": "Rhode Island",
"isAllowed": true
},
{
"code": "US-SC",
"name": "South Carolina",
"isAllowed": true
},
{
"code": "US-SD",
"name": "South Dakota",
"isAllowed": true
},
{
"code": "US-TN",
"name": "Tennessee",
"isAllowed": true
},
{
"code": "US-TX",
"name": "Texas",
"isAllowed": true
},
{
"code": "US-UT",
"name": "Utah",
"isAllowed": true
},
{
"code": "US-VT",
"name": "Vermont",
"isAllowed": true
},
{
"code": "US-VA",
"name": "Virginia",
"isAllowed": true
},
{
"code": "US-VI",
"name": "Virgin Islands (U.S.)",
"isAllowed": true
},
{
"code": "US-WA",
"name": "Washington",
"isAllowed": true
},
{
"code": "US-WV",
"name": "West Virginia",
"isAllowed": true
},
{
"code": "US-WI",
"name": "Wisconsin",
"isAllowed": true
},
{
"code": "US-WY",
"name": "Wyoming",
"isAllowed": true
}
]
}
]
}
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Response
200 - application/json
OK
2 letter code representing a country
Minimum length:
1
KYC requirements are satisfied without needing a document proof
Minimum length:
1
Minimum length:
1
curl --request GET \
--url https://api.sandbox.sardine.ai/v1/geo-coverage \
--header 'Authorization: Basic <encoded-value>'
{
"data": [
{
"countryCode": "US",
"isAllowed": true,
"isBasicKycAllowed": true,
"name": "United States of America",
"supportedDocuments": [
"passport",
"drivers license",
"identity card"
],
"currencyCode": "USD",
"paymentMethods": [
{
"name": "ach",
"type": "bank",
"isAllowed": true
}
],
"states": [
{
"code": "US-AL",
"name": "Alabama",
"isAllowed": true
},
{
"code": "US-AK",
"name": "Alaska",
"isAllowed": true
},
{
"code": "US-AZ",
"name": "Arizona",
"isAllowed": true
},
{
"code": "US-AR",
"name": "Arkansas",
"isAllowed": true
},
{
"code": "US-CA",
"name": "California",
"isAllowed": true
},
{
"code": "US-CO",
"name": "Colorado",
"isAllowed": true
},
{
"code": "US-CT",
"name": "Connecticut",
"isAllowed": true
},
{
"code": "US-DE",
"name": "Delaware",
"isAllowed": true
},
{
"code": "US-DC",
"name": "District of Columbia",
"isAllowed": true
},
{
"code": "US-FL",
"name": "Florida",
"isAllowed": true
},
{
"code": "US-GA",
"name": "Georgia",
"isAllowed": true
},
{
"code": "US-HI",
"name": "Hawaii",
"isAllowed": false
},
{
"code": "US-ID",
"name": "Idaho",
"isAllowed": true
},
{
"code": "US-IL",
"name": "Illinois",
"isAllowed": true
},
{
"code": "US-IN",
"name": "Indiana",
"isAllowed": true
},
{
"code": "US-IA",
"name": "Iowa",
"isAllowed": true
},
{
"code": "US-KS",
"name": "Kansas",
"isAllowed": true
},
{
"code": "US-KY",
"name": "Kentucky",
"isAllowed": true
},
{
"code": "US-LA",
"name": "Louisiana",
"isAllowed": true
},
{
"code": "US-ME",
"name": "Maine",
"isAllowed": true
},
{
"code": "US-MD",
"name": "Maryland",
"isAllowed": true
},
{
"code": "US-MA",
"name": "Massachusetts",
"isAllowed": true
},
{
"code": "US-MI",
"name": "Michigan",
"isAllowed": true
},
{
"code": "US-MN",
"name": "Minnesota",
"isAllowed": true
},
{
"code": "US-MS",
"name": "Mississippi",
"isAllowed": true
},
{
"code": "US-MO",
"name": "Missouri",
"isAllowed": true
},
{
"code": "US-MT",
"name": "Montana",
"isAllowed": true
},
{
"code": "US-NE",
"name": "Nebraska",
"isAllowed": true
},
{
"code": "US-NV",
"name": "Nevada",
"isAllowed": true
},
{
"code": "US-NH",
"name": "New Hampshire",
"isAllowed": true
},
{
"code": "US-NJ",
"name": "New Jersey",
"isAllowed": true
},
{
"code": "US-NM",
"name": "New Mexico",
"isAllowed": true
},
{
"code": "US-NY",
"name": "New York",
"isAllowed": false
},
{
"code": "US-NC",
"name": "North Carolina",
"isAllowed": true
},
{
"code": "US-ND",
"name": "North Dakota",
"isAllowed": true
},
{
"code": "US-OH",
"name": "Ohio",
"isAllowed": true
},
{
"code": "US-OK",
"name": "Oklahoma",
"isAllowed": true
},
{
"code": "US-OR",
"name": "Oregon",
"isAllowed": true
},
{
"code": "US-PA",
"name": "Pennsylvania",
"isAllowed": true
},
{
"code": "US-PR",
"name": "Puerto Rico",
"isAllowed": true
},
{
"code": "US-RI",
"name": "Rhode Island",
"isAllowed": true
},
{
"code": "US-SC",
"name": "South Carolina",
"isAllowed": true
},
{
"code": "US-SD",
"name": "South Dakota",
"isAllowed": true
},
{
"code": "US-TN",
"name": "Tennessee",
"isAllowed": true
},
{
"code": "US-TX",
"name": "Texas",
"isAllowed": true
},
{
"code": "US-UT",
"name": "Utah",
"isAllowed": true
},
{
"code": "US-VT",
"name": "Vermont",
"isAllowed": true
},
{
"code": "US-VA",
"name": "Virginia",
"isAllowed": true
},
{
"code": "US-VI",
"name": "Virgin Islands (U.S.)",
"isAllowed": true
},
{
"code": "US-WA",
"name": "Washington",
"isAllowed": true
},
{
"code": "US-WV",
"name": "West Virginia",
"isAllowed": true
},
{
"code": "US-WI",
"name": "Wisconsin",
"isAllowed": true
},
{
"code": "US-WY",
"name": "Wyoming",
"isAllowed": true
}
]
}
]
}