{"id":24676456,"url":"https://github.com/masa-finance/masa-identity-protocol","last_synced_at":"2025-10-08T09:32:02.764Z","repository":{"id":115710193,"uuid":"514289615","full_name":"masa-finance/masa-identity-protocol","owner":"masa-finance","description":"Masa, the premiere web3 identity and credit protocol. Be the first to build soulbound tokens in web3.","archived":false,"fork":false,"pushed_at":"2024-05-07T15:06:04.000Z","size":1479,"stargazers_count":133,"open_issues_count":0,"forks_count":4,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-01-26T12:15:00.457Z","etag":null,"topics":["documentation","markdown","protocol"],"latest_commit_sha":null,"homepage":"https://masa.finance","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/masa-finance.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-07-15T14:00:28.000Z","updated_at":"2025-01-10T12:41:17.000Z","dependencies_parsed_at":null,"dependency_job_id":"ffd951df-b020-4ae9-a740-75571c6a616e","html_url":"https://github.com/masa-finance/masa-identity-protocol","commit_stats":null,"previous_names":["masa-finance/masa-identity-protocol"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/masa-finance%2Fmasa-identity-protocol","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/masa-finance%2Fmasa-identity-protocol/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/masa-finance%2Fmasa-identity-protocol/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/masa-finance%2Fmasa-identity-protocol/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/masa-finance","download_url":"https://codeload.github.com/masa-finance/masa-identity-protocol/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235700101,"owners_count":19031671,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","markdown","protocol"],"created_at":"2025-01-26T12:15:05.540Z","updated_at":"2025-10-08T09:31:57.437Z","avatar_url":"https://github.com/masa-finance.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Masa Protocol\n\nMasa, the premiere web3 identity and credit protocol. Be the first to build soulbound tokens in web3.\n\n\u003c!-- TOC --\u003e\n* [Masa Protocol](#masa-protocol)\n  * [Introduction](#introduction)\n  * [Masa soulbound Identity](#masa-soulbound-identity)\n  * [Masa soulbound Credit Score](#masa-soulbound-credit-score)\n  * [Masa Soul Names](#masa-soul-names)\n* [Masa Metadata API](#masa-metadata-api)\n  * [Soulbound Identity](#soulbound-identity)\n    * [Metadata base URI](#metadata-base-uri)\n    * [**JSON Schema**](#json-schema)\n  * [Soulbound Credit Score](#soulbound-credit-score)\n    * [Metadata base URI](#metadata-base-uri-1)\n    * [**JSON Schema**](#json-schema-1)\n* [Relevant Repositories](#relevant-repositories)\n  * [Frontends](#frontends)\n  * [Libraries](#libraries)\n  * [Backend \u0026 Contracts](#backend--contracts)\n  * [Blockchain](#blockchain)\n  * [Relevant Links](#relevant-links)\n    * [Soulbound Identity](#soulbound-identity-1)\n    * [Additional Resources](#additional-resources)\n\u003c!-- TOC --\u003e\n\n## Introduction\n\nIn 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.\n\n## Masa soulbound Identity\n\nThe 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:\n\n## Masa soulbound Credit Score\n\nThe 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](https://developers.masa.finance/docs/supported-countries)):\n\n- Credit Bureau Data\n- Bank Transaction Data\n- Mobile Money Data\n- On-chain Data\n- Centralized Exchange Data\n\n## Masa Soul Names\n\nMasa 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.\n\n# Masa Metadata API\n\nMasa’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.\n\n## Soulbound Identity\n\n### Metadata base URI\n\n`https://metadata.masa.finance/v1.0/identity/`\n\n### **JSON Schema**\n\nA unique JSON schema is created for each user with the following format. Details can be found [here](https://developers.masa.finance/docs/developers/sdk/interfaces/IIdentity)\n\n`GET https://metadata.masa.finance/v1.0/identity/{id}.json`\n\nWhere `{id}` is a unique 77 character ID that is numeric characters only\n\nFrom: `0`  \nTo: `99999999999999999999999999999999999999999999999999999999999999999999999999999`\n\nPublic Request `GET https://metadata.masa.finance/v1.0/identity/17012826615246396599027510140925.json`:\n\nResponse:\n\n```json\n{\n  \"name\": \"Masa Soulbound Identity v1.0.0\",\n  \"description\": \"A self-sovereign identity for accessing DeFi\",\n  \"image\": \"https://metadata.masa.finance/v1.0/identity/masa-identity.png\",\n  \"properties\": {\n    \"tokenId\": \"17012826615246396599027510140925\",\n    \"account\": \"0xd5Dc7fdb68f365901Fc86E6A32f3a5d35022dC84\",\n    \"soulName\": \"alice\"\n  }\n}\n```\n\nGated Request `GET https://metadata.masa.finance/v1.0/identity/17012826615246396599027510140925.json` while being logged in to the Masa Infrastructure:\n\n```json\n{\n  \"headers\": {\n    \"cookie\": \"sid=s:\u003csession id\u003e;\"\n  }\n}\n```\n\nResponse:\n\n```json\n{\n  \"name\": \"Masa Soulbound Identity v1.0.0\",\n  \"description\": \"A self-sovereign identity for accessing DeFi\",\n  \"image\": \"https://metadata.masa.finance/v1.0/identity/masa-identity.png\",\n  \"properties\": {\n    \"tokenId\": \"17012826615246396599027510140925\",\n    \"account\": \"0xd5Dc7fdb68f365901Fc86E6A32f3a5d35022dC84\",\n    \"soulName\": \"alice\"\n  }\n}\n```\n\n## Soulbound Credit Score\n\n### Metadata base URI\n\n`https://metadata.masa.finance/v1.0/credit-score/`\n\n### **JSON Schema**\n\nA unique JSON schema is created for each user with the following format. Details can be found [here](https://developers.masa.finance/docs/developers/sdk/interfaces/ICreditScore)\n\n`GET https://metadata.masa.finance/v1.0/credit-score/{id}.json`\n\nWhere `{id}` is a unique 77 character ID that is numeric characters only\n\nFrom: `0`  \nTo: `99999999999999999999999999999999999999999999999999999999999999999999999999999`\n\nPublic Request `GET https://metadata.masa.finance/v1.0/credit-score/23334135456782334234234234.json`:\n\nResponse:\n\n```json\n{\n  \"name\": \"Masa Soulbound Credit Score v1.0.0\",\n  \"description\": \"A decentralized credit score\",\n  \"image\": \"https://metadata.masa.finance/v1.0/identity/credit-score.png\",\n  \"properties\": {\n    \"tokenId\": \"23334135456782334234234234\",\n    \"account\": \"0x418c9210D7EECa2C6e65830130f2d648D3d455A1\"\n  }\n}\n```\n\nGated Request `GET https://metadata.masa.finance/v1.0/credit-score/23334135456782334234234234.json` while being logged in to the Masa Infrastructure:\n\n```json\n{\n  \"headers\": {\n    \"cookie\": \"sid=s:\u003csession id\u003e;\"\n  }\n}\n```\n\nResponse:\n\n```json\n{\n  \"name\": \"Masa Soulbound Credit Score v1.0.0\",\n  \"description\": \"A decentralized credit score\",\n  \"image\": \"https://metadata.masa.finance/v1.0/identity/credit-score.png\",\n  \"properties\": {\n    \"tokenId\": \"23334135456782334234234234\",\n    \"account\": \"0x418c9210D7EECa2C6e65830130f2d648D3d455A1\",\n    \"lastUpdated\": \"2022-10-07T18:13:34.955924172Z\",\n    \"model_version\": \"nebula_1.0.0\",\n    \"value\": 744,\n    \"decile\": \"2.00\",\n    \"value_rating\": \"Fair\"\n  }\n}\n```\n\n# Relevant Repositories\n\n## Frontends\n\n- [Soulbound Token App](https://github.com/masa-finance/masa-sbt)\n  | [Changelog](https://github.com/masa-finance/masa-sbt/blob/dev/CHANGELOG.md)\n- [Web App](https://github.com/masa-finance/masa-web-app)\n  | [Changelog](https://github.com/masa-finance/masa-web-app/blob/dev/CHANGELOG.md)\n- [Mobile App](https://github.com/masa-finance/masa-mobile-app)\n  | [Changelog](https://github.com/masa-finance/masa-mobile-app/blob/main/CHANGELOG.md)\n- [Contracts Dashboard](https://github.com/masa-finance/contract-stats)\n  | [Changelog](https://github.com/masa-finance/contract-stats/blob/master/CHANGELOG.md)\n\n## Libraries\n\n- [SDK](https://github.com/masa-finance/masa-sdk)\n  | [Changelog](https://github.com/masa-finance/masa-sdk/blob/main/CHANGELOG.md)\n- [Masa React](https://github.com/masa-finance/masa-react)\n  | [Changelog](https://github.com/masa-finance/masa-react/blob/master/CHANGELOG.md)\n- [Masa Express](https://github.com/masa-finance/masa-express)\n  | [Changelog](https://github.com/masa-finance/masa-express/blob/master/CHANGELOG.md)\n\n## Backend \u0026 Contracts\n\n- [API Middleware](https://github.com/masa-finance/masa-api-middleware)\n  | [Changelog](https://github.com/masa-finance/masa-api-middleware/blob/dev/CHANGELOG.md)\n- [Lending Contracts](https://github.com/masa-finance/masa-contracts-lending)\n  | [Changelog](https://github.com/masa-finance/masa-contracts-lending/blob/master/CHANGELOG.md)\n- [Identity Contracts](https://github.com/masa-finance/masa-contracts-identity)\n  | [Changelog](https://github.com/masa-finance/masa-contracts-identity/blob/main/CHANGELOG.md)\n\n## Blockchain\n\n- [Node](https://github.com/masa-finance/masa-node-v1.0) | [Changelog]\n- [Node UI](https://github.com/masa-finance/node-ui) | [Changelog]\n- [Node Cluster](https://github.com/masa-finance/masa-node-cluster) | [Changelog]\n\n## Relevant Links\n\n### Soulbound Identity\n\n- [Masa Soulbound Tokens App - Production](http://app.masa.finance)\n- [Masa Soulbound Tokens App - Staging](http://testnet.app.masa.finance)\n- [Masa Soulbound Tokens App - Test](http://test.app.masa.finance)\n- [Masa Soulbound Tokens App - Dev](https://dev.app.masa.finance/)\n\n### Additional Resources\n\n- [Soulbound Identity](https://github.com/masa-finance/masa-contracts-identity/blob/main/docs/SoulboundIdentity.md)\n- [Soulbound Credit Score](https://github.com/masa-finance/masa-contracts-identity/blob/main/docs/SoulboundCreditScore.md)\n- [Soul Name](https://github.com/masa-finance/masa-contracts-identity/blob/main/docs/SoulName.md)\n- [Soul Linker](https://github.com/masa-finance/masa-contracts-identity/blob/main/docs/SoulLinker.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmasa-finance%2Fmasa-identity-protocol","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmasa-finance%2Fmasa-identity-protocol","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmasa-finance%2Fmasa-identity-protocol/lists"}