The Business Account object represents a RocketKOR Business Account. This object contains details about the Business Account such as the account ID, name, description, industry code, and Identity Verification (IDV) status. It also contains the ID of the account’s Parent Business Account.
id
string (UUID)
ID of the Business Account.
parentId
string (UUID)
ID of the Parent Business Account.
name
string
Business Account name.
description
string
Business Account description.
industryCode
string, value range: 001001 to 999999
Industry code for the Business Account. 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 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.
firstName REQUIRED
string, min length: 1, max length: 40
Contact’s first name.
middleName
string, min length: 1, max length: 40
Contact’s middle name.
lastName REQUIRED
string, min length: 1, max length: 40
Contact’s last name.
primary
boolean
Whether this is the primary contact for the business.
primaryPhoneNumber REQUIRED
object
Contact’s primary phone number.
primaryPhoneNumber REQUIRED
object
Contact’s primary phone number.
type REQUIRED
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 REQUIRED
object
Contact’s primary email address.
value REQUIRED
string (email), max length: 320
Contact’s email address.
verified
boolean
Whether the email address has been verified through Identity Verification (IDV).
verificationStatus
object
Current Identity Verification (IDV) status of the Business 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:
Business Account Object
{
"id": "string(UUID)",
"parentId": "string(UUID)",
"name": "string",
"description": "string",
"industryCode": "string",
"registeredStateCode": "string",
"contacts": [
{
"firstName": "string",
"middleName": "string",
"lastName": "string",
"primary": boolean,
"primaryPhoneNumber": {
"number": "string",
"type": "HOME | MOBILE | WORK",
"provider": "string",
"extension": "string",
"verified": boolean
},
"primaryEmail": {
"value": "string(email)",
"verified": boolean
}
}
],
"verificationStatus": {
"status": "UNVERIFIED | PROCESSING | APPROVED | REVIEW | DECLINED | RESTRICTED",
"reason": "string",
"updatedAt": "string(date-time)",
"updatedBy": {
"id": "string(UUID)",
"type": "employee | internal | kor_employee | service-account"
}
}
}
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.
