Skip to content

masa-finance/masa-protocol

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Masa Protocol

Masa, the premiere web3 identity and credit protocol. Be the first to build soulbound tokens in web3.

Introduction

In order to create the first decentralized credit bureau Masa implements a set of soulbound Tokens and non-fungible Tokens (NFTs). The following components are attributed to a users account during each step of the lending lifecycle. Metadata attributed to a soulbound token encrypted and can only be accessed with permission from the owner through the Masa API and Smart Contracts.

Masa soulbound Identity

The Masa Identity is a soulbound Identity Token that is generated for a user when they sign up to the Masa protocol and includes the following information:

Masa soulbound Credit Score

The soulbound Masa Credit Score enables the bridging and aggregation of on and off-chain data in order to create a hybrid decentralized credit score. The Masa credit score can include the following information depending on which region you are located (read a full list of supported countries here):

  • Credit Bureau Data
  • Bank Transaction Data
  • Mobile Money Data
  • On-chain Data
  • Centralized Exchange Data

Masa Soul Names

Masa Soul Names are non-fungible tokens that can be attached to the Masa soulbound identity. They act as a human-readable address for the Masa soulbound identity.

Masa Metadata API

Masa’s soulbound tokens have their metadata stored in the Masa API which is updated in real time with verified data throughout the lifecycle of the user. The Masa API has the following endpoints available with metadata data schema’s for attribution to the soulbound Tokens URI.

Soulbound Identity

Metadata base URI

https://metadata.masa.finance/v1.0/identity/

JSON Schema

A unique JSON schema is created for each user with the following format. Details can be found here

GET https://metadata.masa.finance/v1.0/identity/{id}.json

Where {id} is a unique 77 character ID that is numeric characters only

From: 0
To: 99999999999999999999999999999999999999999999999999999999999999999999999999999

Public Request GET https://metadata.masa.finance/v1.0/identity/17012826615246396599027510140925.json:

Response:

{
  "name": "Masa Soulbound Identity v1.0.0",
  "description": "A self-sovereign identity for accessing DeFi",
  "image": "https://metadata.masa.finance/v1.0/identity/masa-identity.png",
  "properties": {
    "tokenId": "17012826615246396599027510140925",
    "account": "0xd5Dc7fdb68f365901Fc86E6A32f3a5d35022dC84",
    "soulName": "alice"
  }
}

Gated Request GET https://metadata.masa.finance/v1.0/identity/17012826615246396599027510140925.json while being logged in to the Masa Infrastructure:

{
  "headers": {
    "cookie": "sid=s:<session id>;"
  }
}

Response:

{
  "name": "Masa Soulbound Identity v1.0.0",
  "description": "A self-sovereign identity for accessing DeFi",
  "image": "https://metadata.masa.finance/v1.0/identity/masa-identity.png",
  "properties": {
    "tokenId": "17012826615246396599027510140925",
    "account": "0xd5Dc7fdb68f365901Fc86E6A32f3a5d35022dC84",
    "soulName": "alice"
  }
}

Soulbound Credit Score

Metadata base URI

https://metadata.masa.finance/v1.0/credit-score/

JSON Schema

A unique JSON schema is created for each user with the following format. Details can be found here

GET https://metadata.masa.finance/v1.0/credit-score/{id}.json

Where {id} is a unique 77 character ID that is numeric characters only

From: 0
To: 99999999999999999999999999999999999999999999999999999999999999999999999999999

Public Request GET https://metadata.masa.finance/v1.0/credit-score/23334135456782334234234234.json:

Response:

{
  "name": "Masa Soulbound Credit Score v1.0.0",
  "description": "A decentralized credit score",
  "image": "https://metadata.masa.finance/v1.0/identity/credit-score.png",
  "properties": {
    "tokenId": "23334135456782334234234234",
    "account": "0x418c9210D7EECa2C6e65830130f2d648D3d455A1"
  }
}

Gated Request GET https://metadata.masa.finance/v1.0/credit-score/23334135456782334234234234.json while being logged in to the Masa Infrastructure:

{
  "headers": {
    "cookie": "sid=s:<session id>;"
  }
}

Response:

{
  "name": "Masa Soulbound Credit Score v1.0.0",
  "description": "A decentralized credit score",
  "image": "https://metadata.masa.finance/v1.0/identity/credit-score.png",
  "properties": {
    "tokenId": "23334135456782334234234234",
    "account": "0x418c9210D7EECa2C6e65830130f2d648D3d455A1",
    "lastUpdated": "2022-10-07T18:13:34.955924172Z",
    "model_version": "nebula_1.0.0",
    "value": 744,
    "decile": "2.00",
    "value_rating": "Fair"
  }
}

Relevant Repositories

Frontends

Libraries

Backend & Contracts

Blockchain

Relevant Links

Soulbound Identity

Additional Resources

About

Masa, the premiere web3 identity and credit protocol. Be the first to build soulbound tokens in web3.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published