SmartGarant Guarantee API

This page documents the partner-facing SmartGarant Guarantee (GLI) workflow for API v3: pre-scoring, project creation, document management, validation request, and rental information.

Before You Start

Environment URLs, API key provisioning, and the global response envelope are centralized in Getting Started. Authentication flow is documented in Authentication. For the functional lifecycle, see GLII Process.

Canonical Endpoint Paths

All endpoint paths on this page are documented without an extra service prefix and start directly with /v3.

1. Endpoint Summary

Operation	Method	Endpoint
Get a pre-scoring	POST	/v3/score
Create a project	POST	/v3/projects
Get projects	GET	/v3/projects
Get a project	GET	/v3/projects/{id}
Get required documents	GET	/v3/projects/{projectId}/required
Add documents	POST	/v3/projects/{id}/documents
Get project documents	GET	/v3/projects/{id}/documents
Delete a document	DELETE	/v3/projects/{id}/documents/{documentId}
Apply (request validation)	POST	/v3/projects/{id}/apply
Get eligibility certificate	GET	/v3/projects/{id}/documents/certificate
Add rental information	POST	/v3/projects/{id}/rent
Get project payment	GET	/v3/projects/{id}/payment
Get organization stats	GET	/v3/projects/stats

2. Get a Pre-Scoring

Returns the maximum guaranteed rent for a given financial profile, before creating a project.

POST /v3/score

POST /v3/score HTTP/1.1
Host: sandbox.api.smart-garant.fr
Authorization: Bearer {bearerToken}
Content-Type: application/json

{
  "finance": {
    "status": 1,
    "monthlyIncome": 1800
  }
}

3. Create a Project

Creates a guarantee project for a tenant.

POST /v3/projects

POST /v3/projects HTTP/1.1
Host: sandbox.api.smart-garant.fr
Authorization: Bearer {bearerToken}
Content-Type: application/json

{
  "profile": {
    "firstName": "Cyril",
    "lastName": "Blibi",
    "gender": 1,
    "dateOfBirth": "1986-01-02",
    "phone": {
      "phoneContryCode": "FR",
      "phoneOrigin": "0606060606",
      "phoneFormated": "+33606060606"
    },
    "email": "cyril.blibi@yopmail.com"
  },
  "finance": {
    "status": 1,
    "monthlyIncome": 1800
  },
  "metadata": {
    "source": "partner-api",
    "externalLeadId": "LD-20260630-001"
  }
}

3.1 Business Rules

1. The tenant status (finance.status) is required.
2. Below 250 € of rent (SmartGarant scoring), the project cannot be created (non-eligible).
3. If the tenant status is retired (14), put the income in retirementPensionAmount and not in monthlyIncome.
4. If the tenant status is student (12), a referent and the referent referentFinance are required.
5. A referent cannot be a student nor retired.
6. For CDD and interim statuses, contractPrecarious must be provided.

3.2 profile

Field	Description / Note	Required
gender	1 Homme, 2 Femme	true
firstName		true
lastName		true
email		true
dateOfBirth	Format yyyy-MM-dd	true
phone	{ "phoneOrigin": "0666666666", "phoneContryCode": "FR", "phoneFormated": "+33666666666" } — uses libphonenumber-js	true

3.3 finance (tenant finance)

Field	Description / Note	Required
status	See Status Types	true
contractPrecarious	Only for CDD and interim — 0 superior to 6 months, 1 inferior to 6 months, 2 trial period
monthlyIncome	Net monthly income of the tenant
bonusesAmount	Bonuses of the tenant
savingsAmount	Tenant savings
socialSecurityAmount	Tenant social security
familyAllowanceAmount	Family allowances / grants of the tenant
foodSupportAmount	Alimony of the tenant
landIncome	Land income of the tenant
unemploymentBenefit	Unemployment benefit of the tenant
maternityLeave	Maternity/paternity leave of the tenant
retirementPensionAmount	Net retirement pension of the tenant (retired only)

3.4 referent / referentFinance

Required only when the tenant finance.status is student (12). referentFinance follows the same structure as finance, and the referent status cannot be student or retired.

3.5 Status Types

Value	Status
0	Titulaire du public
1	CDI Public
2	CDD Public
3	Militaire
4	CDI privé
5	CDD privé
6	Intérimaire
7	Intermittent
8	Artisan / Commerçant
9	Auto-entrepreneur
10	Profession libérale
11	Chef d'entreprise
12	Étudiant
14	Retraité
15	Recherche d'emploi

3.6 Response Model

Field	Description
id	Unique project id
userId	Unique user id
status	See Project Status
createDate	Project creation date
score	Maximum guaranteed rent

3.7 Project Status

Value	Description
0	Documents pending / missing
1	Documents in validation, waiting for manager
2	Documents validated, waiting for rental information
3	Rental in validation, waiting for manager
4	Project validated, waiting for payment
5	Payment done, waiting for tenant signature
6	Tenant signature ok, waiting for owner signature
7	Project active — contract in progress
9	Project suspended (no follow-up or too old)
12	Contract will end at a defined date
13	Contract ended, no longer active
14	Project not eligible

4. Get Projects

GET /v3/projects

GET /v3/projects HTTP/1.1
Host: sandbox.api.smart-garant.fr
Authorization: Bearer {bearerToken}

5. Get a Project

GET /v3/projects/{id}

6. Documents

6.1 Get Required Documents

Returns the list of expected documents for a project.

GET /v3/projects/{projectId}/required

6.2 Add Documents

POST /v3/projects/{id}/documents

6.3 Get Project Documents

GET /v3/projects/{id}/documents

6.4 Delete a Document

DELETE /v3/projects/{id}/documents/{documentId}

6.5 Get Eligibility Certificate

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

7. Apply — Request Validation

Requests verification of the uploaded documents.

POST /v3/projects/{id}/apply

8. Rental Information

Adds the rental information once documents are validated.

POST /v3/projects/{id}/rent

9. Payment

GET /v3/projects/{id}/payment

10. Organization Stats

Returns statistics for the authenticated organization.

GET /v3/projects/stats