KintsugiKintsugi

Onboarding step completion status

GET/onboarding/steps-status

Which onboarding steps are complete for the organization selected by Organization-Id, Connection-Id, or Entity-Id.

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.

Response

transactionsStatusbooleanRequired

Whether the org has imported or connected transaction data.

physicalNexusStatusbooleanRequired

Whether physical nexus locations are recorded.

organizationDetailsStatusbooleanRequired

Whether required organization profile fields are complete.

bankDetailsStatusbooleanRequired

Whether the bank details step is done. True when remittance bank details are on file, or when a partner files the organization's returns and none are needed.

primaryProductsStatusbooleanRequired

Whether primary product categories are configured.

planStepStatusbooleanRequired

Whether a billing plan step is complete.

onboardingStepsStatusbooleanRequired

Whether all required onboarding steps are complete.

autoRegisterbooleanRequired

Whether automatic registration is enabled, if configured.

autoFilebooleanRequired

Whether automatic filing is enabled, if configured.

physicalMailAddressStatusstringRequired

Status of the physical mailing address step, if applicable.

accountSetupCompleteboolean

Sticky flag when account setup gating is satisfied.

checklistBranchstring

Onboarding checklist branch identifier for triage UI.

setupPaymentStatusboolean

Whether payment setup is complete.

mailStepStatusboolean

Whether the mail-related onboarding step is complete.

ecmStepStatusboolean

Whether the exemption certificate management step is complete.

analyticsStepStatusboolean

Whether the analytics onboarding step is complete.

primaryProductsCompletedViastring

How the primary products step reached completion: 'done' or 'skipped'. Null when the step is not yet complete, or does not apply to this organization's plan.

Available options:doneskipped
planStepCompletedViastring

How the plan step reached completion: 'done' or 'skipped'. Null when the step is not yet complete, or does not apply to this organization's plan.

Available options:doneskipped
mailStepCompletedViastring

How the mail step reached completion: 'done' or 'skipped'. Null when the step is not yet complete, or does not apply to this organization's plan.

Available options:doneskipped
ecmStepCompletedViastring

How the exemption certificate management step reached completion: 'done' or 'skipped'. Null when the step is not yet complete, or does not apply to this organization's plan.

Available options:doneskipped
analyticsStepCompletedViastring

How the analytics step reached completion: 'done' or 'skipped'. Null when the step is not yet complete, or does not apply to this organization's plan.

Available options:doneskipped
200

Successful Response

400

The request was invalid.

401

Authentication failed or was missing.

404

The requested resource was not found.

422

Validation Error

cURL
GET /onboarding/steps-status
-H "Api-Key: ***"
-H "Api-Version: 2026-07-21"
Response
{
"transactionsStatus": false,
"physicalNexusStatus": false,
"organizationDetailsStatus": false,
"bankDetailsStatus": false,
"primaryProductsStatus": false,
"planStepStatus": false,
"onboardingStepsStatus": false,
"autoRegister": false,
"autoFile": false,
"physicalMailAddressStatus": "physical mail address status",
"accountSetupComplete": false,
"checklistBranch": "checklist branch",
"setupPaymentStatus": false,
"mailStepStatus": false,
"ecmStepStatus": false,
"analyticsStepStatus": false,
"primaryProductsCompletedVia": "done",
"planStepCompletedVia": "done",
"mailStepCompletedVia": "done",
"ecmStepCompletedVia": "done",
"analyticsStepCompletedVia": "done"
}
Onboarding step completion status (2026-07-21) | Kintsugi API Reference