VC API Use Cases

1.1 Existing Work

TODO: fill in

5.1 Issuer to Holder

5.2 Present for Verification

5.3 Refresh

6.1 Get Digital Permanent Resident Card

Lana is an IT administrator for the United States Citizenship and Immigration Services (USCIS) Digital Permanent Resident Card (PRC) program. She configures the USCIS website to issue digital Permanent Resident Cards by utilizing industry standard issuer software and setting up the appropriate HTTP API Authorizations between systems. Legal Permanent Residents, upon receiving their physical card in the mail, are given the USCIS website URL, a login account, and PIN code that they may use to manage their account and pick up their digital Permanent Resident Card. When Louis, a Legal Permanent Resident, requests a digital Permanent Resident Card via the USCIS website, he authenticates using his login account and once authenticated, provides a DID associated with his client-side digital wallet against which the website will issue VCs. The USCIS website then connects to the digital card issuing server, which builds the Verifiable Credential Permanent Resident Card using Louis' account data, and then utilizes industry standard HTTP APIs to issue the Permanent Resident Card as a Verifiable Credential. Louis can then use his Digital Permanent Resident Card in online scenarios when he needs to prove his resident status, such as when applying for a job.

Requirements:

• 1. Verify DID Authentication Presentation,
• 2. API Authorization,
• 3. Issue Verifiable Credential,
• X. Website as Consumer

Contributed by: Digital Bazaar

Mermaid

6.2 Refresh Expired Over Age Token

Riley has onboarded into the TruAge digital age verification system, which has provided her with a set of Verifiable Credentials that she stores in her digital wallet. A subset of the Verifiable Credentials that she has received are digitally signed single-use age tokens that only assert that she is above the age of 21 and are marked as "used" by the TruAge system when they are submitted as a part of an age-restricted goods purchase, such as buying a bottle of wine. Eventually, Riley runs out of single use age tokens in her digital wallet. The digital wallet keeps track of which tokens have been used and once all tokens have been consumed, contacts a refresh service endpoint listed in one of the TruAge credentials that provides new over-age tokens. The digital wallet requests a new set of tokens by hitting the HTTP API of this VC-refresh service listed in the “refreshService” array and POSTing the original Verifiable Credential containing the refresh service description. The HTTP API ensures that it has received a valid credential and reissues a set of new digitally signed single-use age tokens in the response.

Requirements:

• 1. Start Presentation Flow,
• 2. Verify Presentation,
• 3. Issue Verifiable Credential,
• 4. Refresh Credential

Mermaid

Contributed by: Digital Bazaar

6.3 Execute Multi-stage Presentation Workflow

Description: Ignio, a logistics manager for "Kirk Company", would like to submit all necessary paperwork to send his company's products across international boundaries. These products are considered hazardous chemicals and thus are regulated, requiring extra paperwork to be filed before transportation is approved across boundaries. Some hazardous material shipments are different resulting in different required paperwork, and Ignio wants to automate as much of the process as possible with Shippers, their 3rd Party Logistics company (3PL). There are a set of verifiable credentials that Ignio is willing to share with Customs as well as the transportation company.

When Kirk starts a shipping workflow, his company's systems initiate the workflow by contacting a known location on the Shipper's Website. A presentation exchange occurs to first DIDAuth the company and send generic mandatory information for any shipment; if and only if the information provided requires additional information‒in this case a hazmat certification‒a second exchange is initiated to request this outstanding/required hazmat info. Once this is received, Shippers can send back a Bill of Lading in VC form. The two (or more) credential exchanges are composable and idempotent, ending in a valid BoL if successful.

Requirements:

• 1. Verify DID Authentication Presentation,
• 2. API Authorization,
• 3. Issue Verifiable Credential,
• X. Website as Consumer,
• X. continuous workflow

Mermaid

Contributed by: Digital Bazaar

6.4 Aggregated Credential Workflow

Tod is using digital credentials to apply for a service/qualify for a job/gain access to a programme. Some of his credentials are available today, some will need to be provided when they are ready (for example, a criminal background check can take 24-48 hrs to process). He would like these credentials to be presented to the Verifier (service provider) when ready, without having to constantly return to the Verifier (service provider) and deliver them "by hand". He should be able to have them released from his Holder directly as they become available.

Requirements:

• X. Verifiable Presentation by policy,
• X. Automated notifications,
• X. Asynchronous release,
• X. Authorized/pre-consented authorization,
• X. VP formed with future VCs ("stateful VP")
• X. Present Credentials issued by third party?,

Mermaid

sequenceDiagram
    autonumber
        Kenzie 
(Holder)->>jobapplications.com 
(Verifier App):jobapplications.com/presenations/submit?"application"
        jobapplications.com 
(Verifier App)->>jobapplications.com 
(Verifier App):process application
        jobapplications.com 
(Verifier App)->>Kenzie 
(Holder):Request credentials A and B
        Kenzie 
(Holder)->>Kenzie's Wallet 
(Holder Service):Check for A and B
        Kenzie's Wallet 
(Holder Service)->>Kenzie 
(Holder):Display A, B not found
        Kenzie 
(Holder)->>Kenzie's Wallet 
(Holder Service):Need B
        Kenzie's Wallet 
(Holder Service)->>backgroundcheck.com 
(Issuer App):backgroundcheck.com/index.html
        backgroundcheck.com 
(Issuer App)->>Kenzie's Wallet 
(Holder Service):index.html
        Kenzie's Wallet 
(Holder Service)->>backgroundcheck.com 
(Issuer App):backgroundcheck.com/getBackgroundCheck
        backgroundcheck.com 
(Issuer App)->>Kenzie's Wallet 
(Holder Service):getBackgoundCheck.html
        Kenzie's Wallet 
(Holder Service)->>backgroundcheck.com 
(Issuer App):backgroundcheck.com/getBackgrounCheck/credentials/issue?"RequestedInfo"
        backgroundcheck.com 
(Issuer App)->>backgroundcheck.com 
(Issuer App):evaluate requested info
        backgroundcheck.com 
(Issuer App)->>Generic Issuer 
(Issuer Service):genericissuer.com/credentials/issue?"backgrounCheckCredential+info"
        Generic Issuer 
(Issuer Service)->>backgroundcheck.com 
(Issuer App):issued VC
        backgroundcheck.com 
(Issuer App)->>Kenzie's Wallet 
(Holder Service):kenzieswallet.com/credentials/recieve?"VC"
        Kenzie's Wallet 
(Holder Service)->>Kenzie 
(Holder):Notify B Ready
        Kenzie 
(Holder)->>jobapplications.com 
(Verifier App):jobapplications.com/presenations/submit?"application"
        jobapplications.com 
(Verifier App)->>Kenzie 
(Holder):Request Credentials A and B
        Kenzie 
(Holder)->>Kenzie's Wallet 
(Holder Service):Send A and B to jobapplications.com
        Kenzie's Wallet 
(Holder Service)->>jobapplications.com 
(Verifier App):jobapplications.com/presentations/submit?"application with A and B"
        jobapplications.com 
(Verifier App)->>Generic Verifier 
(Verifier Service):genericVerifer.com/presentations/verify?"applicationwith A and B"
        Generic Verifier 
(Verifier Service)->>jobapplications.com 
(Verifier App):Verification Result
        jobapplications.com 
(Verifier App)->>jobapplications.com 
(Verifier App):process application
        jobapplications.com 
(Verifier App)->>Kenzie's Wallet 
(Holder Service):Application Accepted
        Kenzie's Wallet 
(Holder Service)->>Kenzie 
(Holder):Application Accepted

Contributed by:SecureKey Technologies Inc.

6.5 Submit/Sign/Verify a test credential to a licensure system

A student, Shabazz, wants to publish their MBLEx test results from an education test provider, Massage Therapy Test Corp. Massage Therapy Test Corp proxies their authority to sign to a service provider, SSI Ventures. SSI Ventures issues Shabazz a VC when he logs into his Massage Therapy Test Corp account and enables his browser-based SSI Wallet, Billfold. The signed VC is then stored in Shabazz’ Billfold™ Wallet to be presented elsewhere.

In a separate session, Shabazz logs into a web portal of a State Massage Therapy licensure system to apply for his Massage Therapy license. The licensure specialist at the State checks the issuer using a State accreditation system, then checks the signature on the test results VC and ingests the credential’s payload. The licensure specialist then finalizes their workflow and issues Shabazz a Massage Therapy license.

Requirements:

Mermaid

Contributed by:RANDA Solutions

6.6 Supply Chain Import

In order to export steel products to the global market, Steel Mills Global must prove the quality of their products. For this, they rely on Inspectors & Co, an internationally recognized steel testing company. Upon inspection, Inspectors & Co issues a Mill Test Report VC to Steel Mills Global.

Steel, Inc. imports and distributes steel products domestically. Negotiating a shipment Steel Mills Global presents the MTR as proof of product quality. Steel Inc. verifies the MTR VP and accepts the shipment.

Steel, Inc. initiates the importing procedures, starting out self-issuing an Import Declaration Form VC. The MTR and IDF are jointly presented to the Customs authority which verifies the VP. Upon verification the customs release is granted for goods import.

Note: These VC types are taken from the Traceability Vocabulary, a W3C-CCG work item for supply chain use-cases.

Requirements:

• 1. VC Issuance,
• X. Self-Issuance,
• X. Re-Presentation and VC+VP Verification across a common supply chain process.

Mermaid

sequenceDiagram               
autonumber     
  Holder - Steel Mills Global (SMG)->>Holder App -  SMG Enterprise API:getMillTestReportVC     
  Holder App -  SMG Enterprise API->>Issuer App - Inspectors & Co Enterprise Software:inspectorandco.com/credentials/issue     
  Issuer App - Inspectors & Co Enterprise Software->>Lacy - Inspectors & Co Inspector:New inspection requested     
  Lacy - Inspectors & Co Inspector->>Lacy - Inspectors & Co Inspector:Completes SMG Inspection     
  Lacy - Inspectors & Co Inspector->>Issuer App - Inspectors & Co Enterprise Software:Issue Mill Test Report to SMG     
  Issuer App - Inspectors & Co Enterprise Software->>Issuer Service - Inspectors & Co Issuer:IandCoIssuer.com/credentials/issue     
  Issuer Service - Inspectors & Co Issuer->>Issuer Service - Inspectors & Co Issuer:Process request     
  Issuer Service - Inspectors & Co Issuer->>Issuer App - Inspectors & Co Enterprise Software:Issued Credentials     
  Issuer App - Inspectors & Co Enterprise Software->>Holder App -  SMG Enterprise API:smgApi.com/credentials/recieve?\"MillTestReportVP\"     
  Holder App -  SMG Enterprise API->>Holder App -  SMG Enterprise API:Process returned VP     
  Holder App -  SMG Enterprise API->>Holder Service - SMG Wallet:smgWallet.com/credentials/store?\"MTRVP\"     
  Holder Service - SMG Wallet->>Holder Storage - SMG EDV/KMS:smgEdv.com/credentials/store?\"MTRVP\"     
  Holder Storage - SMG EDV/KMS->>Holder Storage - SMG EDV/KMS:Store credentials     
  Holder Storage - SMG EDV/KMS->>Holder Service - SMG Wallet:Storage success and access info     
  Holder Service - SMG Wallet->>Holder App -  SMG Enterprise API:Storage acknowledged     
  Holder App -  SMG Enterprise API->>Holder - Steel Mills Global (SMG):Mill Test Report recieved     
  Steel, Inc->>Holder - Steel Mills Global (SMG):Purchase Inquiry     
  Holder - Steel Mills Global (SMG)->>Holder - Steel Mills Global (SMG):Process Inquiry    
  Holder - Steel Mills Global (SMG)->>Steel, Inc:Agree to sell     
  Steel, Inc->>Holder - Steel Mills Global (SMG):Request Mill Test Report     
  Holder - Steel Mills Global (SMG)->>Holder App -  SMG Enterprise API:sendMillTestReportVC     
  Holder App -  SMG Enterprise API->>Verifier App - Steel, Inc. Business API:steelincapi.com/presentations/available     
  Verifier App - Steel, Inc. Business API->>Holder App -  SMG Enterprise API:Domain&Challenge     
  Holder App -  SMG Enterprise API->>Holder Service - SMG Wallet:smgWallet.com/presentations/issue?\"Domain&Challenge\"     
  Holder Service - SMG Wallet->>Holder Service - SMG Wallet:Generate VP containing the MTR     
  Holder Service - SMG Wallet->>Holder Storage - SMG EDV/KMS:smgEdv.com/credentials/sign?\"GeneratedVP\"     
  Holder Storage - SMG EDV/KMS->>Holder Storage - SMG EDV/KMS:Sign VP     
  Holder Storage - SMG EDV/KMS->>Holder Service - SMG Wallet:SignedVP     
  Holder Service - SMG Wallet->>Holder App -  SMG Enterprise API:SignedVP     
  Holder App -  SMG Enterprise API->>Verifier App - Steel, Inc. Business API:steelincapi.com/presentations/submissions?\"SignedVP\"     
  Verifier App - Steel, Inc. Business API->>Verifier App - Steel, Inc. Business API:Check business rules     
  Verifier App - Steel, Inc. Business API->>Verifier Service - Steel Industry Verifier:steelindustryverifier.com/presentations/verify     
  Verifier Service - Steel Industry Verifier->>Verifier Service - Steel Industry Verifier:Check proofs     
  Verifier Service - Steel Industry Verifier->>Issuer Service - Inspectors & Co Issuer:IandCoIssuer.com/credentials/revocationList?\"MTRVC\"     
  Issuer Service - Inspectors & Co Issuer->>Issuer Service - Inspectors & Co Issuer:Check revocation list     
  Issuer Service - Inspectors & Co Issuer->>Verifier Service - Steel Industry Verifier:revocationStatus=notRevoked     
  Verifier Service - Steel Industry Verifier->>Verifier App - Steel, Inc. Business API:steelincapi.com/presentations/verified?\"MTRVC\"     
  Verifier App - Steel, Inc. Business API->>Verifier App - Steel, Inc. Business API:Check business rules     
  Verifier App - Steel, Inc. Business API->>Verifier App - Steel, Inc. Business API:Record verification result     
  Verifier App - Steel, Inc. Business API->>Steel, Inc:New Verification Result Notification     
  Verifier App - Steel, Inc. Business API->>Holder App -  SMG Enterprise API:steelincapi.com/presentations/verified?\"SignedVP\"     
  Holder App -  SMG Enterprise API->>Holder - Steel Mills Global (SMG):Mill Test Report Verified

Contributed by:Transmute Industries