Schemas

A schema is the type of an attestation. It declares what a verification proves — basic identity, accreditation, and so on — so platforms can require exactly the level of assurance an asset needs.

What a schema is

Every attestation references a schema by ID. The schema is a contract about meaning: it tells a reading platform what checks stood behind the proof, without exposing any of the underlying data. When you call POST /kyc/start, you choose the schema the session should produce.

Built-in schemas

Schema IDProvesTypical use
kyc_individual_v1Identity verified for an individual (document + liveness).Retail access, general onboarding.
kyc_accredited_v1Identity verified and accredited-investor status confirmed.Securities and accredited-only offerings.

Versioning

Schema IDs are versioned with a _vN suffix. When verification requirements change, a new version is introduced rather than redefining an existing one. Attestations already written under an older version remain valid and readable — a platform decides which versions it accepts.

Choosing a schema

  • Require the least assurance the asset legally needs — over-collecting is a liability.
  • For accredited or restricted offerings, require kyc_accredited_v1; a basic attestation will not satisfy the rule.
  • Set the asset's required schema to match, so enforcement is automatic at mint and transfer.

Last updated