Identity Schema

The Json Schema contains the Identity information to get a validated identity.

⚠️

Keys cannot start with $, except schema. Example: { $schema: "http://myschema.com", name:'my name', $ref:'my internalref '}.

Overview

Parameter	Optional	Displayed in wallet	Description
$schema	Required	Not applicable	Content file
name	Required	✅	Brand name
companyName	Required	❌	The company name which owns the brand
parentCompanyName	Optional	❌	Name of the Company who owns a company that owns the brand
description	Optional	✅	Description of the brand
externalContents	Optional	✅	Storing of links to external contents
i18n	Optional	✅	Localize content for extra languages
arianeeMembership	Required	❌	If the brand is a member of the Arianee Association
contacts	Optional	❌	Brand contact list
address	Required	❌	Brand address
pictures	Optional	✅	Pictures to illustrate the brand identity
socialmedia	Optional	✅	Brand social media
providers	Optional	❌	Brand providers
rpcEndpoint	Required	Not applicable	RPC endpoint URL

Schema body

Schema file content

$Schema - URL of the Schema json file.

JSON SNIPPET

{
    "$schema": "https://cert.arianee.org/version1/ArianeeBrandIdentity-i18n.json",
...

JSON SCHEMA

{
    "$id": "https://cert.arianee.org/version1/ArianeeBrandIdentity-i18n.json",
    "$schema": "https://cert.arianee.org/version1/ArianeeBrandIdentity-i18n.json",
    "title": "Arianee Brand Identity",
    "description": "Describing an Arianee Brand Identity.",
    "type": "object",
    "properties": {
      "$schema": {
        "title": "$schema",
        "type": "string",
        "default": "https://cert.arianee.org/version1/ArianeeBrandIdentity-i18n.json",
        "widget": "hidden"
      },
...  

---

Identity name

name - Brand name. First information displayed on the wallet app.

JSON SNIPPET

...
    "name":"Arianee",
...

JSON SCHEMA

...
      "name": {
        "type": "string",
        "title": "Brand Name",
        "description": "Name of the Brand.\n Likely to be one of the first things displayed on a wallet app."
      },
...  

---

Identity Company name

companyName - Name of the company which owns the brand.

JSON SNIPPET

...
    "companyName":"Arianee",
...

JSON SCHEMA

...
      "companyName": {
        "type": "string",
        "title": "Company Name",
        "description": "Name of the Company who owns the Brand."
      },
...  

---

Identity Parent Company name

parentCompanyName - Name of the company that owns the company who owns the brand.

📌

Information used for groups with multiple companies.

JSON SNIPPET

...
    "parentCompanyName":"Arianee",
...

JSON SCHEMA

...
      "parentCompanyName": {
        "type": "string",
        "title": "Parent Company Name",
        "description": "Name of the Company who owns the Company who owns the Brand. \n Used for Groups with multiple Companies."
      },
...  

---

Identity Description

description - Description of the brand and the company.

💡

• HTML format is supported.
• Multi-languages are supported.

JSON SNIPPET

...
    "description":"<b>The Digital Identity Consortium</b><br/>\nConsumption behaviors are changing, new generations have a digital life of their own and the demand for data privacy is increasing.\nWhat if brands could propose a modern way of owning their creations? What if, thanks to technology, we could augment the ownership of goods?\n\nAt Arianee we are building perpetual relationships between brands and owners, made of trust, respect and transparency.\n\nWith the Arianee protocol, ownership is augmented and groundbreaking features are added to the most valuable items.",
...

JSON SCHEMA

...
      "description": {
        "type": "string",
        "title": "Description",
        "description": "Description of the Brand / Company. (HTML Accepted)\n A description can be stored for each language",
        "widget": {
          "id": "textarea"
        }
      },
...  

---

External Contents

externalContents - External content links storing that the brand wishes to introduce to the NFTs owners.

💡

Multi-languages are supported. Complete the i18n parameter.

JSON SNIPPET

...
    "externalContents":[
 
    ],
...

JSON SCHEMA

      "externalContents": {
        "type": "array",
        "title": "External Contents",
        "description": "This field is designed to store the links to external contents the Brand whish to introduce to the end customer in a wallet app at the Brand level.\n Specific external contents can be stored for each language.",
        "items": {
          "type": "object",
          "properties": {
            "type": {
              "title": "Type",
              "type": "string",
              "widget": {
                "id": "select"
              },
              "oneOf": [
                    {"enum": ["website"], "title":"Website (main)", "description": "Website (main)"},
                    {"enum": ["eshop"], "title":"Eshop", "description": "Eshop"},
                    {"enum": ["label"], "title":"Label", "description": "official label supported by the Brand and its products"},
                    {"enum": ["iosScheme"], "title":"iosScheme", "description": "iosScheme"},
                    {"enum": ["androidScheme"], "title":"androidScheme", "description": "androidScheme"},
                    {"enum": ["other"], "title":"other", "description": "other"},
                    {"enum": ["deepLinkDomain"], "title":"Domain to use for deeplink", "description": "Domain to use for deeplink"},
                    {"enum": ["hostedWallet"], "title":"HostedWallet", "description": "custodial wallet's url"}
              ]
            },
            "title": {
              "type": "string",
              "title": "Title",
              "widget": {
                "id": "string"
              }
            },
            "url": {
              "type": "string",
              "title": "Url",
              "widget": {
                "id": "string"
              }
            },
            "order": {
              "type": "number",
              "title": "Order (number)"
            }
          }
        }
      },

---

Localize contents

i18n - Description of the brand and company in extra languages.

📌

HTML format is allowed.

JSON SNIPPET

...
    "i18n":[
 
    ],
...

JSON SCHEMA

...

      "i18n": {
        "type": "array",
        "title": "Other languages :  description / external contents",
        "description": "Description of the Brand / Company in languages different than the default one. (HTML Accepted)",

        "items": {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "title": "Language",
              "widget": {
                "id": "select"
              },
              "oneOf": [
                    {"enum": ["fr-FR"], "title":"French", "description": "French"},
                    {"enum": ["en-US"], "title":"English (american)", "description": "English (american)"},
                    {"enum": ["zh-TW"], "title":"Traditional chinese", "description": "Traditional chinese"},
                    {"enum": ["zh-CN"], "title":"Simplified chinese", "description": "Simplified chinese"},
                    {"enum": ["ko-KR"], "title":"Korean", "description": "Korean"},
                    {"enum": ["ja-JP"], "title":"Japanese", "description": "Japanese"},
                    {"enum": ["de_DE"], "title":"German", "description": "German"}
              ]
            },
            "description": {
              "type": "string",
              "title": "Description",
              "widget": {
                "id": "textarea"
              }
            },

            "externalContents": {
              "type": "array",
              "title": "External Contents",
              "description": "Tanslation or specific links to external contents the Brand whish to introduce to the end customer in a wallet app at the Brand level and in languages different than the default one.",
              "items": {
                "type": "object",
                "properties": {
                  "type": {
                    "title": "Type",
                    "type": "string",
                    "widget": {
                      "id": "select"
                    },
                    "oneOf": [
                          {"enum": ["website"], "title":"Website (main)", "description": "Website (main)"},
                          {"enum": ["eshop"], "title":"Eshop", "description": "Eshop"},
                          {"enum": ["label"], "title":"Label", "description": "label"},
                          {"enum": ["iosScheme"], "title":"iosScheme", "description": "iosScheme"},
                          {"enum": ["androidScheme"], "title":"androidScheme", "description": "androidScheme"},
                          {"enum": ["other"], "title":"other", "description": "other"}
                      ]
                  },
                  "title": {
                    "type": "string",
                    "title": "Title",
                    "widget": {
                      "id": "string"
                    }
                  },
                  "url": {
                    "type": "string",
                    "title": "Url",
                    "widget": {
                      "id": "string"
                    },
                  "order": {
                    "type": "number",
                    "title": "Order (number)"
                    }
                  }
                }
              }
            }
          }
        }
      },

...  

---

Membership status

arianeeMembership - When a brand or company is a member of the Arianee Association.

JSON SNIPPET

...
    "arianeeMembership":"associate_member",
...

JSON SCHEMA

...
      "arianeeMembership": {
        "type": "string",
        "title": "Arianee Member",
        "description": "Is the Company a member of the Arianee project ?",
        "widget": {
          "id": "select"
        },
        "oneOf": [
              {"enum": ["not_member"], "title":"Not member", "description": "Not member"},
              {"enum": ["associate_member"], "title":"Associate Member", "description": "Associate Member"},
              {"enum": ["group_member"], "title":"Group member", "description": "Group member"},
              {"enum": ["maison_member"], "title":"Maison member", "description": "Maison member"}

          ]
      },
...  

---

Identity address

address - Brand or company address.

JSON SNIPPET

...
    "address":{
       "street_address":"120 rue Réaumur",
       "zipcode":"75002",
       "city":"Paris",
       "country":"France"
    },
...

JSON SCHEMA

...
      "address": {
        "type": "object",
        "title": "Address",
        "description": "Company HQ address",

        "properties": {
          "street_address": {
            "type": "string",
            "title": "Street Address"
          },
          "street_address2": {
            "type": "string",
            "title": "Street Address 2"
          },
          "zipcode": {
            "type": "string",
            "title": "Zip Code"
          },
          "city": {
            "type": "string",
            "title": "City"
          },
          "state": {
            "type": "string",
            "title": "State"
          },
          "country": {
            "type": "string",
            "title": "Country"
          }
        }
      },
...  

---

Brand contact list

contacts - Brand or company contact list.

JSON SNIPPET

...
    "contacts":[
 
    ],
...

JSON SCHEMA

...
      "contacts": {
        "description": "List of company contacts",
        "type": "array",
        "title": "Contacts",
        "items": {
          "title": "Contacts",
          "type": "object",
          "properties": {
            "name": {
              "title": "Name",
              "type": "string"
            },
            "email": {
              "title": "Email",
              "type": "string"
            },
            "title": {
              "title": "Title",
              "type": "string"
            },
            "type": {
              "title": "Type",
              "type": "string",
              "widget": {
                "id": "select"
              },
              "oneOf": [
                    {"enum": ["support"], "title":"Support", "description": "Customer Support"},
                    {"enum": ["sales"], "title":"Sales", "description": "Sales team"},
                    {"enum": ["hq"], "title":"Headquarter", "description": "Headquarter"},
                    {"enum": ["other"], "title":"other", "description": "other"}

                ]
            }
          }
        }
      },
...  

---

Picture

pictures - Pictures and medias used to support the presentation of the brand and its products in the owner's wallet.

JSON SNIPPET

...
    "pictures":[
       {
          "type":"brandLogoHeader",
          "url":"https://theseus.arianee.org/pub/-LvRQM23uL73ArIyshF0"
       },
       {
          "type":"brandLogoHeaderReversed",
          "url":"https://theseus.arianee.org/pub/-LvRRVI126tywVNOHdOM"
       },
       {
          "type":"brandLogoSquare",
          "url":"https://theseus.arianee.org/pub/-M0vj64EKf288-E08H_K_arianeeResized"
       },
       {
          "type":"brandHomePicture",
          "url":"https://theseus.arianee.org/pub/-LvRQkAOVY9XBrQIR_TZ"
       },
       {
          "type":"brandItemBackgroundPicture",
          "url":"https://theseus.arianee.org/pub/-LvRQrmb_IvXRTKdkYx5"
       },
       {
          "type":"itemBackgroundPicture",
          "url":"https://theseus.arianee.org/pub/-Lvk4MBEz5KjmE95dr9n"
       },
       {
          "type":"brandBackgroundPicture",
          "url":"https://theseus.arianee.org/pub/-M0vhSQcadtYDapY8qdb_arianeeResized"
       },
       {
          "type":"certificateBackgroundPicture",
          "url":"https://theseus.arianee.org/pub/-LvRRHXoEBb_l89d1YdW"
       }
    ],
...

JSON SCHEMA

...

      "pictures": {
        "type": "array",
        "title": "Pictures & Medias",
        "description": "Pictures & Medias used to support the presentation of the Brand and products in the wallet app.",
        "items": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "title": "Type",
              "widget": {
                "id": "select"
              },
              "oneOf": [
                    {"enum": ["brandLogoHeader"], "title":"Brand Logo Header (2000x700) transparent (working with a white background) PNG", "description": "Brand Logo Header (2000x700) transparent (working with a white background) PNG"},
                    {"enum": ["brandLogoHeaderReversed"], "title":"Brand Logo Header (2000x700) transparent (working with a black background) PNG", "description": "Brand Logo Header (2000x700) transparent (working with a black background) PNG"},
                    {"enum": ["brandLogoSquare"], "title":"Brand Logo Square (1000x1000) no transparency", "description": "Brand Logo Square (1000x1000) no transparency"},
                    {"enum": ["brandHomePicture"], "title":"Brand Collection Picture (3200x1900) ratioed", "description": "Brand Collection Picture (3200x1900) ratioed"},
                    {"enum": ["brandItemBackgroundPicture"], "title":"Brand Item Background Picture (3200x1900) ratioed", "description": "Brand Item Background Picture (3200x1900) ratioed"},
                    {"enum": ["itemBackgroundPicture"], "title": "Item Background Picture (3000x3000) ratioed", "description": "Item Background Picture (3000x3000) ratioed"},
                    {"enum": ["brandBackgroundPicture"], "title":"Brand Background picture (1900x3200) preferably dark", "description": "Brand Background picture (1900x3200) preferably dark"},
                    {"enum": ["certificateBackgroundPicture"], "title":"Certificate Background Picture (1900x3200 TBD) preferably dark", "description": "Certificate Background Picture (1900x3200 TBD) preferably dark - with logo on top"}


                ]
            },
            "url": {
              "type": "string",
              "title": "URL",
              "widget": {
                "id": "staticAssets"
              }
            },
            "hash": {
              "type": "string",
              "title": "Image Hash",
              "widget": {
                "id": "string"
              }
            }
          }
        }
      },
...  

---

Social media list

socialmedia - Links storing of the brand's social media.

JSON SNIPPET

...
    "socialmedia":[
       {
          "type":"facebook",
          "value":"208072396631649"
       },
       {
          "type":"twitter",
          "value":"arianeeproject"
       },
       {
          "type":"youtube",
          "value":"UCE2QoVA3Fx29NM-lG6T52oQ"
       }
    ],
...

JSON SCHEMA

...
      "socialmedia": {
        "type": "array",
        "title": "Social Media",
        "description": "Links to most popular Social Media.",
        "items": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "title": "Type",
              "widget": {
                "id": "select"
              },
              "oneOf": [
                    {"enum": ["facebook"], "title":"Facebook", "description": "Facebook"},
                    {"enum": ["instagram"], "title":"Instagram", "description": "Instagram"},
                    {"enum": ["twitter"], "title":"Twitter", "description": "Twitter"},
                    {"enum": ["youtube"], "title":"Youtube", "description": "Youtube"}

                ]
            },
            "value": {
              "type": "string",
              "title": "Value",
              "widget": {
                "id": "string"
              }
            }
          }
        }
      },
...  

---

Providers

providers - External brand's providers.

JSON SNIPPET

...
	"providers": {
        "title": "Providers",
        "description": "Define external providers approved by the brand."
    },
...

JSON SCHEMA

...
	"providers": {
        "type": "array",
        "title": "Providers",
        "description": "Define external providers approved by the brand.",
        "items": {
          "type": "object",
          "properties": {
            "type": {
              "title": "Type",
              "type": "string",
              "widget": {
                "id": "select"
              },
              "oneOf": [
                    {"enum": ["missing"], "title":"Provider for missing/stolen process", "description": "Provider for missing/stolen process"},
                    {"enum": ["custodialWallet"], "title":"Custodial Wallet Landing Page", "description": "website where user lands when exporting mnemonic to brand. Address is pub key of to encrypt mnemonic"}
              ]
            },
            "address": {
              "type": "string",
              "title": "Address",
              "widget": {
                "id": "string"
              }
            },
            "url": {
              "type": "string",
              "title": "Url",
              "widget": {
                "id": "string"
              }
            }
          }
        }
      },
...

---

RPC Endpoint

rpcEndpoint - NFT Management Platform RPC URL.

📌

The link must be a JSON RPC end point compatible with Arianee Privacy Gateway.

JSON SNIPPET

...
     "rpcEndpoint":"https://theseus.arianee.org/rpc"
...

JSON SCHEMA

...
      "rpcEndpoint": {
        "type": "string",
        "title": "RPC Endpoint",
        "description": "Certificate Management Platform RPC URL"
      }
...