Customers 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 United States federal law and ensure authentic transfers. 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.
Customer phone numbers and addresses are stored and partially used in KYC/OFAC validation. Arbitrary key/value pairs can be stored for a Customer. Documents and Disclaimers, and their acknowledgment are also stored under a Customer as they're accepted. Bank Accounts, which can be validated with micro-deposits currently, are stored under each Customer.
This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: v1
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://github.com/moov-io/customers
Install the following dependencies:
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optionalPut the package under your project folder and add the following in import:
import "./client"All URIs are relative to http://localhost:8087
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AccountValidationApi | CompleteAccountValidation | Put /customers/{customerID}/accounts/{accountID}/validations | Complete Account Validation |
| AccountValidationApi | GetAccountValidation | Get /customers/{customerID}/accounts/{accountID}/validations/{validationID} | Get Account Validation |
| AccountValidationApi | InitAccountValidation | Post /customers/{customerID}/accounts/{accountID}/validations | Initiate Account Validation |
| AccountsApi | CreateCustomerAccount | Post /customers/{customerID}/accounts | Create Customer Account |
| AccountsApi | DecryptAccountNumber | Post /customers/{customerID}/accounts/{accountID}/decrypt | Decrypt Account Number |
| AccountsApi | DeleteCustomerAccount | Delete /customers/{customerID}/accounts/{accountID} | Delete Customer Account |
| AccountsApi | GetCustomerAccountByID | Get /customers/{customerID}/accounts/{accountID} | Get Customer Account |
| AccountsApi | GetCustomerAccounts | Get /customers/{customerID}/accounts | Get Customer Accounts |
| AccountsApi | GetLatestAccountOFACSearch | Get /customers/{customerID}/accounts/{accountID}/ofac | Latest Account OFAC Search |
| AccountsApi | RefreshAccountOFACSearch | Put /customers/{customerID}/accounts/{accountID}/refresh/ofac | Refresh Account OFAC Search |
| AccountsApi | UpdateAccountStatus | Put /customers/{customerID}/accounts/{accountID}/status | Update Account Status |
| ConfigurationApi | GetOrganizationConfiguration | Get /configuration/customers | Get Organization Configuration |
| ConfigurationApi | GetOrganizationLogo | Get /configuration/logo | Get Organization Logo |
| ConfigurationApi | UpdateOrganizationConfiguration | Put /configuration/customers | Update Organization Configuration |
| ConfigurationApi | UploadOrganizationLogo | Put /configuration/logo | Update Organization Logo |
| CustomersApi | AddAddress | Post /customers/{customerID}/address | Add Customer Address |
| CustomersApi | CreateCustomer | Post /customers | Create Customer |
| CustomersApi | DeleteAddress | Delete /customers/{customerID}/addresses/{addressID} | Delete Customer Address |
| CustomersApi | DeleteCustomer | Delete /customers/{customerID} | Delete Customer |
| CustomersApi | GetCustomer | Get /customers/{customerID} | Get Customer |
| CustomersApi | GetLatestOFACSearch | Get /customers/{customerID}/ofac | Latest Customer OFAC search |
| CustomersApi | Ping | Get /ping | Ping Customers Service |
| CustomersApi | RefreshOFACSearch | Put /customers/{customerID}/refresh/ofac | Refresh Customer OFAC search |
| CustomersApi | ReplaceCustomerMetadata | Put /customers/{customerID}/metadata | Update Customer Metadata |
| CustomersApi | SearchCustomers | Get /customers | Search Customers |
| CustomersApi | UpdateAddress | Put /customers/{customerID}/addresses/{addressID} | Update Customer Address |
| CustomersApi | UpdateCustomer | Put /customers/{customerID} | Update Customer |
| CustomersApi | UpdateCustomerStatus | Put /customers/{customerID}/status | Update Customer Status |
| DisclaimersApi | AcceptDisclaimer | Post /customers/{customerID}/disclaimers/{disclaimerID} | Accept Customer Disclaimer |
| DisclaimersApi | GetCustomerDisclaimers | Get /customers/{customerID}/disclaimers | Get Customer Disclaimers |
| DocumentsApi | DeleteCustomerDocument | Delete /customers/{customerID}/documents/{documentID} | Delete Customer Document |
| DocumentsApi | GetCustomerDocumentContents | Get /customers/{customerID}/documents/{documentID} | Get Customer Document |
| DocumentsApi | GetCustomerDocuments | Get /customers/{customerID}/documents | Get Customer Documents |
| DocumentsApi | UploadCustomerDocument | Post /customers/{customerID}/documents | Upload Customer Document |
| ReportsApi | GetReportOfCustomerAccounts | Get /reports/accounts | Create Report of Accounts |
| RepresentativesApi | AddRepresentative | Post /customers/{customerID}/representatives | Add Customer Representative |
| RepresentativesApi | AddRepresentativeAddress | Post /customers/{customerID}/representatives/{representativeID}/address | Add Customer Representative Address |
| RepresentativesApi | DeleteRepresentative | Delete /customers/{customerID}/representatives/{representativeID} | Delete Customer Representative |
| RepresentativesApi | DeleteRepresentativeAddress | Delete /customers/{customerID}/representatives/{representativeID}/addresses/{addressID} | Delete a Customer Representative Address |
| RepresentativesApi | UpdateRepresentative | Put /customers/{customerID}/representatives/{representativeID} | Update Customer Representative |
| RepresentativesApi | UpdateRepresentativeAddress | Put /customers/{customerID}/representatives/{representativeID}/addresses/{addressID} | Update Customer Representative Address |
- Account
- AccountStatus
- AccountType
- AccountValidationResponse
- Address
- AddressType
- Amount
- BusinessType
- CompleteAccountValidationRequest
- CompleteAccountValidationResponse
- CreateAccount
- CreateAddress
- CreateCustomer
- CreatePhone
- CreateRepresentative
- Customer
- CustomerMetadata
- CustomerStatus
- CustomerType
- Disclaimer
- Document
- Error
- InitAccountValidationRequest
- InitAccountValidationResponse
- InstitutionAddress
- InstitutionDetails
- NaicsCode
- OfacSearch
- OrganizationConfiguration
- OwnerType
- Phone
- PhoneType
- ReportAccountResponse
- Representative
- SicCode
- TransitAccountNumber
- UpdateAccountStatus
- UpdateAddress
- UpdateCustomerStatus
- UpdateValidation
Endpoints do not require authorization.