License and Usage Terms:

Copyright (c) 2021 Jeremy Carter <jeremy@jeremycarter.ca>

GPL v2 (or newer) License: [ GitLab Mirror | GitHub Mirror ]

*** NO WARRANTY, USE AT YOUR OWN RISK! ***

Website:

• Online version (mirror 1): https://kycaml.saladfinder.com
• Online version (mirror 2): https://kycaml.cryptospread.com
• GitLab mirror (demo): https://defcronyke.gitlab.io/kycaml-app
• GitHub mirror (demo): https://defcronyke.github.io/kycaml-app
• Local server: http://127.0.0.1:3000
• Local server (Docker): http://127.0.0.1:8080

Source Code:

Golang App:

• GitLab: https://gitlab.com/defcronyke/kycaml-app
• GitHub: https://gitlab.com/defcronyke/kycaml-app

Golang Module:

• GitLab: https://gitlab.com/defcronyke/kycaml
• GitHub: https://gitlab.com/defcronyke/kycaml

Automated builds from the master branch:

• Release Binary:

  • Linux x86_64 (GitLab mirror)
  • Linux x86_64 (GitHub mirror)

• Debug Binary:

  • Linux x86_64 Debug (GitLab mirror)
  • Linux x86_64 Debug (GitHub mirror)

• NOTE: After downloading and extracting from the GitHub mirror, you need to run the following commands because GitHub Actions isn't preserving the correct permissions for the files:

  cd kycaml-app && \
  chmod 755 kycaml-app && \
  chmod 755 *.sh && \
  chmod -R 755 cmd

How to compile from source:

• Clone the git repositories, and build the source code:

  git clone https://gitlab.com/defcronyke/kycaml.git; \
  git clone https://gitlab.com/defcronyke/kycaml-app.git; \
  cd kycaml-app; \
  ./build.sh

Usage:

• Update the sanctions lists:

  ./update-lists.sh

• Run the server:

  # Binary version:
  ./kycaml-app
  
  # Source version:
  ./run.sh
  
  # Docker version (docker-compose with MongoDB):
  ./up.sh
  
  # Stop Docker version (docker-compose with MongoDB):
  ./down.sh
  
  # Rebuild Docker version and run:
  ./up.sh -b
  
  # Rebuild Docker version:
  ./build-container.sh

• API:

  • GET /names
    • https://kycaml.saladfinder.com/names (mirror 1)
    • https://kycaml.cryptospread.com/names (mirror 2)
    • http://127.0.0.1:3000/names (local)
    • http://127.0.0.1:8080/names (Docker)

• Specially Designated Nationals And Blocked Persons (USA):

  [ JSON (unofficial format) | XML (local version only) ]
  
  From: https://home.treasury.gov/policy-issues/financial-sanctions/specially-designated-nationals-list-data-formats-data-schemas
  -> SDN_ADVANCED.XML
  

• Consolidated Advanced Sanctions (USA):

  [ JSON (unofficial format) | XML ]
  
  From: https://home.treasury.gov/policy-issues/financial-sanctions/consolidated-sanctions-list-non-sdn-lists
  -> CONS_ADVANCED.XML