Use the Certificate Center API to retrieve a jurisdiction hierarchy.

Base URL:

https://ccservices.vertexsmb.com/certificate-center/v1/

Jurisdiction hierarchy endpoint	Jurisdiction hierarchy description
`/jurisdictions`	GET - Retrieve a jurisdiction hierarchy. We recommend filtering by certificate reason to retrieve only relevant jurisdictions.

Retrieve a jurisdiction hierarchy

Retrieve jurisdiction hierarchy records based on your choice of filter criteria.

Request

All request parameters are optional. Passing a request with no parameters returns all records.

Retrieve a jurisdiction hierarchy request parameter name	Retrieve a jurisdiction hierarchy request parameter format	Retrieve a jurisdiction hierarchy request parameter description
`reasonType`	string enum	The reason for the certificate. Reasons can be Vertex-defined or user-defined. Possible values include Agricultural, Charitable, Contractor, Direct Mail, Direct Pay Permit, Educational, Federal Government, Foreign Diplomat, Manufacturing, Native American, Packaging, Religious, Resale, State or Local or Provincial Government, Other.
`asOfDate`	date	The date to filter results having an effectivity range (GMT). If not specified, the default value is the current date.

Example request

curl --request GET \
     --url https://vertex-enterprise-group.readme.io/certificate-center/v1/jurisdictions \
     --header 'accept: application/json'

Response

A response includes any number of jurisdictions. Each jurisdiction includes these fields.

Retrieve a jurisdiction hierarchy response field	Retrieve a jurisdiction hierarchy response description
`id`	The jurisdiction ID.
`parentId`	The parent ID, if any, for this jurisdiction.
`name`	Jurisdiction name.
`abbreviation`	Abbreviation for this jurisdiction.
`jurisdictionType`	Jurisdiction type, such as country, state, or province.
`children`	An array of child objects under this jurisdiction.

Example response

[
    {
        "id": 1,
        "parentId": null,
        "name": "United States",
        "abbreviation": "USA",
        "jurisdictionType": "Country",
        "children": [
            {
                "id": 11,
                "parentId": 1,
                "name": "Alabama",
                "abbreviation": "AL",
                "jurisdictionType": "State",
                "children": []
            },
            {
                "id": 912,
                "parentId": 1,
                "name": "Alaska",
                "abbreviation": "AK",
                "jurisdictionType": "State",
                "children": []
            },
            {
                "id": 1112,
                "parentId": 1,
                "name": "Arizona",
                "abbreviation": "AZ",
                "jurisdictionType": "State",
                "children": []
            },
            {
                "id": 1485,
                "parentId": 1,
                "name": "Arkansas",
                "abbreviation": "AR",
                "jurisdictionType": "State",
                "children": []
            }
        ]
    },
    {
        "id": 8,
        "parentId": null,
        "name": "Canada",
        "abbreviation": "CAN",
        "jurisdictionType": "Country",
        "children": [
            {
                "id": 43423,
                "parentId": 8,
                "name": "Alberta",
                "abbreviation": "AB",
                "jurisdictionType": "Province",
                "children": []
            },
            {
                "id": 43604,
                "parentId": 8,
                "name": "British Columbia",
                "abbreviation": "BC",
                "jurisdictionType": "Province",
                "children": []
            }
        ]
    }
]