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

Natural person statement

This API endpoint makes an HTTP GET request to retrieve the details of a natural person with the specified statement ID.

Last updated 1 year ago

Was this helpful?

The response contains an array of "persons details" including information such as statement ID, verification status, creation and modification dates, nationalities, names, demographic details, gender, date of birth, country of residence, and addresses. Additionally, the response includes an array of "links" containing related hypermedia links.

person-details

get

Get the individual person details with significant control by statement Id

Authorizations
Path parameters
statementidInteger ยท enumRequired

Person statement Id

Possible values:
Responses
200
Success
application/json
401
Unauthorised
application/json
404
Resource Not Found
get
GET /sandbox/boreg/person-details/{statementid} HTTP/1.1
Host: cipc-apm-rs-dev.azure-api.net
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Accept: */*
{
  "persons": [
    {
      "statementid": 76,
      "statementtype": "personStatement",
      "is_verified": 0,
      "created_on": "14-04-2023",
      "describedbyentitystatement": 4,
      "describedbypersonstatement": 97,
      "persontype": "naturalPerson",
      "nationalities": [
        {
          "country_of_birth": "South Africa",
          "code": "ZA"
        }
      ],
      "names": [
        {
          "type": "individual",
          "full_name": "SHIRLEY DIANE BRAHAM",
          "name": "SHIRLEY DIANE",
          "last_name": "BRAHAM"
        }
      ],
      "demographic": "White",
      "gender": "Female",
      "date_of_birth": "13-04-1964",
      "country_of_residence": "South Africa",
      "addresses": [
        {
          "address_type": "business",
          "address_line_1": "43 BERILLEUM AVENUE",
          "address_line_2": "WILRO PARK",
          "city": "ROODEPOORT",
          "region": "Gauteng",
          "postal_code": "1724"
        },
        {
          "address_type": "postal",
          "address_line_1": "POSTNET SUITE 402",
          "address_line_2": "PRIVATE BAG X033",
          "city": "RIVONIA",
          "region": "Gauteng",
          "postal_code": "2128"
        }
      ],
      "modified_on": "13-10-2023"
    }
  ],
  "links": [
    {
      "rel": "collection",
      "href": "/individual-details/K2013187505/"
    }
  ]
}