KYB

KYB flow can be used for enrolling customers who own small businesses.

Partners who are configured for KYB flow, can enroll customers who own small businesses. An optional node, businessData, will be available under the encryptedUserData payload.

Successful Business Enrollment (Happy Path):

  • The accountType, businessData (required fields), and business phone number is provided by the customer during enrollment.
  • POST /enrollments is submitted and processed.
  • The customer’s account is created and activated, including paymentInstruments.

Response Codes

ScenarioHTTP Status CodeCodesubCodeDescription
When POST /enrollments is submitted and processed and businessData required fields are missing.4002000property name is required
When POST /enrollments is submitted and processed and the account Type provided is:
• consumer or
• Is not provided at all (defaults to consumer) and businessData node is provided
4006300businessData is only valid when accountType is "business”

Active Small Business Account Limits

Social Security Number (SSN) Limits

  • Up to 10 active accounts with the same SSN per program is allowed
  • Up to 20 lifetime accounts with the same SSN per program are allowed

Phone Limits

The following phone limits will be implemented (during enrollment) only for the phone number that is listed as the default for the account:

  • Up to 10 active accounts with the same phone number per program are allowed
  • Up to 20 lifetime accounts with the same phone number per program are allowed

ITIN Limits

  • Up to 10 active accounts with the same ITIN per program are allowed
  • Up to 20 lifetime accounts with the same ITIN per program are allowed

Refer to Active Consumer Account Limits for details about consumer account limit thresholds.

Response Codes

Account TypeScenarioCodeSubCodeDescription
BusinessMore than 10 active accounts are created with the same phone number per program.263Maximum number of active accounts with the same phone number.
BusinessMore than 20 lifetime accounts are created with the same phone number.266Maximum number of accounts over a lifetime with the same phone number.
BusinessThe limit of active accounts with the same SSN or ITIN is exceeded.260Number of Active Accounts Exceeded.
BusinessThe limit of lifetime accounts with the same SSN or ITIN is exceeded.261Number of Activated Accounts over Lifetime exceeded.

Sample Request: - POST /programs/{programCode}/enrollments

{
  "user":{
	"encryptedUserData":{
	  "version":"EC_v1",
	  "ephemeralPublicKey":"AABBBCC ==",
	  "publicKeyHash":"abc123=",
	  "data":"encryptedString”
	},
	"termsAcceptances": [{
	  "termsIdentifier": "termsAndConditions",
	  "termsAcceptanceDateTime": "2019-10-22T00":"21":18.847Z"
	}]
},
"account": {
"accountType":"business",
"productCode": "99999",

Sample Unencrypted Business Data Object

{
	"businessData": {-- required if accountType is “business”, but otherwise must be excluded.
	"businessName": "Acme Corporation",
	"businessAddressLine1": "100 Main St.",
	"businessAddressLine2": "Suite 100", -- optional
	"businessCity": "Pasadena",
	"businessState": "CA",
	"businessZipCode": "91107",
	"businessCountryCode": "USA",
	"businessType": "soleProp", -- required.
	"businessTaxID": "1234567", -- optional for soleProp
	"businessIndustry": "12345", -- Cannot be retrieved. Passed to Green Dot’s backend fraud system as optional business metadata.
	"avgMonthlyProcessingVolume": 1234567.12, -- Cannot be retrieved. Passed to Green Dot’s backend fraud system as optional business metadata.                               
	"businessEmailAddress": "[email protected]" -- optional.  Only provide if distinct from the user’s email address which should be provided under the email node.
	"URL": "http"://www.acmecorpA7E.com", -- Cannot be retrieved. Passed to Green Dot’s backend fraud system as optional business metadata.
	},
	"profileData": {
	  "firstName": "Alice",
	  "middleName": "Mary",
	  "lastName": "Jones",
	  "addresses": 
	  [{
	    "addressLine1": "215 Main St.",
	    "addressLine2": "Suite 200",
	    "city": "Pasadena",
	    "state": "CA",
	    "zipCode": "91107",
	    "countryCode": "USA",
	    "type": "home",
	    "isDefault": true
     }]
	},
	"identifyingData": {
	  "ssn": "555555555",
	  "dateOfBirth": "1990-01-20"
	},
	"email": {
	  "emailAddress": "[email protected]" -- re-use business email if no personal email.
	},
	"phoneNumbers": [{
	  "number": "3105555555",
	  "type": "mobile",
	  "isDefault": true
	}]
}

Business Data Schema Validations - business Data Node

PropertyMinimum LengthMaximum LengthValid Characters/Values
businessName1100In general:

Allowable values for name fields are ascii 32 to 126.

ascii characters that are not allowed (decimal representation) are:
• 33-38
• 40-43
• 47
• 58-64
• 91-96
• 123-126 .

Special allowed characters are listed in the Appendices as “allowed”.
businessLegalNameN/AN/A• For small business programs, businessLegalName will be an optional parameter during enrollment. • Please provide the businessLegalName, if it is different from the businessName (typically the DBA name).
businessAddressLine1140In general: Allowable values for city and address are ascii 32 - 126 and 192 - 255. address exceptions (disallowed): 33-34, 36-37, 42-43, 58-64, 91-96, 123-126, 215, 247 and address specific: 217-220
businessAddressLine2Optional. 1 if provided40same as address line 1
businessCity125city exceptions (disallowed): 33-34, 36- 37, 42-43, 58-64, 91-96, 123-126, 215, 247
businessState12Deferred to a future sprint
businessZipCode55 (truncated)The 1st 5 characters must be digits and it must be 5 digits long. Any characters after the first 5 digits will be truncated.
businessCountryCode33USA
businessTypeenumN/A• ConsumerProfileType • Individual • soleProp • llc • corp • partnership • nonprofit • SingleLLC • ProCorp
businessTaxIDOptional. 9 if provided.9Description not available.
businessIndustryOptional. 1 if provided20Note: Cannot be retrieved by the Partner. Passed to Green Dot’s backend fraud system as optional business metadata.
avgMonthlyProcessingVolumeOptionalN/ANote: Cannot be retrieved by the Partner. Passed to Green Dot’s backend fraud system as optional business metadata.
businessEmailAddressOptionalN/AValid email if provided
URLOptionalN/ANote: Cannot be retrieved by the Partner. Passed to Green Dot’s backend fraud system as optional business metadata.

Note: Refer to the Valid Characters for Names, Cities, and Addresses table for details.

Response Codes - Length Validation

Type of Response CodesHTTP Status CodeCodesubCodeProperty
Length Validation400400507businessName
Length Validation400400504city
Length Validation400400505addressLine1
Length Validation400400506addressLine2
Length Validation4004000zipCode
Length Validation4004000businessState
Length Validation4004000businessZipCode
Length Validation4004000businessTaxID
Length Validation4004000businessIndustry
Invalid Character Validation400640507businessName
Invalid Character Validation400640504city
Invalid Character Validation400640505addressLine1
Invalid Character Validation400640506addressLine2
Additional Validation Errors400350N/AInvalid Business Zip Code
Additional Validation Errors400740N/AInvalid URL Format
Additional Validation Errors400750N/AInvalid Email Format
Additional Validation Errors400600N/AInvalid Business Country Code
Additional Validation Errors400600N/AInvalid Business Type
Additional Validation Errors400300N/AInvalid Avg Monthly Processing Volume