DOCUMENTATION / ALL DATA ATTRIBUTES

Company Data API Attributes & Response Fields

OpenAPI 3.1 ↗

Browse exact CompanyProof API field paths, JSON types, required properties and allowed values from the OpenAPI 3.1 response schemas.

BASE URLhttps://companyproof.ai/v2JSON · Bearer authentication

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 APIprofile.lite · provenance form
41 of 41 entries
Attribute pathTypePresenceDetails
idinteger | stringOptionalReturned field; availability depends on the record.
basicobjectRequired in parentLegal-identity fields in the provenance-enabled lite profile.
basic.namestring | nullOptionalReturned field; availability depends on the record.
basic.registration_numberstring | nullOptionalReturned field; availability depends on the record.
basic.vat_numberstring | nullOptionalReturned field; availability depends on the record.
basic.incorporation_datestring | nullOptionalReturned field; availability depends on the record.
basic.statusstring | nullOptionalReturned field; availability depends on the record.
basic.legal_formstring | nullOptionalReturned field; availability depends on the record.
basic.sourceobject | nullOptionalExpand using the nested attributes listed below.
basic.source.categoryProfileSourcestring | nullOptionalSource class, such as Government Registry, Enriched or Modelled.
basic.source.commentProfileSourcestring | nullOptionalReturned field; availability depends on the record.
basic.source.idProfileSourceinteger | string | nullOptionalProvider source identifier. Upstream records can encode identifiers as integers or strings.
basic.source.nameProfileSourcestring | nullOptionalReturned field; availability depends on the record.
basic.source.urlProfileSourcestring | nullOptionalSource URL when it can be disclosed; otherwise null. Format: uri.
basic.source.retrieved_atProfileSourcestring | nullOptionalFormat: date-time.
addressobjectOptionalRegistered-address fields in the provenance-enabled lite profile.
address.country_codestring | nullOptionalReturned field; availability depends on the record.
address.country_namestring | nullOptionalReturned field; availability depends on the record.
address.country_regionstring | nullOptionalReturned field; availability depends on the record.
address.address_streetstring | nullOptionalReturned field; availability depends on the record.
address.address_locationstring | nullOptionalReturned field; availability depends on the record.
address.address_citystring | nullOptionalReturned field; availability depends on the record.
address.zip_codestring | nullOptionalReturned field; availability depends on the record.
address.jurisdictionstring | nullOptionalReturned field; availability depends on the record.
address.sourceobject | nullOptionalExpand using the nested attributes listed below.
address.source.categoryProfileSourcestring | nullOptionalSource class, such as Government Registry, Enriched or Modelled.
address.source.commentProfileSourcestring | nullOptionalReturned field; availability depends on the record.
address.source.idProfileSourceinteger | string | nullOptionalProvider source identifier. Upstream records can encode identifiers as integers or strings.
address.source.nameProfileSourcestring | nullOptionalReturned field; availability depends on the record.
address.source.urlProfileSourcestring | nullOptionalSource URL when it can be disclosed; otherwise null. Format: uri.
address.source.retrieved_atProfileSourcestring | nullOptionalFormat: date-time.
contactobjectOptionalPublic contact fields in the provenance-enabled lite profile.
contact.websitestring | nullOptionalReturned field; availability depends on the record.
contact.linkedinstring | nullOptionalReturned field; availability depends on the record.
contact.sourceobject | nullOptionalExpand using the nested attributes listed below.
contact.source.categoryProfileSourcestring | nullOptionalSource class, such as Government Registry, Enriched or Modelled.
contact.source.commentProfileSourcestring | nullOptionalReturned field; availability depends on the record.
contact.source.idProfileSourceinteger | string | nullOptionalProvider source identifier. Upstream records can encode identifiers as integers or strings.
contact.source.nameProfileSourcestring | nullOptionalReturned field; availability depends on the record.
contact.source.urlProfileSourcestring | nullOptionalSource URL when it can be disclosed; otherwise null. Format: uri.
contact.source.retrieved_atProfileSourcestring | nullOptionalFormat: 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.