The Right To Work / Right to Rent details can be downloaded via 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)
The response object is structured as follows:
{
"entityId": "a24f21e6-976a-4ea4-9c90-bb125e7beb6g",
"type": 11,
"name": "Right to Work",
"status": 3,
"lastCheckedDate": "2024-03-15T13:49:41.65",
"requestedDate": "2024-03-15T13:50:52.193",
"idvEntryId": "dee00252-249d-40c0-b276-0643b7f8g8f8",
"isOnGoingMonitoring": false,
"isManuallyChecked": false,
"submittedBy": "User name",
"requestedBy": "User name",
"rtxCheckId": 12323,
"canReview": true,
"legislation": 0
},
The possible status values:
1 = Pass
2 = Requested
3 = ActionRequired
4 = Fail
5 = NotPerformed
6 = Refer
7 = UnderReview
8 = Complete
9 = AwaitingData
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article