Create a Business without a Customer. You don't need to have a Customer to create a Business, as Businesses can exist as separate entities in Gathr just as they do in the real world.
POST{{baseUrl}}/businesses
It is important to note that, if you create a Business without a Customer, you will not be able to perform any of the Customer verifications and validations in Gathr that require a customer_id.
Therefore, you will not be able to:
Generate a Customer Credit Report/Credit Report and Score
Collect personal [consumer] Bank Statements and Transactions via Online Login or Manual Upload
Upload and Verify an Identity Document for Proof of Identification
Upload and Verify Address Documentation for Proof of Address.
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
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"
]
}
}