Applicant to tenancy
A 9-step recipe with Arthur Online. We can help you get access.
Recipe · 9 steps
Applicant to tenancy
with Arthur Online
Create an applicant, view a unit, take the offer and open the tenancy.
- Confirm which Arthur entity this token can address.
- Create the applicant. strict=true so an unknown source is rejected, not created.
- Book a viewing of the unit for this applicant.
- Confirm the applicant is attached to the viewing.
- Record the applicant's offer against the viewing.
- Convert the accepted viewing into a tenancy. Not idempotent - never auto-retry.
- Add the tenant to the tenancy.
- Invite the tenant into the Arthur tenant portal.
- Read the deposit registration state on the new tenancy.
What you'll need to have ready
- entityId: The Arthur entity to operate in, sent as X-EntityID on every call.
- unitId: The lettable unit being viewed.
- applicant: Applicant fields as documented on the Add Applicant operation.
- viewing: Viewing fields - viewing_date, viewing_time, duration, notes.
- offer: Offer fields - offer amount and offer_frequency.
- tenancy: Tenancy fields - start_date, end_date, rent and frequency.
- tenant: Tenant person fields.
For your developer
Arazzo workflow arthur-online:applicantToTenancy, 9 operations: $sourceDescriptions.entitiesApi.listEntities → $sourceDescriptions.applicantsApi.addApplicant → $sourceDescriptions.viewingsApi.addViewingOnUnit → $sourceDescriptions.applicantsApi.listApplicantsOnViewing → $sourceDescriptions.offersApi.submitOfferOnViewing → $sourceDescriptions.tenanciesApi.addTenancyOnViewing → $sourceDescriptions.tenantsApi.addTenantOnTenancy → $sourceDescriptions.inviteApi.inviteTenant → $sourceDescriptions.registerDepositApi.registerDepositOnTenancy. Specs on APIs.io.