@zerohash-sdk/onboarding-js 1.15.5 → 1.15.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -0
- package/dist/index.d.ts +15 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -171,6 +171,10 @@ onCompleted: ({ participantCode, kycStatus }) => {
|
|
|
171
171
|
};
|
|
172
172
|
```
|
|
173
173
|
|
|
174
|
+
> **`onboardingFlow: "tax_only"`:** no KYC runs in this flow. `onCompleted` fires once the tax
|
|
175
|
+
> certification is saved, with the participant's existing KYC status when it is known, otherwise
|
|
176
|
+
> `kycStatus: "UNKNOWN"`. Don't treat it as a new KYC result.
|
|
177
|
+
|
|
174
178
|
### onError
|
|
175
179
|
|
|
176
180
|
```javascript
|
package/dist/index.d.ts
CHANGED
|
@@ -478,12 +478,27 @@ declare type OnboardingCompletedData = {
|
|
|
478
478
|
};
|
|
479
479
|
|
|
480
480
|
export declare interface OnboardingConfig extends BaseConfig<OnboardingEvent>, OnboardingCallbacks {
|
|
481
|
+
/**
|
|
482
|
+
* Onboarding experience to render. Optional; when omitted the default
|
|
483
|
+
* experience is used. Init-only. `BaseJsSdk.render` forwards it to the web
|
|
484
|
+
* component.
|
|
485
|
+
*/
|
|
486
|
+
onboardingFlow?: OnboardingFlow;
|
|
481
487
|
}
|
|
482
488
|
|
|
483
489
|
declare type OnboardingEvent = AppEvent<OnboardingEventType>;
|
|
484
490
|
|
|
485
491
|
declare type OnboardingEventType = string;
|
|
486
492
|
|
|
493
|
+
/**
|
|
494
|
+
* Onboarding experience to render.
|
|
495
|
+
*
|
|
496
|
+
* - `"full_with_tax"` - Full onboarding plus brokerage tax certification
|
|
497
|
+
* - `"full_without_tax"` - Full onboarding, no tax certification
|
|
498
|
+
* - `"tax_only"` - Tax certification only, for existing participants
|
|
499
|
+
*/
|
|
500
|
+
export declare type OnboardingFlow = 'full_with_tax' | 'full_without_tax' | 'tax_only';
|
|
501
|
+
|
|
487
502
|
/**
|
|
488
503
|
* Generic HTMLElement representing a web component with custom config
|
|
489
504
|
*/
|