Record a Right to Rent check you did yourself (England): free.

A share code checked on GOV.UK ("method": "share-code") or original documents seen in person ("manual-document"). listType A (no time limit) or B (time-limited, with leaveExpiry). confirmed: true says you did the check yourself. The record gives the follow-up date for list B and how long to keep it.

post/v1/transactions/{id}/right-to-rent

Request

  • Base URL: https://api.stratumapis.com
  • URL: https://api.stratumapis.com/v1/transactions/{id}/right-to-rent
  • Auth: API key in header X-Stratum-Key

Path parameters

idstring required

The txnId from creating the transaction.

Response

Recorded on the job.

Changes

No recorded changes to this operation across all 1 revision of this API.