MImiddesk
questions

List questions

Changed on

Retrieve the set of dynamic questions required for a registration in a given state or local jurisdiction. The questions returned depend on the jurisdiction and registration type.

get/v1/agent/questions

Request

Query parameters

statestring

Two-letter US state abbreviation (e.g., CA, NY). Required when jurisdiction_slugs is not provided and states is not used.

states[]string

Array of two-letter US state abbreviations. Used when fetching questions for multiple states.

jurisdiction_slugs[]string

Array of local jurisdiction slug identifiers. Used to fetch questions specific to local jurisdictions. Must be provided together with the state parameter.

categories[]'state_tax_withholdings' | 'state_unemployment_insurance' | 'foreign_qualification' | 'annual_filing'

Filter questions by registration type. Only applicable to state-level questions; omit for local jurisdiction questions.

Response

questions list

Changes

  • 4c9cd4e834baRevision changes
    • breaking

      added subschema #1 subschema #2 subschema #3 to the response property oneOf list for the response status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security bearer_auth was added to the API

    • info

      removed subschema #1 subschema #2 subschema #3 from the response property oneOf list for the response status

  • 668373c892ceRevision changes
    • info

      api operation id listQuestions removed and replaced with questions_listQuestions