API reference / Get jurisdiction specific fields
Get jurisdiction specific fields
GET/v1/registrations/jurisdiction-specific-fields
Returns the JSON Schema and UI metadata for a state-specific registration form
Authorization
x-api-keystringRequired
Your secret API key. Include it with every request.
Query
Every query parameter below is optional. Combine as many as you need and append them to the endpoint as a query string. The example shows a few to get you started.
/v1/registrations/jurisdiction-specific-fields?country_code=<country_code>&state_code=<state_code>country_codestringRequired
ISO 3166-1 alpha-2 country code (e.g., US).
state_codestringRequired
State/province code (e.g., AL, LA).
Response
country_codestringRequired
state_codestringRequired
default_formbooleanRequired
True when no state-specific schema exists and the generic form should be used.
jurisdiction_fields_json_schemaobjectRequired
JSON Schema for the jurisdiction-specific fields, or empty dict when default_form is True.
metadataobjectRequired
UI metadata (help articles, portal URL, filing frequencies, etc.).
200
Successful Response
Validation Error
cURL
GET /v1/registrations/jurisdiction-specific-fields?country_code={country_code}&state_code={state_code}
-H "x-api-key: ***"
Example request
https://api.trykintsugi.com/v1/registrations/jurisdiction-specific-fields?country_code={country_code}&state_code={state_code}
Response
{
"country_code": "string",
"state_code": "string",
"default_form": true,
"jurisdiction_fields_json_schema": null,
"metadata": null
}