Skip to main content
POST
/
v2
/
partner
/
registrations
Create Partner Registration
curl --request POST \
  --url https://api.trykintsugi.com/v2/partner/registrations \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "organizationId": "<string>"
}
'
{
  "state_code": "<string>",
  "state_name": "<string>",
  "id": "<string>",
  "filing_days": 123,
  "registration_date": "2023-12-25",
  "registration_email": "<string>",
  "registration_requested": "2023-11-07T05:31:56Z",
  "registration_completed": "2023-11-07T05:31:56Z",
  "deregistration_requested": "2023-11-07T05:31:56Z",
  "deregistration_completed": "2023-11-07T05:31:56Z",
  "auto_registered": false,
  "third_party_enabled": false,
  "do_not_file": false,
  "two_factor_enabled": true,
  "marked_collecting": true,
  "username": "<string>",
  "comment": "<string>",
  "create_filings_from": "2023-12-25",
  "initial_sync": false,
  "amount_fees": "0.00",
  "vda": false,
  "imported": true,
  "sales_tax_id": "<string>",
  "sst_import": false,
  "marked_collecting_date": "2023-11-07T05:31:56Z",
  "needs_mark_as_collecting": false,
  "credits_total_available": "0.00",
  "registration_category": "REGULAR",
  "jurisdiction_specific_fields": {}
}

Authorizations

​
X-API-KEY
string
header
required

Headers

​
x-partner-id
string | null

Target partner. Required for referral partner API keys (selects the owned sub-partner; omitting it returns 400 PARTNER_ID_REQUIRED). For multi-partner bearer users, selects the active partner.

Maximum string length: 100

Body

application/json
​
organizationId
string
required
Maximum string length: 100
​
countryCode
enum<string>
required
Available options:
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
​
filingFrequency
enum<string>
required
Available options:
UNKNOWN,
MONTHLY,
QUARTERLY,
SEMI_ANNUALLY,
ANNUALLY,
ANNUAL_FISCAL_YEAR,
SEMI_MONTHLY,
BI_MONTHLY,
FOUR_MONTHLY,
QUARTERLY_PREPAYMENT
​
stateCode
string | null
Maximum string length: 50
​
stateName
string | null
Maximum string length: 200
​
registrationDate
string<date> | null
​
registrationType
enum<string>
default:IMPORTED
Available options:
REGULAR,
IMPORTED,
DEREGISTRATION
​
registrationEmail
string | null
Maximum string length: 200
​
username
string | null
Maximum string length: 200
​
password
string | null
Maximum string length: 200
​
securityQuestions
SecurityQuestion · object[] | null
​
selfManaged
boolean
default:false
​
jurisdictionSpecificFields
Jurisdictionspecificfields · object

Response

Successful Response

​
status
enum<string>
required

The current status of the registration. Possible values: REGISTERED, PROCESSING, UNREGISTERED, DEREGISTERING, DEREGISTERED, CANCELLED, VALIDATING, AWAITING_CLARIFICATION, SELF_MANAGED.

Available options:
REGISTERED,
PROCESSING,
UNREGISTERED,
DEREGISTERING,
DEREGISTERED,
CANCELLED,
VALIDATING,
AWAITING_CLARIFICATION,
SELF_MANAGED
​
country_code
enum<string>
required

The country code (ISO 3166-1 alpha-2 format) where the registration applies.

Available options:
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
​
state_code
string
required

The state/province code where the registration applies.

​
state_name
string
required

The name of the state/province.

​
filing_frequency
enum<string>
required

Specifies how often tax filings should be made. Possible values: MONTHLY, QUARTERLY, ANNUALLY, UNKNOWN.

Available options:
UNKNOWN,
MONTHLY,
QUARTERLY,
SEMI_ANNUALLY,
ANNUALLY,
ANNUAL_FISCAL_YEAR,
SEMI_MONTHLY,
BI_MONTHLY,
FOUR_MONTHLY,
QUARTERLY_PREPAYMENT
​
id
string
required

The unique identifier for the registration.

​
filing_days
integer
required
read-only
​
registration_type
enum<string>
required
read-only
Available options:
EU_OSS,
OTHER
​
registration_date
string<date> | null

The date when the registration was created. Format: YYYY-MM-DD.

​
registration_email
string | null

Email address associated with the registration.

​
registration_requested
string<date-time> | null

Timestamp when the registration was requested.

​
registration_completed
string<date-time> | null

Timestamp when the registration was completed.

​
deregistration_requested
string<date-time> | null

Timestamp when deregistration was requested.

​
deregistration_completed
string<date-time> | null

Timestamp when the deregistration was completed.

​
auto_registered
boolean | null
default:false

Indicates whether the registration was completed automatically.

​
registrations_regime
enum<string> | null

The tax registration regime (e.g., STANDARD, SIMPLIFIED).

Available options:
STANDARD,
SIMPLIFIED
​
change_regime_status
enum<string> | null
Available options:
REQUESTED,
APPROVED,
DONE,
ACKNOWLEDGED
​
third_party_enabled
boolean | null
default:false

Indicates whether third-party access is enabled for this registration.

​
do_not_file
boolean
default:false

If true, do not file for this registration (treated as False by default).

​
two_factor_enabled
boolean | null

Indicates whether two-factor authentication (2FA) is enabled for this registration.

​
marked_collecting
boolean | null

Indicates whether the registration is marked as collecting in shopify

​
username
string | null

Username for accessing tax registration details.

​
comment
string | null

Additional comments related to the registration.

​
create_filings_from
string<date> | null

The date from which filings should be created. should start (YYYY-MM-DD).

​
initial_sync
boolean | null
default:false

Indicates whether an initial synchronization should be performed.

​
amount_fees
string
default:0.00

The amount of fees associated with the registration.

Pattern: ^(?!^[-+.]*$)[+-]?0*(?:\d{0,18}|(?=[\d.]{1,21}0*$)\d{0,18}\.\d{0,2}0*$)
​
vda
boolean | null
default:false

Indicates whether a Voluntary Disclosure Agreement (VDA) applies.

​
imported
boolean | null

Whether the registration was imported from another system.

​
sales_tax_id
string | null

The sales tax ID associated with the registration.

​
sst_import
boolean | null
default:false

Indicates whether the registration is an SST Import.

​
oss_type
enum<string> | null

The type of OSS registration. Should be filled for ZZ_EU OSS registrations.

Available options:
UNION,
NON_UNION
​
oss_member_state_of_identification_code
enum<string> | null

The Member State of Identification code for OSS registrations.

Available options:
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
​
marked_collecting_date
string<date-time> | null

The date when the registration was marked as collecting.

​
needs_mark_as_collecting
boolean | null
default:false

Indicates whether the registration needs to be marked as collecting.

​
credits_total_available
string
default:0.00
Pattern: ^(?!^[-+.]*$)[+-]?0*(?:\d{0,18}|(?=[\d.]{1,21}0*$)\d{0,18}\.\d{0,2}0*$)
​
registration_category
enum<string>
default:REGULAR

The category of the registration. Possible values: REGULAR, IMPORTED, DEREGISTRATION.

Available options:
REGULAR,
IMPORTED,
DEREGISTRATION
​
jurisdiction_specific_fields
Jurisdiction Specific Fields · object

Jurisdiction-specific registration fields.