Optional
anchorsOptional
attestationThe attestation ID. If you are the owner, you can simply use the attestationId to update the attestation. One of inviteCode or attestationId must be provided.
Optional
attestationThesse are the attestations that are signed. For BBS+ signatures, there can be >1 attestationMessages, and the signer can selectively disclose the attestations. For standard signatures, there is only 1 attestationMessage.
Optional
dataThis is the signature and accompanying details of the attestationMessages. The siganture maintains the integrity of the attestationMessages.
This should match the expected scheme. For example, if the scheme is BBS+, the signature should be a BBS+ signature and signer should be a BBS+ public key.
Optional
descriptionMetadata for the attestation for display purposes. Note this should not contain anything sensitive. It may be displayed to verifiers.
Optional
holdersHolders can use the attestation to prove something about themselves. This is a list of holders that have added this attestation to their profile.
Optional
imageMetadata for the attestation for display purposes. Note this should not contain anything sensitive. It may be displayed to verifiers.
Optional
inviteThe key to add oneself as a holder to the attestation. This is given to the holder themselves. One of inviteCode or attestationId must be provided.
Optional
messageThe message format of the attestationMessages.
Optional
nameMetadata for the attestation for display purposes. Note this should not contain anything sensitive. It may be displayed to verifiers.
Optional
proofProof of issuance is used for BBS+ signatures (scheme = bbs) only. BBS+ signatures are signed with a BBS+ key pair, but you would often want the issuer to be a native address. The prooofOfIssuance establishes a link saying that "I am the issuer of this attestation signed with BBS+ key pair ___".
Fields can be left blank for standard signatures.
Optional
rotateWhether or not to rotate the invite code.
Optional
schemeThe scheme of the attestation. BBS+ signatures are supported and can be used where selective disclosure is a requirement. Otherwise, you can simply use your native blockchain's signature scheme.
Optional
typeThe type of the attestation (e.g. credential).
Blockchain anchors to add to the attestation. These are on-chain transactions that can be used to prove stuff about the attestation, like existence at a certain point in time or to maintain data integrity.