Get NRS Countries

Retrieve available countries for a specific business.

Quick Reference

Method	Endpoint	Authentication Required
`GET`	`{{baseUrl}}/{{stage}}/external/{businessId}/resources/countries`	Yes

Request Structure

Path Parameters

Parameter	Type	Required	Description	Example
`businessId`	string	✅	Unique identifier of the business	`26ede24b-ac50-475f-aacc-5ea6339f0863`

Headers

Header	Value	Required
`Content-Type`	`application/json` or `/`	Yes
`Accept`	`application/json` or `/`	Yes
`X-Business-Key`	`businessKey`	Yes

Response Format

Success Response (200)

{
  "responseCode": "00",
  "responseMessage": "Country resources retrieved successfully",
  "data": [
    {
      "alpha_2": "NG",
      "alpha_3": "NGA",
      "country_code": "566",
      "intermediate_region": "",
      "intermediate_region_code": "",
      "iso_3166_2": "ISO 3166-2:NG",
      "name": "Nigeria",
      "region": "Africa",
      "region_code": "002",
      "sub_region": "Western Africa",
      "sub_region_code": "011"
    },
    {
      "alpha_2": "US",
      "alpha_3": "USA",
      "country_code": "840",
      "intermediate_region": "",
      "intermediate_region_code": "",
      "iso_3166_2": "ISO 3166-2:US",
      "name": "United States of America",
      "region": "Americas",
      "region_code": "019",
      "sub_region": "Northern America",
      "sub_region_code": "021"
    }
  ]
}

Response Data Structure

Country Object

Field	Type	Description
`alpha_2`	string	ISO 3166-1 alpha-2 country code
`alpha_3`	number	ISO 3166-1 alpha-3 country code
`country_code`	string	ISO 3166-1 numeric country code
`intermediate_region`	string	Intermediate region label; empty if not applicable
`intermediate_region_code`	number	Intermediate region numeric code; empty if not applicable
`iso_3166_2`	string	ISO 3166-2 subdivision code prefix
`name`	string	Official country name
`region`	string	Continent or major world region
`region_code`	string	Numeric code for the region
`sub_region`	string	Sub-region classification
`sub_region_code`	string	Numeric sub-region code

Error Responses

Error Code	Message	Description
`404`	Business not found	Business ID doesn't exist
`403`	Access denied	User doesn't have permission
`400`	Invalid business ID	Business ID format is invalid

Example Error Response

{
  "responseCode": "404",
  "responseMessage": "Business not found with ID: invalid-business-id",
  "data": null
}

POST /invoices - Create invoice (uses currency data)

GET /businesses/{businessId}/settings - Get business configuration

This endpoint provides currency information for businesses to use in invoices and financial documents.

{ "responseCode": "00", "responseMessage": "Completed successfully", "data": [ { "alpha2": "AF", "alpha3": "AFG", "countryCode": "004", "intermediateRegion": "", "intermediateRegionCode": "", "iso31662": "ISO 3166-2:AF", "name": "Afghanistan", "region": "Asia", "regionCode": "142", "subRegion": "Southern Asia", "subRegionCode": "034" }, { "alpha2": "AX", "alpha3": "ALA", "countryCode": "248", "intermediateRegion": "", "intermediateRegionCode": "", "iso31662": "ISO 3166-2:AX", "name": "Åland Islands", "region": "Europe", "regionCode": "150", "subRegion": "Northern Europe", "subRegionCode": "154" }, { "alpha2": "AL", "alpha3": "ALB", "countryCode": "008", "intermediateRegion": "", "intermediateRegionCode": "", "iso31662": "ISO 3166-2:AL", "name": "Albania", "region": "Europe", "regionCode": "150", "subRegion": "Southern Europe", "subRegionCode": "039" }, { "alpha2": "DZ", "alpha3": "DZA", "countryCode": "012", "intermediateRegion": "", "intermediateRegionCode": "", "iso31662": "ISO 3166-2:DZ", "name": "Algeria", "region": "Africa", "regionCode": "002", "subRegion": "Northern Africa", "subRegionCode": "015" }, { "alpha2": "AS", "alpha3": "ASM", "countryCode": "016", "intermediateRegion": "", "intermediateRegionCode": "", "iso31662": "ISO 3166-2:AS", "name": "American Samoa", "region": "Oceania", "regionCode": "009", "subRegion": "Polynesia", "subRegionCode": "061" }, { "alpha2": "AD", "alpha3": "AND", "countryCode": "020", "intermediateRegion": "", "intermediateRegionCode": "", "iso31662": "ISO 3166-2:AD", "name": "Andorra", "region": "Europe", "regionCode": "150", "subRegion": "Southern Europe", "subRegionCode": "039" }, { "alpha2": "AO", "alpha3": "AGO", "countryCode": "024", "intermediateRegion": "Middle Africa", "intermediateRegionCode": "017", "iso31662": "ISO 3166-2:AO", "name": "Angola", "region": "Africa", "regionCode": "002", "subRegion": "Sub-Saharan Africa", "subRegionCode": "202" }, { "alpha2": "AI", "alpha3": "AIA", "countryCode": "660", "intermediateRegion": "Caribbean", "intermediateRegionCode": "029", "iso31662": "ISO 3166-2:AI", "name": "Anguilla", "region": "Americas", "regionCode": "019", "subRegion": "Latin America and the Caribbean", "subRegionCode": "419" }, { "alpha2": "AQ", "alpha3": "ATA", "countryCode": "010", "intermediateRegion": "", "intermediateRegionCode": "", "iso31662": "ISO 3166-2:AQ", "name": "Antarctica", "region": "", "regionCode": "", "subRegion": "", "subRegionCode": "" }, { "alpha2": "AG", "alpha3": "ATG", "countryCode": "028", "intermediateRegion": "Caribbean", "intermediateRegionCode": "029", "iso31662": "ISO 3166-2:AG", "name": "Antigua and Barbuda", "region": "Americas", "regionCode": "019", "subRegion": "Latin America and the Caribbean", "subRegionCode": "419" }, { "alpha2": "AR", "alpha3": "ARG", "countryCode": "032", "intermediateRegion": "South America", "intermediateRegionCode": "005", "iso31662": "ISO 3166-2:AR", "name": "Argentina", "region": "Americas", "regionCode": "019", "subRegion": "Latin America and the Caribbean", "subRegionCode": "419" }, { "alpha2": "AM", "alpha3": "ARM", "countryCode": "051", "intermediateRegion": "", "intermediateRegionCode": "", "iso31662": "ISO 3166-2:AM", "name": "Armenia", "region": "Asia", "regionCode": "

Get NRS Countries

Quick Reference#

Request Structure#

Path Parameters#

Headers#

Response Format#

Success Response (200)#

Response Data Structure#

Country Object#

Error Responses#

Example Error Response#

Related Endpoints#

Request

Responses