List supported countries - MoonPay Developer Docs

List supported countries

curl --request GET \
  --url 'https://api.moonpay.com/v3/countries?apiKey='

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.moonpay.com/v3/countries?apiKey=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.moonpay.com/v3/countries?apiKey="

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.moonpay.com/v3/countries?apiKey=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

[
  {
    "alpha2": "GB",
    "alpha3": "GBR",
    "isAllowed": true,
    "isBuyAllowed": true,
    "isSellAllowed": true,
    "name": "United Kingdom",
    "supportedDocuments": [
      "additional_proof_of_income",
      "driving_licence",
      "national_identity_card",
      "passport",
      "proof_of_address",
      "proof_of_income",
      "residence_permit",
      "selfie"
    ]
  }
]

{
  "moonPayErrorCode": "4_SYS_BAD_REQUEST",
  "message": "<string>",
  "type": "<string>",
  "errors": [
    {
      "property": "<string>",
      "message": "<string>",
      "children": [
        {}
      ]
    }
  ]
}

GET

/

v3

/

countries

List supported countries

curl --request GET \
  --url 'https://api.moonpay.com/v3/countries?apiKey='

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.moonpay.com/v3/countries?apiKey=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.moonpay.com/v3/countries?apiKey="

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.moonpay.com/v3/countries?apiKey=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

[
  {
    "alpha2": "GB",
    "alpha3": "GBR",
    "isAllowed": true,
    "isBuyAllowed": true,
    "isSellAllowed": true,
    "name": "United Kingdom",
    "supportedDocuments": [
      "additional_proof_of_income",
      "driving_licence",
      "national_identity_card",
      "passport",
      "proof_of_address",
      "proof_of_income",
      "residence_permit",
      "selfie"
    ]
  }
]

{
  "moonPayErrorCode": "4_SYS_BAD_REQUEST",
  "message": "<string>",
  "type": "<string>",
  "errors": [
    {
      "property": "<string>",
      "message": "<string>",
      "children": [
        {}
      ]
    }
  ]
}

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.

Response

Successful response. List of Countries

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"

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

name

string

The country's name.

Example:

"United Kingdom"

supportedDocuments

enum<string>[]

A list of supported identity documents for the country.

Possible values are: additional_proof_of_income, driving_licence, national_identity_card, passport, proof_of_address, proof_of_income, residence_permit, selfie

Available options:

additional_proof_of_income,

driving_licence,

national_identity_card,

passport,

proof_of_address,

proof_of_income,

residence_permit,

selfie

Example:

[
  "additional_proof_of_income",
  "driving_licence",
  "national_identity_card",
  "passport",
  "proof_of_address",
  "proof_of_income",
  "residence_permit",
  "selfie"
]