Add media to an entity


The unit21_id field is being deprecated for this endpoint after September 30, 2023. Requests made using unit21_id in the path will fail. entity_id should be used instead. More information.

Adds rich media objects (images, videos, etc.) to an existing entity.

Placeholder entities cannot be updated.

This endpoint is useful for sending in rich media such as profile pictures, ID card scans, official documents etc. that you want available for investigative and verification purposes.

Supported file types are: txt, pdf, video (mp4, mov, wmv, avi, mkv), images (png, jpg, tiff, gif, raw, eps).

The payload to this endpoint can either be a form-data or a base64 encoded media file via the requests JSON body.

Form-data sent to this endpoint must use the key media_key and the value as the media file. If you wish to provide optional information, use the media_key and provide stringified JSON data as the value. There are no required fields in each media file's supplementary form data. However, if a recognized media_type value is provided, the Unit21 system will be able to use the media object for purposes such as document verification.

  --form 'document_front=@/src/103031/images/document_front.jpg' \
  --form 'document_front={"media_type": "IMAGE_ID_CARD_FRONT", "source": "passport_app", "timestamp": 1572673229}'

Base64 encoded media objects must follow the format:

    "name": "Drivers_License.png",
    "media_type": "IMAGE_DRIVERS_LICENSE_FRONT",
    "custom_data": {
      "internal_notes": "Reviewed by Mitchell on 31 June 2019",
      "reviewers": 3,
      "login": 1638384860,
      "timestamp": "2012-03-40 05:12:41.000Z",
      "daily_email": true,
      "employees": ["John", "Anna", "Peter"],
      "socure_device_session_id": "12121212121212112"

media and name are the only required fields for each media object. The name must include the file extension such a File.pdf. Supplementary form data is sent through the optional custom_data object.

For verification purposes, recognized values of media_type are:

Click Try It! to start a request and see the response here!