Retrieve Company Details

Created by Jonathan Mugridge, Modified on Wed, 27 May at 3:20 PM by Jonathan Mugridge

Retrieve Company Details

Once a company has been created in Connect, you can retrieve the results in two ways depending on your requirements: either as a paginated list of companies or as detailed information for an individual company.

Retrieve a List of Companies

You can retrieve a paginated list of all previously added companies by calling the following endpoint. This allows you to search using either a company name or registration number.

GET /api/v2/ci/companies

This endpoint accepts the following parameters:

searchTerm (string) → The company name or registration number to search for
pageNumber (integer) → Optional; used to paginate results

Example Request

GET /api/v2/ci/companies?searchTerm=credas

Example Response

{
  "list": [
    {
      "id": 0,
      "resultId": "string",
      "companyName": "string",
      "companyNumber": "string",
      "addressLine1": "string",
      "addressLine2": "string",
      "postcode": "string",
      "locality": "string",
      "region": "string",
      "country": "string",
      "status": 0,
      "type": 0,
      "dateOfRegistration": "2026-05-21T13:49:07.691Z",
      "dateAdded": "2026-05-21T13:49:07.691Z",
      "saved": true,
      "addedByUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "email": "user@example.com",
        "firstName": "string",
        "surname": "string",
        "isSuperUser": true,
        "diallingCode": "string",
        "mobileNumber": "string"
      },
      "legalForm": "string"
    }
  ],
  "totalCount": 0,
  "pageNumber": 0
}

Individual Company Details

The full details for an individual company can also be retrieved by specifying its unique ID in the below endpoint:

GET /api/v2/ci/companies/{id}

Example Payload Response

{
  "id": 6510,
  "companyName": "CREDAS TECHNOLOGIES LTD.",
  "companyNumber": "10429398",
  "country": "GB",
  "dateAdded": "2025-09-23T08:54:20Z",
  "addedByUser": {
    "email": "user@example.com"
  },
  "fullReport": {
    "companySummary": {
      "businessName": "CREDAS TECHNOLOGIES LTD.",
      "companyStatus": {
        "description": "Active"
      }
    }
  },
  "sanctions": {
    "dateCreated": "2025-09-23T08:54:20Z",
    "searchMatches": []
  }
}

What's included in the full response

The fullReport object provides an in-depth view of the company, including:

Company summary (status, activity, registration details)
Identification data (legal form, VAT details, previous names)
Addresses and contact information
Directors and shareholders
Financial statements and ratios
Group structure and ownership hierarchy
Additional regulatory and historical information

The sanctions object includes:

Business profile and identifiers
Sanctions and watchlist matches
Related entities and risk indicators

IMPORTANT:

- The {id} parameter is required to retreive a specific company
- This endpoint returns the complete dataset available for that company
- Use the endpoint when detailed due diligence or reporting information is required

Generate a PDF report

It is also possible to export the results of a company check to a PDF using the API.

GET /api/v2/ci/companies/{id}/export

How it works

Simply pass the Connect company id in the request. This is the unique identifier returned when the company was created or retrieved.

Response

The API returns a direct URL to the generated PDF report. This link can be used to download or view the file.

If a PDF viewer is available, the document will open in the browser
Otherwise, the file will be downloaded automatically

Summary

Use /companies to retrieve and search across stored companies

Use /companies/{id} to pull full details for a specific company

Combine both endpoints to support list views and detailed drill-down in your integration

Use /companies/{id}/export to generate a PDF document

For further information on how to send checks to Directors, Shareholders and PSCs, please click below:

Got any questions?

If you have any questions please reach out to the Credas support team by contacting us here

We are committed to continually improving our support resources for you. We would greatly appreciate your feedback on this article to help us enhance your experience.

Join our live training sessions

Whether you're new to Credas or simply looking for a refresher, we’ve got you covered! We now offer regular training sessions designed to help you get the most out of the Credas platform. These sessions are tailored to different product areas, including:

- AML / ID verification
- Right to Work
- Our brand-new Credas Lettings solution
- Admin / advanced training

In each session we will walk you through how platform works and answer any questions you may have.

See our full training schedule