DossierFacile

https://partenaire.dossierfacile.logement.gouv.fr/
Admin
DossierFacile is a French public digital service that helps tenants create compliant, verified, and...
Tokens:29,511
Snippets:205
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Perform an HTTP GET request on the documentation index

Source: https://partenaire.dossierfacile.logement.gouv.fr/llms.txt

Use this request to ask a specific question about the documentation. The 'ask' parameter is required, while the 'goal' parameter is optional for tailoring the response.

```http
GET https://partenaire.dossierfacile.logement.gouv.fr/comment-ca-marche.md?ask=<question>&goal=<end_goal>
```

--------------------------------

### GET {baseUrl}/dfc/api/v1/settings

Source: https://partenaire.dossierfacile.logement.gouv.fr/documentation-technique/dossierfacile-connect.md

Visualise la configuration du partenaire.

```APIDOC
## GET {baseUrl}/dfc/api/v1/settings

### Description
Visualise la configuration du partenaire.

### Method
GET

### Endpoint
{baseUrl}/dfc/api/v1/settings

### Parameters
#### Headers
- **Authorization** (string) - Required - Bearer token du service.

### Request Example
Aucun corps de requête.

### Response
#### Success Response (200)
- **apiVersion** (string) - Version des API.
- **webhookUrl** (string) - URL du webhook.
- **webhookApiKey** (string) - Clé API associée au webhook.
- **contactEmail** (string) - Email de contact technique.

#### Response Example
{
  "apiVersion": "v1",
  "webhookUrl": "https://example.com/webhook",
  "webhookApiKey": "string",
  "contactEmail": "tech@example.com"
}
```

--------------------------------

### POST {baseurl_API}/dfc/tenant/profile

Source: https://partenaire.dossierfacile.logement.gouv.fr/documentation-technique/dossierfacile-connect.md

Récupère les données de l'utilisateur DossierFacile après connexion.

```APIDOC
## POST {baseurl_API}/dfc/tenant/profile

### Description
Récupère les données de l'utilisateur DossierFacile après connexion.

### Method
POST

### Endpoint
{baseurl_API}/dfc/tenant/profile

### Parameters
#### Request Body
- **token** (string) - Required - Le token d'accès de l'utilisateur.

### Request Example
{
  "token": "string"
}

### Response
#### Success Response (200)
- **id** (integer) - Identifiant de l'apartmentSharing.
- **onTenantId** (integer) - Identifiant du tenant.
- **partnerCallBackType** (string) - Type de callback.
- **applicationType** (string) - Type d'application.
- **dossierUrl** (string) - URL vers la page de résumé.
- **dossierPdfDocumentStatus** (string) - Statut de génération du PDF.
- **dossierPdfUrl** (string) - URL vers le PDF.
- **status** (string) - Statut de l'apartmentSharing.
- **tenants** (array) - Liste des tenants.

#### Response Example
{
  "id": 0,
  "onTenantId": 1,
  "partnerCallBackType": "DELETED_ACCOUNT",
  "applicationType": "COUPLE",
  "dossierUrl": "https://example.com/dossier",
  "dossierPdfDocumentStatus": "COMPLETED",
  "dossierPdfUrl": "https://example.com/dossier.pdf",
  "status": "VALIDATED",
  "tenants": []
}
```

--------------------------------

### POST {baseurl_SSO}/auth/realms/dossier-facile/protocol/openid-connect/token

Source: https://partenaire.dossierfacile.logement.gouv.fr/documentation-technique/dossierfacile-connect.md

Obtient un accessToken "service" pour l'authentification OAuth2 du service.

```APIDOC
## POST {baseurl_SSO}/auth/realms/dossier-facile/protocol/openid-connect/token

### Description
Obtient un accessToken "service" pour l'authentification OAuth2 du service.

### Method
POST

### Endpoint
{baseurl_SSO}/auth/realms/dossier-facile/protocol/openid-connect/token

### Parameters
#### Request Body (form)
- **grant_type** (string) - Required - Doit être `client_credentials`.
- **clientId** (string) - Required - Votre identifiant client.
- **clientSecret** (string) - Required - Votre secret client.

### Request Example
{
  "grant_type": "client_credentials",
  "clientId": "VotreClientId",
  "clientSecret": "VotreClientSecret"
}

### Response
#### Success Response (200)
- **access_token** (string) - Le jeton d'accès.
- **token_type** (string) - Le type de jeton.
- **expires_in** (integer) - Durée de validité en secondes.

#### Response Example
{
  "access_token": "string",
  "token_type": "Bearer",
  "expires_in": 3600
}
```

--------------------------------

### Exemple de callback webhook JSON

Source: https://partenaire.dossierfacile.logement.gouv.fr/documentation-technique/dossierfacile-connect?_hsenc=p2ANqtz-85PmdGG8HPFX-wgo6fMhXZ1ljE2avSGQDeeENN_prWA8v-ZQMBgsRGEdj2M1fkaD8Qk_BF

Exemple de corps JSON envoyé par une requête POST sur l'URL de callback du webhook. Certains attributs sont facultatifs selon l'état et le type de callback. Les commentaires indiquent les valeurs possibles pour chaque champ.

```json
{
    "id": 0, // Id de l'apartmentSharing
    "onTenantId": 1, // tenant duquel provient l'evenement
    "partnerCallBackType": "XXXXXXX", // type de CallBack: DELETED_ACCOUNT / ...
    "applicationType": "XXXX", // type d'application: COUPLE / ALONE / GROUP
    "dossierUrl": "url vers la page de résumé" // lorsque le compte est validé
    "dossierPdfDocumentStatus": "DELETED", // statut génération du document PDF : COMPLETED, ...
    "dossierPdfUrl": "url vers le path du pdf " // !POST pour génération avec GET // lorsque le compte est validé
    "status": "TO_PROCESS", // status de l'apartmentSharing : TO_PROCESS / VALIDATED / DECLINED / INCOMPLETE
    "tenants": ...
    ...
}
```

--------------------------------

### PATCH {baseurl}/dfc/api/v1/settings

Source: https://partenaire.dossierfacile.logement.gouv.fr/documentation-technique/dossierfacile-connect.md

Édite certains champs de la configuration du partenaire.

```APIDOC
## PATCH {baseurl}/dfc/api/v1/settings

### Description
Édite certains champs de la configuration du partenaire.

### Method
PATCH

### Endpoint
{baseurl}/dfc/api/v1/settings

### Parameters
#### Headers
- **Authorization** (string) - Required - Bearer token du service.

#### Request Body
- **apiVersion** (string) - Optional - Version des API.
- **webhookUrl** (string) - Optional - URL du webhook.
- **webhookApiKey** (string) - Optional - Clé API associée au webhook.
- **contactEmail** (string) - Optional - Email de contact technique.

### Request Example
{
  "apiVersion": "v2",
  "webhookUrl": "https://example.com/new-webhook",
  "webhookApiKey": "new-api-key",
  "contactEmail": "new-tech@example.com"
}

### Response
#### Success Response (200)
- **apiVersion** (string) - Version des API.
- **webhookUrl** (string) - URL du webhook.
- **webhookApiKey** (string) - Clé API associée au webhook.
- **contactEmail** (string) - Email de contact technique.

#### Response Example
{
  "apiVersion": "v2",
  "webhookUrl": "https://example.com/new-webhook",
  "webhookApiKey": "new-api-key",
  "contactEmail": "new-tech@example.com"
}
```

--------------------------------

### Configuration Management Endpoints

Source: https://partenaire.dossierfacile.logement.gouv.fr/documentation-technique/dossierfacile-connect.md

Endpoints for viewing and editing client configuration settings, such as API versions and webhook URLs.

```http
GET {{baseUrl}}/dfc/api/v1/settings
```

```http
PATCH {baseurl}/dfc/api/v1/settings
```

--------------------------------

### Endpoint d'upload de document garant v3

Source: https://partenaire.dossierfacile.logement.gouv.fr/documentation-technique/journal-des-communications-importantes.md

Nouvel endpoint pour l'upload de certificats de garantie, nécessitant le champ typeDocumentCertificate.

```text
/api-partner/register/guarantorOrganism/documentCertificate
```

--------------------------------

### Refresh token request with curl

Source: https://partenaire.dossierfacile.logement.gouv.fr/documentation-technique/dossierfacile-connect?_hsenc=p2ANqtz-85PmdGG8HPFX-wgo6fMhXZ1ljE2avSGQDeeENN_prWA8v-ZQMBgsRGEdj2M1fkaD8Qk_BF

Use this curl command to obtain a new access token using the refresh token returned during authentication. Replace the placeholders with your actual client ID and refresh token values.

```bash
curl --location --request POST https://sso-preprod.dossierfacile.fr/auth/realms/dossier-facile/protocol/openid-connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=refresh_token' \
--data-urlencode 'client_id={CLIENT ID VALUE}' \
--data-urlencode 'refresh_token={REFRESH TOKEN VALUE}'\
```

--------------------------------

### Service Access Token Request

Source: https://partenaire.dossierfacile.logement.gouv.fr/documentation-technique/dossierfacile-connect.md

Required parameters for the POST request to obtain a service access token using client credentials.

```http
grant_type=client_credentials, clientId=VotreClientId, clientSecret=VotreClientSecret
```
Tokens:
Raw