{"_id":"592835dfbc8bca0f000cca03","user":"563cc6fa8894d20d00014ea3","category":{"_id":"592835c7bc8bca0f000cc9ff","project":"563cc7119799fb0d00047685","__v":0,"version":"563cc7119799fb0d00047688","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-05-26T14:03:51.946Z","from_sync":false,"order":3,"slug":"countries","title":"Countries"},"version":{"_id":"563cc7119799fb0d00047688","__v":18,"project":"563cc7119799fb0d00047685","createdAt":"2015-11-06T15:28:17.683Z","releaseDate":"2015-11-06T15:28:17.683Z","categories":["563cc7129799fb0d00047689","566f37f37ffa002300c3cd5b","56914e9bd47b020d002225ac","5692b19ffe72e00d00e4f0a8","56940bc2d8c04d1700e5adb6","56940bc83e9d080d00f064f0","56951b2dfcb1032d0089df7a","569522aecaa32519009c410c","569523ce562335190016da97","569523fddcaf0d1700cb86bf","56980e4a8560a60d00e2c3c3","569921a41693520d002e1305","5699323b7465970d00650b82","569e6cc4fbee990d0072d927","56a2768a0aefae0d00b7fe66","5862e862b8b7fa23009665b7","592835c7bc8bca0f000cc9ff","596f693df43cca002e690e1c"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Model T","version_clean":"1.0.0","version":"1"},"__v":1,"project":"563cc7119799fb0d00047685","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-05-26T14:04:15.478Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"code":"GET /v1/countries HTTP/1.1\nHost: api.drivewealth.io\nAccept: application/json\nContent-Type: application/json","language":"curl"}]},"method":"get","results":{"codes":[{"name":"","code":"[\n  {\n    \"countryID\": \"ALA\",\n    \"countryName\": \"Aland Islands\",\n    \"code2\": \"AX\",\n    \"active\": true\n  },\n  {\n    \"countryID\": \"ALB\",\n    \"countryName\": \"Albania\",\n    \"code2\": \"AL\",\n    \"active\": true\n  },\n  {\n    \"countryID\": \"DZA\",\n    \"countryName\": \"Algeria\",\n    \"code2\": \"DZ\",\n    \"active\": true\n  },\n  {\n    \"countryID\": \"ASM\",\n    \"countryName\": \"American Samoa\",\n    \"code2\": \"AS\",\n    \"active\": true\n  },\n  {\n    \"countryID\": \"AND\",\n    \"countryName\": \"Andorra\",\n    \"code2\": \"AD\",\n    \"active\": true\n  },\n  {\n    \"countryID\": \"AGO\",\n    \"countryName\": \"Angola\",\n    \"code2\": \"ag\",\n    \"active\": true\n  },{\n    ...\n  }\n]","language":"json","status":200},{"language":"json","status":400,"name":"","code":"{\n    \"code\": 400,\n    \"message\": \"Invalid status.\"\n}"}]},"auth":"required","params":[{"_id":"592836cbbc8bca0f000cca0c","ref":"","in":"query","required":false,"desc":"Status of country. Options:<br />• `\"active\"` - Only active countries<br />• `\"inactive\"` - Only inactive countries<br />• `\"all\"` - Show all countries, regardless of status","default":"","type":"string","name":"status"}],"url":"/countries"},"isReference":false,"order":0,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Opening Accounts For Active Countries Only\",\n  \"body\": \"We can only accept clients from countries that are active (`\\\"active\\\"` set to `true`). We recommend calling this API during your customer on-boarding process so your country list can always be up to date.\"\n}\n[/block]","excerpt":"","slug":"list-all-countries","type":"endpoint","title":"List All Countries"}

getList All Countries


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

status:
string
Status of country. Options:<br />• `"active"` - Only active countries<br />• `"inactive"` - Only inactive countries<br />• `"all"` - Show all countries, regardless of status

Examples


Result Format


Documentation

[block:callout] { "type": "warning", "title": "Opening Accounts For Active Countries Only", "body": "We can only accept clients from countries that are active (`\"active\"` set to `true`). We recommend calling this API during your customer on-boarding process so your country list can always be up to date." } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}