Working With Support Docs

At times you'd need to provide supporting documentation on to an Entity for manual verification by your operational team.

The code snippet below can be used to insert a document into the Entity and it can also be visible in the portal and managed by a user to approve it or decline it if it does not meet the requirements.

The Supporting document should be added in as an identity document in the identityDocs array.

{
    "entity": {
        "entityProfile": "safe_harbour",
        "entityType": "INDIVIDUAL",
        "name": {
            "familyName": "TESTtwo",
            "givenName": "matthew"
        },
        "dateOfBirth": {
            "dateOfBirth": "1990-01-02"
        },
        "identityDocs": [
            {
                "country": "AUS",
                "docScan": [
                    {
                        "scanData": "<BASE64 ENCODED DATA>", #Base 64 Encode your data and put it as a string here
                        "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"
            }
        ]
    }
}

It is also possible to include support docs as part of your recipe / entityProfile to enable this please reach out to the team at [email protected] to enable this.

When using Support Docs, it is important to make sure you only upload valid document mime-types.

Below are the valid types that you can upload through API:

"image/jpeg"
"image/png"
"image/gif"
"image/webp"
"image/tiff"
"image/bmp"
"application/zip"
"application/x-tar"
"application/x-rar-compressed"
"application/gzip"
"application/x-bzip2"
"application/x-7z-compressed"
"application/pdf"
"application/rtf"
"application/postscript"
"application/json"
"audio/mpeg"
"audio/m4a"
"audio/x-wav"
"audio/amr"
"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"
"video/mp4"
"video/webm"
"video/quicktime"
"video/x-msvideo"
"video/x-ms-wmv"
"video/mpeg"
"text/plain"
"image/heif"
"image/heic"
"image/avif" 
"application/vnd.ms-outlook"
"application/x-zip"
"application/x-zip-compressed"
"application/x-gzip"
"text/rtf"
"application/vnd.oasis.opendocument.text"
"video/avi"
"video/x-m4a"
"video/msvideo"

You can also upload the same valid mime-types through Portal and Smart UI, except:

"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"