API Documentation
  • 👋Welcome
  • 🚦Getting Started
    • 🖥️Environment setup
    • 👨‍💻Sign up on portal
    • Subscribe to APIs
    • 📖Terminology
    • 🔐Authorization
  • 💲PRICING
    • Subscription
  • API Documentation
    • Companies API reference
      • Companyprofile
      • Information
      • Appointments
      • Directors
      • Employee verification
      • Registered office address
      • Filing history
    • BO API reference
      • Entity statement
      • Ownership or control statement
      • Natural person statement
      • Supporting documents
      • Individual document
  • Specification
  • USER GUIDE
    • For Data Consumers
Powered by GitBook
On this page

Was this helpful?

  1. API Documentation
  2. BO API reference

Entity statement

This HTTP GET request retrieves the registration details of an enterprise based on the provided enterprise number.

Last updated 1 year ago

Was this helpful?

The response is in JSON format and includes information such as statement ID, type, creation date, reference number, legal entity type, company type, enterprise name, status, registration date, total shares, identifiers, publication details, and links.

The response will contain an array of "register" objects, each representing the registration details of an enterprise, along with a "links" array providing related hyperlinks.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Ocp-Apim-Subscription-Key

<api key>

Response example:

"register": [
        {
            "statementid": 4,
            "statementtype": "entityStatement",
            "created_on": "2023-04-03",
            "reference_number": "60000705245",
            "legal_entity_type": "Private Company",
            "company_type": "NON-AFFECTED COMPANY WITH BENEFICIAL OWNERSHIP",
            "enterprise_name": "CIPC LTD",
            "status": "Complete",
            "registration_date": "2013-10-06",
            "total_shares": 46,
            "identifiers": [
                {
                    "registration authority": "ZA-CIPC",
                    "enterprise_number": "2013/187505/07"
                }
            ],
            "publication_details": [
                {
                    "publisher_id": "CIP123",
                    "publisher": "Sello Ndhlovu",
                    "publication_date": 2023-03-31"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "collection",
            "href": "../enterprise/register/"
        }
    ]
}
{
    "statusCode": 401,
    "message": "Unauthorized. Access token is missing or invalid."
}

{

"statusCode": 404,
"message": "Resource Not Found."

}

beneficial-ownership-register

get

Get beneficial ownership by enterprise number.

Authorizations
Path parameters
enterprise_numberstringRequired

Company registration number

Responses
200
Success
application/json
401
Unauthorised
application/json
404
Not Found
get
GET /sandbox/boreg/enterprise/register/{enterprise_number} HTTP/1.1
Host: cipc-apm-rs-dev.azure-api.net
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Accept: */*
{
  "register": [
    {
      "statementid": 4,
      "statementtype": "entityStatement",
      "created_on": "2023-04-03T07:49:37.0000000+00:00",
      "reference_number": "60000705245",
      "legal_entity_type": "Private Company",
      "company_type": "NON-AFFECTED COMPANY WITH BENEFICIAL OWNERSHIP",
      "enterprise_name": "FLUIDROCK GOVERNANCE ACADEMY",
      "status": "BO COMPLETE REGISTRATIONS",
      "registration_date": "2013-09-10",
      "total_shares": 46,
      "identifiers": [
        {
          "registration authority": "ZA-CIPC",
          "enterprise_number": "2013/187505/07"
        }
      ],
      "publication_details": [
        {
          "publisher_id": "AN0790",
          "publisher": "AN0790",
          "publication_date": "2023-03-04"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "collection",
      "href": "/enterprise/register/4"
    }
  ]
}