Skip to main content
POST
Déposer un document dans un lot

Authorizations

Authorization
string
header
required

Clé API créée dans Administration → Développeurs → Clés API (licence Groupe). Une clé en lecture seule ne peut appeler que les opérations GET.

Path Parameters

id
string
required

Body

application/json
documentCategory
enum<string>
required

Nature du document transmis.

Available options:
identite,
administratif
document
string
required

Le document en base64 (préfixe data URL et retours à la ligne tolérés). Identité : image JPEG, PNG ou WebP (le recto). Administratif : PDF, JPEG, PNG, WebP ou TIFF d'une seule page, fichier unique. 10 Mo maximum.

documentVerso
string

Verso de la pièce d'identité (base64, optionnel). Refusé pour un document administratif.

externalRef
string

Votre référence de dossier — renvoyée dans le résultat et filtrable en lecture.

Maximum string length: 255
agencyPostalCode
string

Code postal de la commune de l'agence qui contrôle (optionnel, France). Pour une pièce d'identité, il place son passage sur la carte du parcours du document, au centre de la commune ; un code partagé par plusieurs communes désigne la plus peuplée. Un code qu'aucune commune ne porte (CEDEX, faute de frappe) est refusé en 400 invalid_request, avant toute analyse.

Pattern: ^\d{5}$

Response

Document enregistré.

id
string
position
integer