Retrieving a settled status certificate | API

Created by Kevin Smith, Modified on Fri, 16 Aug, 2024 at 12:41 PM by Hannah Rowe


It the Entity provided a Share Code, their Settled Status certificate may have been attached to the Entity.  This can be downloaded via the GET /api/v2/ci/entities/{entityID}/data-checks/rtw/{rtwCheckId} endpoint for Right To Work checks and the GET /api/v2/ci/entities/{entityID}/data-checks/rtr/{rtrCheckId} endpoint for Right to Rent checks.


Before calling this endpoint you will need to retrieve the rtwCheckId from the GET /api/v2/ci/entities/{entityId}/active-checks endpoint - this can be located in the section which has a "type" 11 (Right To Work) or 12 (Right to Rent)


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