Get Geocoverage

GET

geo-coverage

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

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Response

200 - application/json

data

object[]

data.countryCode

string

2 letter code representing a country

Minimum length: 1

Example:

"US"

data.isAllowedOnRamp

boolean

Indicates if Sardine Onramp supports this country

Example:

true

data.isAllowedNFT

boolean

Indicates if Sardine NFT supports this country

Example:

true

data.isBasicKycRequired

enum<string>[]

KYC requirements are satisfied without needing a document proof

Available options:

OnRamp,

OffRamp,

NFT

Example:

["OnRamp", "OffRamp"]

data.isSsnRequired

enum<string>[]

KYC requirements include SSN verification

Available options:

OnRamp,

OffRamp,

NFT

Example:

["OnRamp", "OffRamp"]

data.name

string

Full country name

Minimum length: 1

Example:

"United States"

data.supportedDocuments

enum<string>[]

Type of documents that are supported

Available options:

passport,

drivers_license,

identity_card

Example:

[
  "passport",
  "drivers_license",
  "identity_card"
]

data.currencyCode

string

Currency code for this country

Minimum length: 1

Example:

"USD"

data.otpMethod

enum<string>

OTP method used for this country

Available options:

sms,

email

Example:

"sms"

data.paymentMethods

object[]

data.paymentMethods.name

string

Supported payment method name

Minimum length: 1

Example:

"credit"

data.paymentMethods.type

enum<string>

Supported payment method type

Available options:

card,

bank

Example:

"card"

data.paymentMethods.subType

enum<string>

Supported payment method subtype

Available options:

credit,

debit,

ach

Example:

"credit"

data.paymentMethods.subTypes

enum<string>

Supported payment method subtypes

Available options:

us_credit,

us_debit,

ach,

international_credit,

international_debit

Example:

["us_credit", "international_credit"]

data.paymentMethods.isAllowedOnRamp

boolean

Indicates if the payment method is support for Sardine Onramp

Example:

true

data.paymentMethods.isAllowedNFT

boolean

Indicates if the payment method is support for Sardine NFT

Example:

true

data.states

object[]

data.isPayrollSupported

boolean

Indicates if this country is support for Sardine Payroll

Example:

false

Send Bank Information Get Fiat Currencies

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
    }
  ]
}

API Reference

Payment Method

Authorizations

Response