---
title: "Check includes identifying bankruptcy, insolvency, CCJ's or Company Directorship."
method: POST
path: "/api/credit-status/perform"
tags: ["CreditStatus"]
---

# Check includes identifying bankruptcy, insolvency, CCJ's or Company Directorship.

`POST /api/credit-status/perform`

## Headers

- `apikey` string, required

## Request body

- CredasApiModelsStatusChecksStatusCheckRequest
  - `regEntryId` string, uuid, required
  - `person` CredasApiModelsDataCheckPerson, required
    - `forename` string, required
    - `middleName` string
    - `surname` string, required
    - `dateOfBirth` string, date-time, required
  - `address` CredasApiModelsDataCheckAddress, required
    - `addressLine1` string, required
    - `addressLine2` string
    - `addressLine3` string
    - `city` string, required
    - `postcode` string, required
    - `county` string
    - `country` string, required

## Response `200`

Success

- CredasApiModelsStatusChecksStatusCheck
  - `status` 0 | 1 | 2 | 3 — Unknown = 0, Pass = 1, Refer = 2, Fail = 3
  - `hasBeenOverridden` boolean
  - `checkDate` string, date-time
  - `insolvency` CredasApiModelsStatusChecksInsolvencyInsolvencyResult[]
    - `type` 0 | 1 | 2 | 3 | 4 | 5 — Unknown = 0, NorthernIrelandBankruptcy = 1, ScottishSequestrationBankruptcy = 2, EnglandAndWalesIVA = 3, EnglandAndWalesDRO = 4, EnglandAndWalesBankruptcy = 5
    - `typeText` string
    - `name` string
    - `caseNo` string
    - `address` CredasApiModelsStatusChecksInsolvencyAddress
      - `address1` string
      - `address2` string
      - `address3` string
      - `address4` string
      - `address5` string
      - `postcode` string
      - `dps` string
      - `isEmpty` boolean
    - `dob` string, date-time
    - `court` string
    - `startDate` string, date-time
    - `status` string
    - `occupation` string
    - `aliases` string
    - `description` string
    - `serviceOffice` string
    - `telephoneNumber` string
    - `caseType` string
    - `tradingNames` string
    - `debtTotal` string
    - `assetTotal` string
    - `previousAddress` CredasApiModelsStatusChecksInsolvencyAddress
      - `address1` string
      - `address2` string
      - `address3` string
      - `address4` string
      - `address5` string
      - `postcode` string
      - `dps` string
      - `isEmpty` boolean
    - `presentationDate` string, date-time
  - `ccj` CredasApiModelsStatusChecksCCJCcjResult[]
    - `name` string
    - `dob` string, date-time
    - `address1` string
    - `address2` string
    - `address3` string
    - `address4` string
    - `address5` string
    - `postcode` string
    - `judgementDate` string, date-time
    - `judgementType` 0 | 1 | 2 | 3 | 4 | 5 — Unknown = 0, Judgement = 1, Satisfaction = 2, Revocation = 3, SetAside = 4, AdministrationOrder = 5
    - `judgementTypeText` string
    - `amount` string
    - `caseNumber` string
    - `courtName` string
    - `dateEnd` string, date-time
  - `companyDirector` CredasApiModelsStatusChecksCompanyDirectorCompanyDirectorResult[]
    - `matchType` 0 | 1 | 2 | 3 — Unknown = 0, NameAndDateOfBirth = 1, NameAndAddress = 2, NameAndAddressAndDateOfBirth = 3
    - `matchTypeText` string
    - `dateAppointed` string, date-time
    - `companyRegNo` string
    - `companyName` string
    - `registeredOffice` string
    - `companyAppointments` CredasApiModelsStatusChecksCompanyDirectorCompanyAppointment[]
      - `title` string
      - `name` string
      - `address` string
      - `dob` string, date-time
      - `occupation` string
      - `nationality` string
      - `appointmentDate` string, date-time
      - `appointmentType` string
  - `person` CredasApiModelsDataCheckPerson
    - `forename` string, required
    - `middleName` string
    - `surname` string, required
    - `dateOfBirth` string, date-time, required
  - `address` CredasApiModelsDataCheckAddress
    - `addressLine1` string, required
    - `addressLine2` string
    - `addressLine3` string
    - `city` string, required
    - `postcode` string, required
    - `county` string
    - `country` string, required

## Other responses

- `400` — If the service was supplied invalid data.
- `401` — If credentials supplied were invalid.
- `402` — Error code meaning that the operation was aborted due to insufficient credits.
- `500` — If an unexpected exception occurred whilst processing the request.

---

[API](https://skmtc.dev/credas/apis/credas-api.md) · [All operations](https://skmtc.dev/credas/apis/credas-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/credas/credas-api/revisions/a8dd82736563/schema)