React
React UI Package for KYC
Installation
You can install the @faceki/react-kyc-sdk
package using npm or yarn:
Usage
To use the <FacekiSDK>
component in your React application, follow these steps:
Import the component at the top of your component file:
Configure the SDK by providing the necessary props:
Configurable Props
The <FacekiSDK>
component accepts the following configurable props:
link
(required): Your generated link Id from https://docs.faceki.com/api-integration/verification-apis/generate-kyc-link
theme
(optional): An object to customize the visual appearance of the SDK. It includes properties likemainColor
,secondaryColor
, etc.onSuccess
(optional): A callback function to be called when the SDK operation is successful. It receives data as a parameter.onFail
(optional): A callback function to be called when the SDK operation fails. It receives data as a parameter.
Theme Configuration
The theme
object can be customized with the following properties:
mainColor
: Main color used in the theme.secondaryColor
: Secondary color for the theme.backgroundColor
: Background color of the SDK component.cardBackgroundColor
: Background color of cards within the SDK.headingTextColor
: Color of text used in headings.secondaryTextColor
: Color of secondary text.secondaryBorderColor
: Color of secondary borders.iconFillColor
: Fill color for icons.iconBorderColor
: Border color for icons.iconTextColor
: Color of text within icons.logo
: URL for a custom logo image.disableGuidance
: A boolean to disable guidance (if applicable).failedText
: Text to display on failure.successText
: Text to display on success.buttonbg
: Background color for buttons.textBg
: Background color for text elements.verificationProcessingText
: Text to display during verification processing.
Example
Here's an example of how you can use the <FacekiSDK>
component with minimal configuration:
For advanced customization, you can provide additional theme properties and callback functions as needed.
Last updated