Customers

Customers are automatically created when an application is approved. For general customer concepts, see the Customers Overview.

After approval, Thread Bank partners can update regulatory fields on the customer resource using the PATCH endpoints below.

Update Individual Customer

Update an IndividualCustomer. The Customer Updated webhook event will be fired.

Note

Changes to a customer's name, date of birth and SSN require the discretion of a compliance officer and therefore cannot be changed using this endpoint. To change any of these, please contact Unit support with the change details and required documents (if there are any) and our compliance team will process the request for you.

Verb	PATCH
URL	https://api.s.unit.sh/customers/:customerId
Required Scope	customers-write or customer-tags-write
Data Type	individualCustomer
Timeout (Seconds)	5

Attributes

Name	Type	Description
tags Required	object	See Updating Tags.
accountPurpose Optional	accountPurpose	The primary purpose of the account.
accountPurposeDetail	string	Optional. Required if accountPurpose is one of Cryptocurrency,CashHeavyPersonalIncome,InternationalRemittances
sourceOfFunds Optional	sourceOfFunds	The primary source of funds. One of SalaryOrWages,BusinessIncome,InvestmentIncome,RetirementSavings,Inheritance,Gift,SaleOfAssets,LegalSettlement,LoanProceeds
transactionVolume Optional	transactionVolume	The expected monthly transaction volume. One of Between1KAnd5K,Between5KAnd15K,Between15KAnd30K,Between30KAnd60K,GreaterThan60K
transactionVolumeDescription	string	Optional. Required when transactionVolume is $30,001 or higher. Further detail around transaction volume selection.
profession Optional	profession	The occupation of the individual.

Response

Response is a JSON:API document.

200 OK

Name	Type	Description
data Required	IndividualCustomer	The updated IndividualCustomer resource.

Update individual customer:

curl -X PATCH 'https://api.s.unit.sh/customers/:customerId'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
  "data": {
    "type": "individualCustomer",
    "attributes": {
      "tags": {
        "by": "Richard Hendricks",
        "id": "23033b64-38f8-4dbc-91a1-313ff0156d02"
      },
      "profession": "Lawyer"
    }
  }
}'

Update Sole Proprietor Customer

Update a sole-proprietorship customer. The Customer Updated webhook event will be fired.

Note

Changes to a customer's name, date of birth and SSN require the discretion of a compliance officer and therefore cannot be changed using this endpoint. To change any of these, please contact Unit support with the change details and required documents (if there are any) and our compliance team will process the request for you.

Verb	PATCH
URL	https://api.s.unit.sh/customers/:customerId
Required Scope	customers-write or customer-tags-write
Data Type	individualCustomer
Timeout (Seconds)	5

Attributes

Name	Type	Description
tags Required	object	See Updating Tags.
website Optional	string	A Valid website URL. Providing a null value is indicative of the business customer attesting that they do not have a website.
sourceOfFunds Optional	sourceOfFunds	The primary source of funds of the business.
sourceOfFundsDescription	string	Optional. Required if sourceOfFunds is one of governmentContractsOrGrants,donationsOrFundraising,importExportRevenue.
businessIndustry Optional	businessIndustry	The industry of the sole proprietor.
businessDescription Optional	string	A brief description of the business, including its main products or services and the customers.
isIncorporated Optional	boolean	Is the business incorporated.
stateOfIncorporation	string	Optional. Required if isIncorporated is true. Two letters representing a US state.
yearOfIncorporation	Year string	Optional. Required if isIncorporated is true. Year of incorporation of the business.
countriesOfOperation Optional	Array of ISO31661-Alpha2 strings	The countries in which business is conducted.
usNexus Optional	array of usNexus	The nature of the business's ties to the U.S. Either NotAvailable or one or more of the other options.
transactionVolume Optional	transactionVolume	The expected monthly transaction volume of the business.
transactionVolumeDescription	string	Optional. Required when transactionVolume is $150,001 or higher. Further detail around transaction volume selection.
accountPurpose Optional	accountPurpose	The primary purpose of the account.
accountPurposeDetail	string	Optional. Required if accountPurpose is one of CashHeavyIncomeAndOperations,ProfessionalServicesHandlingFunds,CharitableOrNonProfitOrganizationOperations,CommercialCashOperations,ThirdPartyPaymentProcessing.

Response

Response is a JSON:API document.

200 OK

Name	Type	Description
data Required	IndividualCustomer	The updated IndividualCustomer resource.

Update sole-proprietor customer:

curl -X PATCH 'https://api.s.unit.sh/customers/:customerId'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
  "data": {
    "type": "individualCustomer",
    "attributes": {
      "tags": {
        "by": "Richard Hendricks",
        "id": "23033b64-38f8-4dbc-91a1-313ff0156d02"
      },
      "website": "https://unit.co"
    }
  }
}'

Update Business Customer

Update a BusinessCustomer. The Customer Updated webhook event will be fired.

Note

Changes to a customer's name, date of birth and SSN require the discretion of a compliance officer and therefore cannot be changed using this endpoint. To change any of these, please contact Unit support with the change details and required documents (if there are any) and our compliance team will process the request for you.

Verb	PATCH
URL	https://api.s.unit.sh/customers/:customerId
Required Scope	customers-write or customer-tags-write
Data Type	businessCustomer
Timeout (Seconds)	5

Attributes

Name	Type	Description
tags Required	object	See Updating Tags.
operatingAddress Optional	Address	The physical location of the business.
sourceOfFunds Optional	sourceOfFunds	The primary source of funds of the business.
sourceOfFundsDescription	string	Optional. Required if sourceOfFunds is one of governmentContractsOrGrants,donationsOrFundraising,importExportRevenue.
businessIndustry Optional	businessIndustry	The industry of the business.
businessDescription Optional	string	A brief description of the business, including its main products or services and the customers.
isRegulated Optional	boolean	Is the business regulated by a government agency or financial regulator?
regulatorName	string	Optional. Required if isRegulated is true. The name of the regulator if the business is regulated.
usNexus Optional	array of usNexus	The nature of the business's ties to the U.S. Either NotAvailable or one or more of the other options.
accountPurpose Optional	accountPurpose	The primary purpose of the account.
accountPurposeDetail	string	Optional. Required if accountPurpose is one of CashHeavyIncomeAndOperations,ProfessionalServicesHandlingFunds,CharitableOrNonProfitOrganizationOperations,CommercialCashOperations,ThirdPartyPaymentProcessing.
transactionVolume Optional	transactionVolume	The expected monthly transaction volume of the business.
transactionVolumeDescription	string	Optional. Required when transactionVolume is $1,000,001 or higher. Further detail around transaction volume selection.
countriesOfOperation Optional	Array of ISO31661-Alpha2 strings	The countries in which business is conducted.
yearOfIncorporation Optional	Year string	Year of incorporation of the business.
website Optional	string	A Valid website URL. Providing a null value is indicative of the business customer attesting that they do not have a website.
stockExchangeName	string	Optional. Required if entityType is PubliclyTradedCorporation. The name of the stock exchange where the business's stock is traded.
stockSymbol	string	Optional. Required if entityType is PubliclyTradedCorporation. The stock symbol (ticker) of the business.

Response

Response is a JSON:API document.

200 OK

Name	Type	Description
data Required	BusinessCustomer	The updated BusinessCustomer resource.

Update business customer:

curl -X PATCH 'https://api.s.unit.sh/customers/:customerId'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
  "data": {
    "type": "businessCustomer",
    "attributes": {
      "tags": {
        "by": "Richard Hendricks",
        "id": "23033b64-38f8-4dbc-91a1-313ff0156d02"
      },
      "usNexus": [
        "NotAvailable"
      ]
    }
  }
}'