Skip to content
tlyfePro Partner API
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Menu
Getting started
Introduction
Authentication
Quickstart
Scopes & entitlements
Errors
Rate limits
Managing keys
Managing keys
API Reference
Overview
progression
Overview
UpdateOpenFlowNegotiator
BuyFlows
GetOpenFlowDashboardData
GetFlowPackages
RenewFlow
GetFlow
CreateFlow_progression
DeleteFlow
ArchiveFlow
UnarchiveFlow
MarkAsComplete
MarkAsInComplete
CompleteFlowStepByType
Getcouncils
GetCommonClauses
GetOpenflowLogs
UpdateYotiDocSignatureStatus
GetLogEventsTimeline
GetOpenFlowTenancyDepositSchemes
GetGlobal4
AddFlowToProperty
GetPropertyFlows
GetTenantFlows
GetActiveFlows
GetArchivedFlows
GetRenewedFlows
GetCompletedFlows
DeleteBespokeContract
EmailContract
SignAstStatus
UploadBespokeContract
DeleteContractAgreement
UploadAdditionalContractDocs
DeleteSupportingDoc
StartEsignatureForContract
DeleteAST
DeleteNHA
GenerateContract
EmailEsignatureURL
DownloadSignedAgreement
AddEditDeposit
RequestHoldingDeposit
ConfirmHoldingDeposit
ConfirmDeposit
RemoveCertificate
AddEditCertificate
SendCertificates
ViewCertificate
GetCertificateBuyRequests
BuyCertificate
MarkLandlordAsLead
RemoveLandlord
AddEditLandlord
UploadInventoryDocuments
EditMoveInAccount
RequestMoveInMonies
ConfirmMoveInMonies
AcceptMoveIn
AddEditProtectAndSetup
AddEditTenant
RemoveTenantFromFlow
SendTenantDetails
MarkTenantAsLead
ResendConfirmTenantDetailsReminder
SaveNoRTRRequired
SaveRTR
ApproveRTR
RequestRTR
ReminderRTR
AddEditRentalOffer
SendRentalOffer
AcceptRentalOffer
ConfirmGaurantor
RequestGuarantor
AddGuarantor
RemoveGuarantor
UploadReferenceDocuments
RemoveReferenceDocuments
UploadVerificationDocument
DeleteVerificationDocument
RequestDigitalVerification
VerificationByObx
IdVerificationReminder
CreateTdsDeposit
CreateTdsSdsDepositDraft
GetTdsDeposit
GetTdsDan
rent_ready
Overview
GetBranchVouchers
BuyVouchers
AssignVoucher
GetRentReadySummary
GetTenantInfoData
WriteTenantInfoData
GetShareCodes
CreateShareCode
GetRentReadySettings
UpdateRentReadySettings
GetRentReadySignUp
CreateSignUpRequest
StartDigitalReference
StartDigitalReferenceWithGuarantor
AddGuarantorToDigitalReference
GetDigitalReferencePackages
GetIDVerificationPackages
GetPrequalificationStatus
StartPayment
PurchaseProductWithVoucher
AddCoTenant
GetCOTenants
RemoveCoTenant
maintenance
Overview
GetMaintenanceRoomTypes
GetMaintenanceCategories
GetBranchMaintenanceIssues
CreateMaintenanceIssue
GetOpenFlowMaintenanceIssue
GetMaintenanceIssuesReportedByMe
GetMaintenanceIssueByID
UpdateMaintenanceIssue
UpdateOpenFlowMaintenanceIssueStatus
GetMaintenanceFlowWithActiveIssues
GetMaintenanceFlowsWithActiveIssues
GetMaintenanceProjects
CreateMaintenanceProject
GetMaintenanceProject
UpdateMaintenanceProject
AddIssueToMaintenanceProject
RemoveIssueFromMaintenanceProject
AddMaintenanceProjectComment
UpdateMaintenanceProjectComment
RemoveMaintenanceProjectComment
SummarizeMaintenanceIssue
GetArchivedMaintenanceProjects
ArchiveMaintenanceProject
UnArchiveMaintenanceProject
ArchiveMaintenanceIssue
portal
Overview
GetPropertyCard
GetPropertyDetails
SearchProperties
SaveOrUnsaveProperty
GetSavedProperties
SubmitLead
ArchiveLead
UnarchiveLead
GetLeads
GetPropertiesWithActiveLeads
CreateFlow_portal
Select theme
Dark
Light
Auto
Overview
progression
Section titled “progression”
Sales/lettings progression (OpenFlow) endpoints.
Operations
Section titled “ Operations ”
PUT
/v2.0/openflow/negotiator/{id}
POST
/v2.0/openflow/flows/buy
GET
/v2.0/openflow/flows/summary
GET
/v2.0/openflow/flow/packages
POST
/v2.0/openflow/flow/renew
GET
/v2.0/openflow/flow
POST
/v2.0/openflow/flow
DELETE
/v2.0/openflow/flow
POST
/v2.0/openflow/flow/archive
POST
/v2.0/openflow/flow/unarchive
POST
/v2.0/openflow/{flowtype}/mark-as-complete
POST
/v2.0/openflow/{flowtype}/mark-as-incomplete
POST
/v2.0/openflow/{flowtype}/complete-step
GET
/v2.0/openflow/licencing/councils
GET
/v2.0/openflow/common_clauses
GET
/v2.0/openflow/logs
GET
/v2.0/openflow/updateYotiDocSignatureStatus
GET
/v2.0/openflow_logs_timeline
GET
/v2.0/openflow/tds
GET
/v2.0/openflow/global4/getopenflows/{id}
POST
/v2.0/openflow/flow/add-to-property
GET
/v2.0/openflow/property-flows/{propertyId}
GET
/v2.0/openflow/tenant/flows
GET
/v2.0/openflow/flows
GET
/v2.0/openflow/flow/archived
GET
/v2.0/openflow/flow/renewed
GET
/v2.0/openflow/flow/completed
DELETE
/v2.0/openflow/manualAst
POST
/v2.0/openflow/email-contract
GET
/v2.0/openflow/signAstStatus
POST
/v2.0/openflow/uploadManualAst
DELETE
/v2.0/openflow/deleteContractAgreement
POST
/v2.0/openflow/uploadSupportingDocs
DELETE
/v2.0/openflow/deleteSupportingDoc
POST
/v2.0/openflow/signAstEmbedded
DELETE
/v2.0/openflow/tenancyinformation/AST
DELETE
/v2.0/openflow/tenancyinformation/NHA
POST
/v2.0/openflow/tenancyinformation/generateContract
POST
/v2.0/openflow/emailEsignatureURL
GET
/v2.0/openflow/signedAgreement
POST
/v2.0/openflow/deposits
POST
/v2.0/openflow/requestHoldingDeposit
POST
/v2.0/openflow/confirmHoldingDeposit
POST
/v2.0/openflow/deposits/confirm
DELETE
/v2.0/openflow/certificates/{certificate_id}
POST
/v2.0/openflow/certificates
POST
/v2.0/openflow/certificates/send
POST
/v2.0/openflow/certificate/view
GET
/v2.0/openflow/certificates/buy_requests
POST
/v2.0/openflow/certificatesandinventories/{certificatetype}/buy
POST
/v2.0/openflow/landlords/make_lead/{open_flow_landlord_id}
DELETE
/v2.0/openflow/landlords/{open_flow_landlord_id}
POST
/v2.0/openflow/landlords
POST
/v2.0/openflow/uploadInventoryDocuments
POST
/v2.0/openflow/editMoveInAccount
POST
/v2.0/openflow/requestMoveInMonies
POST
/v2.0/openflow/confirmMoveInMonies
POST
/v2.0/openflow/acceptmovein
POST
/v2.0/openflow/protectandsetup
POST
/v2.0/openflow/tenant
DELETE
/v2.0/openflow/tenant/{open_flow_sub_tenant_id}
POST
/v2.0/openflow/tenant/send
POST
/v2.0/openflow/tenant/make_lead/{open_flow_sub_tenant_id}
POST
/v2.0/openflow/tenant_details/reminder
POST
/v2.0/openflow/no-rtr-required
POST
/v2.0/openflow/save-rtr-code
POST
/v2.0/openflow/approve-rtr-code
POST
/v2.0/openflow/request-right-to-rent
POST
/v2.0/openflow/right_to_rent/reminder
POST
/v2.0/openflow/rental-offer
POST
/v2.0/openflow/send-rental-offer
POST
/v2.0/openflow/acceptrentaloffer
POST
/v2.0/openflow/confirm-gaurantor
POST
/v2.0/openflow/request-guarantor
POST
/v2.0/openflow/add-guarantor
DELETE
/v2.0/openflow/remove-guarantor
POST
/v2.0/openflow/uploadreferencingdocs
DELETE
/v2.0/openflow/uploadreferencingdocs
POST
/v2.0/openflow/uploadVerificationDocument
DELETE
/v2.0/openflow/deleteVerificationDocument
POST
/v2.0/openflow/verification/requestdigital
PUT
/v2.0/openflow/id_verification_by_obx
POST
/v2.0/openflow/id_verification/reminder
POST
/v2.0/openflow/create-tds-deposit
POST
/v2.0/openflow/create-tds-deposit-draft
GET
/v2.0/openflow/get-tds-deposit
GET
/v2.0/openflow/get-tds-dan