Update registration
The Update Registration API allows you to modify an existing registration using its unique registration_id.
Authorization
Your secret API key. Include it with every request.
Path parameters
The unique identifier of the registration to be updated.
Body
The date when the registration was created. Format: YYYY-MM-DD.
Email address associated with the registration.
Timestamp when the registration was requested.
Timestamp when the registration was completed.
Timestamp when deregistration was requested.
Timestamp when the deregistration was completed.
Indicates whether the registration was completed automatically.
The tax registration regime (e.g., STANDARD, SIMPLIFIED).
STANDARDSIMPLIFIEDREQUESTEDAPPROVEDDONEACKNOWLEDGEDIndicates whether third-party access is enabled for this registration.
If true, do not file for this registration (treated as False by default).
Indicates whether two-factor authentication (2FA) is enabled for this registration.
Indicates whether the registration is marked as collecting in shopify
The encrypted username for the registration.
The username associated with the registration.
The updated filing frequency (MONTHLY, QUARTERLY, etc.).
UNKNOWNMONTHLYQUARTERLYSEMI_ANNUALLYANNUALLYANNUAL_FISCAL_YEARSEMI_MONTHLYBI_MONTHLYFOUR_MONTHLYQUARTERLY_PREPAYMENTThe updated date from which filings should start (YYYY-MM-DD).
Indicates whether the registration is approaching an action (e.g., renewal).
Additional notes or comments related to the registration.
Indicates if the Voluntary Disclosure Agreement (VDA) applies.
Organization-level tax ID (e.g., VAT number, Canada Business Number).
The Importer of Record (IOR) number for the registration.
Whether to also file the single period preceding the first filing period.
Response
The date when the registration was created. Format: YYYY-MM-DD.
Email address associated with the registration.
Timestamp when the registration was requested.
Timestamp when the registration was completed.
Timestamp when deregistration was requested.
Timestamp when the deregistration was completed.
Indicates whether the registration was completed automatically.
The tax registration regime (e.g., STANDARD, SIMPLIFIED).
STANDARDSIMPLIFIEDREQUESTEDAPPROVEDDONEACKNOWLEDGEDIndicates whether third-party access is enabled for this registration.
If true, do not file for this registration (treated as False by default).
Indicates whether two-factor authentication (2FA) is enabled for this registration.
Indicates whether the registration is marked as collecting in shopify
The current status of the registration. Possible values: REGISTERED, PROCESSING, UNREGISTERED, DEREGISTERING, DEREGISTERED, CANCELLED, VALIDATING, AWAITING_CLARIFICATION, SELF_MANAGED.
REGISTEREDPROCESSINGUNREGISTEREDDEREGISTERINGDEREGISTEREDCANCELLEDVALIDATINGAWAITING_CLARIFICATIONSELF_MANAGEDThe country code (ISO 3166-1 alpha-2 format) where the registration applies.
AFAXALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCGCDCKCRHRCUCWCYCZDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITCIJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMKMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUSUMUYUZVUVEVNVGVIWFEHYEZMZWXKZZ_EUThe state/province code where the registration applies.
The name of the state/province.
Specifies how often tax filings should be made. Possible values: MONTHLY, QUARTERLY, ANNUALLY, UNKNOWN.
UNKNOWNMONTHLYQUARTERLYSEMI_ANNUALLYANNUALLYANNUAL_FISCAL_YEARSEMI_MONTHLYBI_MONTHLYFOUR_MONTHLYQUARTERLY_PREPAYMENTThe first non-UNKNOWN filing frequency this registration was ever assigned.
UNKNOWNMONTHLYQUARTERLYSEMI_ANNUALLYANNUALLYANNUAL_FISCAL_YEARSEMI_MONTHLYBI_MONTHLYFOUR_MONTHLYQUARTERLY_PREPAYMENTThe filing frequency that will automatically replace
filing_frequency on filing_frequency_effective_date. Null when no
frequency change is pending.
UNKNOWNMONTHLYQUARTERLYSEMI_ANNUALLYANNUALLYANNUAL_FISCAL_YEARSEMI_MONTHLYBI_MONTHLYFOUR_MONTHLYQUARTERLY_PREPAYMENTThe date on which scheduled_filing_frequency should
automatically become the registration's filing_frequency. Null when
no frequency change is pending.
Month (1-12) on which this registration's filing period ends, for fiscal-year filers whose quarterly/semiannual periods are offset from the calendar. Null means calendar-aligned periods.
Username for accessing tax registration details.
Additional comments related to the registration.
The date from which filings should be created. should start (YYYY-MM-DD).
Whether to also file the single period preceding the first filing period.
Whether this registration is declared obligated to file a Retail Delivery Fee return (e.g. Colorado DR 1786).
First date from which retail delivery fee filings may be generated. Periods that closed before this date must not get those filings.
Indicates whether an initial synchronization should be performed.
The amount of fees associated with the registration.
Indicates whether a Voluntary Disclosure Agreement (VDA) applies.
Whether the registration was imported from another system.
Account number for this registration. Holds the sales tax ID on a sales or combined permit, and the consumer use tax account number on a use tax registration.
The Importer of Record (IOR) number associated with the registration.
The date the Importer of Record (IOR) became effective (YYYY-MM-DD). For jurisdictions where tax collection starts after the IOR date rather than the registration date, this is the date on/after which tax is collected.
Indicates whether the registration is an SST Import.
The type of OSS registration. Should be filled for ZZ_EU OSS registrations.
UNIONNON_UNIONIOSSThe Member State of Identification code for OSS registrations.
AFAXALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCGCDCKCRHRCUCWCYCZDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITCIJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMKMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUSUMUYUZVUVEVNVGVIWFEHYEZMZWXKZZ_EUWhich taxes this registration account covers. SALES_AND_USE_TAX is one real permit covering both; it does not imply sales activity or that sales tax should be calculated.
SALES_TAXUSE_TAXSALES_AND_USE_TAXThe date when the registration was marked as collecting.
Indicates whether the registration needs to be marked as collecting.
The unique identifier for the registration.
Timestamp when this registration was created in Kintsugi.
The category of the registration. Possible values: REGULAR, IMPORTED, DEREGISTRATION.
REGULARIMPORTEDDEREGISTRATIONJurisdiction-specific registration fields.
EU_OSSOTHERState tax portal URL for this registration's jurisdiction.
Successfully retrieved registration by id
Unauthenticated request.
Resource Not Found
Validation error
Internal server error