Skip to main content
POST
/
apps
/
gov-fr
/
v1
/
entry
/
{silo_entry_id}
/
identity
Upload an identity document image
curl --request POST \
  --url https://api.invopop.com/apps/gov-fr/v1/entry/{silo_entry_id}/identity \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": "aSDinaTvuI8gbWludGxpZnk="
}
'
{
  "error": "missing siren parameter"
}

Documentation Index

Fetch the complete documentation index at: https://docs.invopop.com/llms.txt

Use this file to discover all available pages before exploring further.

Stores one face of the signer’s identity document as an attachment on the silo entry. Required before confirming when the agreement was uploaded with signature=identity. Call once per view — front + back for an ID card (CNI, titre de séjour), or page for a passport. Re-uploading the same view overwrites the previous image; the MIME type is detected from the bytes.

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 10 MB. Text on the document should be clearly legible. The MIME type is detected from the bytes.

Response

Identity image stored.