Module VC-Data

VC Data

This repository contains the suggested specification for Verifiable Credential data, referred to as credentialSubject in the VC data model. In general, these schemas are based on schema.org base types such as Person and Organization, with custom extensions for concepts not described by schema.org.

Installation

npm i @onramp/vc-data

OR

yarn add @onramp/vc-data

vc-data

Index

Namespaces

Type Aliases

AMLHitCriteriaV2 AMLHitV1 AMLHitV2 AMLListV1 AMLListV2 AMLOrganizationV1 AMLPersonV1 AMLPersonV2 AMLSearchV1 AMLSearchV2 AccountOrganizationV1 AccountOrganizationV2 AccountPaymentV1 AccountPaymentV2 AccountPersonV1 AccountPersonV2 AccountStatementV1 AccountStatementV2 AccountV1 AccountV2 AccreditationPersonV2 AccreditationV2 AddressCheckV1 AddressCheckV2 AddressOrganizationV1 AddressPersonV1 AddressPersonV2 AdministrativeAreaV2 BankAccountTransactionGroupV1 BankAccountTransactionGroupV2 BankAccountTransactionV1 BankAccountTransactionV2 BillOfLadingV1 CargoReceiptV1 CityV2 CorporationV2 CountryV2 CourtRecordSearchPersonV1 CourtRecordSearchQueryV1 CourtRecordSearchV1 CoverageEV1 CredentialUV1 CredentialV1 CreditOrganizationV2 CreditPersonV2 CreditScorePersonV1 CreditScoreRangeV2 CreditScoreV1 CryptographicWallet DOBPersonV1 DOBPersonV2 EducationPersonV1 EmailOrganizationV1 EmailPersonV1 EmailPersonV2 EmploymentOfferPersonV1 EmploymentOrganizationV1 EmploymentPersonV1 FHIRBundleContainer FHIRBundleEntry FHIRBundleV1 FHIROrganizationV1 FHIRPatientE FHIRResourceList GenderPersonV1 GenderPersonV2 GenericOrgType GeoCoordinates GovernmentOrgV1 GovernmentOrgV2 GovernmentOrganizationV2 IDDocumentClassV2 IDDocumentFaceMatchV1 IDDocumentIssuerV2 IDDocumentMatchV2 IDDocumentPersonV1 IDDocumentPersonV2 IDDocumentRoleV1 IDDocumentRoleV2 IDDocumentV1 IDDocumentV2 IdentityCheckV1 IdentityCheckV2 IdentityPersonV2 ImmunizationV1 IncomeOrganizationV2 IncomePersonV2 LeanEntityV1 MetaOrganizationV1 MetaPersonV1 MonetaryAmountEV1 MonetaryAmountEV1Mixin MonetaryAmountRV1 MonetaryAmountV2 MonetaryFlowV2 MonetaryRangeV2 NameOrganizationV1 NamePersonV1 NamePersonV2 NatIDNumOrganizationV1 NatIDNumPersonV1 NatPropertyValueV1 NationalityRoleV1 NumberOverTimePeriodV2 NumericRangeV2 ObservationV1 OrganizationAccountV1 OrganizationEV1 OrganizationEmployeeRoleEV1 OrganizationV2 OrganizationalCredentialV1 PersonEV1 PersonEmployeeCandidateRoleEV1 PersonEmployeeRoleEV1 PhoneOrganizationV1 PhonePersonV1 PhonePersonV2 PortV1 PossibleCheckVals PossibleMatchVals PostalAddressV2 ProductEV1 PropertyValueV2 ReceivedCredentialRoleV1 SalaryV1 ServiceAccountStatementV1 ServiceAccountStatementV2 ShipmentV1 SpecimenV1 StateV2 TDocumentClassV1 TradelinePayStatusV1 TradelineRemarkV1 TradelineV1 TransferInformationV2 VCAMLOrganizationV1 VCAMLPersonV1 VCAMLPersonV2 VCAMLPersonV2Type VCAccountOrganizationV1 VCAccountPersonV1 VCAccountPersonV2 VCAccountPersonV2Type VCAccreditationPersonV2 VCAccreditationPersonV2Type VCAddressOrganizationV1 VCAddressPersonV1 VCAddressPersonV2 VCAddressPersonV2Type VCBillOfLadingV1 VCCargoReceiptV1 VCCourtRecordSearchPersonV1 VCCreditPersonV2 VCCreditPersonV2Type VCCreditScorePersonV1 VCDOBPersonV1 VCDOBPersonV2 VCDOBPersonV2Type VCEducationPersonV1 VCEmailOrganizationV1 VCEmailPersonV1 VCEmailPersonV2 VCEmailPersonV2Type VCEmploymentOfferPersonV1 VCEmploymentOrganizationV1 VCEmploymentPersonV1 VCGenderPersonV1 VCGenderPersonV2 VCGenderPersonV2Type VCHealthPassportBundleV1 VCHealthPassportGeneralV1 VCHealthPassportImmunizationV1 VCHealthPassportObservationV1 VCIDDocumentPersonV1 VCIDDocumentPersonV2 VCIDDocumentPersonV2Type VCIdentityPersonV2 VCIdentityPersonV2Type VCIncomePersonV2 VCIncomePersonV2Type VCInsuranceAccountPersonV1 VCLeanEntityOrganizationV1 VCMetaOrganizationV1 VCMetaPersonV1 VCNameOrganizationV1 VCNamePersonV1 VCNamePersonV2 VCNamePersonV2Type VCNatIDNumOrganizationV1 VCNatIDNumPersonV1 VCPhoneOrganizationV1 VCPhonePersonV1 VCPhonePersonV2 VCPhonePersonV2Type VCSAMLOrganizationV1 VCSAMLPersonV1 VCSAccountOrganizationV1 VCSAccountPersonV1 VCSAddressOrganizationV1 VCSAddressPersonV1 VCSBillOfLadingV1 VCSCargoReceiptV1 VCSCourtRecordSearchPersonV1 VCSCreditScorePersonV1 VCSDOBPersonV1 VCSEducationPersonV1 VCSEmailOrganizationV1 VCSEmailPersonV1 VCSEmploymentOfferPersonV1 VCSEmploymentOrganizationV1 VCSEmploymentPersonV1 VCSGenderPersonV1 VCSHealthPassportBundleV1 VCSHealthPassportGeneralV1 VCSHealthPassportImmunizationV1 VCSHealthPassportObservationV1 VCSIDDocumentPersonV1 VCSImmunizationV1 VCSInsuranceAccountCoverageV1 VCSInsuranceAccountPatientV1 VCSInsuranceAccountPersonV1 VCSLeanEntityOrganizationV1 VCSMetaOrganizationV1 VCSMetaPersonV1 VCSNameOrganizationV1 VCSNamePersonV1 VCSNatIDNumOrganizationV1 VCSNatIDNumPersonV1 VCSObservationV1 VCSPatientV1 VCSPhoneOrganizationV1 VCSPhonePersonV1 VCWalletPersonV2 VCWalletPersonV2Type WalletPersonV2

Variables

addressCheckV2Context administrativeAreaV2Context cityV2Context corporationV2Context countryV2Context geoCoordinatesContext governmentOrgContexts governmentOrganizationV2Context identityCheckV2Context monetaryAmountV2Context organizationV2Context postalAddressV2Context propertyValueV2Context stateV2Context

Functions

genericOrgContext getBaseV1ContextEntries getFHIRV1ContextEntries getVCAMLOrganizationV1Context getVCAMLPersonV1Context getVCAMLPersonV2Context getVCAMLPersonV2ContextConfig getVCAccountOrganizationV1Context getVCAccountPersonV1Context getVCAccountPersonV2Context getVCAccountPersonV2ContextConfig getVCAccreditationPersonV2Context getVCAccreditationPersonV2ContextConfig getVCAddressOrganizationV1Context getVCAddressPersonV1Context getVCAddressPersonV2Context getVCAddressPersonV2ContextConfig getVCBillOfLadingV1Context getVCCargoReceiptV1Context getVCCourtRecordSearchPersonV1Context getVCCreditPersonV2Context getVCCreditPersonV2ContextConfig getVCCreditScorePersonV1Context getVCDOBPersonV1Context getVCDOBPersonV2Context getVCDOBPersonV2ContextConfig getVCEducationPersonV1Context getVCEmailOrganizationV1Context getVCEmailPersonV1Context getVCEmailPersonV2Context getVCEmailPersonV2ContextConfig getVCEmploymentOfferPersonV1Context getVCEmploymentOrganizationV1Context getVCEmploymentPersonV1Context getVCGenderPersonV1Context getVCGenderPersonV2Context getVCGenderPersonV2ContextConfig getVCHealthPassportBundleV1Context getVCHealthPassportGeneralV1Context getVCHealthPassportImmunizationV1Context getVCHealthPassportObservationV1Context getVCIDDocumentPersonV1Context getVCIDDocumentPersonV2Context getVCIDDocumentPersonV2ContextConfig getVCIdentityPersonV2Context getVCIdentityPersonV2ContextConfig getVCIncomePersonV2Context getVCIncomePersonV2ContextConfig getVCInsuranceAccountPersonV1Context getVCLeanEntityOrganizationV1Context getVCMetaOrganizationV1Context getVCMetaPersonV1Context getVCNameOrganizationV1Context getVCNamePersonV1Context getVCNamePersonV2Context getVCNamePersonV2ContextConfig getVCNatIDNumOrganizationV1Context getVCNatIDNumPersonV1Context getVCPhoneOrganizationV1Context getVCPhonePersonV1Context getVCPhonePersonV2Context getVCPhonePersonV2ContextConfig getVCWalletPersonV2Context getVCWalletPersonV2ContextConfig