POST api/CompanyName

Validates a company name with Companies House. Also checks against pending incorporations made through ID.

Request Information

Parameters

Name	Description	Additional information
companyName	Company name to validate.	Define this parameter in the request body.

Request body formats

application/json, text/json, text/html

Sample:

sample company name

Response Information

SimilarCompanyNames will only be populated on failures.

Response body formats

application/json, text/json, text/html

Sample:

{
  "message": "sample string 1",
  "nameResult": {
    "isValid": true,
    "requiresAdditionalEvidence": true,
    "changeDuplicate": true,
    "isExactActiveDuplicate": true,
    "isExactPendingDuplicate": true,
    "requiresApprovalFrom": "sample string 6",
    "invalidDiacritics": [
      "A",
      "A",
      "A"
    ],
    "invalidCharacters": [
      "A",
      "A",
      "A"
    ],
    "firstThreeInvalidCharacters": [
      "A",
      "A",
      "A"
    ],
    "restrictedWords": [
      {
        "id": 1,
        "name": "sample string 2",
        "allowWithEvidence": true,
        "allowWithAmendedArticles": true
      },
      {
        "id": 1,
        "name": "sample string 2",
        "allowWithEvidence": true,
        "allowWithAmendedArticles": true
      },
      {
        "id": 1,
        "name": "sample string 2",
        "allowWithEvidence": true,
        "allowWithAmendedArticles": true
      }
    ],
    "companiesHouseErrors": [
      "sample string 1",
      "sample string 2",
      "sample string 3"
    ]
  },
  "similarCompanyNames": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ]
}