# WeIdentity

**Repository Path**: WeBank/WeIdentity

## Basic Information

- **Project Name**: WeIdentity
- **Description**: 基于区块链实现的符合W3C DID和Verifiable Credential规范的分布式身份解决方案。 
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: develop
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 55
- **Forks**: 35
- **Created**: 2019-10-09
- **Last Updated**: 2025-12-25

## Categories & Tags

**Categories**: blockchain

**Tags**: None

## README

`中文版本 <./README.rst>`_ | English Version

.. image:: context/weidentity-logo.png
   :target: context/weidentity-logo.png

----

What is WeIdentity?
===================

WeIdentity is a blockchain solution on Open Consortium Chain to serve as a hub for identity authentication by establishing identity of entities (e.g. persons or objects) on the chain and allowing the interchange of such information among organizations when authorized.
WeIdentity is an open source platform built by WeBank and promotes the values of Open Consortium Chain: streamline resources, collaborate to produce values and serve the public.

Modules
-------

WeIdentity includes two major modules: WeIdentity DID and WeIdentity Credential.

Decentralized Identifiers (WeIdentity DID)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Traditionally, user identity is issued and managed by single centralized organization. With the advent of blockchain technology, it is possible to publish and distribute user identity on chain to allow more than one organization to manage on as a multi-centers solution
WeIdentity DID Module has come with a distributed identification protocol based on \ `FISCO-BCOS Blockchain Platform <https://fisco-bcos-documentation-en.readthedocs.io/en/latest/>`_\ , and \ `W3C DID specification <https://w3c-ccg.github.io/did-spec/>`_\, to create identities on chain and associate it with any person or object in the real world. Moreover, DID ensures the Subject’s owner with full rights of control and ownership of the identities.

The design goals of WeIdentity DID:

.. raw:: html

    <embed>
      <table style="width:100%;border-collapse:collapse">
         <tr>
            <th width="100">Objective</th>
            <th>Description</th>
         </tr>
         <tr>
            <td>Distributed</td>
            <td>Distributed ID registration model removes the dependencies on traditional single, centralized registration organization. </td>
         </tr>
         <tr>
            <td>Open Sourced</td>
            <td>The solution is fully open sourced and publicly available.</td>
         </tr>
         <tr>
            <td>Privacy</td>
            <td>The actual content of identity or credential are stored off-chain to maintain minimal information on the chain. Such can prevent any 3rd party from speculating the actual identity in real-world using the information on the chain.</td>
         </tr>
         <tr>
            <td>Portability</td>
            <td>Data on WeIdentity can be ported into mainstream blockchain platforms or those which are compliant with WeIdentitie’s specification.</td>
         </tr>
         <tr>
            <td>Interoperability</td>
            <td>Provides standard interfaces to support cross chains or cross platforms interoperation.</td>
         </tr>
         <tr>
            <td>Extensibility</td>
            <td>The data model can be extended for different business scenarios while maintaining its operability, portability and simplicity.</td>
         </tr>
      </table>
      <br />
    </embed>



WeIdentity Credential
^^^^^^^^^^^^^^^^^^^^^

There are a lot of credentials describing identity in daily life such as personal identity card, driving license, account book, prescription, graduate certificate, property ownership certificate and credit report. WeIdentity Credential offers a complete set of `W3C Verifiable Credentials <https://w3c.github.io/vc-data-model/>`_ based solutions designated to standardize and digitize such credentials into a verifiable and interchangeable format. The solution also supports Selectively Disclosure of Credential attributes and generating evidence of Credentials on blockchain.

WeIdentity encourages certificate organization to issue their own standardized credential templates to enrich the ecosystem on open consortium chain.

More
^^^^

*
   `Use Cases and Scenarios (Chinese Version) <https://weidentity.readthedocs.io/zh_CN/latest/docs/use-cases.html>`_

*
   `WeIdentity Specification (Chinese Version) <https://weidentity.readthedocs.io/zh_CN/latest/docs/weidentity-spec.html>`_

*
   `FAQ <https://weidentity.readthedocs.io/en/latest/docs/faq.html>`_

Current Status
---------------

WeIdentity is running on top of FISCO-BCOS with JAVA SDK provided for developers, please review the Installation & Deployment guide and SDK user guide listed below:


.. raw:: html

    <embed>
      <table style="border-collapse:collapse">
         <tr>
            <th width="20%">Integration Method</th>
            <th width="40%">Documentation</th>
            <th width="40%">Status</th>
         </tr>
         <tr>
            <td style="text-align:center"><a href="https://github.com/WeBankFinTech/WeIdentity">JAVA SDK</a></td>
            <td>
               <ul>
                 <li><a href="https://weidentity.readthedocs.io/zh_CN/latest/docs/one-stop-experience.html">Installation and Deployment Guide (Chinese Version)</a></li>
                 <li><a href="https://weidentity.readthedocs.io/projects/javasdk/zh_CN/latest/docs/weidentity-java-sdk-doc.html">SDK User Guide (Chinese Version)</a></li>
                 <li><a href="https://weidentity.readthedocs.io/zh_CN/latest/docs/weidentity-rest.html">RestService Guide (Chinese Version)</a></li>
               </ul>
            </td>
            <td>
               <a href="https://github.com/WeBankFinTech/WeIdentity"><img src="https://github.com/WeBankFinTech/WeIdentity/workflows/CI/badge.svg?branch=master" /></a>
               <a href="https://github.com/WeBankFinTech/WeIdentity/releases/latest"><img src="https://img.shields.io/github/release/WeBankFinTech/WeIdentity.svg" /></a>
               <a href="https://search.maven.org/search?q=g:%22com.webank%22%20AND%20a:%22weid-java-sdk%22"><img src="https://img.shields.io/maven-central/v/com.webank/weid-java-sdk.svg?label=Maven%20Central" /></a>
               <a href="https://www.codacy.com/manual/chaoxinhu/WeIdentity?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=WeBankFinTech/WeIdentity&amp;utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/37d3bc478ede4839ba16ccac469ad3f2" /></a>
               <a href="https://www.codefactor.io/repository/github/webankfintech/weidentity"><img src="https://www.codefactor.io/repository/github/webankfintech/weidentity/badge" /></a>
               <a href="https://codecov.io/gh/WeBankFinTech/WeIdentity"><img src="https://codecov.io/gh/WeBankFinTech/WeIdentity/branch/master/graph/badge.svg" /></a>
               <a href="https://www.gnu.org/licenses/lgpl-3.0"><img src="https://img.shields.io/badge/license-GNU%20LGPL%20v3.0-blue.svg" /></a>
               <a href="https://github.com/WeBankFinTech/WeIdentity"><img src="https://sloc.xyz/github/WeBankFinTech/WeIdentity" /></a>
            </td>
         </tr>
      </table>
      <br />
    </embed>

Diving in
----------------

Now, please feel free to dive in via \ `this page <https://weidentity.readthedocs.io/zh_CN/latest/docs/one-stop-experience.html>`_ for a one-stop experience of WeIdentity.



Contributions
---------------

You can find all our contributors in \ `this page <./ALLCONTRIBUTOR.md>`_ . Thanks for everything these guys have done for WeIdentity!


Contact Us
----------

Email：weidentity@webank.com