Skip to main content
POST
Upload an identity document image
Stores one face of the signer’s identity document. Required on both signing paths. Call before POST /confirm. Call once per side: front + back for an ID card (CNI, titre de séjour), or a single page for a passport. Re-uploading the same view overwrites the previous image.

Authorizations

Authorization
string
header
required

Authenticate using a valid Invopop enrollment token in the Bearer scheme.

Example: Authorization: Bearer <token>

Path Parameters

silo_entry_id
string
required

ID of the org.Party silo entry being onboarded.

Example:

"5b45453c-cdd0-11ed-afa1-0242ac120002"

Body

application/json
view
enum<string>
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.
Available options:
front,
back,
page
data
string<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.