KYB Overview

Partners who are configured for KYB flow can enroll customers who own small businesses.

📘

Please note that an optional node, businessData, will be available under the encryptedUserData payload.

Successful Business Enrollment

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

Response Codes

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

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",
 	"businessLegalName": "Acme United Corporation LLC", -- Required if different from businessName.
 	"businessEmbossedName": "ACME UNT CORP", -- Optional, if you want to override the use of "businessName" on the card.
	"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

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

Response Codes - Length Validation

Business Profile API Endpoints

Get Business Profile

This endpoint allows the retrieval of business data associated with a business account.

Response Codes

Update Business Profile

This endpoint allows Partners to update the business data associated with a business account.

This endpoint can be used with the following businessTypes:

• ConsumerProfileType
• Individual
• soleProp
• llc
• corp
• partnership
• nonprofit
• SingleLLC
• ProCorp

📘

If the businessName on the account is updated, then the next card replacement request will use the updated businessName.

Currently, both plaintext and encryption are supported; If both plaintext and encryption have values, the encrypted data is processed first and the plaintext is no longer processed.

Response Codes

Retrieve Business Data

This endpoint allows the retrieval of business data associated with a business account.

Get Business Lookup Data

This endpoint retrieves business data.

Save Business Address

This endpoint saves the business address.

Set Business Profile Owner

This endpoint sets the profile owner for the business.

Update Business Profile Owner

This endpoint updates the business profile owner.

Delete Owner

This endpoint deletes the business profile owner.

Save Business Info

This endpoint saves the info for the business.

Get Business Metadata

This endpoint retrieves the metadata for the business.

Save Business Application

This endpoint saves the application for the business.