API Reference
- POSTGet Client Token
- GETGet Trades
- POSTCreate Trade
- GETGet Quote
- POSTSend Identity information
- POSTAccept Identity documents
- GETGet Supported Tokens
- GETGet Enabled Tokens
- GETGet Payment Method information
- GETGet Order(s)
- GETGet Bank Account
- GETFetch KYC
- GETGet Customers
- POSTPost Customer Information
- POSTSend Bank Information
- GETGet Geocoverage
- GETGet Fiat Currencies
Get Geocoverage
Get list of regions where Sardine is supported, separated by county and state regions
curl --request GET \
--url https://api.sandbox.sardine.ai/v1/geo-coverage \
--header 'Authorization: Basic <encoded-value>'
{
"data": [
{
"countryCode": "US",
"isAllowedOnRamp": true,
"isAllowedNFT": true,
"isBasicKycRequired": [
"OnRamp",
"OffRamp"
],
"isSsnRequired": [
"OnRamp",
"OffRamp"
],
"name": "United States",
"supportedDocuments": [
"passport",
"drivers_license",
"identity_card"
],
"currencyCode": "USD",
"otpMethod": "sms",
"paymentMethods": [
{
"name": "credit",
"type": "card",
"subType": "credit",
"subTypes": [
"us_credit",
"international_credit"
],
"isAllowedOnRamp": true,
"isAllowedNFT": true
}
],
"states": [
{
"code": "US-CA",
"name": "California",
"isAllowedOnRamp": true,
"isAllowedNFT": true
}
],
"isPayrollSupported": false
}
]
}
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Response
2 letter code representing a country
1
Indicates if Sardine Onramp supports this country
Indicates if Sardine NFT supports this country
KYC requirements are satisfied without needing a document proof
OnRamp
, OffRamp
, NFT
KYC requirements include SSN verification
OnRamp
, OffRamp
, NFT
Full country name
1
Type of documents that are supported
passport
, drivers_license
, identity_card
Currency code for this country
1
OTP method used for this country
sms
, email
Supported payment method name
1
Supported payment method type
card
, bank
Supported payment method subtype
credit
, debit
, ach
Supported payment method subtypes
us_credit
, us_debit
, ach
, international_credit
, international_debit
Indicates if the payment method is support for Sardine Onramp
Indicates if the payment method is support for Sardine NFT
Indicates if this country is support for Sardine Payroll
curl --request GET \
--url https://api.sandbox.sardine.ai/v1/geo-coverage \
--header 'Authorization: Basic <encoded-value>'
{
"data": [
{
"countryCode": "US",
"isAllowedOnRamp": true,
"isAllowedNFT": true,
"isBasicKycRequired": [
"OnRamp",
"OffRamp"
],
"isSsnRequired": [
"OnRamp",
"OffRamp"
],
"name": "United States",
"supportedDocuments": [
"passport",
"drivers_license",
"identity_card"
],
"currencyCode": "USD",
"otpMethod": "sms",
"paymentMethods": [
{
"name": "credit",
"type": "card",
"subType": "credit",
"subTypes": [
"us_credit",
"international_credit"
],
"isAllowedOnRamp": true,
"isAllowedNFT": true
}
],
"states": [
{
"code": "US-CA",
"name": "California",
"isAllowedOnRamp": true,
"isAllowedNFT": true
}
],
"isPayrollSupported": false
}
]
}