Working With Support Docs

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

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.

Example Support Document Request
1{
2    "entity": {
3        "entityProfile": "safe_harbour",
4        "entityType": "INDIVIDUAL",
5        "name": {
6            "familyName": "TESTtwo",
7            "givenName": "matthew"
8        },
9        "dateOfBirth": {
10            "dateOfBirth": "1990-01-02"
11        },
12        "identityDocs": [
13            {
14                "country": "AUS",
15                "docScan": [
16                    {
17                        "scanData": "<BASE64 ENCODED DATA>", // Your base64 encoded document
18                        "scanFilename": "Scanned Documents.pdf",
19                        "scanMIME": "application/pdf",
20                        "scanSide": "F"
21                    }
22                ],
23                "extraData": [
24                    {
25                        "kvpKey": "supporting_docs.label",
26                        "kvpValue": "Trust Deed"
27                    },
28                    {
29                        "kvpKey": "supporting_docs.status",
30                        "kvpValue": "Needs Review"
31                    }
32                ],
33                "idExpiry": "0001-01-01",
34                "idIssued": "0001-01-01",
35                "idType": "HOUSE_REGISTRATION"
36            }
37        ],
38        "extraData": [
39            {
40                "kvpKey": "customer_reference",
41                "kvpType": "id.external",
42                "kvpValue": "supportDocTest"
43            },
44            {
45                "kvpKey": "consent.general",
46                "kvpValue": "true"
47            },
48            {
49                "kvpKey": "consent.docs",
50                "kvpValue": "true"
51            },
52            {
53                "kvpKey": "consent.creditheader",
54                "kvpValue": "true"
55            }
56        ]
57    }
58}

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:

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
Built with