kych

OAuth 2.0 API for Swiyu to enable Taler integration of Swiyu for KYC (experimental)
Log | Files | Refs | README

README (1429B)

      1 KYCH Documentation
      2 ==================
      3 
      4 This directory contains technical specifications and diagrams for the
      5 KYCH system.
      6 
      7 For integration with GNU Taler, see the taler-docs/ directory which
      8 contains reStructuredText documentation intended for the official
      9 GNU Taler documentation (https://docs.taler.net/).
     10 
     11 
     12 Files
     13 -----
     14 
     15   vc.md                   Verifiable Credential format specification (SD-JWT)
     16   vp.md                   Verifiable Presentation format specification
     17 
     18   kych_verifier_logo.svg  KYCH verifier logo
     19 
     20 
     21 Sequence Diagrams
     22 -----------------
     23 
     24 The sequence_diagrams/ directory contains ASCII diagrams documenting
     25 the OAuth2 and credential verification flows:
     26 
     27   swiyu_taler_sequence_diagram.txt
     28       Complete end-to-end flow showing how a GNU Taler exchange
     29       interacts with KYCH and the SWIYU verifier for KYC verification.
     30 
     31   setup_sequence.txt
     32       Initial client setup and registration flow.
     33 
     34   authorize_sequence.txt
     35       OAuth2 authorization request and credential verification.
     36 
     37   token_sequence.txt
     38       Token exchange after successful verification.
     39 
     40   info_sequence.txt
     41       User information retrieval endpoint.
     42 
     43   notification_sequence.txt
     44       Webhook callback flow for verification status updates.
     45 
     46 
     47 Related Standards
     48 -----------------
     49 
     50   SD-JWT VC   https://datatracker.ietf.org/doc/draft-ietf-oauth-sd-jwt-vc/
     51   OpenID4VP   https://openid.net/specs/openid-4-verifiable-presentations-1_0.html