Skip to main content

GLII Process

This page explains the complete SmartGarant guarantee (GLI) lifecycle for partners, from the initial pre-scoring to an active contract: project creation, document upload, validation, rental information, payment, and signatures.

Scope

This is a functional guide. For full request and response contracts, see Guarantee API.

1. Project Lifecycle​

A guarantee project usually follows this business sequence:

  1. Get a pre-scoring (optional) to know the maximum guaranteed rent.
  2. Create the project with tenant profile and finance.
  3. Upload all required documents.
  4. Apply for validation.
  5. Add the rental information.
  6. Payment and tenant/owner signatures.
  7. The contract becomes active.

For endpoint details, see Guarantee API.

2. Step 0 - Pre-Scoring​

Before creating a project, you can request a pre-scoring to know the maximum guaranteed rent for a given financial profile.

POST /v3/score
Eligibility Rule

Below 250 € of rent (SmartGarant scoring), a project cannot be created (non-eligible).

API reference: Guarantee API

3. Step 1 - Create a Project​

The project is created with the tenant profile and finance.

Business rules:

  • The tenant status (finance.status) is required.
  • If the tenant is retired (14), put the income in retirementPensionAmount, not in monthlyIncome.
  • If the tenant is a student (12), a referent and referentFinance are required. A referent cannot be a student nor retired.
  • For CDD and interim statuses, contractPrecarious must be provided.
POST /v3/projects

API reference: Guarantee API

4. Step 2 - Required Documents​

After project creation, all mandatory documents must be uploaded before requesting validation.

Use the required-documents endpoint to know which files are expected:

GET /v3/projects/{projectId}/required

Then upload each document as multipart/form-data with the file and documentType fields:

POST /v3/projects/{id}/documents

Use the project-specific required-documents response to select documentType. Supported files are JPEG, GIF, PNG, and PDF, up to 10 MB each.

API reference: Guarantee API

5. Step 3 - Validation Request​

When mandatory documents are complete, request project validation:

POST /v3/projects/{id}/apply

API reference: Guarantee API

6. Step 4 - Rental Information​

Once documents are validated and the project is in status 2, add the owner, property, rent, and lease information:

POST /v3/projects/{id}/rent

API reference, request fields, and payload example: Guarantee API

7. Step 5 - Payment & Signatures​

After validation of the rental information, the project moves to payment, then tenant and owner signatures. When both signatures are done, the contract becomes active (status 7).

GET /v3/projects/{id}/payment

You can retrieve the eligibility certificate at any eligible step:

GET /v3/projects/{id}/documents/certificate

API reference: Guarantee API

8. Statistics​

Retrieve statistics for your organization:

GET /v3/projects/stats

9. Webhooks​

Project lifecycle changes can be tracked through webhooks. See Webhook for registration rules and events.