COMPANYPROOF · EXACT ATTRIBUTE REFERENCE
Find the field. See its type. Know its location.
This explorer reads the same OpenAPI schemas as the downloadable specification. Select a module to inspect nested paths, types, allowed values and optional fields.
CompanyProof API
profile.lite · provenance form41 of 41 entries
| Attribute path | Type | Presence | Details |
|---|---|---|---|
id | integer | string | Optional | Returned field; availability depends on the record. |
basic | object | Required in parent | Legal-identity fields in the provenance-enabled lite profile. |
basic.name | string | null | Optional | Returned field; availability depends on the record. |
basic.registration_number | string | null | Optional | Returned field; availability depends on the record. |
basic.vat_number | string | null | Optional | Returned field; availability depends on the record. |
basic.incorporation_date | string | null | Optional | Returned field; availability depends on the record. |
basic.status | string | null | Optional | Returned field; availability depends on the record. |
basic.legal_form | string | null | Optional | Returned field; availability depends on the record. |
basic.source | object | null | Optional | Expand using the nested attributes listed below. |
basic.source.categoryProfileSource | string | null | Optional | Source class, such as Government Registry, Enriched or Modelled. |
basic.source.commentProfileSource | string | null | Optional | Returned field; availability depends on the record. |
basic.source.idProfileSource | integer | string | null | Optional | Provider source identifier. Upstream records can encode identifiers as integers or strings. |
basic.source.nameProfileSource | string | null | Optional | Returned field; availability depends on the record. |
basic.source.urlProfileSource | string | null | Optional | Source URL when it can be disclosed; otherwise null. Format: uri. |
basic.source.retrieved_atProfileSource | string | null | Optional | Format: date-time. |
address | object | Optional | Registered-address fields in the provenance-enabled lite profile. |
address.country_code | string | null | Optional | Returned field; availability depends on the record. |
address.country_name | string | null | Optional | Returned field; availability depends on the record. |
address.country_region | string | null | Optional | Returned field; availability depends on the record. |
address.address_street | string | null | Optional | Returned field; availability depends on the record. |
address.address_location | string | null | Optional | Returned field; availability depends on the record. |
address.address_city | string | null | Optional | Returned field; availability depends on the record. |
address.zip_code | string | null | Optional | Returned field; availability depends on the record. |
address.jurisdiction | string | null | Optional | Returned field; availability depends on the record. |
address.source | object | null | Optional | Expand using the nested attributes listed below. |
address.source.categoryProfileSource | string | null | Optional | Source class, such as Government Registry, Enriched or Modelled. |
address.source.commentProfileSource | string | null | Optional | Returned field; availability depends on the record. |
address.source.idProfileSource | integer | string | null | Optional | Provider source identifier. Upstream records can encode identifiers as integers or strings. |
address.source.nameProfileSource | string | null | Optional | Returned field; availability depends on the record. |
address.source.urlProfileSource | string | null | Optional | Source URL when it can be disclosed; otherwise null. Format: uri. |
address.source.retrieved_atProfileSource | string | null | Optional | Format: date-time. |
contact | object | Optional | Public contact fields in the provenance-enabled lite profile. |
contact.website | string | null | Optional | Returned field; availability depends on the record. |
contact.linkedin | string | null | Optional | Returned field; availability depends on the record. |
contact.source | object | null | Optional | Expand using the nested attributes listed below. |
contact.source.categoryProfileSource | string | null | Optional | Source class, such as Government Registry, Enriched or Modelled. |
contact.source.commentProfileSource | string | null | Optional | Returned field; availability depends on the record. |
contact.source.idProfileSource | integer | string | null | Optional | Provider source identifier. Upstream records can encode identifiers as integers or strings. |
contact.source.nameProfileSource | string | null | Optional | Returned field; availability depends on the record. |
contact.source.urlProfileSource | string | null | Optional | Source URL when it can be disclosed; otherwise null. Format: uri. |
contact.source.retrieved_atProfileSource | string | null | Optional | Format: date-time. |
Paths are relative to the selected schema; $ means the schema value itself. Required applies when its parent object exists. null, an absent field and an empty list are different values. Alternative response shapes are labelled.
