The Business Customer object represents a RocketKOR Customer Account that has been created for a business.
Note You can also create a RocketKOR Customer Account for an individual.
id
string (UUID)
Unique ID assigned to the customer.
status
string enum, values: ACTIVE, SUSPENDED
Current status of the customer’s RocketKOR account. Possible values are ACTIVE (account is active) and SUSPENDED (account is inactive).
addresses
array
Customer addresses. You can add multiple addresses, such as a billing address, shipping address, and mailing address.
type
string enum, values: WORKPLACE, RESIDENTIAL, MAILING, BILLING, SHIPPING, OTHER
Type of address.
addressLine1
string, max length: 50, min length: 1
Address line 1.
addressLine2
string, max length: 50, min length: 1
Address line 2.
addressLine3
string, max length: 50, min length: 1
Address line 3.
addressLine4
string, max length: 50, min length: 1
Address line 4.
addressLine5
string, max length: 50, min length: 1
Address line 5.
cityName
string
Customer’s city.
stateCode
string
Customer’s state, province, or territory. Required if country 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
Customer’s country. Must be an ISO 3166-1 uppercase alpha 3-character country code. For example, the United States is USA.
zipCode
string
Customer’s zip code or postal code.
shippingContact
object
Customer’s shipping contact person.
shipToFirstName
string, max length: 40, min length: 1
First name of the person responsible for receiving shipments.
shipToMiddleName
string, max length: 40, min length: 1
Middle name of the person responsible for receiving shipments.
shipToLastName
string, max length: 40, min length: 1
Last name of the person responsible for receiving shipments.
metadata
string, max items: 5, value max length: 1024
Use a maximum of 5 key/value pairs to store additional information about the customer.
createdBy
object
Entity that requested the customer creation. This could be a RocketKOR Service Account (if the customer was created via an API) or a Team Member (if the customer was created in the RocketKOR Portal).
id
string (UUID)
ID of the entity that requested the customer creation.
type
string enum, values: EMPLOYEE, SERVICE_ACCOUNT
Type of entity that created the customer. Possible values are:
createdAt
string (date-time), required 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. This could be a RocketKOR Service Account (if the customer was updated via an API) or a Team Member (if the customer was updated in the RocketKOR Portal).
id
string (UUID)
ID of the entity that last updated the customer.
type
string enum, values: EMPLOYEE, SERVICE_ACCOUNT
Type of entity that last updated the customer. Possible values are:
updatedAt
string (date-time), required format: yyyy-MM-dd’T’HH:mm:ss.SSSz
Date and time the customer was last updated.
type
string enum, values: INDIVIDUAL, BUSINESS
Type of customer. For business customers, value must be BUSINESS.
doingBusinessAsName
string, max length: 40, min length: 1
Business operating name. Used by the business in marketing and day-to-day activities.
contacts
object
Contacts for the business. At least one contact mut be provided.
firstName
string, max length: 40, min length: 1
Contact’s first name.
middleName
string, max length: 40, min length: 1
Contact’s middle name.
lastName
string, max length: 40, min length: 1
Contact’s last name.
primary
boolean
Whether this is the primary contact for the business.
primaryPhoneNumber
object
Contact’s primary phone number.
number
string
required format: [+] [country code] [phone number including area code]
Contact’s phone number. The phone number can be entered in any of the following formats:
[+] [country code] [phone number including area code] (example: +14151234)
[country code] [phone number including area code] (example: 14151234)
[phone number including area code] (example: 4151234)
RocketKOR will convert the phone number to E.164 format (example: +14151234).
type
string enum, values: WORK, HOME, MOBILE
Type of phone number.
provider
string, max length: 40, min length: 1
Phone provider.
extension
string, max length: 10, min length: 1
Phone extension.
verified
boolean
Whether the phone number has been verified.
primaryEmail
string (email), max length: 320
Contact’s primary email address.
value
string (email), max length: 320
Contact’s email address.
verified
boolean
Whether the email address has been verified.
Business Customer Object
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "ACTIVE",
"addresses": [
{
"type": "MAILING",
"addressLine1": "100 Main St",
"addressLine2": "Suite 100",
"addressLine3": "",
"addressLine4": "",
"addressLine5": "",
"cityName": "Greenville",
"stateCode": "MO",
"countryCode": "USA",
"zipCode": "63368"
},
{
"type": "SHIPPING",
"addressLine1": "200 King St",
"addressLine2": "Suite 310",
"addressLine3": "",
"addressLine4": "",
"addressLine5": "",
"cityName": "Greenville",
"stateCode": "MO",
"countryCode": "USA",
"zipCode": "63368"
}
],
"shippingContact": {
"shipToFirstName": "Jack",
"shipToMiddleName": "Fred",
"shipToLastName": "Smith"
},
"metadata": {
"customerRefId": "100000333"
},
"createdBy": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "EMPLOYEE"
},
"createdAt": "2022-11-23T00:42:50.311Z",
"updatedBy": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "EMPLOYEE"
},
"updatedAt": "2022-11-23T00:42:50.311Z",
"type": "BUSINESS",
"doingBusinessAsName": "ACME Corp.",
"contacts": [
{
"firstName": "Jack",
"middleName": "Fred",
"lastName": "Smith",
"primary": true,
"primaryPhoneNumber": {
"number": "+14151234",
"type": "WORK",
"provider": "ABC",
"extension": "675",
"verified": false
},
"primaryEmail": {
"value": "jsmith@acme.com",
"verified": false
}
}
]
}
© 2022 Rocket Financial. All rights reserved. RocketFNCL, RocketKOR, RocketBNK are trade names of Rocket Financial Inc.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL
© 2023 by Rocket Financial Inc. All rights reserved.