🙋Create a Business for a Customer

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.

Create a Business for a Customer

POST {{baseUrl}}/businesses

Create a Business for a pre-existing customer_id.

Headers

Name	Type	Description
Content-Type*	application/json

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 Customer response. 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.

201: Created Business created without a CPIC check.

```postman_json
{
    "data": {
        "id": "{{businessId}}",
        "name": "Finch Technologies (Pty) Ltd",
        "type": "Private Company",
        "reg": "xxxx/xxxxxx/24",
        "enterprise_num": "KXXXXXXXXXX",
        "linked_customers": [
            {
                "customer": "{{customerId}}",
                "relationship": "director"
            }
        ],
        "cipc_business_verified": false,
        "cipc_director_verified": false,
        "cipc_information": null,
        "cipc_timestamp": null
    }
}
```

422: Unprocessable Entity Missing registration number

```postman_json
{
    "errors": {
        "reg": [
            "The reg field is required."
        ]
    }
}
```

201: Created CIPC director verified

```postman_json
{
    "data": {
        "id": "{{businessId}}",
        "name": "N CONSTRUCTION",
        "type": "Close Corporation",
        "reg": "xxxx/xxxxxx/23",
        "enterprise_num": "Bxxxxxxxxxx",
        "linked_customers": [
            {
                "customer": "{{customerId}}",
                "relationship": "director"
            }
        ],
        "cipc_business_verified": true,
        "cipc_director_verified": true,
        "cipc_information": {
            "entity": {
                "number": "Bxxxxxxxxxx",
                "name": "N CONSTRUCTION",
                "type": "Close Corporation",
                "status": "In Business",
                "registration_date": "xxxx-xx-xx",
                "physical_address": "x STREET BLOEMFONTEIN  9306",
                "postal_address": "x STREET BLOEMFONTEIN  9306"
            },
            "directors": [
                {
                    "id_number": "123456 XXXX 01 X",
                    "names": "JOHN JAMES",
                    "surname": "DOE",
                    "type": "Member",
                    "status": "Active"
                }
            ],
            "audit": {
                "filed_annual_returns": [
                    {
                        "ar_year": "2008",
                        "amount_paid": "-100,00",
                        "date_filed": "2008-10-20"
                    },
                    {
                        "ar_year": "2009",
                        "amount_paid": "-100,00",
                        "date_filed": "2009-10-02"
                    },
                    {
                        "ar_year": "2010",
                        "amount_paid": "-100,00",
                        "date_filed": "2010-11-02"
                    },
                    {
                        "ar_year": "2011",
                        "amount_paid": "-200,00",
                        "date_filed": "2012-10-30"
                    },
                    {
                        "ar_year": "2012",
                        "amount_paid": "-200,00",
                        "date_filed": "2012-10-30"
                    },
                    {
                        "ar_year": "2013",
                        "amount_paid": "-250,00",
                        "date_filed": "2014-01-07"
                    },
                    {
                        "ar_year": "2014",
                        "amount_paid": "-250,00",
                        "date_filed": "2015-02-10"
                    },
                    {
                        "ar_year": "2015",
                        "amount_paid": "-100,00",
                        "date_filed": "2015-11-11"
                    },
                    {
                        "ar_year": "2016",
                        "amount_paid": "-100,00",
                        "date_filed": "2016-10-19"
                    },
                    {
                        "ar_year": "2017",
                        "amount_paid": "-250,00",
                        "date_filed": "2018-01-12"
                    },
                    {
                        "ar_year": "2018",
                        "amount_paid": "-100,00",
                        "date_filed": "2018-11-21"
                    },
                    {
                        "ar_year": "2019",
                        "amount_paid": "-250,00",
                        "date_filed": "2021-05-18"
                    },
                    {
                        "ar_year": "2020",
                        "amount_paid": "-250,00",
                        "date_filed": "2021-05-18"
                    },
                    {
                        "ar_year": "2021",
                        "amount_paid": "-250,00",
                        "date_filed": "2022-01-20"
                    }
                ],
                "outstanding_annual_returns": [
                    {
                        "ar_year": "2022",
                        "ar_month": "OCTOBER",
                        "ar_noncompliance_date": "2022-12-02"
                    }
                ]
            },
            "enterprise_history": [
                {
                    "date": "2022-10-10",
                    "details": "No Valid SMS or Email Address for enterprise Bxxxxxxxxxx"
                },
                {
                    "date": "2022-01-20",
                    "details": " Company / Close Corporation AR Filing - Web Services : Ref No. : 535XXXX658"
                },
                {
                    "date": "2021-10-09",
                    "details": "No Valid SMS or Email Address for enterprise Bxxxxxxxxxx"
                },
                {
                    "date": "2021-05-18",
                    "details": " Company / Close Corporation AR Filing - Web Services : Ref No. : 534XXXX495"
                },
                {
                    "date": "2021-02-24",
                    "details": "Annual Return Non Compliance - In Process of Deregistration Last Payment for AR Year/Month is 2018/10. "
                },
                {
                    "date": "2020-10-15",
                    "details": "No Valid SMS or Email Address for enterprise Bxxxxxxxxxx"
                },
                {
                    "date": "2019-10-10",
                    "details": "No Valid SMS or Email Address for enterprise Bxxxxxxxxxx"
                },
                {
                    "date": "2018-11-21",
                    "details": " Company / Close Corporation AR Filing - Web Services : Ref No. : 515XXXX700"
                },
                {
                    "date": "2018-10-19",
                    "details": "No Valid SMS or Email Address for enterprise Bxxxxxxxxxx"
                },
                {
                    "date": "2018-01-12",
                    "details": "Company / Close Corporation AR Filing - Web Services : Ref No. : 599042358"
                },
                {
                    "date": "2017-10-07",
                    "details": "No Valid SMS or Email Address for enterprise Bxxxxxxxxxx"
                },
                {
                    "date": "2016-10-19",
                    "details": "Company / Close Corporation AR Filing - Web Services : Ref No. : 554593430"
                },
                {
                    "date": "2016-10-05",
                    "details": "No Valid SMS or Email Address for enterprise Bxxxxxxxxxx"
                },
                {
                    "date": "2015-11-11",
                    "details": "Company / Close Corporation AR Filing - Web Services : Ref No. : 530619358"
                },
                {
                    "date": "2015-02-10",
                    "details": "Company / Close Corporation AR Filing - Web Services : Ref No. : 524238484"
                },
                {
                    "date": "2014-01-07",
                    "details": "Company / Close Corporation AR Filing - Web Services : Ref No. : 53859890"
                },
                {
                    "date": "2012-02-06",
                    "details": "PO BOX 12345\nHOF\n\n\n9310"
                },
                {
                    "date": "2012-02-06",
                    "details": "Change Record\nSurname: = MCOOL\nFirst Names: = JAMES ALPINE\nStatus: = Active"
                },
                {
                    "date": "2012-02-06",
                    "details": "Change Record\r\nName: = CONSULTANCY SERVICES\r\nStatus: = Current"
                },
                {
                    "date": "2012-02-06",
                    "details": "XXXXXXXXXX\ARO\nBLOEMFONTEIN\n\n9301"
                },
                {
                    "date": "2009-12-01",
                    "details": "Change Record\r\nName: = CONSULTANCY SERVICES\r\nStatus: = Current"
                },
                {
                    "date": "2009-12-01",
                    "details": "Change Record\nSurname: = MCOOL\nFirst Names: = JAMES ALPINE\nStatus: = Active"
                },
                {
                    "date": "2008-10-20",
                    "details": "Change Record\r\nName: = CONSULTANCY SERVICES\r\nStatus: = Current"
                },
                {
                    "date": "2007-05-22",
                    "details": "Change Record\nSurname: = MCOOL\nFirst Names: = JAMES ALPINE\nStatus: = Active"
                }
            ],
            "bbee": {
                "b_bbee_level": "",
                "procurement_recognition": "",
                "valid_period": "",
                "total_shareholders": "",
                "black_shareholders": "",
                "black_percentage": "",
                "black_female_percentage": "",
                "white_percentage": "",
                "black_unemployed_percentage": "",
                "black_youth_percentage": "",
                "black_disabled_percentage": "",
                "black_rural_percentage": "",
                "black_veterans_percentage": ""
            },
            "other": {
                "sars_tax_number": "xxxxxxxxxx",
                "uif_number": "NOT AVAILABLE",
                "compensation_fund_registration_number": "NOT AVAILABLE"
            }
        },
        "cipc_timestamp": "2023-05-09T08:26:57.886767Z"
    }
}
```

201: Created CIPC director not verified

```postman_json
{
    "data": {
        "id": "{{businessId}}",
        "name": "N CONSTRUCTION",
        "type": "Close Corporation",
        "reg": "xxxx/xxxxxx/23",
        "enterprise_num": "Bxxxxxxxxxx",
        "linked_customers": [
            {
                "customer": "{{customerId}}",
                "relationship": "director"
            }
        ],
        "cipc_business_verified": true,
        "cipc_director_verified": false,
        "cipc_information": {
            "entity": {
                "number": "Bxxxxxxxxxx",
                "name": "N CONSTRUCTION",
                "type": "Close Corporation",
                "status": "In Business",
                "registration_date": "xxxx-xx-xx",
                "physical_address": "x STREET BLOEMFONTEIN  9306",
                "postal_address": "x STREET BLOEMFONTEIN  9306"
            },
            "directors": [
                {
                    "id_number": "123456 XXXX 01 X",
                    "names": "JAMES ALPINE",
                    "surname": "MCSANS",
                    "type": "Member",
                    "status": "Active"
                }
            ],
            "audit": {
                "filed_annual_returns": [
                    {
                        "ar_year": "2008",
                        "amount_paid": "-100,00",
                        "date_filed": "2008-10-20"
                    },
                    {
                        "ar_year": "2009",
                        "amount_paid": "-100,00",
                        "date_filed": "2009-10-02"
                    },
                    {
                        "ar_year": "2010",
                        "amount_paid": "-100,00",
                        "date_filed": "2010-11-02"
                    },
                    {
                        "ar_year": "2011",
                        "amount_paid": "-200,00",
                        "date_filed": "2012-10-30"
                    },
                    {
                        "ar_year": "2012",
                        "amount_paid": "-200,00",
                        "date_filed": "2012-10-30"
                    },
                    {
                        "ar_year": "2013",
                        "amount_paid": "-250,00",
                        "date_filed": "2014-01-07"
                    },
                    {
                        "ar_year": "2014",
                        "amount_paid": "-250,00",
                        "date_filed": "2015-02-10"
                    },
                    {
                        "ar_year": "2015",
                        "amount_paid": "-100,00",
                        "date_filed": "2015-11-11"
                    },
                    {
                        "ar_year": "2016",
                        "amount_paid": "-100,00",
                        "date_filed": "2016-10-19"
                    },
                    {
                        "ar_year": "2017",
                        "amount_paid": "-250,00",
                        "date_filed": "2018-01-12"
                    },
                    {
                        "ar_year": "2018",
                        "amount_paid": "-100,00",
                        "date_filed": "2018-11-21"
                    },
                    {
                        "ar_year": "2019",
                        "amount_paid": "-250,00",
                        "date_filed": "2021-05-18"
                    },
                    {
                        "ar_year": "2020",
                        "amount_paid": "-250,00",
                        "date_filed": "2021-05-18"
                    },
                    {
                        "ar_year": "2021",
                        "amount_paid": "-250,00",
                        "date_filed": "2022-01-20"
                    }
                ],
                "outstanding_annual_returns": [
                    {
                        "ar_year": "2022",
                        "ar_month": "OCTOBER",
                        "ar_noncompliance_date": "2022-12-02"
                    }
                ]
            },
            "enterprise_history": [
                {
                    "date": "2022-10-10",
                    "details": "No Valid SMS or Email Address for enterprise Bxxxxxxxxxx"
                },
                {
                    "date": "2022-01-20",
                    "details": " Company / Close Corporation AR Filing - Web Services : Ref No. : 535XXXX658"
                },
                {
                    "date": "2021-10-09",
                    "details": "No Valid SMS or Email Address for enterprise Bxxxxxxxxxx"
                },
                {
                    "date": "2021-05-18",
                    "details": " Company / Close Corporation AR Filing - Web Services : Ref No. : 534XXXX495"
                },
                {
                    "date": "2021-02-24",
                    "details": "Annual Return Non Compliance - In Process of Deregistration Last Payment for AR Year/Month is 2018/10. "
                },
                {
                    "date": "2020-10-15",
                    "details": "No Valid SMS or Email Address for enterprise Bxxxxxxxxxx"
                },
                {
                    "date": "2019-10-10",
                    "details": "No Valid SMS or Email Address for enterprise Bxxxxxxxxxx"
                },
                {
                    "date": "2018-11-21",
                    "details": " Company / Close Corporation AR Filing - Web Services : Ref No. : 515XXXX700"
                },
                {
                    "date": "2018-10-19",
                    "details": "No Valid SMS or Email Address for enterprise Bxxxxxxxxxx"
                },
                {
                    "date": "2018-01-12",
                    "details": "Company / Close Corporation AR Filing - Web Services : Ref No. : 599042358"
                },
                {
                    "date": "2017-10-07",
                    "details": "No Valid SMS or Email Address for enterprise Bxxxxxxxxxx"
                },
                {
                    "date": "2016-10-19",
                    "details": "Company / Close Corporation AR Filing - Web Services : Ref No. : 554593430"
                },
                {
                    "date": "2016-10-05",
                    "details": "No Valid SMS or Email Address for enterprise Bxxxxxxxxxx"
                },
                {
                    "date": "2015-11-11",
                    "details": "Company / Close Corporation AR Filing - Web Services : Ref No. : 530619358"
                },
                {
                    "date": "2015-02-10",
                    "details": "Company / Close Corporation AR Filing - Web Services : Ref No. : 524238484"
                },
                {
                    "date": "2014-01-07",
                    "details": "Company / Close Corporation AR Filing - Web Services : Ref No. : 53859890"
                },
                {
                    "date": "2012-02-06",
                    "details": "PO BOX 12345\nHOF\n\n\n9310"
                },
                {
                    "date": "2012-02-06",
                    "details": "Change Record\nSurname: = MCOOL\nFirst Names: = JAMES ALPINE\nStatus: = Active"
                },
                {
                    "date": "2012-02-06",
                    "details": "Change Record\r\nName: = CONSULTANCY SERVICES\r\nStatus: = Current"
                },
                {
                    "date": "2012-02-06",
                    "details": "XXXXXXXXXX\ARO\nBLOEMFONTEIN\n\n9301"
                },
                {
                    "date": "2009-12-01",
                    "details": "Change Record\r\nName: = CONSULTANCY SERVICES\r\nStatus: = Current"
                },
                {
                    "date": "2009-12-01",
                    "details": "Change Record\nSurname: = MCOOL\nFirst Names: = JAMES ALPINE\nStatus: = Active"
                },
                {
                    "date": "2008-10-20",
                    "details": "Change Record\r\nName: = CONSULTANCY SERVICES\r\nStatus: = Current"
                },
                {
                    "date": "2007-05-22",
                    "details": "Change Record\nSurname: = MCOOL\nFirst Names: = JAMES ALPINE\nStatus: = Active"
                }
            ],
            "bbee": {
                "b_bbee_level": "",
                "procurement_recognition": "",
                "valid_period": "",
                "total_shareholders": "",
                "black_shareholders": "",
                "black_percentage": "",
                "black_female_percentage": "",
                "white_percentage": "",
                "black_unemployed_percentage": "",
                "black_youth_percentage": "",
                "black_disabled_percentage": "",
                "black_rural_percentage": "",
                "black_veterans_percentage": ""
            },
            "other": {
                "sars_tax_number": "xxxxxxxxxx",
                "uif_number": "NOT AVAILABLE",
                "compensation_fund_registration_number": "NOT AVAILABLE"
            }
        },
        "cipc_timestamp": "2023-05-09T08:26:57.886767Z"
    }
}
```

201: Created CIPC check not enabled

```postman_json
{
    "data": {
        "id": "{{businessId}}",
        "name": "B CONTRACTORS",
        "type": "Private Company",
        "reg": "xxxx/xxxxxx//24",
        "enterprise_num": "KXXXXXXXXXX",
        "linked_customers": [
            {
                "customer": "{{customerId}}",
                "relationship": "director"
            }
        ],
        "cipc_business_verified": false,
        "cipc_director_verified": false,
        "cipc_information": {
            "errors": {
                "error": "CIPC checks are not available for your account"
            }
        },
        "cipc_timestamp": "2023-05-12T12:48:26.846718Z"
    }
}
```

201: Created CIPC director and business not verified

```postman_json
{
    "data": {
        "id": "{{businessId}}",
        "name": "Dunder Mifflin",
        "type": "Private Company",
        "reg": "1999/123456/23",
        "enterprise_num": "Bxxxxxxxxxx",
        "linked_customers": [
            {
                "customer": "{{customerId}}",
                "relationship": "director"
            }
        ],
        "cipc_business_verified": false,
        "cipc_director_verified": false,
        "cipc_information": {
            "errors": {
                "message": "Invalid enterprise number"
            }
        },
        "cipc_timestamp": "2023-05-09T08:31:29.448656Z"
    }
}
```

422: Unprocessable Entity Missing enterprise number

```postman_json
{
    "errors": {
        "enterprise_num": [
            "The enterprise num field is required."
        ]
    }
}
```

422: Unprocessable Entity Invalid Company Type

```postman_json
{
    "errors": {
        "type": [
            "The accepted Business types include Private Company, Sole Proprietor, Public Company, Closed Corporation, Partnership, NGO, Business Trust"
        ]
    }
}
```

422: Unprocessable Entity Invalid Enterprise Number Format

```postman_json
{
    "errors": {
        "enterprise_num": [
            "Expected enterprise number K/B/Mxxxxxxxxxxxx or guid v4"
        ]
    }
}
```

422: Unprocessable Entity Invalid Registration Number Format

```postman_json
{
    "errors": {
        "reg": [
            "Expected registration number xxxx/xxxxxx/xx or customer id number"
        ]
    }
}
```

409: Conflict Business not unique

```postman_json
{
    "errors": "Business not unique"
}
```

Suggested entries for Registration Number and Enterprise Number

Company/Business Type	Registration Number	Enterprise Number
Private Company	Company Registration Number	Company Registration Number
Public Company	Company Registration Number	Company Registration Number
Sole Proprietor	Customer ID Number	Unique Company Identifier
Closed Corporation
Partnership
Business Trust	Business Trust Number	Unique Company Identifier
NGO	Company Registration Number	Company Registration Number

Example Request without CIPC check

{
    "customer_id": "{{customerId}}",
    "name": "Finch Technologies (Pty) Ltd",
    "type": "Private Company",
    "reg": "2015/123456/23",
    "enterprise_num":"K2016513771"
}

Example Request with CIPC check

{
    "customer_id": "{{customerId}}",
    "name": "Finch Technologies (Pty) Ltd",
    "type": "Private Company",
    "reg": "2015/123456/23",
    "enterprise_num": "K2016513771", 
    "cipc_check":true 
}