TRtrykintsugi
Registrations

Get jurisdiction specific fields

Changed on

Returns the JSON Schema and UI metadata for a state-specific registration form, and the tax types that can be imported there.

get/v1/registrations/jurisdiction-specific-fields

Request

  • Base URL
    https://api.trykintsugi.com
  • URL
    https://api.trykintsugi.com/v1/registrations/jurisdiction-specific-fields
  • Auth
    API key in header X-API-KEY

Query parameters

country_codestring required

ISO 3166-1 alpha-2 country code (e.g., US).

state_codestring required

State/province code (e.g., AL, LA).

Headers

x-organization-idstring nullable required

The unique identifier for the organization making the request

Response

Successful Response

country_codestring required
state_codestring required
default_formboolean required

True when no state-specific schema exists and the generic form should be used.

jurisdiction_fields_json_schemaobject required

JSON Schema for the jurisdiction-specific fields, or empty dict when default_form is True.

metadataobject required

UI metadata (help articles, portal URL, filing frequencies, etc.).

tax_typesTaxTypeEnum[] required

Tax types that can be imported for this jurisdiction.

Changes