https://github.com/prevailexcel/vue-identity-kyc
A Vue.js plugin for Prembly Identity Verification
https://github.com/prevailexcel/vue-identity-kyc
Last synced: 5 months ago
JSON representation
A Vue.js plugin for Prembly Identity Verification
- Host: GitHub
- URL: https://github.com/prevailexcel/vue-identity-kyc
- Owner: PrevailExcel
- License: mit
- Created: 2024-06-07T13:21:20.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-06-07T13:23:45.000Z (about 2 years ago)
- Last Synced: 2025-08-09T18:45:47.541Z (10 months ago)
- Language: TypeScript
- Size: 3.91 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Prembly Identitypass VueJS SDK
> vue-identity-kyc
[](https://www.npmjs.com/package/vue-identity-kyc) [](https://standardjs.com)
The Prembly Identitypass VueJS SDK is a library that allows you to easily integrate verification services into your JS/TS app. The SDK is based on the Prembly Identitypass API, which provides a range of verification services, including data verification, identity verification, document verification, biometric verification, radar verification and other verification services.
#### It has full TypeScript Support.
## Install
```bash
npm install --save vue-identity-kyc
```
## Usage
```vue
import { useIdentityPayKYC } from 'vue-identity-kyc';
const config = {
first_name: "test",
last_name: "test",
email: "prevailejimadu@myidentitypass.com",
merchant_key: "<your-key-here>",
user_ref: "a unique ref for your user",
is_test: true, //set this to through for a test
config_id: "<configuration ID retrieve from your widget settings>", //optional
callback: (response) => console.log(response)
}
const verifyWithIdentity = useIdentityPayKYC(config)
Verify Identity
```
## RESPONSES
```js
RESPONSES
1. Failed response:
{
code: "E01",
message: "Message goes here",
status: "failed"
}
2. Cancelled
{
code: "E02",
message: "Verification Canceled",
status: "failed"
}
3. Success
{
code: "00",
status: "success",
message: "Verification Successful",
data:{
//Verification data goes here
// kindly check official documentation for data structure for each channel
//https://developer.myidentitypass.com
},
channel:"Channel goes here", e.g BVN,NIN and many more
}
```
## Contributing
Please feel free to fork this package and contribute by submitting a pull request to enhance the functionalities.
## Thank You
Why not star the github repo? I'd love the attention! Why not share the link for this repository on Twitter or HackerNews? Spread the word!
Don't forget to [follow me on twitter](https://twitter.com/EjimaduPrevail)!
Also check out my page on medium to catch articles and tutorials on Laravel [follow me on medium](https://medium.com/@prevailexcellent)!
Thanks!
Chimeremeze Prevail Ejimadu.
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.