Resources

IndividualApplication

IndividualApplication is a JSON:API resource, top-level fields:

Name	Type	Description
id Required	string	Identifier of the application resource.
type Required	string	Type of the application resource. For individual application the value is always individualApplication.
attributes Required	JSON Object	JSON object representing the application data.
relationships Required	JSON:API Relationships	Describes relationships between the application resource and other resources (documents).

Attributes

Name	Type	Description
status Required	string	One of AwaitingDocuments, PendingReview, Approved, Denied or Pending, see Application Statuses.
message Required	string	A message describing the IndividualApplication status.
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Optional	RFC3339 Date string	The date the resource was updated.
ssn Required	string	SSN of the individual (numbers only). Either ssn or passport will be populated.
passport Required	string	Individual passport number. Either ssn or passport will be populated.
nationality	ISO31661-Alpha2 string	Required if a passport is used as the main ID and optional when ssn is used. Two letters representing the individual's nationality. (e.g. "US").
fullName Required	FullName	Full name of the individual.
dateOfBirth Required	RFC3339 Date string	Date only (e.g. "2001-08-15").
address Required	Address	Address of the individual.
phone Required	Phone	Phone of the individual.
email Required	string	Email address of the individual.
ip Required	string	IP address of the end-customer creating the application, if specified.
soleProprietorship Optional	boolean	Indicates whether the individual is a sole proprietor, if specified.
ein Optional	string	Indicates if the individual is a sole proprietor who has an Employer Identification Number, if specified.
dba Optional	string	Indicates if the individual is a sole proprietor who is doing business under a different name, if specified.
archived Required	boolean	Indicates whether the application has been archived. Archived applications are read-only and no changes can be made to them. Once an application has been archived, a new application with the same SSN (or Passport) may be submitted. An application becomes archived once the corresponding customer is archived.
idTheftScore Optional	number	Score (0-1000) for ID theft verification, >900 is auto rejected as default (threshold is configurable).
tags Required	object	See Tags.
accountPurpose Required	accountPurpose	The primary purpose of the account.
accountPurposeDetail	string	Required if accountPurpose is one of Cryptocurrency,CashHeavyPersonalIncome,InternationalRemittances
sourceOfFunds Required	sourceOfFunds	The primary source of funds of the business. One of SalaryOrWages,BusinessIncome,InvestmentIncome,RetirementSavings,Inheritance,Gift,SaleOfAssets,LegalSettlement,LoanProceeds
transactionVolume Required	transactionVolume	The expected monthly transaction volume of the business. One of Between1KAnd5K,Between5KAnd15K,Between15KAnd30K,Between30KAnd60K,GreaterThan60K
transactionVolumeDescription	string	Required when transactionVolume is $30,001 or higher. Further detail around transaction volume selection.
profession Required	profession	The occupation of the individual.
website Optional	string	A Valid website URL. Present when soleProprietorship is true.
sourceOfFundsDescription	string	Required if sourceOfFunds is one of GovernmentContractsOrGrants,DonationsOrFundraising,ImportExportRevenue. Present when soleProprietorship is true.
businessIndustry Required	businessIndustry	The industry of the sole proprietor. Present when soleProprietorship is true.
businessDescription Required	string	A brief description of the business, including its main products or services and the customers. Present when soleProprietorship is true.
isIncorporated Required	boolean	Is the business incorporated. Present when soleProprietorship is true.
stateOfIncorporation	string	Required if isIncorporated is true. Two letters representing a US state. Present when soleProprietorship is true.
yearOfIncorporation	Year string	Required if isIncorporated is true. Year of incorporation of the business. Present when soleProprietorship is true.
countriesOfOperation Required	Array of ISO31661-Alpha2 strings	Present when soleProprietorship is true.
usNexus Required	array of usNexus	The nature of the business's ties to the U.S. Present when soleProprietorship is true.

Relationships

Name	Type	Description
documents Optional	Array of JSON:API Relationship	Application's documents.
customer Optional	JSON:API Relationship	The created Customer in case of approved application.
applicationForm Optional	JSON:API Relationship	The ApplicationForm through which the application has been submitted.

Example IndividualApplication resource:

{
  "type": "individualApplication",
  "id": "53",
  "attributes": {
    "createdAt": "2020-01-14T14:05:04.718Z",
    "fullName": {
      "first": "Peter",
      "last": "Parker"
    },
    "ssn": "721074426",
    "address": {
      "street": "20 Ingram St",
      "street2": null,
      "city": "Forest Hills",
      "state": "NY",
      "postalCode": "11375",
      "country": "US"
    },
    "dateOfBirth": "2001-08-10",
    "email": "peter@oscorp.com",
    "phone": {
      "countryCode": "1",
      "number": "1555555578"
    },
    "status": "AwaitingDocuments",
    "message": "Waiting for you to upload the required documents.",
    "archived": false,
    "soleProprietorship": false,
    "accountPurpose": "PayrollOrDirectDeposit",
    "sourceOfFunds": "SalaryOrWages",
    "transactionVolume": "Between1KAnd5K",
    "profession": "Farmer",
    "tags": {
      "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
    }
  },
  "relationships": {
    "org": {
      "data": {
        "type": "org",
        "id": "1"
      }
    },
    "documents": {
      "data": [
        {
          "type": "document",
          "id": "1"
        },
        {
          "type": "document",
          "id": "2"
        }
      ]
    },
    "applicationForm": {
      "data": {
        "type": "applicationForm",
        "id": "3"
      }
    }
  }
}

See attribute descriptions above. When soleProprietorship is true, the resource includes sole-proprietor regulatory fields such as website, businessIndustry, and usNexus.

Example Sole Proprietorship IndividualApplication resource:

{
  "type": "individualApplication",
  "id": "54",
  "attributes": {
    "createdAt": "2020-01-14T14:05:04.718Z",
    "fullName": {
      "first": "Peter",
      "last": "Parker"
    },
    "ssn": "721074426",
    "address": {
      "street": "20 Ingram St",
      "street2": null,
      "city": "Forest Hills",
      "state": "NY",
      "postalCode": "11375",
      "country": "US"
    },
    "dateOfBirth": "2001-08-10",
    "email": "peter@oscorp.com",
    "phone": {
      "countryCode": "1",
      "number": "1555555578"
    },
    "status": "Approved",
    "message": "Congrats - your application has been approved.",
    "archived": false,
    "soleProprietorship": true,
    "ein": "123456789",
    "dba": "Piedpiper Inc",
    "website": "https://www.piedpiper.com",
    "accountPurpose": "EcommerceSales",
    "sourceOfFunds": "SalesOfServices",
    "transactionVolume": "LessThan5K",
    "usNexus": [
      "NotAvailable"
    ],
    "countriesOfOperation": [
      "US",
      "CA"
    ],
    "isIncorporated": false,
    "businessIndustry": "GroceryStoresOrSupermarkets",
    "tags": {
      "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
    }
  },
  "relationships": {
    "org": {
      "data": {
        "type": "org",
        "id": "1"
      }
    },
    "customer": {
      "data": {
        "type": "individualCustomer",
        "id": "8"
      }
    },
    "applicationForm": {
      "data": {
        "type": "applicationForm",
        "id": "3"
      }
    }
  }
}

BusinessApplication

BusinessApplication is a JSON:API resource, top-level fields:

Name	Type	Description
id Required	string	Identifier of the application resource.
type Required	string	Type of the application resource, for business application the value is always businessApplication.
attributes Required	JSON Object	JSON object representing the application data.
relationships Required	JSON:API Relationships	Describes relationships between the application resource and other resources (documents).

Attributes

Name	Type	Description
status Required	string	One of AwaitingDocuments, PendingReview, Approved, Denied or Pending, see Application Statuses.
message Required	string	A message describing the BusinessApplication status.
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Optional	RFC3339 Date string	The date the resource was updated.
name Required	string	Name of the business.
dba Optional	string	"Doing business as".
address Required	Address	Address of the business.
operatingAddress	Address	Optional. The operating address of the business. Required when the address is of a registered agent (see Detecting Operating Address Required) or if any beneficial owner or officer is non-US.
phone Required	Phone	Phone of the business.
stateOfIncorporation Required	string	Two letters representing a US state.
ein Required	string	Business EIN (numbers only).
website Optional	string	Business's website.
contact Required	BusinessContact	Primary contact of the business.
officer Required	Officer	Officer representing the business (must be the CEO, COO, CFO, President, BenefitsAdministrationOfficer, CIO, VP, AVP, Treasurer, Secretary, Controller, Manager, Partner or Member). To successfully onboard a business, provide the officer's personal details.
beneficialOwners Required	Array of BeneficialOwner	Array of beneficial owners in the business. A beneficial owner is anyone who owns at least 25% of the business. To successfully onboard a business, provide each beneficial owner's personal details. If the business has no beneficial owners, the array should be empty.
attestedNoBeneficialOwners Required	boolean	true if no beneficial owners are provided; otherwise - false .
ip Optional	string	IP address of the end-customer creating the application. Both IPv4 and IPv6 formats are supported. Highly recommended as a fraud prevention measure, if the information is available when submitting the application.
archived Required	boolean	Indicates whether the application has been archived. Archived applications are read-only and no changes can be made to them. An application becomes archived once the corresponding customer is archived.
tags Required	object	See Tags.
sourceOfFunds Required	sourceOfFunds	The primary source of funds of the business.
sourceOfFundsDescription	string	Required if sourceOfFunds is one of GovernmentContractsOrGrants,DonationsOrFundraising,ImportExportRevenue.
businessIndustry Required	businessIndustry	The industry of the business
businessDescription Required	string	A brief description of the business, including its main products or services and the customers.
isRegulated Required	boolean	Is the business regulated by a government agency or financial regulator?
regulatorName	string	Required if isRegulated is true. The name of the regulator if the business is regulated.
usNexus Required	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 Required	accountPurpose	The primary purpose of the account.
accountPurposeDetail	string	Required if accountPurpose is one of CashHeavyIncomeAndOperations,ProfessionalServicesHandlingFunds,CharitableOrNonProfitOrganizationOperations,CommercialCashOperations,ThirdPartyPaymentProcessing.
transactionVolume Required	transactionVolume	The expected monthly transaction volume of the business.
transactionVolumeDescription	string	Required when transactionVolume is $1,000,001 or higher. Further detail around transaction volume selection.
stockExchangeName	string	Required if entityType is PubliclyTradedCorporation. The name of the stock exchange where the business's stock is traded.
stockSymbol	string	Required if entityType is PubliclyTradedCorporation. The stock symbol (ticker) of the business.
countriesOfOperation Required	Array of ISO31661-Alpha2 strings
yearOfIncorporation Required	Year string	Year of incorporation of the business.
isIncorporated Required	boolean	Is the business incorporated.
entityType Required	string	One of LLC, Partnership, PubliclyTradedCorporation, PrivatelyHeldCorporation or NotForProfitOrganization, Estate, Trust,ForeignFinancialInstitution, DomesticFinancialInstitution, GovernmentEntityOrAgency, ReligiousOrganization, Charity.

Relationships

Name	Type	Description
documents Optional	Array of JSON:API Relationship	Application's documents.
customer Optional	JSON:API Relationship	The created Customer in case of approved application.
applicationForm Optional	JSON:API Relationship	The ApplicationForm through which the application has been submitted.

Example BusinessApplication resource:

{
  "type": "businessApplication",
  "id": "50",
  "attributes": {
    "createdAt": "2020-01-13T16:01:19.346Z",
    "name": "Pied Piper",
    "dba": null,
    "address": {
      "street": "5230 Newell Rd",
      "street2": null,
      "city": "Palo Alto",
      "state": "CA",
      "postalCode": "94303",
      "country": "US"
    },
    "phone": {
      "countryCode": "1",
      "number": "1555555578"
    },
    "stateOfIncorporation": "DE",
    "ein": "123456789",
    "entityType": "Corporation",
    "contact": {
      "fullName": {
        "first": "Richard",
        "last": "Hendricks"
      },
      "email": "richard@piedpiper.com",
      "phone": {
        "countryCode": "1",
        "number": "1555555578"
      }
    },
    "officer": {
      "fullName": {
        "first": "Richard",
        "last": "Hendricks"
      },
      "ssn": "123456789",
      "address": {
        "street": "5230 Newell Rd",
        "street2": null,
        "city": "Palo Alto",
        "state": "CA",
        "postalCode": "94303",
        "country": "US"
      },
      "dateOfBirth": "2001-08-10",
      "email": "richard@piedpiper.com",
      "phone": {
        "countryCode": "1",
        "number": "1555555589"
      },
      "occupation": "ArchitectOrEngineer",
      "annualIncome": "Between10kAnd25k",
      "sourceOfIncome": "EmploymentOrPayrollIncome",
      "status": "Approved"
    },
    "beneficialOwners": [
      {
        "fullName": {
          "first": "Richard",
          "last": "Hendricks"
        },
        "ssn": "123456789",
        "address": {
          "street": "5230 Newell Rd",
          "street2": null,
          "city": "Palo Alto",
          "state": "CA",
          "postalCode": "94303",
          "country": "US"
        },
        "dateOfBirth": "2001-08-10",
        "phone": {
          "countryCode": "1",
          "number": "1555555589"
        },
        "email": "richard@piedpiper.com",
        "occupation": "ArchitectOrEngineer",
        "annualIncome": "Between10kAnd25k",
        "sourceOfIncome": "EmploymentOrPayrollIncome",
        "status": "Approved"
      }
    ],
    "isIncorporated": true,
    "yearOfIncorporation": "2014",
    "businessIndustry": "TechnologyMediaOrTelecom",
    "accountPurpose": "RetailSalesInPerson",
    "sourceOfFunds": "SalesOfGoods",
    "transactionVolume": "Between1KAnd5K",
    "usNexus": [
      "NotAvailable"
    ],
    "countriesOfOperation": [
      "US",
      "CA"
    ],
    "isRegulated": false,
    "website": "www.piedpiper.com",
    "businessDescription": "We are a technology company that sells technology products to our customers.",
    "tags": {
      "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
    },
    "archived": false,
    "status": "AwaitingDocuments",
    "message": "Waiting for you to upload the required documents."
  },
  "relationships": {
    "org": {
      "data": {
        "type": "org",
        "id": "1"
      }
    },
    "documents": {
      "data": [
        {
          "type": "document",
          "id": "1"
        },
        {
          "type": "document",
          "id": "2"
        },
        {
          "type": "document",
          "id": "3"
        }
      ]
    },
    "applicationForm": {
      "data": {
        "type": "applicationForm",
        "id": "3"
      }
    }
  }
}

BeneficialOwner

BeneficialOwner is a JSON:API resource, top-level fields:

Name	Type	Description
id Required	string	Identifier of the beneficial owner resource.
type Required	string	Always beneficialOwner.
attributes Required	JSON Object	JSON object representing the beneficial owner's data.

Attributes

Name	Type	Description
status Required	string	One of Approved, Denied or PendingReview.
fullName Required	FullName	Full name of the beneficial owner.
ssn	string	SSN of the beneficial owner (numbers only). One of ssn or passport is required.
passport	string	Passport of the beneficial owner. One of ssn or passport is required.
nationality	ISO31661-Alpha2 string	Required if a passport is used as the main ID and optional when ssn is used. Two letters representing the beneficial owner's nationality. (e.g. "US").
dateOfBirth Required	RFC3339 Date string	Date only (e.g. "2001-08-15").
address Required	Address	The beneficial owner's address.
phone Required	Phone	The beneficial owner's phone number.
email Required	string	The beneficial owner's email address.

Example BeneficialOwner resource:

{
  "type": "beneficialOwner",
  "id": "5",
  "attributes": {
    "address": {
      "street": "20 Ingram St",
      "street2": "Apt #10",
      "city": "Forest Hills",
      "state": "NY",
      "postalCode": "11375",
      "country": "US"
    },
    "dateOfBirth": "1990-04-05",
    "email": "erlich@piedpiper.com",
    "fullName": {
      "first": "Erlich",
      "last": "Bachman"
    },
    "phone": {
      "countryCode": "1",
      "number": "5555555555"
    },
    "ssn": "721074426",
    "status": "Approved"
  }
}

IndividualCustomer

IndividualCustomer is a JSON:API resource, top-level fields:

Name	Type	Description
id Required	string	Identifier of the customer resource.
type Required	string	Type of the customer resource. For individual customer the value is always individualCustomer.
attributes Required	JSON Object	JSON object representing the customer data.
relationships Required	JSON:API Relationships	Describes relationships between the customer resource and other resources.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
ssn Required	string	SSN of the individual (numbers only). Either ssn or passport will be populated.
passport Required	string	Individual passport number. Either ssn or passport will be populated.
nationality	ISO31661-Alpha2 string	Required if a passport is used as the main ID and optional when ssn is used. Two letters representing the individual's nationality. (e.g. "US").
fullName Required	FullName	Full name of the individual.
dateOfBirth Required	RFC3339 Date string	Date only (e.g. "2001-08-15").
address Required	Address	Address of the individual.
phone Required	Phone	Phone of the individual.
email Required	string	Email address of the individual.
soleProprietorship Optional	boolean	Indicates whether the individual is a sole proprietor, if specified.
ein Optional	string	Indicates if the individual is a sole proprietor who has an Employer Identification Number, if specified.
dba Optional	string	Indicates if the individual is a sole proprietor who is doing business under a different name, if specified.
status Required	string	Status of the customer, either Active or Archived. You can't do any write operations on an Archived customer.
eligibleProducts Optional	Array of Product	The products that the customer is eligible for.
authorizedUsers Required	Array of AuthorizedUser	Array of authorized users.
tags Required	object	See Tags. Inherited from the application tags (see Tag Inheritance).
accountPurpose Required	accountPurpose	The primary purpose of the account.
accountPurposeDetail	string	Required if accountPurpose is one of Cryptocurrency,CashHeavyPersonalIncome,InternationalRemittances
sourceOfFunds Required	sourceOfFunds	The primary source of funds. One of SalaryOrWages,BusinessIncome,InvestmentIncome,RetirementSavings,Inheritance,Gift,SaleOfAssets,LegalSettlement,LoanProceeds
transactionVolume Required	transactionVolume	The expected monthly transaction volume. One of Between1KAnd5K,Between5KAnd15K,Between15KAnd30K,Between30KAnd60K,GreaterThan60K
transactionVolumeDescription	string	Required when transactionVolume is $30,001 or higher. Further detail around transaction volume selection.
profession Required	profession	The occupation of the individual.
website Optional	string	A Valid website URL. Present when soleProprietorship is true.
sourceOfFundsDescription	string	Required if sourceOfFunds is one of GovernmentContractsOrGrants,DonationsOrFundraising,ImportExportRevenue. Present when soleProprietorship is true.
businessIndustry Required	businessIndustry	The industry of the sole proprietor. Present when soleProprietorship is true.
businessDescription Required	string	A brief description of the business, including its main products or services and the customers. Present when soleProprietorship is true.
isIncorporated Required	boolean	Is the business incorporated. Present when soleProprietorship is true.
stateOfIncorporation	string	Required if isIncorporated is true. Two letters representing a US state. Present when soleProprietorship is true.
yearOfIncorporation	Year string	Required if isIncorporated is true. Year of incorporation of the business. Present when soleProprietorship is true.
countriesOfOperation Required	Array of ISO31661-Alpha2 strings	Present when soleProprietorship is true.
usNexus Required	array of usNexus	The nature of the business's ties to the U.S. Present when soleProprietorship is true.

Relationships

Name	Type	Description
org Required	JSON:API Relationship	The Org of the individual.
application Required	JSON:API Relationship	The Application that created this individual.
authorizedUserResources Required	JSON:API Relationship	A list of the related AuthorizedUser.

Example IndividualCustomer resource:

{
  "type": "individualCustomer",
  "id": "8",
  "attributes": {
    "createdAt": "2020-05-12T19:41:04.123Z",
    "fullName": {
      "first": "Peter",
      "last": "Parker"
    },
    "ssn": "721074426",
    "address": {
      "street": "20 Ingram St",
      "street2": null,
      "city": "Forest Hills",
      "state": "NY",
      "postalCode": "11375",
      "country": "US"
    },
    "dateOfBirth": "2001-08-10",
    "email": "peter@oscorp.com",
    "phone": {
      "countryCode": "1",
      "number": "1555555578"
    },
    "status": "Active",
    "soleProprietorship": false,
    "accountPurpose": "PayrollOrDirectDeposit",
    "sourceOfFunds": "SalaryOrWages",
    "transactionVolume": "Between1KAnd5K",
    "profession": "Farmer",
    "eligibleProducts": [
      "Banking",
      "BillPay"
    ],
    "tags": {
      "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
    },
    "authorizedUsers": [
      {
        "fullName": {
          "first": "Erlich",
          "last": "Backman"
        },
        "email": "erlich-backman@piedpiper.com",
        "phone": {
          "countryCode": "1",
          "number": "1234567890"
        },
        "canConnectWithAuthVendor": true
      },
      {
        "fullName": {
          "first": "Nelson",
          "last": "Bighetti"
        },
        "email": "nelson-bighetti@piedpiper.com",
        "phone": {
          "countryCode": "1",
          "number": "1234567891"
        },
        "canConnectWithAuthVendor": false
      }
    ]
  },
  "relationships": {
    "org": {
      "data": {
        "type": "org",
        "id": "1"
      }
    },
    "application": {
      "data": {
        "type": "individualApplication",
        "id": "8"
      }
    },
    "authorizedUserResources": {
      "data": [
        {
          "type": "authorizedUserResource",
          "id": "1"
        },
        {
          "type": "authorizedUserResource",
          "id": "2"
        }
      ]
    }
  }
}

See attribute descriptions above. When soleProprietorship is true, the resource includes sole-proprietor regulatory fields such as website, businessIndustry, and usNexus.

Example Sole Proprietorship IndividualCustomer resource:

{
  "type": "individualCustomer",
  "id": "9",
  "attributes": {
    "createdAt": "2020-05-12T19:41:04.123Z",
    "fullName": {
      "first": "Peter",
      "last": "Parker"
    },
    "ssn": "721074426",
    "address": {
      "street": "20 Ingram St",
      "street2": null,
      "city": "Forest Hills",
      "state": "NY",
      "postalCode": "11375",
      "country": "US"
    },
    "dateOfBirth": "2001-08-10",
    "email": "peter@oscorp.com",
    "phone": {
      "countryCode": "1",
      "number": "1555555578"
    },
    "status": "Active",
    "soleProprietorship": true,
    "ein": "123456789",
    "dba": "Piedpiper Inc",
    "website": "https://www.piedpiper.com",
    "accountPurpose": "EcommerceSales",
    "sourceOfFunds": "SalesOfServices",
    "transactionVolume": "LessThan5K",
    "usNexus": [
      "NotAvailable"
    ],
    "countriesOfOperation": [
      "US",
      "CA"
    ],
    "isIncorporated": false,
    "businessIndustry": "GroceryStoresOrSupermarkets",
    "eligibleProducts": [
      "Banking",
      "BillPay"
    ],
    "tags": {
      "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
    }
  },
  "relationships": {
    "org": {
      "data": {
        "type": "org",
        "id": "1"
      }
    },
    "application": {
      "data": {
        "type": "individualApplication",
        "id": "54"
      }
    },
    "authorizedUserResources": {
      "data": []
    }
  }
}

BusinessCustomer

BusinessCustomer is a JSON:API resource, top-level fields:

Name	Type	Description
id Required	string	Identifier of the customer resource.
type Required	string	Type of the customer resource. For business customer the value is always businessCustomer.
attributes Required	JSON Object	JSON object representing the customer data.
relationships Required	JSON:API Relationships	Describes relationships between the customer resource and other resources.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
name Required	string	Name of the business.
dba Optional	string	"Doing business as".
address Required	Address	Address of the business.
operatingAddress Optional	Address	The operating address of the business.
phone Required	Phone	Phone of the business.
stateOfIncorporation Required	string	Two letters representing a US state.
ein Required	string	Business EIN (numbers only).
website Optional	string	Business's website.
contact Required	BusinessContact	Primary contact of the business.
authorizedUsers Required	Array of AuthorizedUser	Array of authorized users.
status Required	string	Status of the customer, either Active or Archived. You can't do any write operations on an Archived customer.
eligibleProducts Optional	Array of Product	The products that the customer is eligible for.
tags Required	object	See Tags. Inherited from the application tags (see Tag Inheritance).
sourceOfFunds Required	sourceOfFunds	The primary source of funds of the business.
sourceOfFundsDescription	string	Required if sourceOfFunds is one of GovernmentContractsOrGrants,DonationsOrFundraising,ImportExportRevenue.
businessIndustry Required	businessIndustry	The industry of the business.
businessDescription Required	string	A brief description of the business, including its main products or services and the customers.
isRegulated Required	boolean	Is the business regulated by a government agency or financial regulator?
regulatorName	string	Required if isRegulated is true. The name of the regulator if the business is regulated.
usNexus Required	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 Required	accountPurpose	The primary purpose of the account.
accountPurposeDetail	string	Required if accountPurpose is one of CashHeavyIncomeAndOperations,ProfessionalServicesHandlingFunds,CharitableOrNonProfitOrganizationOperations,CommercialCashOperations,ThirdPartyPaymentProcessing.
transactionVolume Required	transactionVolume	The expected monthly transaction volume of the business.
transactionVolumeDescription	string	Required when transactionVolume is $1,000,001 or higher. Further detail around transaction volume selection.
stockExchangeName	string	Required if entityType is PubliclyTradedCorporation. The name of the stock exchange where the business's stock is traded.
stockSymbol	string	Required if entityType is PubliclyTradedCorporation. The stock symbol (ticker) of the business.
countriesOfOperation Required	Array of ISO31661-Alpha2 strings
yearOfIncorporation Required	Year string	Year of incorporation of the business.
isIncorporated Required	boolean	Is the business incorporated.
entityType Required	string	One of LLC, Partnership, PubliclyTradedCorporation, PrivatelyHeldCorporation or NotForProfitOrganization, Estate, Trust,ForeignFinancialInstitution, DomesticFinancialInstitution, GovernmentEntityOrAgency, ReligiousOrganization, Charity.

Relationships

Name	Type	Description
org Required	JSON:API Relationship	The Org of the business.
application Required	JSON:API Relationship	The Application that created this business.
authorizedUserResources Required	JSON:API Relationship	A list of the related AuthorizedUser.
officer Required	Optional, JSON:API Relationship	The related Officer resource for this business customer.
beneficialOwners Required	Optional, array of JSON:API Relationship	The related BeneficialOwner resources for this business customer.

Example BusinessCustomer resource:

{
  "type": "businessCustomer",
  "id": "1",
  "attributes": {
    "createdAt": "2020-05-10T12:28:37.698Z",
    "name": "Pied Piper",
    "address": {
      "street": "5230 Newell Rd",
      "street2": null,
      "city": "Palo Alto",
      "state": "CA",
      "postalCode": "94303",
      "country": "US"
    },
    "phone": {
      "countryCode": "1",
      "number": "1555555578"
    },
    "stateOfIncorporation": "DE",
    "ein": "123456789",
    "entityType": "Corporation",
    "contact": {
      "fullName": {
        "first": "Richard",
        "last": "Hendricks"
      },
      "email": "richard@piedpiper.com",
      "phone": {
        "countryCode": "1",
        "number": "1555555578"
      }
    },
    "authorizedUsers": [
      {
        "fullName": {
          "first": "Jared",
          "last": "Dunn"
        },
        "email": "jared@piedpiper.com",
        "phone": {
          "countryCode": "1",
          "number": "1555555590"
        },
        "canConnectWithAuthVendor": true
      },
      {
        "fullName": {
          "first": "Nelson",
          "last": "Bighetti"
        },
        "email": "nelson-bighetti@piedpiper.com",
        "phone": {
          "countryCode": "1",
          "number": "1234567891"
        },
        "canConnectWithAuthVendor": true
      }
    ],
    "isIncorporated": true,
    "yearOfIncorporation": "2014",
    "businessIndustry": "TechnologyMediaOrTelecom",
    "accountPurpose": "RetailSalesInPerson",
    "sourceOfFunds": "SalesOfGoods",
    "transactionVolume": "Between1KAnd5K",
    "usNexus": [
      "NotAvailable"
    ],
    "countriesOfOperation": [
      "US",
      "CA"
    ],
    "isRegulated": false,
    "website": "www.piedpiper.com",
    "businessDescription": "We are a technology company that sells technology products to our customers.",
    "status": "Active",
    "eligibleProducts": [
      "Banking",
      "BillPay"
    ],
    "tags": {
      "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
    }
  },
  "relationships": {
    "org": {
      "data": {
        "type": "org",
        "id": "1"
      }
    },
    "application": {
      "data": {
        "type": "businessApplication",
        "id": "1"
      }
    },
    "authorizedUserResources": {
      "data": [
        {
          "type": "authorizedUserResource",
          "id": "1"
        },
        {
          "type": "authorizedUserResource",
          "id": "2"
        }
      ]
    }
  }
}