> ## Documentation Index
> Fetch the complete documentation index at: https://readme.amana-dev.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List countries

> List the countries available for residence and nationality during sign-up.

## Response

`200` Success.

<ResponseField name="response" type="object[]">
  <Expandable title="properties">
    <ResponseField name="country_id" type="number" />

    <ResponseField name="name" type="string" />

    <ResponseField name="show_on_residency" type="boolean" />

    <ResponseField name="show_on_nationality" type="boolean" />

    <ResponseField name="show_on_phone" type="boolean" />

    <ResponseField name="code2" type="string" />

    <ResponseField name="code3" type="string" />
  </Expandable>
</ResponseField>

## Possible Errors

| Error | Possible cause | What to do |
| - | - | - |
| 403 | IP not whitelisted, or account restricted | Confirm your IP is whitelisted; otherwise contact Amana. |
| 429 / 5xx | Rate limit, or temporary issue on our side | Retry with backoff; contact support if it persists. |

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://gateway.amana.io/onboarding/countries'
  ```

  ```python Python theme={null}
  import requests

  url = "https://gateway.amana.io/onboarding/countries"
  headers = {}

  response = requests.request("GET", url, headers=headers)
  print(response.json())
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('https://gateway.amana.io/onboarding/countries', {
    method: 'GET',
    headers: {},
  });
  console.log(await response.json());
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  [
    {
      "country_id": 123.45,
      "name": "<string>",
      "show_on_residency": true,
      "show_on_nationality": true,
      "show_on_phone": true,
      "code2": "<string>",
      "code3": "<string>"
    }
  ]
  ```

  ```json 403 theme={null}
  {
    "error": "<string>",
    "message": "<string>"
  }
  ```

  ```json 429 theme={null}
  {
    "error": "<string>",
    "message": "<string>"
  }
  ```

  ```json 500 theme={null}
  {
    "error": "<string>",
    "message": "<string>"
  }
  ```
</ResponseExample>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.