Add a new Customer Account for a business. The Customer Account contains the Customer’s profile (business name and contact information).
Note You can also add a Customer Account for an individual.
POST /v1/customers
Authorization: Bearer <access_token>
externalId CONDITIONAL
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 REQUIRED
string enum, values: MAILING, PHYSICAL, SHIPPING
Type of address. The following values are supported:
name CONDITIONAL
object
Name of the contact person for shipments. Required if type is SHIPPING. Ignored for other address types.
firstName REQUIRED
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 REQUIRED
string, min length: 1, max length: 40
Contact person’s last name.
streetLine1 REQUIRED
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 CONDITIONAL
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 CONDITIONAL
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 CONDITIONAL
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.
metadata
string, max properties: 6, value max length: 1024
Key/value pairs used to store additional information about the Customer.
type REQUIRED
string enum, value: BUSINESS
Type of Customer. Value must be BUSINESS.
businessName REQUIRED
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.
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 REQUIRED
object
Contacts for the business. A primary contact must be provided.
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 CONDITIONAL
boolean
Whether this is the primary contact for the business. At least one contact must be marked as primary.
primaryPhoneNumber REQUIRED
object
Contact’s primary phone number.
number REQUIRED
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 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).
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 CONDITIONAL
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.
limitsCurrencyCode
string, min length: 3, max length: 3
Expected currency for the account. Must be an ISO 4217 alpha 3-character currency code. This currency will be used for the Customer Account transaction limits.
limits
object
Initial debit transaction limits for the Customer Account.
Note You can update the transaction limits after the Customer Account has been created.
MONTHLY
object
Monthly debit transaction limit (based on a 30-day rolling period).
amount
number
Maximum amount allowed.
WEEKLY
object
Weekly debit transaction limit (based on a 7-day rolling period).
amount
number
Maximum amount allowed.
DAILY
object
Daily debit transaction limit (00:00 – 23:59:59:59 EST).
amount
number
Maximum amount allowed.
SINGLE
object
Limit for a single debit transaction.
amount
number
Maximum amount allowed.
Returns the Business Customer object. This object contains the Customer Account details, including a unique ID for the account.
SAMPLE REQUEST
{
"addresses": [
{
"type": "MAILING",
"streetLine1": "100 Main St",
"streetLine2": "Suite 100",
"cityName": "Greenville",
"stateCode": "MO",
"countryCode": "USA",
"zipCode": "63368",
"primary": true
},
{
"type": "SHIPPING",
"name": {
"firstName": "Jack",
"middleName": "Fred",
"lastName": "Smith"
},
"streetLine1": "200 King St",
"streetLine2": "Suite 310",
"cityName": "Greenville",
"stateCode": "MO",
"countryCode": "USA",
"zipCode": "63368",
"primary": true
}
],
"metadata": {
"customerRefId": "100000333"
},
"type": "BUSINESS",
"businessName": "ACME",
"doingBusinessAsName": "ACME Corp.",
"registeredStateCode": "MO",
"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
}
}
],
"legalName": "ACME Corporation",
"primaryPhone": "+14151234",
"primaryEmail": "info@acme.com",
"website": "https://www.acme.com",
"dateOfFormation": "2010-01-31",
"legalEntityType": "CORP",
"taxIdCountryCode": "USA",
"taxId": "12-3456789",
"limitsCurrencyCode": "USD",
"limits": {
"MONTHLY": {
"amount": 5000.00
},
"WEEKLY": {
"amount": 2000.00
},
"DAILY": {
"amount": 1000.00
},
"SINGLE": {
"amount": 500.00
}
}
}
SAMPLE RESPONSE
{
"id": "e4021849-0e09-43ef-b9a7-18124356f489",
"status": "ACTIVE",
"externalId": "",
"addresses": [
{
"type": "MAILING",
"streetLine1": "100 Main St",
"streetLine2": "Suite 100",
"streetLine3": "",
"streetLine4": "",
"streetLine5": "",
"apartmentNumber": "",
"cityName": "Greenville",
"stateCode": "MO",
"countryCode": "USA",
"zipCode": "63368",
"primary": true,
"verified": false
},
{
"type": "SHIPPING",
"name": {
"firstName": "Jack",
"middleName": "Fred",
"lastName": "Smith"
},
"streetLine1": "200 King St",
"streetLine2": "Suite 310",
"streetLine3": "",
"streetLine4": "",
"streetLine5": "",
"apartmentNumber": "",
"cityName": "Greenville",
"stateCode": "MO",
"countryCode": "USA",
"zipCode": "63368",
"primary": true,
"verified": false
}
],
"metadata": {
"customerRefId": "100000333"
},
"verificationStatus": {
"status": "UNVERIFIED",
"reason": "Processing",
"updatedAt": "2024-08-12T01:09:27.246Z",
"updatedBy": {
"id": "cb51cced-fb9a-43cd-abc8-c6842c871262",
"type": "employee"
}
},
"verificationStatusHistory": [
{
"status": "UNVERIFIED",
"reason": "Processing",
"updatedAt": "2024-08-12T01:09:27.246Z",
"updatedBy": {
"id": "cb51cced-fb9a-43cd-abc8-c6842c871262",
"type": "employee"
}
}
],
"createdBy": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "service-account"
},
"createdAt": "2022-11-23T00:42:50.311Z",
"updatedBy": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "service-account"
},
"updatedAt": "2022-12-11T00:42:50.311Z",
"type": "BUSINESS",
"businessName": "ACME",
"doingBusinessAsName": "ACME Corp.",
"industryCode": "007005",
"registeredStateCode": "MO",
"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
}
}
],
"legalName": "ACME Corporation",
"primaryPhone": "+14151234",
"primaryEmail": "info@acme.com",
"website": "https://www.acme.com",
"dateOfFormation": "2010-01-31",
"legalEntityType": "CORP",
"taxIdCountryCode": "USA",
"taxId": "12-3456789"
}
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.
