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.

Project Status Details

The following statuses describe the main journey shown in the tenant's personal space. The numeric values correspond to the project's status field in the API.

Value	Status	Meaning
0	Awaiting documents	The tenant has created their account. We are waiting for them to upload their documents to their personal space.
1	Documents awaiting validation	The tenant has uploaded their documents. Our team is checking and authenticating them.
2	Documents validated	The tenant's supporting documents have been validated and verified. Rental information can now be provided.
3	Awaiting landlord validation	The rental information is being validated. Our team will contact the landlord.
4	Landlord information validated	We have verified the rental and landlord information. We are waiting for the tenant to activate their contract through payment.
5	Awaiting tenant signature	We are waiting for the tenant to sign their contract.
6	Awaiting landlord signature	The tenant has signed their part of the contract. It is now the landlord's turn to sign.
7	Active contract	The guarantee contracts have been signed. Only the lease remains to be signed for the guarantee to take effect.

For the complete list, including suspended, ending, ended, and ineligible projects, see Project status values.

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.