package
0.6.0-dev6
Repository: https://github.com/moov-io/customers.git
Documentation: pkg.go.dev

# README

Go API client for client

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.

Overview

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.

Installation

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/optional

Put the package under your project folder and add the following in import:

import "./client"

Documentation for API Endpoints

All URIs are relative to http://localhost:8087

ClassMethodHTTP requestDescription
AccountValidationApiCompleteAccountValidationPut /customers/{customerID}/accounts/{accountID}/validationsComplete Account Validation
AccountValidationApiGetAccountValidationGet /customers/{customerID}/accounts/{accountID}/validations/{validationID}Get Account Validation
AccountValidationApiInitAccountValidationPost /customers/{customerID}/accounts/{accountID}/validationsInitiate Account Validation
AccountsApiCreateCustomerAccountPost /customers/{customerID}/accountsCreate Customer Account
AccountsApiDecryptAccountNumberPost /customers/{customerID}/accounts/{accountID}/decryptDecrypt Account Number
AccountsApiDeleteCustomerAccountDelete /customers/{customerID}/accounts/{accountID}Delete Customer Account
AccountsApiGetCustomerAccountByIDGet /customers/{customerID}/accounts/{accountID}Get Customer Account
AccountsApiGetCustomerAccountsGet /customers/{customerID}/accountsGet Customer Accounts
AccountsApiGetLatestAccountOFACSearchGet /customers/{customerID}/accounts/{accountID}/ofacLatest Account OFAC Search
AccountsApiRefreshAccountOFACSearchPut /customers/{customerID}/accounts/{accountID}/refresh/ofacRefresh Account OFAC Search
AccountsApiUpdateAccountStatusPut /customers/{customerID}/accounts/{accountID}/statusUpdate Account Status
ConfigurationApiGetOrganizationConfigurationGet /configuration/customersGet Organization Configuration
ConfigurationApiGetOrganizationLogoGet /configuration/logoGet Organization Logo
ConfigurationApiUpdateOrganizationConfigurationPut /configuration/customersUpdate Organization Configuration
ConfigurationApiUploadOrganizationLogoPut /configuration/logoUpdate Organization Logo
CustomersApiAddAddressPost /customers/{customerID}/addressAdd Customer Address
CustomersApiCreateCustomerPost /customersCreate Customer
CustomersApiDeleteAddressDelete /customers/{customerID}/addresses/{addressID}Delete Customer Address
CustomersApiDeleteCustomerDelete /customers/{customerID}Delete Customer
CustomersApiGetCustomerGet /customers/{customerID}Get Customer
CustomersApiGetLatestOFACSearchGet /customers/{customerID}/ofacLatest Customer OFAC search
CustomersApiPingGet /pingPing Customers Service
CustomersApiRefreshOFACSearchPut /customers/{customerID}/refresh/ofacRefresh Customer OFAC search
CustomersApiReplaceCustomerMetadataPut /customers/{customerID}/metadataUpdate Customer Metadata
CustomersApiSearchCustomersGet /customersSearch Customers
CustomersApiUpdateAddressPut /customers/{customerID}/addresses/{addressID}Update Customer Address
CustomersApiUpdateCustomerPut /customers/{customerID}Update Customer
CustomersApiUpdateCustomerStatusPut /customers/{customerID}/statusUpdate Customer Status
DisclaimersApiAcceptDisclaimerPost /customers/{customerID}/disclaimers/{disclaimerID}Accept Customer Disclaimer
DisclaimersApiGetCustomerDisclaimersGet /customers/{customerID}/disclaimersGet Customer Disclaimers
DocumentsApiDeleteCustomerDocumentDelete /customers/{customerID}/documents/{documentID}Delete Customer Document
DocumentsApiGetCustomerDocumentContentsGet /customers/{customerID}/documents/{documentID}Get Customer Document
DocumentsApiGetCustomerDocumentsGet /customers/{customerID}/documentsGet Customer Documents
DocumentsApiUploadCustomerDocumentPost /customers/{customerID}/documentsUpload Customer Document
ReportsApiGetReportOfCustomerAccountsGet /reports/accountsCreate Report of Accounts
RepresentativesApiAddRepresentativePost /customers/{customerID}/representativesAdd Customer Representative
RepresentativesApiAddRepresentativeAddressPost /customers/{customerID}/representatives/{representativeID}/addressesAdd Customer Representative Address
RepresentativesApiDeleteRepresentativeDelete /customers/{customerID}/representatives/{representativeID}Delete Customer Representative
RepresentativesApiDeleteRepresentativeAddressDelete /customers/{customerID}/representatives/{representativeID}/addresses/{addressID}Delete a Customer Representative Address
RepresentativesApiUpdateRepresentativePut /customers/{customerID}/representatives/{representativeID}Update Customer Representative
RepresentativesApiUpdateRepresentativeAddressPut /customers/{customerID}/representatives/{representativeID}/addresses/{addressID}Update Customer Representative Address

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResonse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewConfiguration returns a new Configuration object.

# Constants

List of AccountStatus.
List of AccountStatus.
List of AccountType.
List of AccountType.
List of AddressType.
List of AddressType.
List of BusinessType.
List of BusinessType.
List of BusinessType.
List of BusinessType.
List of BusinessType.
List of CustomerStatus.
List of CustomerStatus.
List of CustomerStatus.
List of CustomerStatus.
List of CustomerStatus.
List of CustomerStatus.
List of CustomerType.
List of CustomerType.
List of NAICSCode.
List of NAICSCode.
List of NAICSCode.
List of NAICSCode.
List of NAICSCode.
List of NAICSCode.
List of NAICSCode.
List of NAICSCode.
List of NAICSCode.
List of NAICSCode.
List of NAICSCode.
List of NAICSCode.
List of NAICSCode.
List of NAICSCode.
List of NAICSCode.
List of NAICSCode.
List of NAICSCode.
List of NAICSCode.
List of NAICSCode.
List of NAICSCode.
List of NAICSCode.
List of NAICSCode.
List of NAICSCode.
List of NAICSCode.
List of NAICSCode.
List of OwnerType.
List of OwnerType.
List of PhoneType.
List of PhoneType.
List of PhoneType.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.
List of SICCode.

# Variables

ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.

# Structs

AcceptDisclaimerOpts Optional parameters for the method 'AcceptDisclaimer'.
Account struct for Account.
AccountValidationResponse struct for AccountValidationResponse.
AddAddressOpts Optional parameters for the method 'AddAddress'.
AddRepresentativeAddressOpts Optional parameters for the method 'AddRepresentativeAddress'.
Address struct for Address.
Amount struct for Amount.
APIClient manages communication with the Customers API API vv1 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
CompleteAccountValidationOpts Optional parameters for the method 'CompleteAccountValidation'.
CompleteAccountValidationRequest struct for CompleteAccountValidationRequest.
CompleteAccountValidationResponse struct for CompleteAccountValidationResponse.
Configuration stores the configuration of the API client.
CreateAccount struct for CreateAccount.
CreateAddress struct for CreateAddress.
CreateCustomer struct for CreateCustomer.
CreateCustomerAccountOpts Optional parameters for the method 'CreateCustomerAccount'.
CreateCustomerBusiness struct for CreateCustomerBusiness.
CreateCustomerBusinessCorporation struct for CreateCustomerBusinessCorporation.
CreateCustomerBusinessIndividual struct for CreateCustomerBusinessIndividual.
CreateCustomerIndividual struct for CreateCustomerIndividual.
CreateCustomerOpts Optional parameters for the method 'CreateCustomer'.
CreatePhone struct for CreatePhone.
CreateRepresentative struct for CreateRepresentative.
Customer struct for Customer.
CustomerBusiness struct for CustomerBusiness.
CustomerBusinessAllOf struct for CustomerBusinessAllOf.
CustomerBusinessCorporation struct for CustomerBusinessCorporation.
CustomerBusinessCorporationAllOf struct for CustomerBusinessCorporationAllOf.
CustomerBusinessIndividual struct for CustomerBusinessIndividual.
CustomerIndividual struct for CustomerIndividual.
CustomerIndividualAllOf struct for CustomerIndividualAllOf.
CustomerMetadata struct for CustomerMetadata.
DecryptAccountNumberOpts Optional parameters for the method 'DecryptAccountNumber'.
DeleteCustomerAccountOpts Optional parameters for the method 'DeleteCustomerAccount'.
DeleteCustomerDocumentOpts Optional parameters for the method 'DeleteCustomerDocument'.
DeleteCustomerOpts Optional parameters for the method 'DeleteCustomer'.
Disclaimer struct for Disclaimer.
Document struct for Document.
Error struct for Error.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
GetAccountValidationOpts Optional parameters for the method 'GetAccountValidation'.
GetCustomerAccountByIDOpts Optional parameters for the method 'GetCustomerAccountByID'.
GetCustomerAccountsOpts Optional parameters for the method 'GetCustomerAccounts'.
GetCustomerDisclaimersOpts Optional parameters for the method 'GetCustomerDisclaimers'.
GetCustomerDocumentContentsOpts Optional parameters for the method 'GetCustomerDocumentContents'.
GetCustomerDocumentsOpts Optional parameters for the method 'GetCustomerDocuments'.
GetCustomerOpts Optional parameters for the method 'GetCustomer'.
GetLatestAccountOFACSearchOpts Optional parameters for the method 'GetLatestAccountOFACSearch'.
GetLatestOFACSearchOpts Optional parameters for the method 'GetLatestOFACSearch'.
GetOrganizationConfigurationOpts Optional parameters for the method 'GetOrganizationConfiguration'.
GetReportOfCustomerAccountsOpts Optional parameters for the method 'GetReportOfCustomerAccounts'.
InitAccountValidationOpts Optional parameters for the method 'InitAccountValidation'.
InitAccountValidationRequest struct for InitAccountValidationRequest.
InitAccountValidationResponse struct for InitAccountValidationResponse.
InstitutionAddress struct for InstitutionAddress.
InstitutionDetails struct for InstitutionDetails.
OfacSearch struct for OfacSearch.
OrganizationConfiguration struct for OrganizationConfiguration.
Phone struct for Phone.
RefreshAccountOFACSearchOpts Optional parameters for the method 'RefreshAccountOFACSearch'.
RefreshOFACSearchOpts Optional parameters for the method 'RefreshOFACSearch'.
ReplaceCustomerMetadataOpts Optional parameters for the method 'ReplaceCustomerMetadata'.
ReportAccountResponse struct for ReportAccountResponse.
Representative struct for Representative.
SearchCustomersOpts Optional parameters for the method 'SearchCustomers'.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
TransitAccountNumber struct for TransitAccountNumber.
UpdateAccountStatus struct for UpdateAccountStatus.
UpdateAddress struct for UpdateAddress.
UpdateCustomerOpts Optional parameters for the method 'UpdateCustomer'.
UpdateCustomerStatus struct for UpdateCustomerStatus.
UpdateCustomerStatusOpts Optional parameters for the method 'UpdateCustomerStatus'.
UpdateOrganizationConfigurationOpts Optional parameters for the method 'UpdateOrganizationConfiguration'.
UpdateValidation struct for UpdateValidation.
UploadCustomerDocumentOpts Optional parameters for the method 'UploadCustomerDocument'.

# Type aliases

AccountsApiService AccountsApi service.
AccountStatus Enumeration if this account has been validated through micro-deposits or another available strategy.
AccountType Defines the account as *checking* or *savings*.
AccountValidationApiService AccountValidationApi service.
AddressType address type.
BusinessType The type of business for business customers.
ConfigurationApiService ConfigurationApi service.
CustomersApiService CustomersApi service.
CustomerStatus State of the customer.
CustomerType Note if this Customer represents an individual or business.
DisclaimersApiService DisclaimersApi service.
DocumentsApiService DocumentsApi service.
NaicsCode NAICS Code (https://docs.google.com/spreadsheets/d/1erIdqoy60JwLAnpb91EfoJV5YrXDnbwSaA-aqcBlw48/edit#gid=1627409140).
OwnerType The type of individual owner of a resource, such as SSN, phone, or address.
PhoneType phone type.
ReportsApiService ReportsApi service.
RepresentativesApiService RepresentativesApi service.
SicCode SIC Code (https://docs.google.com/spreadsheets/d/1erIdqoy60JwLAnpb91EfoJV5YrXDnbwSaA-aqcBlw48/edit#gid=1627409140).