KnowYourCustomer

Incubating API Repository to evolve and maintain the definitions and documentation of KnowYourCustomer Service API(s) within the Sub Project Know Your Customer

• API wiki page: Know Your Customer

Warning

After the CAMARA Spring25 meta release this repository has been separated into 3 individual repositories:

• KnowYourCustomerMatch
• KnowYourCustomerFill-in
• KnowYourCustomerAgeVerification

This repository should be only used for maintenance of previous releases. For contributions to the API development please use exclusively the new repositories. Thanks!

Scope

• Service APIs for “KnowYourCustomer” (see APIBacklog.md)
• The APIs provide the API consumer with the ability to:
  • compare the information it (Service Provider, SP) has for a particular user with that on file (and verified) by the user's Operator in their own KYC records, in order for the SP to confirm the accuracy of the information and provide a specific service to the user. (KYC Match)
  • request and receive the information for a particular user, which on file (and verified) by the user's Operator in their own KYC records, in order for the SP to confirm the accuracy of the information and provide a specific service to the user. (KYC Fill-in)
  • check if the user of the line is older than a provided age, in order to provide API customer's age-restricted services, access to its age-restricted website etc. (KYC Age Verification)
• Describe, develop, document and test the APIs (with 1-2 Telcos)
• Started: September 2023
• Incubating stage since: February 2025

Release Information

• Note: Please be aware that the project will have updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. For best results, use the latest available release

• NEW:The latest public release of CAMARA Know Your Customer is r2.2. The Release Tag is r2.2.

  • Contains the following API definitions with inline documentation:
    • kyc-match: YAML spec file | View it on ReDoc | View it on Swagger Editor
    • kyc-fill-in: YAML spec file | View it on ReDoc | View it on Swagger Editor
    • kyc-age-verification: YAML spec file | View it on ReDoc | View it on Swagger Editor

Contributing

• Meetings are held virtually
  • Schedule: Bi-weekly, Tuesday, 09:00 CEST (07:00 UTC) (till October 27th 2024)
  • Registration / Join
  • Access Meeting Minutes
• Mailing List
  • Subscribe / Unsubscribe to the mailing list of this Sub Project https://lists.camaraproject.org/g/sp-kyc
  • A message to the community of this Sub Project can be sent using https://lists.camaraproject.org/g/sp-kyc