> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arquos.eu/llms.txt
> Use this file to discover all available pages before exploring further.

# Vérifier un import, sans rien écrire

> La correspondance proposée entre les colonnes du fichier et celles d’Arquos, le nombre de lignes prêtes et les lignes à corriger. Une correspondance donnée remplace la proposée.

### Endpoint & Authentification

| Méthode | URL |
| :- | :- |
| `POST` | `https://api.arquos.eu/api/v2/imports/check` |

**En-têtes (Headers) :**

* `Authorization: Bearer [VOTRE_JETON_D_API]`
* `X-Arquos-Agency: [IDENTIFIANT_D_AGENCE]` (facultatif, voir [Agence](/v2/agence))
* `Content-Type: application/json`

### Paramètres de la requête

<ParamField header="X-Arquos-Agency" type="string">
  L’identifiant de l’agence où agir. Absent : l’agence par défaut du compte. Une agence hors de sa portée est refusée (403).
</ParamField>

<ParamField body="fileId" type="string" required>
  L’identifiant du fichier joint.
</ParamField>

<ParamField body="object" type="string" required>
  Ce que le tableau contient : clients, immeubles (buildings), contacts ou équipements (equipment). Valeurs possibles : `clients`, `buildings`, `contacts`, `equipment`.
</ParamField>

<ParamField body="mapping" type="object">
  Facultatif : colonne du fichier → colonne d’Arquos.
</ParamField>

### Réponse (`200`)

<ResponseField name="file" type="string">
  Le nom du fichier vérifié.
</ResponseField>

<ResponseField name="mapping" type="object">
  Pour chaque colonne d’Arquos, la colonne du fichier qui la remplit.
</ResponseField>

<ResponseField name="arquosColumns" type="object[]">
  Les colonnes du format.

  <Expandable title="Chaque élément">
    <ResponseField name="column" type="string">
      L’en-tête attendu.
    </ResponseField>

    <ResponseField name="required" type="boolean">
      Sans elle, la ligne est refusée.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="rows" type="integer">
  Le nombre de lignes lues.
</ResponseField>

<ResponseField name="ready" type="integer">
  Celles qui s’importeront telles quelles.
</ResponseField>

<ResponseField name="toFix" type="object[]">
  Les lignes à corriger. L’import n’écrit rien tant qu’il en reste une.
</ResponseField>

### Les erreurs

| Code | Quand |
| :- | :- |
| `400` | Requête mal formée ou champ obligatoire manquant. |
| `401` | Jeton absent, inconnu ou révoqué. |
| `403` | Agence hors de votre portée. |
| `404` | Objet introuvable dans vos agences. |
| `429` | Trop d’appels : réessayez après le délai de l’en-tête Retry-After. |

Le corps d'une erreur porte `error`, sa raison en français. Voir [Les erreurs](/v2/erreurs).

<RequestExample>
  ```bash cURL theme={"system"}
  curl --request POST \
  --url https://api.arquos.eu/api/v2/imports/check \
  --header 'Authorization: Bearer arq_agent_VOTRE_JETON' \
  --header 'Content-Type: application/json' \
  --data '{
  "fileId": "3f1c2b9e-8a4d-4c1e-9b7a-2d5e6f708192",
  "object": "clients"
  }'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={"system"}
  {
  "file": "texte",
  "mapping": {},
  "arquosColumns": [
    {
      "column": "texte",
      "required": true
    }
  ],
  "rows": 1,
  "ready": 1,
  "toFix": [
    {}
  ]
  }
  ```
</ResponseExample>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.