Report Schema Structure Per Country

Request

Returns the Company Report JSON schema of the provided country. Largely redundant as the Company Report 200 response is defined as a superset of all country's JSON schemas and can be used for any country.

Security

bearerToken

Path

countryCodestringrequired

ISO2 / Alpha 2 Country Code

Query

sectionstringrequired

Use CompanyReportResponse for the Company Credit Report JSON schema.

Value:"CompanyReportResponse"

templatestring

For Templated Company Report JSON Schemas. Selection of templates can be found here: Connect report templates glossary and availability

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/companies/schema/{countryCode}?section=CompanyReportResponse&template=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success. Returns the JSON Schema (draft-04) of the company report for the country, as a list of schema documents. Each document describes one report structure, with its title, $schema, type and properties. The properties can vary by country and template.

Bodyapplication/json

Array [

titlestring

The name of the structure the schema describes, for example CompanyReportResponse.

$schemastring

The JSON Schema version, http://json-schema.org/draft-04/schema#.

typestring

The JSON type of the structure, object.

propertiesobject

The fields of the structure, each described as a JSON Schema.

<property name>anyadditional property

]

Response

[
  {
    "title": "string",
    "$schema": "string",
    "type": "string",
    "properties": {}
  }
]