@techlabi/kycrazy-ui-kit 0.46.1 → 0.48.0-beta.1
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/CHANGELOG.md +6 -0
- package/README.md +14 -14
- package/dist/index.es.js +17578 -34216
- package/dist/index.umd.js +90 -3903
- package/dist/style.css +1 -1
- package/dist/types/components/steps/kyb/CompanyDocumentsStep.d.ts +1 -1
- package/dist/types/hooks/use-camera.d.ts +2 -1
- package/dist/types/types.d.ts +2 -1
- package/dist/types/utils/imageValidator.d.ts +3 -6
- package/package.json +2 -1
- package/dist/browser-C106t0ST.js +0 -53
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -50,7 +50,7 @@ function App() {
|
|
|
50
50
|
fullName={user.fullName} // optional
|
|
51
51
|
hideCompanyActivity={true}; // optional
|
|
52
52
|
hideQuestionary={true}; // optional
|
|
53
|
-
companyDocumentsTypes={['bank_statement', 'company_structure', 'certificate_of_registration','business_license']} // optional
|
|
53
|
+
companyDocumentsTypes={['bank_statement', 'company_structure', 'certificate_of_registration','business_license', 'void_cheque']} // optional
|
|
54
54
|
onComplete={(token: string, data: KYCRequestData | KYBRequestData) => {}}
|
|
55
55
|
onDoneClick={() => {}}
|
|
56
56
|
/>
|
|
@@ -61,16 +61,16 @@ function App() {
|
|
|
61
61
|
|
|
62
62
|
## 🎨 Props
|
|
63
63
|
|
|
64
|
-
| Prop | Type | Default | Optional | Description
|
|
65
|
-
| ----------------------- | --------------- | ------- | -------- |
|
|
66
|
-
| `apiEndpoint` | `string` | - | no | provide backend API endpoint where the data will be posted upon KYC verification flow
|
|
67
|
-
| `apiKey` | `string` | - | no | provide API key to access backend
|
|
68
|
-
| `isKYB` | `boolean` | false | yes | use in KYB mode
|
|
69
|
-
| `userEmail` | `string` | - | yes | Email of the user undergoing KYC/KYB verification
|
|
70
|
-
| `userId` | `string` | - | no | Unique identifier of the user to save the progress
|
|
71
|
-
| `fullName` | `string` | - | yes | optional full name of the user (will be autocompleted in the KYC flow)
|
|
72
|
-
| `hideCompanyActivity` | `boolean` | false | yes | hide the company activity (KYB mode) section
|
|
73
|
-
| `hideQuestionary` | `boolean` | false | yes | hide the questionnaire section (KYB mode)
|
|
74
|
-
| `companyDocumentsTypes` | `Array<string>` | - | yes | Optional list of company document uppload fields for KYB: <br>`bank_statement`, `company_structure`, `certificate_of_registration`, `business_license` <br> If prop is not used then all of the fields will be shown |
|
|
75
|
-
| `onComplete` | `function` | - | no | A callback function once the request successfully reached the backend
|
|
76
|
-
| `onDoneClick` | `function` | - | yes | A callback function once a user clicked on button on final screen
|
|
64
|
+
| Prop | Type | Default | Optional | Description |
|
|
65
|
+
| ----------------------- | --------------- | ------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
66
|
+
| `apiEndpoint` | `string` | - | no | provide backend API endpoint where the data will be posted upon KYC verification flow |
|
|
67
|
+
| `apiKey` | `string` | - | no | provide API key to access backend |
|
|
68
|
+
| `isKYB` | `boolean` | false | yes | use in KYB mode |
|
|
69
|
+
| `userEmail` | `string` | - | yes | Email of the user undergoing KYC/KYB verification |
|
|
70
|
+
| `userId` | `string` | - | no | Unique identifier of the user to save the progress |
|
|
71
|
+
| `fullName` | `string` | - | yes | optional full name of the user (will be autocompleted in the KYC flow) |
|
|
72
|
+
| `hideCompanyActivity` | `boolean` | false | yes | hide the company activity (KYB mode) section |
|
|
73
|
+
| `hideQuestionary` | `boolean` | false | yes | hide the questionnaire section (KYB mode) |
|
|
74
|
+
| `companyDocumentsTypes` | `Array<string>` | - | yes | Optional list of company document uppload fields for KYB: <br>`bank_statement`, `company_structure`, `certificate_of_registration`, `business_license`, `void_cheque` <br> If prop is not used then all of the fields will be shown |
|
|
75
|
+
| `onComplete` | `function` | - | no | A callback function once the request successfully reached the backend |
|
|
76
|
+
| `onDoneClick` | `function` | - | yes | A callback function once a user clicked on button on final screen |
|