# Files in dossier

This topic describes how to use the files in the dossiers (see also the OpenAPI documentation).

It is possible to keep some of the files relative to the end-user directly in the dossier, as opposed to having them only inside the process. A dossier can keep these types of files:

  • front: Image with the front of the ID document.
  • back: Image with the back of the ID document.
  • selfie: Image with the selfie picture of the end-user.
  • portrait: Portrait image extracted from the ID document. Tip: This cannot be uploaded directly to the dossier. It can only be copied from a process that already contains a portrait image.

The supported formats for these files are the same as for the images in the process. For details, see the Images section.

By using this feature you can:

  • Add files directly to the dossier.
  • Use files from the dossier in a process.
  • Copy the files from a process into the dossier.

# Add files directly to the dossier

You can save images directly in the dossier the same way as you do in a process: You call the Dossier/setFiles endpoint with the images in a dataURL format. You can set all the images at once or one at a time.

Example:

curl --location --request POST 'https://preprod.signicat.com/assure/dossiers/e6137ef5-6470-4e17-897d-9ccde03dc9eb/files' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "front": "data:image/jpeg;base64,/9j/4AAQSkZJR...",
    "back": "data:image/jpeg;base64,/9j/4AAQSkZJR...",
    "selfie": "data:image/jpeg;base64,/9j/4AAQSkZJR..."
}'

# Use files from the dossier in a process

If you request Start Verification on a process that has no images, the Assure API checks if the dossier contains any images and tries to use them to send to the provider in that process. Note: This only works for providers that allow uploading the images directly through the Assure API.

# Copy the files from a process into the dossier

If you have image files inside a process, you can copy them into the dossier: You call the Dossier/setFiles endpoint and give it the ID of the process from which you want to copy the images from.

Example:

curl --location --request POST 'https://preprod.signicat.com/assure/dossiers/e6137ef5-6470-4e17-897d-9ccde03dc9eb/files' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Content-Type: text/plain' \
--data-raw '{
    "processId": "b3f0c899-a0a1-4a69-a0eb-7aa64aaf9bd0"
}'
Last updated: 14/02/2023 08:05 UTC