This document describes optional endpoints that complement the core company search and report workflow.
These endpoints provide additional functionality for:
- Retrieving country-specific report schemas
- Checking available report languages before requesting a report
This endpoint retrieves the response schema for a company report in a specific country. It provides a detailed breakdown of the property structure for reports from that country.
Use this endpoint to:
- Understand report structure before requesting data
- Validate expected response fields
- Map report data to your system
- Support developer onboarding
GET /companies/schema/{countryCode}| Parameter | Type | Description |
|---|---|---|
countryCode | string | ISO2 country code (e.g., GB, US, DE) |
| Parameter | Type | Required | Description |
|---|---|---|---|
section | string | No | Section to retrieve (e.g., CompanyReportResponse) |
GET /companies/schema/US?section=CompanyReportResponse
Authorization: Bearer <token>{
"schema": {
"companyName": "string",
"registrationNumber": "string",
"address": "object",
"financials": "object"
}
}| Status | Cause |
|---|---|
| 400 | Invalid country code or section parameter |
| 401 | Invalid or expired authentication token |
| 404 | Schema not found for specified country or section |
This endpoint retrieves the available report languages for a specific country. Use this to determine which language options are supported before requesting a company report.
GET /access/countries/{countryCode}/reportLanguages| Parameter | Type | Description |
|---|---|---|
countryCode | string | ISO2 country code (e.g., GB, US, BR) |
GET /access/countries/BR/reportLanguages
Authorization: Bearer <token>{
"reportLanguages": [
"PT"
],
"correlationId": "e90e0934-06d9-4cf8-94a5-8e1fa568bd02"
}| Field | Type | Description |
|---|---|---|
reportLanguages | string[] | Array of available language codes for reports in this country |
correlationId | string | Unique identifier for support tracking |
| Status | Cause |
|---|---|
| 400 | Invalid country code format |
| 401 | Invalid or expired authentication token |
| 404 | Country not found or not supported |
Check the report schema when:
- Integrating with the API for the first time
- Building data mapping for a new country
- Validating response structure in automated tests
- Documenting expected fields for downstream systems
Check available languages when:
- Building a multi-language user interface
- Supporting international users
- Determining default language for report requests
- Validating language parameter before requesting reports
| Resource | Description |
|---|---|
| Company Search and Report Workflow | Core workflow for searching companies and retrieving reports |
| Authentication | How to authenticate with the API |
| Error Codes | Complete error code reference |