Set a registration's credentials
Set the stored sign-in credentials for a registration. Send a value for any of username, password, pin, securityQuestions to set it; a field you leave out (or send as null) is left unchanged. Sending securityQuestions replaces the stored set. Credentials are write-only: this returns the registration, never the values you sent, which are readable only through the credentials reveal endpoint.
Only an owner of the organization (or an API key scoped to it) may call it. Returns 404 if the registration does not exist or belongs to an organization your credential cannot access; 403 if your credential may read the organization but is not permitted to change credentials.
Authorization
Headers
Release date, as YYYY-MM-DD. Defaults to 2026-07-21.
Target organization id (Organization-Id selector).
Target connection id; resolves to its organization.
Platform entity id; resolves to a connection's organization.
Optional source to disambiguate an Entity-Id.
Path parameters
The unique identifier of the registration.
Body
Username for the jurisdiction's portal. Omit it or send null to leave the stored username unchanged. Write-only: reveal it through the credentials reveal endpoint.
Password for the jurisdiction's portal, stored encrypted. Omit it or send null to leave the stored password unchanged. Write-only: reveal it through the credentials reveal endpoint.
PIN for the jurisdiction's portal, where one is used, stored encrypted. Omit it or send null to leave the stored PIN unchanged. Write-only: reveal it through the credentials reveal endpoint.
Security questions for the jurisdiction's portal, stored encrypted. Sending this replaces the stored set with the questions you send; omit it or send null to leave them unchanged. Write-only: reveal them through the credentials reveal endpoint.
Response
Kintsugi's unique identifier for the registration.
Organization the registration belongs to. Send it as Organization-Id to scope a request to this registration.
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.
ISO 3166-1 alpha-2 country the registration is held in.
State or province code the registration is held in, within countryCode. An empty string for a country-level registration.
Display name of the state or province. An empty string for a country-level registration.
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.
REGISTEREDPROCESSINGUNREGISTEREDDEREGISTERINGDEREGISTEREDCANCELLEDVALIDATINGAWAITING_CLARIFICATIONSELF_MANAGEDTrue on a PROCESSING registration that marks the organization as collecting tax in the jurisdiction ahead of registration details. Always false on any other status.
Whether the registration is an EU One Stop Shop scheme covering several member states, or a direct registration with one jurisdiction.
EU_OSSOTHERHow the registration was established: REGULAR for one Kintsugi filed, IMPORTED for one you already held and brought across, DEREGISTRATION for one being wound down.
REGULARIMPORTEDDEREGISTRATIONWhich taxes this registration account covers. SALES_AND_USE_TAX is one permit covering both; it does not imply sales activity.
SALES_TAXUSE_TAXSALES_AND_USE_TAXRETAIL_DELIVERY_FEEHow often returns are filed against this registration. UNKNOWN until the jurisdiction assigns one.
UNKNOWNMONTHLYQUARTERLYSEMI_ANNUALLYANNUALLYANNUAL_FISCAL_YEARSEMI_MONTHLYBI_MONTHLYFOUR_MONTHLYQUARTERLY_PREPAYMENTFiling frequency that replaces filingFrequency on filingFrequencyEffectiveDate. null when no frequency change is pending.
UNKNOWNMONTHLYQUARTERLYSEMI_ANNUALLYANNUALLYANNUAL_FISCAL_YEARSEMI_MONTHLYBI_MONTHLYFOUR_MONTHLYQUARTERLY_PREPAYMENTDate scheduledFilingFrequency takes effect, as YYYY-MM-DD. null when no frequency change is pending.
Date the registration takes effect in the jurisdiction, as YYYY-MM-DD. null before the jurisdiction has assigned one.
First period filings are generated for, as YYYY-MM-DD. null before a first filing period has been established.
When the registration was submitted to the jurisdiction. null when it has not been submitted.
When the jurisdiction confirmed the registration. null when it has not been confirmed.
When deregistration was submitted to the jurisdiction. null when no deregistration has been requested.
When the jurisdiction confirmed the deregistration. null when it has not been confirmed.
Effective date the registration closes. null when not set.
Reason the registration is closing. null when not set.
FULL_BUSINESS_CLOSURECLOSING_NEXUS_IN_STATEWhen final-return acknowledgement was recorded. null when not set.
Email address the jurisdiction has on file for this registration. An empty string when none is recorded.
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.
Importer of Record number recorded on the registration. An empty string when none is recorded.
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.
Free-text note recorded against the registration. An empty string when there is none.
Filing regime the registration is held under. null in jurisdictions that offer only one regime.
STANDARDSIMPLIFIEDProgress of a request to move this registration to a different filing regime. null when no regime change is in flight.
REQUESTEDAPPROVEDDONEACKNOWLEDGEDOne Stop Shop scheme this registration files under. null for a registration that is not an EU OSS scheme.
UNIONNON_UNIONIOSSISO 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.
Tax authority's filing portal for this jurisdiction. null when Kintsugi has no portal recorded for it.
Kintsugi's service fee for this registration, as a decimal string in amountFeesCurrency. 0.00 when no fee applies.
ISO-4217 currency code of amountFees.
Whether the registration was made under a Voluntary Disclosure Agreement.
Whether returns are suppressed for this registration. When true, Kintsugi does not file against it.
Whether the registration was already held and brought into Kintsugi, rather than filed by Kintsugi.
Whether the registration was completed without manual intervention.
Successful Response
The request was invalid.
Authentication failed or was missing.
The credential is not permitted for this request.
The requested resource was not found.
The request conflicts with existing state.
The request failed validation.