Skip to main content
GET
/
nexus
Get registration threshold exposure
curl --request GET \
  --url https://api.prod.commenda.io/api/v1/nexus \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "corporation_id": "b6d009b0-d174-463f-b030-94643c28e209",
    "states": [
      {
        "state": "CA",
        "rule": {
          "threshold_type": "SALES_OR_TRANSACTIONS",
          "sales_threshold": 100000,
          "transactions_threshold": 200
        },
        "calculation": {
          "total_sales": 0,
          "total_transactions": 0,
          "sales_exposure_percentage": 0,
          "transactions_exposure_percentage": 0,
          "gross_sales": 0,
          "gross_transactions": 0,
          "taxable_sales": 0,
          "taxable_transactions": 0,
          "retail_sales": 0,
          "retail_transactions": 0,
          "includable_sales_type": "GROSS"
        },
        "is_nexus_breached": true,
        "date_of_breach": "2023-12-25"
      }
    ]
  },
  "message": "Successfully fetched nexus."
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
corporation_id
string
required

The unique identifier for the corporation to retrieve registration threshold data for.

​
v2
enum<string>

Set to true to use the global registration threshold engine. When enabled, the response uses a jurisdictions array with expanded fields including jurisdiction_id, exposure_type, exposure_rule_id, subdivision, and currency. When omitted or false, the legacy response format with a states array is returned.

Available options:
true,
false

Response

Registration threshold exposure data

Returned when v2 is not set or false.

​
data
object

Default response when v2 is not set or false. Returns US-state-level registration threshold data.

​
message
string
Example:

"Successfully fetched nexus."