🏨Get Business by Customer Property

Search for a Business and retrieve their data using their enterprise number or business registration number.

Get Business by Custom Property

GET {{baseUrl}}/businesses/property/:property?value=Kxxxxxxx

Search for a Business Record using a custom search parameter such as enterprise_num or reg.

Path Parameters

Name	Type	Description
property*	String	The property you would like to search by (e.g. enterprise_num and or reg)

Query Parameters

Name	Type	Description
value*	string	The value of the property to get the Business. (e.g. Kxxxxxxx, xxxx/xxxxxx/xx )

200: OK Found the Business - Registration Number

```postman_json
{
    "data": {
        "id": "{{businessId}}",
        "name": "Finch Technologies",
        "type": "Private Company",
        "reg": "2016/123456/23",
        "enterprise_num": "718",
        "linked_customers": [],
        "cipc_business_verified": false,
        "cipc_director_verified": false,
        "cipc_information": null,
        "cipc_timestamp": null
    }
}
```

404: Not Found Business not found

```postman_json
{
    "errors": "Business not found by enterprise_num"
}
```

200: OK Found Business - Enterprise Number

```postman_json
{
    "data": {
        "id": "{{businessId}}",
        "name": "Finch Technologies",
        "type": "Private Company",
        "reg": "2016/123456/23",
        "enterprise_num": "718",
        "linked_customers": [],
        "cipc_business_verified": false,
        "cipc_director_verified": false,
        "cipc_information": null,
        "cipc_timestamp": null
    }
}
```

Properties you can use to search by:

Enterprise Number

Search for a business record by the companies enterprise number as provided by the Master of the High Court's Endorsement Letter(if Trust) or CIPC Registration Document (if Company). You can retrieve the business information in the GET Get Business by Custom Property API call by making use of the enterprise_num search parameter.

Registration Number

Search for a business record by the companies enterprise number as provided by the Master of the High Court's Endorsement Letter(if Trust) or CIPC Registration Document (if Company). You can retrieve the business information in the GET Get Business by Custom Property API call by making use of the reg search parameter.