Lets Safe API

All calls can be made using PHP, see our examples below.

Or npm install lets-safe-api

To test the API use the sandbox site. https://sandbox.letssafe.com/ and go to https://sandbox.letssafe.com/swagger/ui/index to see all the api calls available.

View our Swagger documents here

• Create a new tenant reference
• Add a guarantor to an applicant
• Get an applicant
• Get a PDF report (Does not work on the test api, only live data)
• Query using OData
• Get inprogress tenant references
• Get completed tenant references
• Delete an applicant

Billing Api Examples

• Get all orders
• Get an order
• Get an orders pdf

How to setup Webhooks

To enable webhooks: 1: Login to the Portal 2: Go to Settings 3: Add a webhook url

Webhook Events

• applicant/created, when a new reference is created
• applicant/gtor/created, when a guarantor is added to a reference
• applicant/deleted, when an applicant is delete from a reference
• applicant/details/completed, when an applicant completes their initial application
• applicant/completed, when an applicant's reference completes
• applicant/employer/completed, when the employer completes the reference
• applicant/futureemployer/completed, when the future employer completes the reference
• applicant/landlord/completed, when the landlord completes the reference
• applicant/previouslandlord/completed, when the previous landlord completes the reference
• Payments
• payment/created, when a payment is made on your account

Webhook Events Payloads

• { "Payload":"applicant id GUID", "AgentId":1, "EventType":"applicant/created" }
• { "Payload":"applicant id GUID", "AgentId":1, "EventType":"applicant/gtor/created" }
• { "Payload":"applicant id GUID", "AgentId":1, "EventType":"applicant/deleted"}
• { "Payload":"applicant id GUID"," AgentId":1, "EventType":"applicant/details/completed"}
• { "Payload":"applicant id GUID"," AgentId":1, "EventType":"applicant/completed"}
• { "Payload":"applicant id GUID", "AgentId":1, "EventType":"applicant/employer/completed"}
• { "Payload":"applicant id GUID", "AgentId":1, "EventType":"applicant/futureemployer/completed"}
• { "Payload":"applicant id GUID", "AgentId":1, "EventType":"applicant/landlord/completed"}
• { "Payload":"applicant id GUID", "AgentId":1, "EventType":"applicant/previouslandlord/completed"}
• Payments
• { "Payload":"", "AgentId":1, "EventType":"payment/created" }

Product Types

• Full Tenant Reference = 1
• Guarantor Reference = 3
• Credit Check = 4

Grade Types

• Pass = 1
• Failed = 2
• Inconclusive = 3
• Not Applicable = 4
• In Progress = 5
• Warning = 6

• GradeCcId: Credit Check
• GradePorId: Proof of Residence Grade
• GradeEmpId: Employer Reference Grade
• GradeFtrEmpId: Future Employer Reference Grade
• GradeLlId: Landlord Reference Grade
• GradePrvLlId: Previous Landlord Reference Grade
• GradeAcctId: Accountant Reference Grade
• GradeGtorId: Guarantor Reference Grade
• GradeIrrId: Income to Rent Ratio Grade

Employment Types

• Employed = 1
• Employed Part Time = 2
• Self Employed = 3
• Unemployed = 4
• Contract = 5
• Retired = 6
• Student = 7

Residential Type

• Property Owner = 1
• Council Tenant = 2
• Private Tenant = 3
• Living With Friends Or Relatives = 4

Title Types

• Mr = 1
• Mrs = 2
• Miss = 3
• Ms = 4
• Dr = 5
• Rev = 6
• Lord = 7
• Lady = 8
• Sir = 9
• Professor = 10
• Captian = 11
• Colonel = 12
• Hon = 13
• Major = 14

Question Grade Type

• Pass = 1
• Failed = 2
• Warning = 3
• AwaitingGrading = 4