View

Get new metadata view for a company.

Returns an updated metadata view for the specified company.

Endpoint

GET /api/v1/companies/:company_id/view

Parameters

Parameter	Type	In	Description
`company_id`	`integer`	path	The unique identifier of the company.

Code Examples

import requests

url = 'https://api.statsnet.co/api/v1/companies/12345/view'
headers = {
  'Authorization': 'Bearer YOUR_API_KEY',
  'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers).json()
print(response)

Response

Success response

{
  "ok": true,
  "view": {
    "sections": ["general", "officers", "shareholders", "financials"],
    "available_data": {
      "bank_accounts": true,
      "employees": true,
      "gov_contracts": true,
      "licenses": false
    }
  }
}

Error Handling

Error response

{
  "ok": false,
  "error": {
    "code": 403,
    "message": "Forbidden"
  }
}