API Clients & Partenaires

Automatisez vos démarches foncières et hypothécaires.

L’API Hypothèques en ligne offre un accès sécurisé pour commander, suivre et récupérer vos documents immobiliers directement depuis vos systèmes.

Environnements

Configuration

L’authentification s’effectue via OAuth 2.0 JWT Bearer.
Le JWT doit être généré et signé côté client avec un certificat, puis échangé contre un access_token via l’endpoint /oauth.
Les APIs métier utilisent ensuite cet access_token pour réaliser les demandes.

Clé	Valeur
Base URL (production)	`https://api.hypotheques-en-ligne.fr/`
Base URL (sandbox)	`https://api-sandbox.hypotheques-en-ligne.fr/`

Contactez Hypothèques en ligne afin d’activer l’accès aux APIs.

Authentification

POST
/oauth
Obtention d’un access token (JWT Bearer)

Échange un JWT signé côté client contre un access_token utilisable sur l’ensemble des APIs métier.

Type	Paramètres	Notes
En-têtes (oblig.)	`Content-Type: application/x-www-form-urlencoded`
Body (oblig.)	`grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer` `assertion=<token JWT signé côté client>`	`assertion` contient le JWT signé avec la clé privée

Exemple de requête (curl)

curl -X POST "https://api-sandbox.hypotheques-en-ligne.fr/oauth" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer" \
  --data-urlencode "assertion=<JWT_signé_côté_client>"

Exemple de réponse JSON

{
  "access_token": "00Dxx0000000001!AQcAQ...",
  "token_type": "Bearer"
}

APIs

Chaque réponse des APIs métiers POST retourne un jobId (identifiant unique de la commande), réutilisable avec GET /v1/commandes/{jobId} pour en suivre le statut et récupérer le lien de dossier partagé.

POST
/v1/commandes/ehf-parcelle
EHF depuis une parcelle cadastrale

Crée une commande d’état hypothécaire à partir de la référence cadastrale de la parcelle.

Type	Paramètres	Notes
En-têtes (oblig.)	`Content-Type: application/json`, `Authorization: Bearer <access_token>`	`access_token` obtenu préalablement via `/oauth`
Obligatoires	`numero_commande_partenaire`, `localisation_bien`, `section_cadastrale`, `numero_parcelle`	localisation_bien issue du référentiel Hypothèques en ligne
Facultatifs	`reference_partenaire`, `prefixe`, `numero_lot`, `volume`, `filtre_dernier_proprietaire_connu`	`filtre_dernier_proprietaire_connu` : booléen, valeur par défaut `false`. Il permet de limiter la délivrance aux informations concernant le dernier propriétaire connu.
Contraintes	Si le `prefixe` n’est pas renseigné ⇒ valeur par défaut `000`.

Exemple de JSON d’envoi (body)

{
  "numero_commande_partenaire": "CMD-2025-0002",
  "reference_partenaire": "REF-XYZ",
  "localisation_bien": "13400 AUBAGNE",
  "prefixe": "000",
  "section_cadastrale": "AB",
  "numero_parcelle": "123",
  "numero_lot": "102",
  "volume": ""
}

Exemple de requête (curl)

curl -X POST "https://api-sandbox.hypotheques-en-ligne.fr/v1/commandes/ehf-parcelle" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <access_token>" \
  -d '{
    "numero_commande_partenaire": "CMD-2025-0002",
    "reference_partenaire": "REF-XYZ",
    "localisation_bien": "13400 AUBAGNE",
    "prefixe": "000",
    "section_cadastrale": "AB",
    "numero_parcelle": "123",
    "numero_lot": "102",
    "volume": ""
  }'

Exemple de réponse JSON

{
  "success": true,
  "jobId": "500xxxxxxxxxxxx",
  "errors": []
}

POST
/v1/commandes/ehf-personne-physique
EHF depuis une personne physique

Crée une commande d’état hypothécaire à partir d’une identité de personne physique.

Type	Paramètres	Notes
En-têtes (oblig.)	`Content-Type: application/json`, `Authorization: Bearer <access_token>`	`access_token` obtenu préalablement via `/oauth`
Obligatoires	`numero_commande_partenaire`, `localisation_bien`, `nom_personne`, `prenom_1`, `date_naissance` (JJ/MM/AAAA), `lieu_naissance`, `pays_naissance`	localisation_bien issue du référentiel Hypothèques en ligne
Facultatifs	`reference_partenaire`, `prenom_2`, `filtre_dernier_proprietaire_connu`	`filtre_dernier_proprietaire_connu` : booléen, valeur par défaut `false`. Il permet de limiter la délivrance aux informations concernant le dernier propriétaire connu.
Contraintes	Format date : `JJ/MM/AAAA`.

Exemple de JSON d’envoi (body)

{
  "numero_commande_partenaire": "CMD-2025-0003",
  "reference_partenaire": "REF-XYZ",
  "localisation_bien": "13400 AUBAGNE",
  "nom_personne": "DURAND",
  "prenom_1": "ALICE",
  "prenom_2": "VICTOIRE",
  "date_naissance": "30/01/1990",
  "lieu_naissance": "34000 MONTPELLIER",
  "pays_naissance": "FRANCE"
}

Exemple de requête (curl)

curl -X POST "https://api-sandbox.hypotheques-en-ligne.fr/v1/commandes/ehf-personne-physique" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <access_token>" \
  -d '{
    "numero_commande_partenaire": "CMD-2025-0003",
    "reference_partenaire": "REF-XYZ",
    "localisation_bien": "13400 AUBAGNE",
    "nom_personne": "DURAND",
    "prenom_1": "ALICE",
    "prenom_2": "VICTOIRE",
    "date_naissance": "30/01/1990",
    "lieu_naissance": "34000 MONTPELLIER",
    "pays_naissance": "FRANCE"
  }'

Exemple de réponse JSON

{
  "success": true,
  "jobId": "500xxxxxxxxxxxx",
  "errors": []
}

POST
/v1/commandes/ehf-personne-morale
EHF depuis une personne morale

Crée une commande d’état hypothécaire à partir d’une identité de personne morale (entreprise, SCI, association…).

Type	Paramètres	Notes
En-têtes (oblig.)	`Content-Type: application/json`, `Authorization: Bearer <access_token>`	`access_token` obtenu préalablement via `/oauth`
Obligatoires	`numero_commande_partenaire`, `localisation_bien`, `raison_sociale`, `siren`, `code_postal_ville`	localisation_bien issue du référentiel Hypothèques en ligne
Facultatifs	`reference_partenaire`, `filtre_dernier_proprietaire_connu`	`filtre_dernier_proprietaire_connu` : booléen, valeur par défaut `false`. Il permet de limiter la délivrance aux informations concernant le dernier propriétaire connu.
Contraintes	Cohérence raison_sociale / siren.

Exemple de JSON d’envoi (body)

{
  "numero_commande_partenaire": "CMD-2025-0004",
  "reference_partenaire": "REF-XYZ",
  "localisation_bien": "13400 AUBAGNE",
  "raison_sociale": "SOCIETE DEMO",
  "siren": "123456789",
  "code_postal_ville": "13400 AUBAGNE"
}

Exemple de requête (curl)

curl -X POST "https://api-sandbox.hypotheques-en-ligne.fr/v1/commandes/ehf-personne-morale" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <access_token>" \
  -d '{
    "numero_commande_partenaire": "CMD-2025-0004",
    "reference_partenaire": "REF-XYZ",
    "localisation_bien": "13400 AUBAGNE",
    "raison_sociale": "SOCIETE DEMO",
    "siren": "123456789",
    "code_postal_ville": "13400 AUBAGNE"
  }'

Exemple de réponse JSON

{
  "success": true,
  "jobId": "500xxxxxxxxxxxx",
  "errors": []
}

POST
/v1/commandes/ehf-multi
EHF multi-entrées

Crée une commande d’état hypothécaire à partir de listes de références cadastrales de parcelles ou de personnes (physiques et/ou morales).

Type	Paramètres	Notes
En-têtes (oblig.)	`Content-Type: application/json`, `Authorization: Bearer <access_token>`	`access_token` obtenu préalablement via `/oauth`
Obligatoires	`numero_commande_partenaire`, `localisation_bien`, et ≥1 liste non vide : `parcelles` / `personnes_physiques` / `personnes_morales`	localisation_bien issue du référentiel Hypothèques en ligne
Facultatifs	`reference_partenaire`, `prefixe`, `numero_lot`, `volume`, `filtre_dernier_proprietaire_connu`	`filtre_dernier_proprietaire_connu` : booléen, valeur par défaut `false`. Il permet de limiter la délivrance aux informations concernant le dernier propriétaire connu.
Contraintes	Si le `prefixe` n’est pas renseigné ⇒ défaut `000`. Plafonds indicatifs : – Nbre parcelles ≤ 12 ; – Nbre personnes_physiques ≤ 3 ; Nbre personnes_morales ≤ 3. Nbre personnes_physiques + Nbre personnes_morales ≤ 3. – Pas de mélange parcelles / personnes.

Exemple 1 – multi-parcelles (body)

{
  "numero_commande_partenaire": "CMD-2025-0005",
  "reference_partenaire": "REF-XYZ",
  "localisation_bien": "79440 COURLAY",
  "parcelles": [
    {"prefixe": "000", "section_cadastrale": "AB", "numero_parcelle": "123", "numero_lot": "101", "volume": ""},
    {"prefixe": "000", "section_cadastrale": "AB", "numero_parcelle": "124", "numero_lot": "102", "volume": ""},
    {"prefixe": "000", "section_cadastrale": "AC", "numero_parcelle": "210", "numero_lot": "201", "volume": ""}
  ]
}

Exemple 1 – requête (curl)

curl -X POST "https://api-sandbox.hypotheques-en-ligne.fr/v1/commandes/ehf-multi" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <access_token>" \
  -d '{
  "numero_commande_partenaire": "CMD-2025-0005",
  "reference_partenaire": "REF-XYZ",
  "localisation_bien": "79440 COURLAY",
  "parcelles": [
    {"prefixe": "000", "section_cadastrale": "AB", "numero_parcelle": "123", "numero_lot": "101", "volume": ""},
    {"prefixe": "000", "section_cadastrale": "AB", "numero_parcelle": "124", "numero_lot": "102", "volume": ""},
    {"prefixe": "000", "section_cadastrale": "AC", "numero_parcelle": "210", "numero_lot": "201", "volume": ""}
  ]
}'

Exemple de réponse JSON

{
  "success": true,
  "jobId": "500xxxxxxxxxxxx",
  "errors": []
}

Exemple 2 – multi-personnes (body)

{
  "numero_commande_partenaire": "CMD-2025-0006",
  "reference_partenaire": "REF-ACME",
  "localisation_bien": "79440 COURLAY",
  "personnes_physiques": [
    {
      "nom_personne": "DURAND",
      "prenom_1": "ALICE",
      "date_naissance": "30/01/1990",
      "lieu_naissance": "34000 MONTPELLIER",
      "pays_naissance": "FRANCE"
    },
    {
      "nom_personne": "MARTIN",
      "prenom_1": "JEAN",
      "date_naissance": "15/05/1985",
      "lieu_naissance": "69000 LYON",
      "pays_naissance": "FRANCE"
    }
  ],
  "personnes_morales": [
    {
      "raison_sociale": "SOCIETE DEMO",
      "siren": "123456789",
      "code_postal_ville": "79440 COURLAY"
    }
  ]
}

Exemple 2 – requête (curl)

curl -X POST "https://api-sandbox.hypotheques-en-ligne.fr/v1/commandes/ehf-multi" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <access_token>" \
  -d '{
  "numero_commande_partenaire": "CMD-2025-0006",
  "reference_partenaire": "REF-ACME",
  "localisation_bien": "79440 COURLAY",
  "personnes_physiques": [
    {
      "nom_personne": "DURAND",
      "prenom_1": "ALICE",
      "date_naissance": "30/01/1990",
      "lieu_naissance": "34000 MONTPELLIER",
      "pays_naissance": "FRANCE"
    },
    {
      "nom_personne": "MARTIN",
      "prenom_1": "JEAN",
      "date_naissance": "15/05/1985",
      "lieu_naissance": "69000 LYON",
      "pays_naissance": "FRANCE"
    }
  ],
  "personnes_morales": [
    {
      "raison_sociale": "SOCIETE DEMO",
      "siren": "123456789",
      "code_postal_ville": "79440 COURLAY"
    }
  ]
}'

Exemple de réponse JSON

{
  "success": true,
  "jobId": "500yyyyyyyyyy",
  "errors": []
}

POST
/v1/commandes/acte
Copie d’acte notarié

Crée une commande de copie d’acte notarié (acte de vente, donation, succession, partage, …) à partir de sa référence d’enliassement.

Type	Paramètres	Notes
En-têtes (oblig.)	`Content-Type: application/json`, `Authorization: Bearer <access_token>`	`access_token` obtenu préalablement via `/oauth`
Obligatoires	`numero_commande_partenaire`, `localisation_bien`, `date_formalite`, `volume`, `numero`, `numero_sages`	localisation_bien issue du référentiel Hypothèques en ligne
Facultatifs	`reference_partenaire`	—
Contraintes	Format date : `JJ/MM/AAAA`.

Exemple de JSON d’envoi (body)

{
  "numero_commande_partenaire": "CMD-2025-0006",
  "reference_partenaire": "REF-XYZ",
  "localisation_bien": "94100 SAINT-MAUR-DES-FOSSÉS",
  "date_formalite": "15/09/2003",
  "volume": "2003P",
  "numero": "5678",
  "numero_sages": "9404P01"
}

Exemple de requête (curl)

curl -X POST "https://api-sandbox.hypotheques-en-ligne.fr/v1/commandes/acte" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <access_token>" \
  -d '{
    "numero_commande_partenaire": "CMD-2025-0006",
    "reference_partenaire": "REF-XYZ",
    "localisation_bien": "94100 SAINT-MAUR-DES-FOSSÉS",
    "date_formalite": "15/09/2003",
    "volume": "2003P",
    "numero": "5678",
    "numero_sages": "9404P01"
  }'

Exemple de réponse JSON

{
  "success": true,
  "jobId": "500xxxxxxxxxxxx",
  "errors": []
}

POST
/v1/commandes/doc-copro
Document de copropriété (RDC / EDD)

Crée une commande de document ou modificatif de copropriété (RDC : Règlement De Copropriété / EDD : État Descriptif de Division) à partir de sa référence d’enliassement.

Type	Paramètres	Notes
En-têtes (oblig.)	`Content-Type: application/json`, `Authorization: Bearer <access_token>`	`access_token` obtenu préalablement via `/oauth`
Obligatoires	`numero_commande_partenaire`, `localisation_bien`, `document_demande`, `date_formalite`, `volume`, `numero`, `numero_sages`	document_demande ∈ {`RDC`, `EDD`} ; localisation_bien issue du référentiel
Facultatifs	`reference_partenaire`	—
Contraintes	Format date : `JJ/MM/AAAA`.

Exemple de JSON d’envoi (body)

{
  "numero_commande_partenaire": "CMD-2025-0007",
  "reference_partenaire": "REF-XYZ",
  "localisation_bien": "13400 AUBAGNE",
  "document_demande": "RDC",
  "date_formalite": "10/10/2019",
  "volume": "2019P",
  "numero": "345",
  "numero_sages": "9404P01"
}

Exemple de requête (curl)

curl -X POST "https://api-sandbox.hypotheques-en-ligne.fr/v1/commandes/doc-copro" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <access_token>" \
  -d '{
    "numero_commande_partenaire": "CMD-2025-0007",
    "reference_partenaire": "REF-XYZ",
    "localisation_bien": "13400 AUBAGNE",
    "document_demande": "RDC",
    "date_formalite": "10/10/2019",
    "volume": "2019P",
    "numero": "345",
    "numero_sages": "9404P01"
  }'

Exemple de réponse JSON

{
  "success": true,
  "jobId": "500xxxxxxxxxxxx",
  "errors": []
}

GET
/v1/commandes/{jobId}
Suivi d’une commande

Récupère le statut, l’avancement et le lien de dossier partagé associés à une commande existante.
Le paramètre {jobId} correspond à l’identifiant (Id) de la commande créée par les API métiers.

Type	Paramètres	Notes
En-têtes (oblig.)	`Content-Type: application/json`, `Authorization: Bearer <access_token>`	`access_token` obtenu préalablement via `/oauth`
URL (oblig.)	`{jobId}`	Identifiant de la commande
Body	—	Non requis

Exemple de requête (curl)

curl -X GET "https://api-sandbox.hypotheques-en-ligne.fr/v1/commandes/5008Z00000AbCdE" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <access_token>"

Exemple de réponse JSON

{
  "success": true,
  "jobId": "5008Z00000AbCdE",
  "status": "In Progress",
  "share_folder": "https://docs.hypotheques-en-ligne.fr/aZerTy_io-PqsdZg",
  "errors": []
}

Statuts de la commande

Statut	Description
`New`	Commande créée, en attente de traitement.
`In Progress`	Commande en cours de traitement.
`Awaiting Customer`	Attente d’une réponse client.
`Closed`	Commande terminée, documents disponibles.
`Cancelled`	Commande annulée.