KintsugiKintsugi

Update a registration

PATCH/registrations/{registration_id}

Update a registration. This is a partial update: a property you leave out is unchanged, and one you send as null is cleared.

Returns 404 if the registration does not exist or belongs to an organization your credential cannot access, so the API never confirms an id exists. The jurisdiction, the lifecycle status and the sign-in credentials are not editable here: a registration cannot be moved to another jurisdiction, and the other two are separate operations.

Authorization

Api-KeystringRequired

Your secret API key. Include it with every request.

Headers

Api-Versiondate

Release date, as YYYY-MM-DD. Defaults to 2026-07-21.

Organization-Idstring

Target organization id (Organization-Id selector).

Connection-Idstring

Target connection id; resolves to its organization.

Entity-Idstring

Platform entity id; resolves to a connection's organization.

Entity-Sourcestring

Optional source to disambiguate an Entity-Id.

Path parameters

registration_idstringRequired

The unique identifier of the registration.

Body

filingFrequencyPublicFilingFrequencyEnum

How often returns should be filed. Omit to leave unchanged; send a value to replace.

Available options:UNKNOWNMONTHLYQUARTERLYSEMI_ANNUALLYANNUALLYANNUAL_FISCAL_YEARSEMI_MONTHLYBI_MONTHLYFOUR_MONTHLYQUARTERLY_PREPAYMENT
registrationDatestring

Date the registration takes effect in the jurisdiction, as YYYY-MM-DD. Omit to leave unchanged; send null to clear.

registrationEmailstring

Email address the jurisdiction has on file. Omit to leave unchanged; send an empty string or null to clear it.

createFilingsFromstring

First period to generate filings for, as YYYY-MM-DD. Omit to leave unchanged; send null to clear.

registrationRequestedstring

When the registration was submitted to the jurisdiction. Omit to leave unchanged; send null to clear.

registrationCompletedstring

When the jurisdiction confirmed the registration. Omit to leave unchanged; send null to clear.

deregistrationRequestedstring

When deregistration was submitted to the jurisdiction. Omit to leave unchanged; send null to clear.

deregistrationCompletedstring

When the jurisdiction confirmed the deregistration. Omit to leave unchanged; send null to clear.

autoRegisteredboolean

Whether the registration was completed without manual intervention. Omit to leave unchanged; send true or false to replace.

doNotFileboolean

Whether returns are suppressed for this registration. When true, Kintsugi tracks it but does not file against it. Omit to leave unchanged; send true or false to replace.

isPreCollectingboolean

Whether this PROCESSING registration is pre-collecting. Send false to hand the jurisdiction to Kintsugi's Tax Ops team for a normal registration. Omit to leave unchanged.

registrationsRegimePublicRegistrationsRegimeEnum

Filing regime the registration is held under. Omit to leave unchanged; send a value to replace.

Available options:STANDARDSIMPLIFIED
changeRegimeStatusPublicChangeRegimeStatusEnum

Progress of a request to move this registration to a different filing regime. Omit to leave unchanged; send a value to replace.

Available options:REQUESTEDAPPROVEDDONEACKNOWLEDGED
commentstring

Free-text note recorded against the registration. Omit to leave unchanged; send an empty string or null to clear it.

iorNumberstring

Importer of Record number recorded on the registration. Omit to leave unchanged; send an empty string or null to clear it.

Response

idstringRequired

Kintsugi's unique identifier for the registration.

organizationIdstringRequired

Organization the registration belongs to. Send it as Organization-Id to scope a request to this registration.

organizationNamestring

Display name of the organization the registration belongs to. null when the organization has no name set. Sort a list by it with sort=organizationName.

countryCodestringRequired

ISO 3166-1 alpha-2 country the registration is held in.

stateCodestring

State or province code the registration is held in, within countryCode. An empty string for a country-level registration.

stateNamestring

Display name of the state or province. An empty string for a country-level registration.

statusPublicRegistrationStatusEnumRequired

Lifecycle status. Only a REGISTERED or SELF_MANAGED registration has returns filed against it; the others are in progress, wound down, or retained for reporting.

Available options:REGISTEREDPROCESSINGUNREGISTEREDDEREGISTERINGDEREGISTEREDCANCELLEDVALIDATINGAWAITING_CLARIFICATIONSELF_MANAGED
isPreCollectingboolean

True on a PROCESSING registration that marks the organization as collecting tax in the jurisdiction ahead of registration details. Always false on any other status.

registrationTypePublicRegistrationTypeEnumRequired

Whether the registration is an EU One Stop Shop scheme covering several member states, or a direct registration with one jurisdiction.

Available options:EU_OSSOTHER
registrationCategoryPublicRegistrationCategoryEnumRequired

How the registration was established: REGULAR for one Kintsugi filed, IMPORTED for one you already held and brought across, DEREGISTRATION for one being wound down.

Available options:REGULARIMPORTEDDEREGISTRATION
taxTypePublicTaxTypeEnumRequired

Which taxes this registration account covers. SALES_AND_USE_TAX is one permit covering both; it does not imply sales activity.

Available options:SALES_TAXUSE_TAXSALES_AND_USE_TAXRETAIL_DELIVERY_FEE
filingFrequencyPublicFilingFrequencyEnumRequired

How often returns are filed against this registration. UNKNOWN until the jurisdiction assigns one.

Available options:UNKNOWNMONTHLYQUARTERLYSEMI_ANNUALLYANNUALLYANNUAL_FISCAL_YEARSEMI_MONTHLYBI_MONTHLYFOUR_MONTHLYQUARTERLY_PREPAYMENT
scheduledFilingFrequencyPublicFilingFrequencyEnum

Filing frequency that replaces filingFrequency on filingFrequencyEffectiveDate. null when no frequency change is pending.

Available options:UNKNOWNMONTHLYQUARTERLYSEMI_ANNUALLYANNUALLYANNUAL_FISCAL_YEARSEMI_MONTHLYBI_MONTHLYFOUR_MONTHLYQUARTERLY_PREPAYMENT
filingFrequencyEffectiveDatestring

Date scheduledFilingFrequency takes effect, as YYYY-MM-DD. null when no frequency change is pending.

registrationDatestring

Date the registration takes effect in the jurisdiction, as YYYY-MM-DD. null before the jurisdiction has assigned one.

createFilingsFromstring

First period filings are generated for, as YYYY-MM-DD. null before a first filing period has been established.

registrationRequestedstring

When the registration was submitted to the jurisdiction. null when it has not been submitted.

registrationCompletedstring

When the jurisdiction confirmed the registration. null when it has not been confirmed.

deregistrationRequestedstring

When deregistration was submitted to the jurisdiction. null when no deregistration has been requested.

deregistrationCompletedstring

When the jurisdiction confirmed the deregistration. null when it has not been confirmed.

deregistrationClosureDatestring

Effective date the registration closes. null when not set.

deregistrationReasonPublicDeregistrationReasonEnum

Reason the registration is closing. null when not set.

Available options:FULL_BUSINESS_CLOSURECLOSING_NEXUS_IN_STATE
deregistrationAcknowledgedAtstring

When final-return acknowledgement was recorded. null when not set.

registrationEmailstring

Email address the jurisdiction has on file for this registration. An empty string when none is recorded.

salesTaxIdstring

Account number the jurisdiction issued. Holds the sales tax ID on a sales or combined permit, and the consumer use tax account number on a use tax registration. An empty string before one is issued.

iorNumberstring

Importer of Record number recorded on the registration. An empty string when none is recorded.

iorDatestring

Date the Importer of Record number takes effect, as YYYY-MM-DD. In jurisdictions that start collection from this date rather than registrationDate, tax is collected on and after it. null when no IOR date applies.

commentstring

Free-text note recorded against the registration. An empty string when there is none.

registrationsRegimePublicRegistrationsRegimeEnum

Filing regime the registration is held under. null in jurisdictions that offer only one regime.

Available options:STANDARDSIMPLIFIED
changeRegimeStatusPublicChangeRegimeStatusEnum

Progress of a request to move this registration to a different filing regime. null when no regime change is in flight.

Available options:REQUESTEDAPPROVEDDONEACKNOWLEDGED
ossTypePublicOssTypeEnum

One Stop Shop scheme this registration files under. null for a registration that is not an EU OSS scheme.

Available options:UNIONNON_UNIONIOSS
ossMemberStateOfIdentificationCodestring

ISO 3166-1 alpha-2 code of the EU member state the OSS registration is identified in. null for a registration that is not an EU OSS scheme.

filingWebsiteUrlstring

Tax authority's filing portal for this jurisdiction. null when Kintsugi has no portal recorded for it.

amountFeesstringRequired

Kintsugi's service fee for this registration, as a decimal string in amountFeesCurrency. 0.00 when no fee applies.

amountFeesCurrencystring

ISO-4217 currency code of amountFees.

vdabooleanRequired

Whether the registration was made under a Voluntary Disclosure Agreement.

doNotFilebooleanRequired

Whether returns are suppressed for this registration. When true, Kintsugi does not file against it.

importedbooleanRequired

Whether the registration was already held and brought into Kintsugi, rather than filed by Kintsugi.

autoRegisteredbooleanRequired

Whether the registration was completed without manual intervention.

200

Successful Response

400

The request was invalid.

401

Authentication failed or was missing.

403

The credential is not permitted for this request.

404

The requested resource was not found.

409

The request conflicts with existing state.

422

The request failed validation.

cURL
PATCH /registrations/{registration_id}
-H "Api-Key: ***"
-H "Api-Version: 2026-07-21"
{
"filingFrequency": "UNKNOWN",
"registrationDate": "2026-01-01",
"registrationEmail": "tax@example.com",
"createFilingsFrom": "2026-01-01",
"registrationRequested": "2026-07-21T15:30:00Z",
"registrationCompleted": "2026-07-21T15:30:00Z",
"deregistrationRequested": "2026-07-21T15:30:00Z",
"deregistrationCompleted": "2026-07-21T15:30:00Z",
"autoRegistered": false,
"doNotFile": false,
"isPreCollecting": false,
"registrationsRegime": "STANDARD",
"changeRegimeStatus": "REQUESTED",
"comment": "Reviewed and approved.",
"iorNumber": "123456789"
}
Example request
https://api.trykintsugi.com/registrations/{registration_id}
Response
{
"id": "regs_2mNpQr7Ls8f3k",
"organizationId": "orgn_2mNpQr7Ls8f3k",
"organizationName": "Acme Corp",
"countryCode": "US",
"stateCode": "CA",
"stateName": "California",
"status": "REGISTERED",
"isPreCollecting": false,
"registrationType": "EU_OSS",
"registrationCategory": "REGULAR",
"taxType": "SALES_TAX",
"filingFrequency": "UNKNOWN",
"scheduledFilingFrequency": "UNKNOWN",
"filingFrequencyEffectiveDate": "2027-01-01",
"registrationDate": "2026-01-01",
"createFilingsFrom": "2026-01-01",
"registrationRequested": "2026-07-21T15:30:00Z",
"registrationCompleted": "2026-07-21T15:30:00Z",
"deregistrationRequested": "2026-07-21T15:30:00Z",
"deregistrationCompleted": "2026-07-21T15:30:00Z",
"deregistrationClosureDate": "2026-02-15",
"deregistrationReason": "FULL_BUSINESS_CLOSURE",
"deregistrationAcknowledgedAt": "2026-07-28T12:00:00Z",
"registrationEmail": "tax@example.com",
"salesTaxId": "123-456789",
"iorNumber": "123456789",
"iorDate": "2026-01-01",
"comment": "Reviewed and approved.",
"registrationsRegime": "STANDARD",
"changeRegimeStatus": "REQUESTED",
"ossType": "UNION",
"ossMemberStateOfIdentificationCode": "IE",
"filingWebsiteUrl": "https://onlineservices.cdtfa.ca.gov/",
"amountFees": "150.00",
"amountFeesCurrency": "USD",
"vda": false,
"doNotFile": false,
"imported": false,
"autoRegistered": false
}
Update a registration (2026-07-21) | Kintsugi API Reference