Skip to main content
This guide explains how to add supporting documentation to an Entity for manual verification by your operational team.

Adding Support Documents

Supporting documents should be added as identity documents in the identityDocs array of your Entity object.
{
    "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"
            }
        ]
    }
}
To enable support documents in your recipe/entityProfile, contact us at help@frankieone.com .

Supported File Types

API Supported Types

The following file types (MIME types) are supported when uploading through the API:
  • image/jpeg
  • image/png
  • image/gif
  • image/webp
  • image/tiff
  • image/bmp
  • image/heif
  • image/heic
  • image/avif
  • 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
  • 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
  • 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
Maximum File Size: Each document attached to an entity can be up to 20MB. Files exceeding this size will be rejected by the system.

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