Get Supported Regions

get/api/accounts/{partnerAccountId}/supported-regions

Get a complete list of regions that are supported by the partner to issue cards. The response will include the following information about a region:

The region name.
The region's code for use with our APIs.
The region's availability for the partner to issue cards.
Any legal documents for the region.

Request

Path Parameters

partnerAccountIdstringrequired
ID of the partner account.

Response

Successful operation.

Body application/json

regionsobject[]
All regions supported by Immersve.
Items
- codestring
  The region's code.
- titlestring
  The region's title.
- isAvailableboolean
  Whether the region is available to the given partner account.
- unstructuredAddressAllowedbooleandefault: false
  Whether unstructured addresses are accepted for partner conducted statements.
- documentsobject
  Regulatory documents for available regions, required to be presented during onboarding.
  generalTermsOfUseobject
  Terms governing the use of the platform.
  titlestring
  Document title.
  sourcestring
  URL to the document.
  privacyPolicyobject
  Privacy policy.
  titlestring
  Document title.
  sourcestring
  URL to the document.
  disclosuresobject[]
  Legal and financial disclosures mandated by regulators.
  Items
  titlestring
  Document title.
  sourcestring
  URL to the document.
  marketComplianceobject[]
  Documentation ensuring compliance with market-specific regulations.
  Items
  titlestring
  Document title.
  sourcestring
  URL to the document.

Subject is not allowed to perform the action with the reason stated in the errorCode.

FORBIDDEN There are no sufficient permissions to view supported regions for this account.

CARD_PROGRAMS_NOT_CONFIGURED Partner account has no card programs configured.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
reasonstring

Example

Example Request

ServerAuthentication

curl 'https://api.immersve.com/api/accounts/{partnerAccountId}/supported-regions' \
  --header 'Authorization: Bearer <access-token>'

curl 'https://api.immersve.com/api/accounts/{partnerAccountId}/supported-regions' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>'

curl 'https://test.immersve.com/api/accounts/{partnerAccountId}/supported-regions' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>'

Example Response

{
  "regions": [
    {
      "code": "AU",
      "title": "Australia",
      "isAvailable": true,
      "unstructuredAddressAllowed": true,
      "documents": {
        "generalTermsOfUse": {
          "title": "General Terms of Use",
          "source": "https://immersve.com/terms-and-conditions/au/general-terms-of-use"
        },
        "privacyPolicy": {
          "title": "Privacy Policy",
          "source": "https://immersve.com/terms-and-conditions/au/privacy-policy"
        },
        "disclosures": [
          {
            "title": "Product Disclosure Statement",
            "source": "https://example.com/disclosures/immersve/pds-au_v001.0_en.pdf"
          }
        ],
        "marketCompliance": []
      }
    },
    {
      "code": "NZ",
      "title": "New Zealand",
      "isAvailable": true,
      "unstructuredAddressAllowed": true,
      "documents": {
        "generalTermsOfUse": {
          "title": "General Terms of Use",
          "source": "https://immersve.com/terms-and-conditions/nz/general-terms-of-use"
        },
        "privacyPolicy": {
          "title": "Privacy Policy",
          "source": "https://immersve.com/terms-and-conditions/nz/privacy-policy"
        },
        "disclosures": [],
        "marketCompliance": []
      }
    },
    {
      "code": "CA",
      "title": "Canada",
      "isAvailable": false
    }
  ]
}

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}