Register Nexus (Partner API)
Kintsugi Partner API — Register a nexus by its ID.
Documentation Index
Fetch the complete documentation index at: https://docs.trykintsugi.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Headers
Path Parameters
The unique identifier of the nexus.
Body
The current status of the registration. Possible values: REGISTERED, PROCESSING, UNREGISTERED, DEREGISTERING, DEREGISTERED, CANCELLED, VALIDATING, AWAITING_CLARIFICATION, SELF_MANAGED.
REGISTERED, PROCESSING, UNREGISTERED, DEREGISTERING, DEREGISTERED, CANCELLED, VALIDATING, AWAITING_CLARIFICATION, SELF_MANAGED The date when the registration was created. Format: YYYY-MM-DD.
Email address associated with the registration.
A unique key assigned to the registration.
A unique key assigned for deregistration.
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).
STANDARD, SIMPLIFIED REQUESTED, APPROVED, DONE, ACKNOWLEDGED Indicates 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 updated filing frequency (MONTHLY, QUARTERLY, etc.).
UNKNOWN, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY, ANNUAL_FISCAL_YEAR, SEMI_MONTHLY, BI_MONTHLY, FOUR_MONTHLY, QUARTERLY_PREPAYMENT The 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.
EU_OSS, OTHER AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, XK, ZZ_EU Response
Successful Response
The current status of the registration. Possible values: REGISTERED, PROCESSING, UNREGISTERED, DEREGISTERING, DEREGISTERED, CANCELLED, VALIDATING, AWAITING_CLARIFICATION, SELF_MANAGED.
REGISTERED, PROCESSING, UNREGISTERED, DEREGISTERING, DEREGISTERED, CANCELLED, VALIDATING, AWAITING_CLARIFICATION, SELF_MANAGED The country code (ISO 3166-1 alpha-2 format) where the registration applies.
AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, XK, ZZ_EU The 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.
UNKNOWN, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY, ANNUAL_FISCAL_YEAR, SEMI_MONTHLY, BI_MONTHLY, FOUR_MONTHLY, QUARTERLY_PREPAYMENT The unique identifier for the registration.
EU_OSS, OTHER The date when the registration was created. Format: YYYY-MM-DD.
Email address associated with the registration.
A unique key assigned to the registration.
A unique key assigned for deregistration.
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).
STANDARD, SIMPLIFIED REQUESTED, APPROVED, DONE, ACKNOWLEDGED Indicates 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
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).
Indicates whether an initial synchronization should be performed.
The amount of fees associated with the registration.
^(?!^[-+.]*$)[+-]?0*(?:\d{0,18}|(?=[\d.]{1,21}0*$)\d{0,18}\.\d{0,2}0*$)Indicates whether a Voluntary Disclosure Agreement (VDA) applies.
Whether the registration was imported from another system.
The sales tax ID associated with the registration.
Indicates whether the registration is an SST Import.
The type of OSS registration. Should be filled for ZZ_EU OSS registrations.
UNION, NON_UNION The Member State of Identification code for OSS registrations.
AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, XK, ZZ_EU The date when the registration was marked as collecting.
Indicates whether the registration needs to be marked as collecting.
^(?!^[-+.]*$)[+-]?0*(?:\d{0,18}|(?=[\d.]{1,21}0*$)\d{0,18}\.\d{0,2}0*$)The category of the registration. Possible values: REGULAR, IMPORTED, DEREGISTRATION.
REGULAR, IMPORTED, DEREGISTRATION Jurisdiction-specific registration fields.