The non-payment insurance steps are in the API reference. The scoring steps
are described here, and their API reference is being prepared.
Score the candidates
1
Send each candidate's data
For each candidate interested in a listing, send the data you have. Declared monthly income is the minimum. Add the ID number (DNI or NIE) to enable the delinquency check, and documents when you have them.See Sending candidate data.
2
Read the score
Vivara returns a score for each candidate: a solvency result, a delinquency result and the confidence tier they are based on. The two results are independent, not a combined verdict.See Reading the result.
3
Prioritize the visits
Use the scores to decide which candidates to offer a visit to. The visits happen in your own process, outside Vivara.
Insure the property
1
Complete the data for the quote
A quote needs more data than the score, but no documents. For each tenant and guarantor: role, ID number, date of birth, postal code, working status, employment start date and gross annual income. For the landlord: ID number. For the contract: start date, duration (12, 18 or 24 months), monthly rental amount and the insured property’s address.You do not need to score the tenant again before asking for a quote. If they were scored without an ID number, add it now: the quote requires it.
2
Open the case
Generate a UUID v4 for the case and send the data with
POST /non-payment-insurance/cases. Read the case with GET /non-payment-insurance/cases/{caseId} to see the offer and the documents the insurer requires.See Get a quote.3
Upload the required documents
Send each document listed in
documentation.missing. They are stored until you issue the policy. When nothing is missing, the case is ready-to-issue.See Provide pending documents.4
Issue the policy
Send the landlord’s details and bank account. Vivara requests the issuance and, when the offer is conditioned, sends the insurer every document merged into a single PDF.See Request the policy.
5
Track the outcome
Poll the case with exponential backoff, waiting at least 30 seconds between calls, until it is
policy-issued or rejected. Once the policy is issued, you receive the policy number.See Track status and policy number.If something does not work out
If a candidate is not solvent, or the insurer rejects the case, go back to your candidates and choose another one. Their existing scores are still valid, so you do not need to score them again. Create a new case, with a new id, for the new tenant.Next steps
Key concepts
The terms used across these docs.
Tenant scoring
How the score works, in detail.