Create a Business for a pre-existing Customer. You are also able to complete a CIPC verification on the Business as well as Customer Record.
POST{{baseUrl}}/businesses
Request Body
Name
Type
Description
name*
String
The registered Business name.
type*
String
The type of company the Business is legally registered as.
Types of companies accepted: Private Company, Sole Proprietor, Public Company, Closed Corporation, Partnership, NGO, and Business Trust.
reg*
String
The Business Registration Number.
Example:
xxxx / xxxxxx / xx
enterprise-num*
String
The Business Enterprise Number.
Example:
Kxxxxxxxxxx
customerId*
String
The UUID for a specific customer that gets generated and returned in the POST Create New Customerresponse. It ensures that the Business is associated to a specific customer.
cipc_check
Boolean
The CIPC check is an additional feature that would need to be enabled and would come at an additional charge.
{
"errors": {
"error": "CIPC checks are not enabled for your tenant. Please contact support if you wish to enable the feature."
}
}
409 - Conflict
Business Not Unique
{
"errors": "Business not unique"
}
422 - Unprocessable Content
Input Validation - Registration Number
{
"errors": {
"reg": [
"The reg field is required."
]
}
}
{
"errors": {
"reg": [
"Expected registration number xxxx/xxxxxx/xx or customer id number"
]
}
}
Input Validation - Enterprise Number
{
"errors": {
"enterprise_num": [
"The enterprise num field is required."
]
}
}
{
"errors": {
"enterprise_num": [
"Expected enterprise number K/B/Mxxxxxxxxxxxx or guid v4"
]
}
}
Input Validation - Business Type
{
"errors": {
"type": [
"The accepted Business types include Private Company, Sole Proprietor, Public Company, Closed Corporation, Partnership, NGO, Business Trust"
]
}
}
