/moov-customers

Customer registry supporting Know Your Customer (KYC), Customer Identification Program (CIP), and OFAC checks

Primary LanguageGoApache License 2.0Apache-2.0

moov-io/customers

GoDoc Build Status Coverage Status Go Report Card Apache 2 licensed

The Customers project focuses on solving authentic identification of humans who are legally able to hold and transfer currency within the US. Primarily this project solves Know Your Customer (KYC), Customer Identification Program (CIP), Office of Foreign Asset Control (OFAC) checks and verification workflows to comply with US federal law and ensure authentic transfers. Also, Customers has an objective to be a service for detailed due diligence on individuals and companies for Financial Institutions and services in a modernized and extensible way.

If you believe you have identified a security vulnerability please should report the as soon as possible via email to security@moov.io. Please do not post it to a public issue tracker.

FFIEC Bank Secrecy Act - Customer Identification Program

Docs: docs | API Endpoints | Admin API Endpoints

Project Status

Moov Customers is under active development, so please star the project if you are interested in its progress. We are developing an extensible HTTP API for interactions along with an OpenAPI specification file for generating clients for integration projects.

Getting Started

Customers has a Docker Compose setup which you can run locally. This uses the latest releases of Customers and Watchman.

$ docker-compose up
Creating customers_watchman_1 ... done
Creating customers_customers_1 ... done
...
customers_1  | ts=2020-03-06T22:56:24.2184402Z caller=main.go:50 startup="Starting moov-io/customers server version v0.4.0-rc1"
customers_1  | ts=2020-03-06T22:56:24.393462Z caller=watchman.go:102 watchman="using http://watchman:8084 for Watchman address"
customers_1  | ts=2020-03-06T22:56:24.3951132Z caller=main.go:171 startup="binding to :8087 for HTTP server"

Once the systems start you can access Customers via http://localhost:8087 and Watchman's web interface or api:

  1. API Endpoints
  2. Admin Endpoints

Read through the project docs over here to get an understanding of the purpose of this project and how to run it.

Getting Help

channel info
Project Documentation Our project documentation available online.
Twitter @moov_io You can follow Moov.IO's Twitter feed to get updates on our project(s). You can also tweet us questions or just share blogs or stories.
GitHub Issue If you are able to reproduce a problem please open a GitHub Issue under the specific project that caused the error.
moov-io slack Join our slack channel to have an interactive discussion about the development of the project.

Contributing

Yes please! Please review our Contributing guide and Code of Conduct to get started! Checkout our issues for first time contributors for something to help out with.

Test Coverage

Improving test coverage is a good candidate for new contributors while also allowing the project to move more quickly by reducing regressions issues that might not be caught before a release is pushed out to our users. One great way to improve coverage is by adding edge cases and different inputs to functions.

License

Apache License 2.0 See LICENSE for details.