Refresh a Company Check

Created by Jonathan Mugridge, Modified on Thu, 2 Jul at 1:28 PM by Jonathan Mugridge


Refresh a Company Check



If you need to retrieve the latest company information and generate an updated company report, you can refresh an existing company check using the refresh report endpoint. This will create a new report based on the most up-to-date data available for the company.


POST /api/v2/ci/companies/{id}/refresh-report

 


Path Parameters


id (integer, required) → The unique identifier of the company to refresh
  • This is the id returned when the company was created or retrieved 


Example Request


POST /api/v2/ci/companies/6510/refresh-report




How it works


  • Provide the id of the company you want to refresh
  • The API will request the latest company data from the relevant data sources
  • A new company report will be generated and attached to the existing company record
  • Subsequent report retrieval requests will return the updated report details




IMPORTANT:

- Triggering a refresh will incur an additional charge
- Refreshing a report does not create a new company record
- The companyId remains unchanged
- Ensure the correct companyId is used before making the request



Summary


  • Use the company id to identify the record
  • Call the refresh endpoint
  • Connect will generate an updated company report using the latest available information
  • Retrieve the report as normal using the existing company record



For more information on how to delete a company checks, please click the below:





Got any questions? 

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


style="font-family: Terminal, monospace;">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.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article

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