Enum CredentialType 

pub enum CredentialType {
    Orb,
    Document,
    SecureDocument,
    Device,
}

A CredentialType represents a specific credential which can be presented by a World ID holder.

For example, if a World ID is Orb-verified, the holder can use their Orb credential to prove they have a valid Orb-verified credential.

More details in https://docs.world.org/world-id/concepts#proof-of-personhood

Variants

Orb

Represents persons who have been biometrically verified at an Orb. Highest level of proof of personhood verification.

Document

Verified biometric ICAO-9303 government-issued document holder

SecureDocument

Verified biometric ICAO-9303 government-issued document holder with additional presence checks such as Chip Authentication or Active Authentication.

The identity trapdoor is secure_passport but it’s serialized as secure_document to match idkit-js and the Developer Portal. Reference: https://github.com/worldcoin/idkit-js/blob/main/packages/core/src/types/config.ts#L18

Device

Represents a semi-unique device

Implementations

impl CredentialType

pub const fn as_identity_trapdoor(&self) -> &[u8]

Returns a predefined seed string which is used to derive the identity commitment.

Protocol Reference.

For usage reference, review sempahore-rs.

• For Orb, it’s a fixed legacy default value. Changing this default would break existing verifying apps, hence its explicit specification here.
• Document (NFC-based check on government-issued document)
• SecureDocument (NFC-based check on government-issued document with additional presence checks)

pub const fn get_sign_up_sequencer_host( &self, environment: &Environment, ) -> &str

Returns the host name for the relevant sign up sequencer to use. The sign up sequencer is used to fetch Merkle inclusion proofs.

Reference

Future

• Support custom sign up sequencer hosts

Trait Implementations

impl Clone for CredentialType

fn clone(&self) -> CredentialType

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CredentialType

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CredentialType

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CredentialType

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl FromStr for CredentialType

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<CredentialType, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for CredentialType

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CredentialType

fn eq(&self, other: &CredentialType) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CredentialType

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for CredentialType

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<CredentialType, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl Copy for CredentialType

impl Eq for CredentialType

impl StructuralPartialEq for CredentialType