Skip to main content

Metadata Schema

Soulbound Identity​

Endpoint: https://metadata.masa.finance/v1.0/identity/<TokenId>.json

See here for a sample and here for an authenticated example

interface IIdentity {
  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: string;
    account?: string;
    soulName?: string;
  };
}

Creation Process​

Soulbound Identity Creation Process

Soulbound Credit Report​

Endpoint: https://metadata.masa.finance/v1.0/credit-report/<TokenId>.json

See here for a sample and here for an authenticated example

interface ICreditReport {
  name: "Masa Soulbound Credit Report v1.0.0";
  description: "A decentralized credit report";
  image: "https://metadata.masa.finance/v1.0/identity/credit-report.png";
  properties: {
    tokenId: string;
    account?: string;
    lastUpdated?: string;
    model_version?: string;
    value?: number;
    decile?: string;
    value_rating?: string;
  };
}

Creation Process​

Soulbound Credit Report Creation Process

Soulbound 2FA​

Endpoint: https://metadata.masa.finance/v1.0/2fa/<TokenId>.json

See [here] for a sample and [here] for an authenticated example

interface I2fa {
  name: "Masa Soulbound 2FA v1.0.0";
  description: "A decentralized 2fa";
  image: "https://metadata.masa.finance/v1.0/2fa/2fa.png";
  properties: {
    tokenId: string;
    account?: string;
  };
}

Creation Process​

Soulbound 2fa Creation Process

Soul Names​

The metadata for the Soul Name contract can be found here

Endpoint: ar://<arweave id>

See here for a sample

interface Attribute {
  display_type?: string;
  trait_type: string;
  value: number | string;
}

interface ISoulName {
  description: "This is a soul name!";
  external_url: "https://beta.claimyoursoul.masa.finance";
  image: string;
  name: string;
  attributes: Attribute[];
}

Creation Process​

Soul Name Creation Process