The Business Customer object represents a Customer Account that has been created for a business. The account contains the Customer’s profile (business name, addresses, contact information, etc.), industry code, and Identity Verification (IDV) status.
id
string (UUID)
ID of the Customer Account.
status
string enum, values: ACTIVE, SUSPENDED
Current status of the Customer Account. The following values are supported:
externalId
string
Your organization’s external reference number for the Customer. Required for Customer Accounts that are linked to an Earned Wage Access (EWA) Customer Profile.
Note An externalId can also be added to the Customer Account when enrolling the Customer in an EWA program.
addresses
array
Customer addresses.
type
string enum, values: MAILING, PHYSICAL, SHIPPING
Type of address. The following values are supported:
name
object
Name of the contact person for shipments. Required if type is SHIPPING. Ignored for other address types.
firstName
string, min length: 1, max length: 40
Contact person’s first name.
middleName
string, min length: 1, max length: 40
Contact person’s middle name.
lastName
string, min length: 1, max length: 40
Contact person’s last name.
streetLine1
string, min length: 1, max length: 50
First line of the street address.
streetLine2
string, min length: 1, max length: 50
Second line of the street address.
streetLine3
string, min length: 1, max length: 50
Third line of the street address.
streetLine4
string, min length: 1, max length: 50
Fourth line of the street address. Only used for issued cards.
streetLine5
string, min length: 1, max length: 50
Fifth line of the street address. Only used for issued cards.
apartmentNumber
string
Apartment number.
cityName
string, min length: 1, max length: 25
City.
stateCode
string, min length: 2, max length: 3
State, province, or territory. Required if countryCode is USA or CAN. Must be an ISO 3166-2 uppercase alpha 2-character or 3-character country subdivision code (for example, Missouri is MO).
countryCode
string, min length: 3, max length: 3
Country code. Must be an ISO 3166-1 uppercase alpha 3-character country code. For example, the United States is USA and Canada is CAN.
zipCode
string, min length: 1, max length: 10
Zip code or postal code. Required if countryCode is USA or CAN. For US addresses, must be a valid value of 5 digits (example: 63368) or 5 digits-4 digits (example: 63368-5555). Can be alphanumeric for other countries.
primary
boolean
Whether this is the primary address for this address type. A primary address must be specified for each address type added to the Customer Account.
verified
boolean
Whether this address has been verified through Identity Verification (IDV).
metadata
string, max properties: 6, value max length: 1024
Key/value pairs used to store additional information about the Customer.
verificationStatus
object
Current Identity Verification (IDV) status of the Customer Account.
status
string enum, values: UNVERIFIED, PROCESSING, APPROVED, REVIEW, DECLINED, RESTRICTED
IDV status of the account. Possible values are:
reason
string
Reason for the account’s IDV status.
updatedAt
string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz
Date and time the account’s IDV status was last updated.
updatedBy
object
Entity that last updated the account’s IDV status.
id
string (UUID)
ID of the entity. Will be blank if updatedBy.type is internal.
type
string enum, values: employee, internal, kor_employee, service-account
Type of entity. The following values are supported:
verificationStatusHistory
array
History of IDV status changes for the Customer Account. The most recent status is shown first.
status
string enum, values: UNVERIFIED, PROCESSING, APPROVED, REVIEW, DECLINED, RESTRICTED
IDV status of the account. Possible values are:
reason
string
Reason for the account’s IDV status.
updatedAt
string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz
Date and time the account’s IDV status was last updated.
updatedBy
object
Entity that last updated the account’s IDV status.
id
string (UUID)
ID of the entity. Will be blank if updatedBy.type is internal.
type
string enum, values: employee, internal, kor_employee, service-account
Type of entity. The following values are supported:
createdBy
object
Entity that created the Customer Account.
id
string (UUID)
ID of the entity. Will be blank if createdBy.type is internal.
type
string enum, values: employee, internal, kor_employee, service-account
Type of entity. The following values are supported:
createdAt
string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz
Date and time the Customer was created in the RocketKOR system.
updatedBy
object
Entity that last updated the Customer Account.
id
string (UUID)
ID of the entity. Will be blank if updatedBy.type is internal.
type
string enum, values: employee, internal, kor_employee, service-account
Type of entity. The following values are supported:
updatedAt
string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz
Date and time the Customer was last updated.
type
string enum, value: BUSINESS
Type of Customer. Value must be BUSINESS.
businessName
string, min length: 1, max length: 100
Name of the business.
doingBusinessAsName
string, min length: 1, max length: 100
Business operating name. Used by the business in marketing and day-to-day activities.
industryCode
string, value range: 001001 to 999999
Industry code for the Business Customer. The industry code is the combination of the category code and subcategory code.
registeredStateCode
string, min length: 2, max length: 3
Registered state code if the Business Customer is registered in the US. Must be an ISO 3166-2 uppercase alpha 2-character or 3-character country subdivision code (for example, Missouri is MO).
contacts
object
Contacts for the business. A primary contact must be provided.
firstName
string, min length: 1, max length: 40
Contact’s first name.
middleName
string, min length: 1, max length: 40
Contact’s middle name.
lastName
string, min length: 1, max length: 40
Contact’s last name.
primary
boolean
Whether this is the primary contact for the business. At least one contact must be marked as primary.
primaryPhoneNumber
object
Contact’s primary phone number.
number
string
Contact’s phone number. The phone number can be entered in any of the following formats:
The phone number will be converted to E.164 format (example: +14151234).
type
string enum, values: HOME, MOBILE, WORK
Type of phone number.
provider
string, min length: 1, max length: 40
Phone provider.
extension
string, min length: 1, max length: 40
Phone extension.
verified
boolean
Whether the phone number has been verified through Identity Verification (IDV).
primaryEmail
object
Contact’s primary email address.
value
string (email), max length: 320
Contact’s email address.
verified
boolean
Whether the email address has been verified through Identity Verification (IDV).
legalName
string, min length: 1, max length: 40
Legal name of the business.
primaryPhone
string
Primary phone number for the business in E.164 format:
[+][country code][phone number including area code]
Example: +14151234
primaryEmail
string (email)
Primary email address for the business
website
string (url)
Complete URL for the business website (example: https://abc.com).
dateOfFormation
string (date), format: yyyy-MM-dd
Date the business was officially created.
legalEntityType
string enum, values: SP, GP, LP, LLP, LLLP, LLC, CORP, NONPROFIT, GOVERNMENT
Legal definition of the business. The following values are supported:
taxIdCountryCode
string, min length: 3, max length: 3
Country where the tax ID was issued. Must be an ISO 3166-1 uppercase alpha 3-character country code. For example, the United States is USA and Canada is CAN. Required if taxId is provided.
taxId
string, max length: 50
Unique national tax identifier for the business, such as an Employer Identification Number (EIN) in the United States. Responses include a truncated value only.
Business Customer Object
{
"id": "string(UUID)",
"status": "ACTIVE | SUSPENDED",
"externalId": "string",
"addresses": [
{
"type": "string",
"name": {
"firstName": "string",
"middleName": "string",
"lastName": "string"
},
"streetLine1": "string",
"streetLine2": "string",
"streetLine3": "string",
"streetLine4": "string",
"streetLine5": "string",
"apartmentNumber": "string",
"cityName": "string",
"stateCode": "string",
"countryCode": "string",
"zipCode": "string",
"primary": boolean,
"verified": boolean
}
],
"metadata": {
"key": "value"
},
"verificationStatus": {
"status": "UNVERIFIED | PROCESSING | APPROVED | RESTRICTED | REVIEW | DECLINED",
"reason": "string",
"updatedAt": "string(date-time)",
"updatedBy": {
"id": "string(UUID)",
"type": "type": "employee | internal | kor_employee | service-account"
}
},
"verificationStatusHistory": [
{
"status": "UNVERIFIED | PROCESSING | APPROVED | RESTRICTED | REVIEW | DECLINED",
"reason": "string",
"updatedAt": "string(date-time)",
"updatedBy": {
"id": "string(UUID)",
"type": "employee | internal | kor_employee | service-account"
}
}
],
"createdBy": {
"id": "string(UUID)",
"type": "employee | internal | kor_employee | service-account"
},
"createdAt": "string(date-time)",
"updatedBy": {
"id": "string(UUID)",
"type": "employee | internal | kor_employee | service-account"
},
"updatedAt": "string(date-time)",
"type": "BUSINESS", // value must be BUSINESS
"businessName": "string",
"doingBusinessAsName": "string",
"industryCode": "string",
"registeredStateCode": "string",
"contacts": [
{
"firstName": "string",
"middleName": "string",
"lastName": "string",
"primary": boolean,
"primaryPhoneNumber": {
"number": "string",
"type": "WORK | HOME | MOBILE",
"provider": "string",
"extension": "string",
"verified": boolean
},
"primaryEmail": {
"value": "string",
"verified": boolean
}
}
],
"legalName": "string",
"primaryPhone": "string",
"primaryEmail": "string",
"website": "string(url)",
"dateOfFormation": "string",
"legalEntityType": "string",
"taxIdCountryCode": "string",
"taxId": "string"
}
Step into the future of Finance with RocketKOR! Simplify payments, banking, lending, and data analytics using our versatile KOR Platform.
A Rocket Financial Inc. company
@ 2024 RocketKOR, Inc. All rights reserved.
