Submit a document
curl --request POST \
--url https://api.vivara.io/v1/non-payment-insurance/cases/{caseId}/documents \
--header 'Content-Type: multipart/form-data' \
--header 'X-API-Key: <api-key>' \
--form type=payslip \
--form 'file=@example-file;type=application/pdf' \
--form tenantId=6b1e0d44-2c3f-4b8e-a0f2-91d7e5c3a810import requests
url = "https://api.vivara.io/v1/non-payment-insurance/cases/{caseId}/documents"
files = { "file": ("example-file", open("example-file", "rb"), "application/pdf") }
payload = {
"type": "payslip",
"tenantId": "6b1e0d44-2c3f-4b8e-a0f2-91d7e5c3a810"
}
headers = {"X-API-Key": "<api-key>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('type', 'payslip');
form.append('file', '<string>');
form.append('tenantId', '6b1e0d44-2c3f-4b8e-a0f2-91d7e5c3a810');
const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};
options.body = form;
fetch('https://api.vivara.io/v1/non-payment-insurance/cases/{caseId}/documents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vivara.io/v1/non-payment-insurance/cases/{caseId}/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\npayslip\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/pdf\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tenantId\"\r\n\r\n6b1e0d44-2c3f-4b8e-a0f2-91d7e5c3a810\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.vivara.io/v1/non-payment-insurance/cases/{caseId}/documents"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\npayslip\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/pdf\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tenantId\"\r\n\r\n6b1e0d44-2c3f-4b8e-a0f2-91d7e5c3a810\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.vivara.io/v1/non-payment-insurance/cases/{caseId}/documents")
.header("X-API-Key", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\npayslip\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/pdf\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tenantId\"\r\n\r\n6b1e0d44-2c3f-4b8e-a0f2-91d7e5c3a810\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vivara.io/v1/non-payment-insurance/cases/{caseId}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\npayslip\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/pdf\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tenantId\"\r\n\r\n6b1e0d44-2c3f-4b8e-a0f2-91d7e5c3a810\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"data": {
"document": {
"id": "c41a8e93-7d2b-4f6a-b5e1-2a9f0c8d3e17",
"type": "payslip",
"fileName": "nomina-septiembre.pdf",
"uploadedAt": "2026-10-26T10:02:41Z",
"tenantId": "6b1e0d44-2c3f-4b8e-a0f2-91d7e5c3a810"
},
"documentation": {
"complete": false,
"missing": [
{
"anyOf": [
"employment-contract",
"work-history-report"
],
"minFiles": 1,
"uploadedFiles": 0,
"tenantId": "6b1e0d44-2c3f-4b8e-a0f2-91d7e5c3a810",
"templateUrl": "https://files.vivara.es/npi/templates/anexo-lopd.pdf"
}
],
"documents": [
{
"id": "c41a8e93-7d2b-4f6a-b5e1-2a9f0c8d3e17",
"type": "payslip",
"fileName": "nomina-septiembre.pdf",
"uploadedAt": "2026-10-26T10:02:41Z",
"tenantId": "6b1e0d44-2c3f-4b8e-a0f2-91d7e5c3a810"
}
],
"sentToInsurerAt": null
}
}
}Non-payment insurance
Submit a document
Uploads one document for a case, either for the case as a whole (tenantId omitted) or for one tenant.
Accepted while the case is pending-documentation or ready-to-issue. Accepted formats: PDF, JPEG and PNG, up to 10 MB each.
Documents are only stored here; they reach the insurer when the policy is issued. When the last missing requirement is met, the case moves to ready-to-issue.
POST
/
non-payment-insurance
/
cases
/
{caseId}
/
documents
Submit a document
curl --request POST \
--url https://api.vivara.io/v1/non-payment-insurance/cases/{caseId}/documents \
--header 'Content-Type: multipart/form-data' \
--header 'X-API-Key: <api-key>' \
--form type=payslip \
--form 'file=@example-file;type=application/pdf' \
--form tenantId=6b1e0d44-2c3f-4b8e-a0f2-91d7e5c3a810import requests
url = "https://api.vivara.io/v1/non-payment-insurance/cases/{caseId}/documents"
files = { "file": ("example-file", open("example-file", "rb"), "application/pdf") }
payload = {
"type": "payslip",
"tenantId": "6b1e0d44-2c3f-4b8e-a0f2-91d7e5c3a810"
}
headers = {"X-API-Key": "<api-key>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('type', 'payslip');
form.append('file', '<string>');
form.append('tenantId', '6b1e0d44-2c3f-4b8e-a0f2-91d7e5c3a810');
const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};
options.body = form;
fetch('https://api.vivara.io/v1/non-payment-insurance/cases/{caseId}/documents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vivara.io/v1/non-payment-insurance/cases/{caseId}/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\npayslip\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/pdf\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tenantId\"\r\n\r\n6b1e0d44-2c3f-4b8e-a0f2-91d7e5c3a810\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.vivara.io/v1/non-payment-insurance/cases/{caseId}/documents"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\npayslip\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/pdf\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tenantId\"\r\n\r\n6b1e0d44-2c3f-4b8e-a0f2-91d7e5c3a810\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.vivara.io/v1/non-payment-insurance/cases/{caseId}/documents")
.header("X-API-Key", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\npayslip\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/pdf\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tenantId\"\r\n\r\n6b1e0d44-2c3f-4b8e-a0f2-91d7e5c3a810\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vivara.io/v1/non-payment-insurance/cases/{caseId}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\npayslip\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/pdf\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tenantId\"\r\n\r\n6b1e0d44-2c3f-4b8e-a0f2-91d7e5c3a810\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"data": {
"document": {
"id": "c41a8e93-7d2b-4f6a-b5e1-2a9f0c8d3e17",
"type": "payslip",
"fileName": "nomina-septiembre.pdf",
"uploadedAt": "2026-10-26T10:02:41Z",
"tenantId": "6b1e0d44-2c3f-4b8e-a0f2-91d7e5c3a810"
},
"documentation": {
"complete": false,
"missing": [
{
"anyOf": [
"employment-contract",
"work-history-report"
],
"minFiles": 1,
"uploadedFiles": 0,
"tenantId": "6b1e0d44-2c3f-4b8e-a0f2-91d7e5c3a810",
"templateUrl": "https://files.vivara.es/npi/templates/anexo-lopd.pdf"
}
],
"documents": [
{
"id": "c41a8e93-7d2b-4f6a-b5e1-2a9f0c8d3e17",
"type": "payslip",
"fileName": "nomina-septiembre.pdf",
"uploadedAt": "2026-10-26T10:02:41Z",
"tenantId": "6b1e0d44-2c3f-4b8e-a0f2-91d7e5c3a810"
}
],
"sentToInsurerAt": null
}
}
}Path Parameters
Body
multipart/form-data
A document to store in the case, sent as multipart form data.
data-protection-consent is the signed data protection annex (Anexo LOPD), a case document signed by the landlord and every tenant. Every other type is a tenant document.
Available options:
data-protection-consent, identity-document, employment-contract, work-history-report, payslip, income-tax-return, quarterly-tax-return, pension-certificate, company-tax-id-card, corporate-income-tax-return, power-of-attorney, guarantor-identity-document, guarantor-income-proof, military-commitment Example:
"payslip"