Types
CreateOfficer
| Field | Type | Description |
|---|---|---|
| fullName | FullName | Full name of the officer. |
| title | string | One of CEO, COO, CFO, President, BenefitsAdministrationOfficer, CIO, VP, AVP, Treasurer, Secretary, Controller, Manager, Partner or Member. |
| ssn | string | SSN of the officer (numbers only). One of ssn or passport is required. It is optional to provide only last 4 SSN digits. |
| passport | string | Passport of the officer. One of ssn or passport is required. |
| nationality | ISO31661-Alpha2 string | Always when Passport is populated and optional when SSN is populated. Two letters representing the officer's nationality. |
| dateOfBirth | RFC3339 Date string | Date only (e.g. "2001-08-15"). |
| address | Address | The officer's address. |
| phone | Phone | The officer's phone number. |
| string | The officer's email address. | |
| evaluationParams | EvaluationParams | Optional. Evaluation Params for this entity. |
Example CreateOfficer type:
{
"fullName": {
"first": "Richard",
"last": "Hendricks"
},
"dateOfBirth": "2001-08-15",
"ssn": "721074426",
"email": "richard@piedpiper.com",
"phone": {
"countryCode": "1",
"number": "5555555555"
},
"address": {
"street": "5230 Newell Rd",
"city": "Palo Alto",
"state": "CA",
"postalCode": "94303",
"country": "US"
}
}
Officer
| Field | Type | Description |
|---|---|---|
| status | string | One of Approved, Denied or PendingReview. |
| fullName | FullName | Full name of the officer. |
| title | string | One of CEO, COO, CFO, President, BenefitsAdministrationOfficer, CIO, VP, AVP, Treasurer, Secretary, Controller, Manager, Partner or Member. |
| ssn | string | SSN of the officer (numbers only). One of ssn or passport is required. |
| passport | string | Passport of the officer. One of ssn or passport is required. |
| nationality | ISO31661-Alpha2 string | Always when Passport is populated and optional when SSN is populated. Two letters representing the officer's nationality. |
| dateOfBirth | RFC3339 Date string | Date only (e.g. "2001-08-15"). |
| address | Address | The officer's address. |
| phone | Phone | The officer's phone number. |
| string | The officer's email address. | |
| idTheftScore | number | Optional. Score (0-1000) for ID theft verification, >900 is auto rejected as default (threshold is configurable). |
Example Officer type:
{
"status": "Approved",
"fullName": {
"first": "Richard",
"last": "Hendricks"
},
"dateOfBirth": "2001-08-15",
"ssn": "721074426",
"email": "richard@piedpiper.com",
"phone": {
"countryCode": "1",
"number": "5555555555"
},
"address": {
"street": "5230 Newell Rd",
"city": "Palo Alto",
"state": "CA",
"postalCode": "94303",
"country": "US"
}
}
CreateBeneficialOwner
| Field | Type | Description |
|---|---|---|
| fullName | FullName | Full name of the beneficial owner. |
| ssn | string | SSN of the beneficial owner (numbers only). One of ssn or passport is required. It is optional to provide only last 4 SSN digits. |
| passport | string | Passport of the beneficial owner. One of ssn or passport is required. |
| nationality | ISO31661-Alpha2 string | Always when Passport is populated and optional when SSN is populated. Two letters representing the beneficial owner's nationality. |
| dateOfBirth | RFC3339 Date string | Date only (e.g. "2001-08-15"). |
| address | Address | The beneficial owner's address. |
| phone | Phone | The beneficial owner's phone number. |
| string | The beneficial owner's email address. | |
| percentage | integer | The beneficial owner percentage of ownership at the business (between 25 and 100). |
| evaluationParams | EvaluationParams | Optional. Evaluation Params for this entity. |
Example CreateBeneficialOwner type:
{
"fullName": {
"first": "Richard",
"last": "Hendricks"
},
"dateOfBirth": "2001-08-15",
"ssn": "721074426",
"email": "richard@piedpiper.com",
"percentage": 25,
"phone": {
"countryCode": "1",
"number": "5555555555"
},
"address": {
"street": "5230 Newell Rd",
"city": "Palo Alto",
"state": "CA",
"postalCode": "94303",
"country": "US"
}
}
BeneficialOwner
| Field | Type | Description |
|---|---|---|
| status | string | One of Approved, Denied or PendingReview. |
| fullName | 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 | Always when Passport is populated and optional when SSN is populated. Two letters representing the beneficial owner's nationality. |
| dateOfBirth | RFC3339 Date string | Date only (e.g. "2001-08-15"). |
| address | Address | The beneficial owner's address. |
| phone | Phone | The beneficial owner's phone number. |
| string | The beneficial owner's email address. | |
| percentage | integer | The beneficial owner percentage of ownership at the business (between 25 and 100). |
| idTheftScore | number | Optional. Score (0-1000) for ID theft verification, >900 is auto rejected as default (threshold is configurable). |
Example BeneficialOwner type:
{
"status": "Approved",
"fullName": {
"first": "Richard",
"last": "Hendricks"
},
"percentage": 25,
"dateOfBirth": "2001-08-15",
"ssn": "721074426",
"email": "richard@piedpiper.com",
"phone": {
"countryCode": "1",
"number": "5555555555"
},
"address": {
"street": "5230 Newell Rd",
"city": "Palo Alto",
"state": "CA",
"postalCode": "94303",
"country": "US"
}
}
Profession
The profession of the individual. One of: Accountant, Actor, Administrator, Analyst, Architect, Artist, Attorney, Auditor, Banker, Barber, Bartender, Bookkeeper, Broker, BusinessOwner, Chef, Clergy, Coach, Consultant, Contractor, CustomerServiceRepresentative, Dentist, Designer, Developer, Doctor, Driver, Economist, Educator, Electrician, Engineer, Entrepreneur, EventPlanner, Executive, Farmer, FinancialAdvisor, Firefighter, Fisherman, FlightAttendant, Freelancer, GovernmentEmployee, GraphicDesigner, HealthcareWorker, HRProfessional, InsuranceAgent, Investor, ITSpecialist, Janitor, Journalist, Laborer, LawEnforcementOfficer, Lawyer, Librarian, LogisticsCoordinator, Manager, MarketingProfessional, Mechanic, MilitaryPersonnel, Musician, Nurse, Optometrist, Painter, Pharmacist, Photographer, PhysicalTherapist, Pilot, Plumber, PoliceOfficer, Professor, Programmer, ProjectManager, RealEstateAgent, Receptionist, Researcher, RetailWorker, Salesperson, Scientist, SocialWorker, SoftwareEngineer, Student, Surgeon, Teacher, Technician, Therapist, Trainer, Veterinarian, WaiterWaitress, Writer.
Source of Funds
The source of funds for the individual or business.
| Application Type | Values |
|---|---|
| Business or Sole Proprietor | SalesOfGoods, SalesOfServices, CustomerPayments, InvestmentCapital, BusinessLoans, OwnerContributions, FranchiseRevenue, RentalIncome, GovernmentContractsOrGrants, DonationsOrFundraising, MembershipFeesOrSubscriptions, LicensingOrRoyalties, CommissionIncome, ImportExportRevenue, CryptocurrencyRelatedActivity |
| Individual | SalaryOrWages, BusinessIncome, InvestmentIncome, RetirementSavings, Inheritance, Gift, SaleOfAssets, LegalSettlement, LoanProceeds |
Business Industry
The business industry.
| Category | Values |
|---|---|
| Retail | GroceryStoresOrSupermarkets, ConvenienceStores, SpecialtyFoodRetailers, GasStationsWithRetail, GeneralMerchandiseOrDepartmentStores, OnlineRetailOrECommerce, SubscriptionAndMembershipPlatforms, DirectToConsumerBrands, Cannabis |
| Financial Services | BanksOrCreditUnions, FinTechOrPaymentProcessing, InsuranceProviders, InvestmentAdvisorsOrBrokerDealers, LendingOrMortgageCompanies, TreasuryManagementPlatforms, PersonalFinanceAppsOrAIAssistants, RetirementPlanning, RealEstateInvestmentPlatforms, MoneyServiceBusinesses, Cryptocurrency, DebtCollection, PaydayLending, Gambling |
| Food & Agriculture | FarmsOrAgriculturalProducers, FoodWholesalersOrDistributors, RestaurantsOrCafes, BarsOrNightclubs, CateringServices, FarmersMarkets, RestaurantTechAndPOSProviders |
| Healthcare | HospitalsOrClinics, Pharmacies, MedicalEquipmentSuppliers, BiotechnologyFirms, HomeHealthServices, HealthcareStaffingPlatforms, WellnessAndBenefitsPlatforms, HealthcareAndSocialAssistance |
| Professional Services | LegalServices, AccountingOrAuditingFirms, ConsultingFirms, MarketingOrAdvertisingAgencies, RealEstateAgentsOrPropertyManagers, CorporateServicesAndIncorporation, HRAndWorkforceManagementPlatforms, DirectMarketingOrTelemarketing, LegalAccountingConsultingOrComputerProgramming |
| Manufacturing | ChemicalManufacturing, ElectronicsOrHardwareManufacturing, AutomotiveManufacturing, ConstructionMaterials, TextilesOrApparel, Mining |
| Real Estate & Construction | RealEstate, Construction |
| Other | TransportationOrWarehousing, WholesaleTrade, BusinessSupportOrBuildingServices, EscortServices, DatingOrAdultEntertainment |
AccountPurpose
The primary purpose of the account.
| Application Type | Values |
|---|---|
| Business or Sole Proprietor | RetailSalesInPerson, EcommerceSales, CashHeavyIncomeAndOperations, ImportExportTradeOperations, ProfessionalServicesNotHandlingFunds, ProfessionalServicesHandlingFunds, HoldingOrInvestmentCompanyOperations, PropertyManagementOrRealEstateOperations, CharitableOrNonProfitOrganizationOperations, ConstructionAndContractingOperations, CommercialCashOperations, FreightForwardingOrLogisticsOperations, ThirdPartyPaymentProcessing, TechnologyStartupOperations, WholesaleDistributionOperations, FranchiseOperationOperations, HealthcareProviderOperations, EducationalInstitutionOperations |
| Individual | PayrollOrDirectDeposit, PersonalSavingsOrEmergencyFund, EverydaySpending, DomesticP2PAndBillPay, InternationalRemittances, CashHeavyPersonalIncome, PropertyPurchaseOrInvestment, EducationOrStudentUse, TrustOrEstateDistributions, Cryptocurrency |
Transaction Volume
The expected transaction volume.
Business
| Value | Description |
|---|---|
LessThan10K | $0 - $10,000 |
Between10KAnd50K | $10,000 - $50,000 |
Between50KAnd250K | $50,000 - $250,000 |
Between250KAnd1M | $250,000 - $1,000,000 |
Between1MAnd2M | $1,000,000 - $2,000,000 |
GreaterThan2M | $2,000,000+ |
Individual
| Value | Description |
|---|---|
LessThan1K | $0 - $1,000 |
Between1KAnd5K | $1,000 - $5,000 |
Between5KAnd15K | $5,000 - $15,000 |
Between15KAnd30K | $15,000 - $30,000 |
Between30KAnd60K | $30,000 - $60,000 |
GreaterThan60K | $60,000+ |
Sole Proprietorship
| Value | Description |
|---|---|
LessThan5K | $0 - $5,000 |
Between5KAnd20K | $5,000 - $20,000 |
Between20KAnd75K | $20,000 - $75,000 |
Between75KAnd150K | $75,000 - $150,000 |
Between150KAnd300K | $150,000 - $300,000 |
GreaterThan300K | $300,000+ |
US Nexus
The nature of the business or sole proprietor's ties to the United States. Either notAvailable or one or more of the other values: Employees, Customers, PhysicalOfficeOrFacility, or BankingRelationships.
Entity Type
The entity type of the business. One of: Estate, Trust, ForeignFinancialInstitution, DomesticFinancialInstitution, GovernmentEntityOrAgency, ReligiousOrganization, Charity, LLC, Partnership, PubliclyTradedCorporation, PrivatelyHeldCorporation, NotForProfitOrganization.