Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-267057121.5 KB

Upload an identity document image

Stores one face of the signer's identity document. Required on both signing paths before calling POST /confirm.

Call once per view:

  • front + back for an ID card (CNI, titre de séjour).
  • page for a passport.

Re-uploading the same view overwrites the previous image.

post/apps/gov-fr/v1/entry/{silo_entry_id}/identity

Path parameters

silo_entry_idstring required
Example:5b45453c-cdd0-11ed-afa1-0242ac120002

ID of the org.Party silo entry being onboarded.

Request body

view'front' | 'back' | 'page' required

Which face of the identity document this image represents.

  • front - Front of an ID card (recto).
  • back - Back of an ID card (verso).
  • page - Photo page of a passport.
datastring byte required

Base64-encoded binary of the image. Must be image/jpeg or image/png, maximum 4 MB. Text on the document should be clearly legible.

Response

Identity image stored.