3. QuadrataReact Package
<QuadrataReact /> Component
<QuadrataReact /> Component
<QuadrataReact />
Props
<QuadrataReact />
PropsProp | Description | Type |
---|---|---|
|
| |
(optional) |
| |
| A callback function: triggered when the application has reached an end state. |
Individual Passport Onboarding Statuses:
- |
| A callback function: triggered when the modal is closed. | |
| A callback function. triggered when a user clicks Claim Passport. the event object passed to this function will contain all the data required to mint a passport.
|
|
| A callback function: triggered when the mint parameters are signed and ready. tip: useful in case the UI needs to prepare the transaction before initiating it, see example page. |
|
| A callback function: triggered when a page is changed. Passes a Page type string. tip: Import the |
|
(required) | A callback function. triggered when a user clicks Sign Wallet or Allow. It passes a message for the user to sign in the Onboarding and/or User Consent flow. |
|
Shared Configuration Object
QuadrataReact
component accepts configUser
and configBusines
props to configure corresponding onboarding flows. It is required to set one of the props to launch the appropriate onboarding flow. If both props are set, the onboarding selection screen is displayed.
Prop | Description | Type |
---|---|---|
| When true, debug information will be printed in the console. Never use in production. |
|
| JWT access token. See "API Authentication" page |
|
(required) | Quadrata endpoint to be used for implementation. |
|
| Overrides the default loader component inside of the form markup. This component will be shown in all loading states during the flow. if not defined, a "Loading..." text will be shown instead. |
|
| The class name to be appended to the component's root DOM element. |
|
| The |
|
| Toggle between dark and light mode. Default: false |
|
| The |
|
(optional) | Generic error text, when defined, an error message will appear at the bottom of the UI. |
|
| The |
|
| The |
|
| The |
|
Business Configuration Object
ConfigBusiness
interface defines the required properties for the kyb
onboarding flow. The ConfigBusiness
interface has no additional options than the ConfigShared
interface.
Always define your configuration object outside of your React components to prevent unexpected behavior
User Configuration Object
ConfigUser
interface defines the required properties for the kyc
onboarding flow.
Prop | Description | Type |
---|---|---|
(required) | The user's wallet address. |
|
| An array of Quadrata attributes required by the protocol. See "Discover User Attributes" page. |
|
(required) | The decimal chain ID number of the currently connected network. In case of unsupported chain IDs the user will be navigated to the "Configuration Error" screen.
Tip: Supported chain IDs can be found in the |
|
| An array of ISO country codes where the onboarding process is made unavailable. |
|
| Upon a successful mint, pass a |
|
(required) | A callback function. triggered when a user clicks Sign Wallet or Allow. It passes a message for the user to sign in the Onboarding and/or User Consent flow. |
|
| An array of Quadrata Privacy Parameter Names that can be requested from the users' privacy data. See "List of Privacy Data" page. |
|
| The user's signature of the "Welcome to Quadrata! By signing, you agree to the Terms of Service." message passed by the |
|
| The user's signature when granting access to privacy data. |
|
| The mint transaction hash. If the value is not undefined, it will trigger navigation to the "Mint in progress" page and will generate the Block explorer transaction link URL. |
|
Last updated