modules_claims.md

Module: modules/claims

Table of contents

Enumerations

• ClaimEventType
• RegistrationTypes

Classes

• ClaimsService

Interfaces

• ApproveRolePublishingOptions
• Claim
• CreateClaimRequestOptions
• CreateSelfSignedClaimOptions
• DeleteClaimOptions
• GetClaimsByIssuerOptions
• GetClaimsByRequesterOptions
• GetClaimsBySubjectOptions
• GetUserClaimsOptions
• IClaimIssuance
• IClaimRejection
• IClaimRequest
• IssueClaimOptions
• IssueClaimRequestOptions
• IssueVerifiablePresentationOptions
• PublishPublicClaimOptions
• RegisterOnchainOptions
• RejectClaimRequestOptions
• VerifyEnrolmentPrerequisitesOptions

Type aliases

• IssueClaim
• RejectClaim
• RequestClaim

Variables

• agreement_type_hash
• defaultClaimExpiry
• erc712_type_hash
• proof_type_hash
• typedMsgPrefix

Functions

• readyToBeRegisteredOnchain

Type aliases

IssueClaim

Ƭ IssueClaim: Object

Type declaration

Name	Type
issuer	string
message	IClaimIssuance

---

RejectClaim

Ƭ RejectClaim: Object

Type declaration

Name	Type
issuer	string
message	IClaimRejection

---

RequestClaim

Ƭ RequestClaim: Object

Type declaration

Name	Type
message	IClaimRequest
requester	string

Variables

agreement_type_hash

• Const agreement_type_hash: string

---

defaultClaimExpiry

• Const defaultClaimExpiry: number

---

erc712_type_hash

• Const erc712_type_hash: string

---

proof_type_hash

• Const proof_type_hash: string

---

typedMsgPrefix

• Const typedMsgPrefix: "1901"

Functions

readyToBeRegisteredOnchain

▸ readyToBeRegisteredOnchain(claim): claim is Required<Pick<Claim, "claimTypeVersion" | "claimType" | "subject" | "onChainProof" | "acceptedBy" | "subjectAgreement">>

Parameters

Name	Type
claim	unknown

Returns

claim is Required<Pick<Claim, "claimTypeVersion" | "claimType" | "subject" | "onChainProof" | "acceptedBy" | "subjectAgreement">>