Retrieving a settled status certificate | API

Created by Kevin Smith, Modified on Fri, 16 Aug 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