liquid-verifier-sdk v0.4.0

Liquid - Verifiable Credentials Platform

• Liquid is a web3 company that offers a comprehensive solution for issuance, verification, and secure holding of verifiable credentials. By leveraging blockchain technology and decentralized systems, Liquid provides trust, security, and transparency to individuals and organizations in managing their digital credentials.

Features

• Issuance: Liquid enables organizations and institutions to issue verifiable credentials to their users. These digital certificates contain information such as educational degrees, professional certifications, licenses, and other forms of digital identification.

• Verification: Liquid provides a tamper-proof verification process to validate the authenticity and validity of the issued credentials. By utilizing blockchain technology, Liquid ensures that the credentials have not been altered or falsified.

• Holding Ability: Liquid offers a secure and decentralized storage solution for individuals to hold their verifiable credentials. Users have complete control over their data and can securely store their credentials in a digital wallet or storage system provided by Liquid.

How it Works Issuance: Organizations and institutions can utilize Liquid's platform to issue verifiable credentials to their users. These credentials are digitally signed using cryptographic techniques to ensure their authenticity and integrity.

Verification: When a verifiable credential is presented for verification, Liquid's system checks the digital signature associated with the credential against the corresponding public key stored on the blockchain. If the digital signature is valid and matches the stored public key, the credential is considered authentic and trustworthy.

Holding: Users can securely store their verifiable credentials in Liquid's decentralized storage system. By leveraging blockchain technology, Liquid ensures that the credentials are stored in a tamper-proof and transparent manner, providing users with complete control over their data.

Getting Started To get started with Liquid, follow these steps:

• Install the Liquid SDK by running. npm install liquid-verifier-sdk
• Configure your API keys and endpoints in the .env file.

Use the Liquid Verifier SDK to integrate verification functionalities into your application.

This Package Provides you the class Verifier with functions mentioned below such that a verification can be performed for a DID

• verificationList

  This function/method returns the verification list. which includes the history of the verifier , All the Request Raised to all Holders.

• createVerificationRequest

  This function/method returns the verifcationId and the confirmation of the mail sent to holder. 

• createQRFromVerificationId

  This function/method provides base64 encoded QR taking the Parameter of VerificationId .

• checkVerificationRequest

  This function/method check's for the DID response from the user/holder and wait's for 2 minutes so that holder can respond to it .. else it's TIMEOUT.

• checkDIDFromIDANDIV

  This function/method decrypt's the DID for you to see the RESPONSE received from the holder and also choose the appopirate the data you want to verify.

• SAMPLE CODE

• Import Verification Class to the Project.

 const {Verification} = require("liquid-verification-sdk");

• URL = REFER's to the Server Address you would be connectiong to.
• ACCESS TOKEN = ACCESS TOKEN refer's to the JWT token for your profile.

• VERIFICATION LIST - RETURNS ALL THE VERIFICATION REQUEST GENERATED BY THE VERIFIER.

• SENT DID/VERIFICATION REQUEST TO HOLDER/USER

• HOLDER_EMAIL_ADDRESS = Specify the Email address of the user to whom this request to be sent for verification

• MESSAGE = Specify the Message needed to be sent with the Verification Request.
• ASKING_FOR = Specify the DID or the attribute you are looking for eg. Identity Proof, Age Proof, Address Proof, Bank Statement Proof etc.

let verificationId = await verifier.createVerificationRequest(HOLDER_EMAIL_ADDRESS,MESSAGE,ASKING_FOR );

• Response - Request Sent Confirmation and Generated Verification ID

• Generates the QR code which can be embedded to website for the verifcaiton; Liquid App can read this QR can respond to it directly;

  let qr = await verifier.createQRForVerificaitonId(verificationId.verificationId)

• RESPONSE - QR CODE IN base64 encoded , it can be directly used with<img> tag .

• It checks for the response from the holder and respond when did is received it wait's for the holder for 2 min . else timeout...

let response  = await verifier.checkVerificationRequest(verificationId.verificationId);

• RESPONSE - DID RESPONSE

Support If you encounter any issues or have questions about Liquid, please reach out to our support team at support@liquid.com.

License Liquid is released under the MIT License