MImiddesk
registrationRequests

Create a registration request

Changed on
post/v1/partner/registration_requests

Request

Request body

state'AL' | 'AK' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'FL' | 'GA' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' required

US state abbreviation (required)

emailstring email required

User email (required)

company_idstring uuid

Existing company ID

company_namestring

Company name for new company

external_idstring

External company identifier

tax_registration_typesRegistrationRequestsRegistrationRequestParamTaxRegistrationTypesItem[]

Tax registration types to request. When omitted, defaults to the types available in the requested state.

jurisdictionsstring[]

Tax jurisdictions

redirect_uristring uri

Success redirect URL

redirect_back_uristring uri

Back redirect URL

Response

registration request created

objectstring required
idstring uuid required
state'AL' | 'AK' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'FL' | 'GA' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' required

US state abbreviation

statusstring required

Request status

tax_registration_typesstring[] nullable required

Types of tax registrations requested

company_idstring uuid required
external_idstring nullable
submitted_atstring nullable
created_atstring required
agenciesobject[] required

Tax agency registrations

itemsobject[] required

Registration items

tax_registrationobject nullable

Tax registration details

invite_linkstring uri required

Changes

  • a32370f9357eRevision changes
    • breaking

      request property / was restricted to a list of enum values

    • info

      added the new state_tax_withholdings enum value to the request property /

    • info

      added the new state_unemployment_insurance enum value to the request property /

  • 4c9cd4e834baRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security bearer_auth was added to the API