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:

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

Request

Path Parameters

partnerAccountId stringrequired
ID of the partner account.
Example: 65a7e8ef0d230d0a6bf755e07d39eb02

Responses

200

application/json

Schema

Schema

regions

object[]

All regions supported by Immersve.

Array [

code string

The region's code.

title string

The region's title.

isAvailable boolean

Whether the region is available to the given partner account.

documents

object

Regulatory documents for available regions, required to be presented during onboarding.

generalTermsOfUse

object

Terms governing the use of the platform.

title string

Document title.

source string

URL to the document.

privacyPolicy

object

Privacy policy.

title string

Document title.

source string

URL to the document.

disclosures

object[]

Legal and financial disclosures mandated by regulators.

Array [

title string

Document title.

source string

URL to the document.

]

marketCompliance

object[]

Documentation ensuring compliance with market-specific regulations.

Array [

title string

Document title.

source string

URL to the document.

]

]

Example (from schema)

{
  "regions": [
    {
      "code": "AU",
      "title": "Australia",
      "isAvailable": 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,
      "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
    }
  ]
}

403

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.

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
reason string

Example (from schema)

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

Loading...