Company Details API Documentation

company-details-api-service

Overview

Version information

Version : 0.0.1 [v.1]

Tags

  • Default

Access

  • Base URL: https://public-api.crunch.co.uk/v1/company-details

Paths

Get a user's company details

Up
get /

Security

oauth2-authorisation-code
Type: oauth2 Scopes: read:all

Return type

Example data

Content-Type: application/json
{
  "content" : [ {
    "vatRegistrationNumber" : "vatRegistrationNumber",
    "companyNumber" : "companyNumber",
    "companyName" : "companyName",
    "vatSchemeChanges" : [ {
      "limitedCostTrader" : true,
      "dateTo" : "2000-01-23T04:56:07.000+00:00",
      "vatScheme" : "vatScheme",
      "industry" : "industry",
      "dateFrom" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "limitedCostTrader" : true,
      "dateTo" : "2000-01-23T04:56:07.000+00:00",
      "vatScheme" : "vatScheme",
      "industry" : "industry",
      "dateFrom" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "businessAddress" : {
      "addressCountry" : "addressCountry",
      "addressLine1" : "addressLine1",
      "addressPostCode" : "addressPostCode",
      "addressCity" : "addressCity"
    }
  }, {
    "vatRegistrationNumber" : "vatRegistrationNumber",
    "companyNumber" : "companyNumber",
    "companyName" : "companyName",
    "vatSchemeChanges" : [ {
      "limitedCostTrader" : true,
      "dateTo" : "2000-01-23T04:56:07.000+00:00",
      "vatScheme" : "vatScheme",
      "industry" : "industry",
      "dateFrom" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "limitedCostTrader" : true,
      "dateTo" : "2000-01-23T04:56:07.000+00:00",
      "vatScheme" : "vatScheme",
      "industry" : "industry",
      "dateFrom" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "businessAddress" : {
      "addressCountry" : "addressCountry",
      "addressLine1" : "addressLine1",
      "addressPostCode" : "addressPostCode",
      "addressCity" : "addressCity"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

The user's company data has been returned ResponseWrapper

404

The user data could not be found

500

An unexpected error occurred while processing the request for company details.

Models

[ Jump to Methods ]

Table of Contents

  1. Address
  2. CompanyDetails
  3. ResponseWrapper
  4. VatSchemeChange

Address Up

addressLine1
addressCity
addressPostCode
addressCountry

CompanyDetails Up

vatSchemeChanges (optional)
companyName (optional)
vatRegistrationNumber (optional)
businessAddress (optional)
registeredAddress (optional)
companyNumber (optional)

VatSchemeChange Up

dateFrom (optional)
Date format: date-time
dateTo (optional)
Date format: date-time
vatScheme (optional)
industry (optional)
limitedCostTrader (optional)