Skip to content

Rep Profile

Description

A Rep Profile allows a representative voter to publish information about themselves to help explain who they are and why someone should consider delegating to them.

It is an extension of all other profiles attached to the same Catalyst ID.

Profiles themselves are intentionally general, however they may be linked to a brand via the template used by the profile.

The payload of a profile is controlled by its template.

Rep ProfileRep Profile Document    Relationshipscluster_system_parametersSystem ParametersRep Profile Form Template                         Rep Profile Form Template                    Rep Profile                         Rep Profile                    content typeapplication/jsontype0f2c86a2-ffda-40b0-ad38-23709e1c10b394579df1-a6dc-433b-a8e8-910c5dc2f0e3idDocument IdverDocument VertemplateRep Profile Form TemplaterevocationsVersion RevocationsparametersBrand ParametersRep Profile:e->Rep Profile Form Template:w1*Brand Parameters                             Brand Parameters                        Rep Profile:e->Brand Parameters1*Rep Nomination                         Rep Nomination                    Rep Nomination:e->Rep Profile:w1*

Validation

  • The signer MUST be a registered 'Representative'.
  • The payload MUST be valid against the JSON schema defined in the referenced 'Rep Profile Template'.

Business Logic

Front End

  • Display and allow editing of the Representative's core profile fields.
  • This profile serves as the central hub for a Representative's public identity.

Back End

  • Validate Representative profile data against the referenced 'Rep Profile Template' and store/index it.
  • This global profile is the foundational document referenced by all of the Rep's contest specific profiles.

COSE Header Parameters

Metadata

type

Parameter Value
Required yes
Format Document Type
Type 0f2c86a2-ffda-40b0-ad38-23709e1c10b3,
94579df1-a6dc-433b-a8e8-910c5dc2f0e3

The document TYPE.

type Validation

MUST be a known document type.

id

Parameter Value
Required yes
Format Document Id

Document ID, created the first time the document is created. This must be a properly created UUIDv7 which contains the timestamp of when the document was created.

id Validation

IF ver does not == id then a document with id and ver being equal MUST exist.

ver

Parameter Value
Required yes
Format Document Ver

The unique version of the document. The first version of the document must set ver == id

ver represents new versions of the same document as it changes over time.

ver Validation

The document version must always be >= the document ID.

template

Parameter Value
Required yes
Format Document Reference
Valid References Rep Profile Form Template

Reference to the template used to create and/or validate this document.

template Validation

In addition to the validation performed for Document Reference type fields, The document payload is not valid if it does not validate completely against the referenced template.

revocations

Parameter Value
Required optional
Format Version Revocations

A document may include a list of any prior versions which are considered to be revoked. Only the revocation list in the latest version of the document applies. Revoked documents are flagged as no longer valid, and should not be displayed. As a special case, if the revocations are set to true then all versions of the document are revoked, including the latest document.

In this case, when the latest document is revoked, the payload may be empty. Any older document that has revocations set to true is always to be filtered and its payload is to be assumed to be invalid.

This allows for an entire document and any/all published versions to be revoked. A new version of the document that is published after this, may reinstate prior document versions, by not listing them as revoked. However, any document where revocations was set true can never be reinstated.

revocations Validation

If the field is true the payload may be absent or invalid. Such documents may never be submitted.

parameters

Parameter Value
Required yes
Format Document Reference
Valid References Brand Parameters
Linked Reference Metadata template

A reference to the Parameters Document this document lies under.

parameters Validation

In addition to the validation performed for Document Reference type fields:

  • Any linked referenced document that includes a parameters metadata must match the parameters of the referencing document, or a parent of those parameters.

For example, a linked reference to Contest Parameters is transitively a reference to the Parameters document it references, and each parameters document they reference until the Brand parameters document is reached.

The use case here is for Templates. The profile template, or proposal templates could be defined at any of these levels, and as long as they all refer to the same chain of parameters in the hierarchy they are all valid.

Payload

The Representative profile payload contains all Representative-specific fields. Its structure is defined by the referenced Rep Profile Template.

Must be valid according to the schema contained within the Document Reference from the template metadata.

Signers

The following User roles may sign documents of this type:

  • Representative

New versions of this document may be published by:

  • author
Copyright © 2024-2025 IOG Singapore, All Rights Reserved
License This document is licensed under CC-BY-4.0
Created 2024-12-27
Modified 2025-06-19
Authors Alex Pozhylenkov alex.pozhylenkov@iohk.io
Neil McAuliffe neil.mcauliffe@iohk.io
Steven Johnson steven.johnson@iohk.io

Changelog

0.01 (2025-06-19)

  • First Published Version