Create Collateral
After you have activated the desired products, you can get started by creating a collateral.
Process Overview
OAuth authorization
Obtain authorization using the Client Credentials Grant flow of OAuth 2.0.
Follow the instructions under Setup OAuth App to create an OAuth App and get client_id and client_secret.
The following scopes must be set for the OAuth App: rental_collateral:read rental_collateral:update
For all subsequent API calls, include the following header: Authorization: Bearer <access_token>.
Create a new collateral object
Create a new collateral object with the given details. The result contains the id of the newly created collateral object.
You must provide all information about the rental object, the collateral amounts and due dates, as well as about the owner of the object and yourself as the manager. You may optionally include information about the tenant(s). Any information you do not provide about the tenant(s), the tenant(s) will need to complete themselves.
There are two options you need to set:
- Option 1
allowTenantToOverride: This applies to tenant information (name, address, DOB etc). If you set this tofalse, make sure you enter all the information correctly, as the tenant will not be allowed to edit information that you have provided about them. (They will still be able to enter any information about themselves that you did not provide.) - Option 2
allowTenantToReject: Settings this tofalsewill prevent the tenant from declining the invitation through Zinsli - the intention is that if any information is wrong, they should contact you directly to fix the information and you cancel the old and send them a new invitation.
You also need to set which products the tenant should be able to choose from (allowedProducts). This must be a subset of the products generally allowed by you as the property manager. You can retrieve the list of allowed products by calling /v1/{organizationSlug}/property-manager/product.
Instead of an array IDs of allowed products, you can send an empty array, and the tenant will be allowed to choose from all the allowed products.
Manage collateral objects
The following methods are available to manage (find, get, update) existing collateral objects. Updates patch:/v1/rental-collateral/{id}/manager are possible as long as the tenant has not been invited to a collateral.
This methods are not mandatory for the onboarding process, but may be useful.
Invite Tenant
Next step is to invite the tenant to the collateral.
The tenant(s) will receive an email with a link to accept the invitation if the property sendViaEmail is set to true.
You can also send the Invitation email by yourself.
You can get the Invitation Link by calling /v1/{organizationSlug}/property-manager/rental-collateral/{id}/invitation
Cancel Tenant Invitation
You have the option to cancel the tenant invitation, as long as the tenant has not yet accepted the invite.
Get Notified of Updates
Next the tenant will accept your invitation to manage their collateral via Zinsli.
Then, they will choose a product.
The product provider will accept or reject the tenant as a client.
If required, the tenant will make a payment (savings account etc).
The product will be fully onboarded and the rental security locked, as confirmed by the product procvider.
You, as the landlord, will get notified every step of the way
Get Collateral Summary as PDF (optional)
Optionally, you can fetch a summary of the whole collateral which contains all the information in a PDF.(Tenant, landlord and rental object owner information, rental object address, deposit amount, as well as terms agreement dates).