> ## Documentation Index
> Fetch the complete documentation index at: https://docs.frankieone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Working With Support Docs

> Supporting documents can be added through the API and will be visible in the portal for review and approval/rejection.

<Callout icon="thumbtack" iconType="regular" color="#1A6CFF">
  This guide explains how to add supporting documentation to an Entity for manual verification by your operational team.
</Callout>

## Adding Support Documents

Supporting documents should be added as identity documents in the `identityDocs` array of your Entity object.

<CodeGroup>
  ```json theme={null}
  {
      "entity": {
          "entityProfile": "safe_harbour",
          "entityType": "INDIVIDUAL",
          "name": {
              "familyName": "TESTtwo",
              "givenName": "matthew"
          },
          "dateOfBirth": {
              "dateOfBirth": "1990-01-02"
          },
          "identityDocs": [
              {
                  "country": "AUS",
                  "docScan": [
                      {
                          "scanData": "<BASE64 ENCODED DATA>", // Your base64 encoded document
                          "scanFilename": "Scanned Documents.pdf",
                          "scanMIME": "application/pdf",
                          "scanSide": "F"
                      }
                  ],
                  "extraData": [
                      {
                          "kvpKey": "supporting_docs.label",
                          "kvpValue": "Trust Deed"
                      },
                      {
                          "kvpKey": "supporting_docs.status",
                          "kvpValue": "Needs Review"
                      }
                  ],
                  "idExpiry": "0001-01-01",
                  "idIssued": "0001-01-01",
                  "idType": "HOUSE_REGISTRATION"
              }
          ],
          "extraData": [
              {
                  "kvpKey": "customer_reference",
                  "kvpType": "id.external",
                  "kvpValue": "supportDocTest"
              },
              {
                  "kvpKey": "consent.general",
                  "kvpValue": "true"
              },
              {
                  "kvpKey": "consent.docs",
                  "kvpValue": "true"
              },
              {
                  "kvpKey": "consent.creditheader",
                  "kvpValue": "true"
              }
          ]
      }
  }
  ```
</CodeGroup>

<Callout icon="star" iconType="regular" color="#3DD892">
  To enable support documents in your recipe/entityProfile, contact us at [help@frankieone.com ](mailto:help@frankieone.com)<Icon icon="arrow-up-right-from-square" size={12} />.
</Callout>

## Supported File Types

### API Supported Types

The following file types (MIME types) are supported when uploading through the API:

<AccordionGroup>
  <Accordion title="Images">
    * image/jpeg
    * image/png
    * image/gif
    * image/webp
    * image/tiff
    * image/bmp
    * image/heif
    * image/heic
    * image/avif
  </Accordion>

  <Accordion title="Documents">
    * application/pdf
    * application/rtf
    * application/msword
    * application/vnd.openxmlformats-officedocument.wordprocessingml.document
    * application/vnd.ms-excel
    * application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
    * application/vnd.ms-powerpoint
    * application/vnd.openxmlformats-officedocument.presentationml.presentation
    * text/plain
    * text/rtf
    * application/vnd.oasis.opendocument.text
  </Accordion>

  {" "}

  <Accordion title="Archives">
    * application/zip
    * application/x-tar
    * application/x-rar-compressed
    * application/gzip
    * application/x-bzip2
    * application/x-7z-compressed
    * application/x-zip
    * application/x-zip-compressed
    * application/x-gzip
  </Accordion>

  <Accordion title="Media">
    * audio/mpeg
    * audio/m4a
    * audio/x-wav
    * audio/amr
    * video/mp4
    * video/webm
    * video/quicktime
    * video/x-msvideo
    * video/x-ms-wmv
    * video/mpeg
    * video/avi
    * video/x-m4a
    * video/msvideo
  </Accordion>
</AccordionGroup>

<Callout icon="bell" iconType="regular" color="#FFCA16">
  **Maximum File Size:** Each document attached to an entity can be up to 20MB. Files exceeding this size will be rejected by the system.
</Callout>

### Portal and Smart UI Limitations

The following file types are NOT supported in Portal and Smart UI:

* application/x-rar-compressed
* application/x-bzip2
* audio/m4a
* audio/x-wav
* application/vnd.ms-outlook
* application/zip (Note: x-zip is supported)
* application/gzip (Note: x-gzip is supported)
* application/x-zip-compressed
* video/x-m4a
