Documentation

The Document Object

Suggest Edits

A document object is used to represent a document or a piece of information, such as a driver's license, a phone number, a report, or a collection of related data.

  • A document can be just meta-data. So in the case of a driver's license, this might just be the ID number, country, and state.
  • A document can be a report or utility bill.
  • A document can be used to represent a mobile phone number or email address.
  • It may optionally include scans of the actual document.

📘

Country Attribute

A document always has the country attribute set.


{
        "country": "AUS",
        "createdFromScan": true,
        "docScan": [
          {
            "ScanDelete": true,
            "scanCreated": "2020-06-02",
            "scanData": "VGhpcyBpcyBzb21lIGV4YW1wbGUgZGF0YS4gV29vLCBJIGJldCB5b3UgcmVncmV0IHRoZSB0aW1lIHlvdSB3YXN0ZWQgZGVjb2RpbmcgdGhpcywgaHVoPw==",
            "scanDataRetrievalState": "NORMAL",
            "scanDocId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
            "scanFilename": "Important Document - ID1234567.pdf",
            "scanMIME": "image/png",
            "scanPageNum": 1,
            "scanSide": "F",
            "scanType": "PDF"
          }
        ],
        "documentId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
        "documentStatus": "DOC_SCANNED",
        "extraData": [
          {
            "kvpKey": "Extra.Information",
            "kvpType": "general.string",
            "kvpValue": "123-456-789A"
          }
        ],
        "idExpiry": "2020-02-01",
        "idIssued": "1972-11-04",
        "idNumber": "123456789",
        "idSubType": "string",
        "idType": "DRIVERS_LICENCE",
        "manuallyModified": "false",
        "region": "VIC"
      }

Scanned documents in business check results

The following scenarios determine whether the scanned document is included in the business check results or not.

Setting the documentData parameter correctly allows you to tailor the results based on your needs:

  • No parameter: Includes the scanned document.
  • full: Includes the full scanned document.
  • meta: Excludes the scanned document, includes only metadata.

📘

Retrieval time for business check results

Including full scanned documents or just their metadata in business check results can impact retrieval time: business check results with full scanned documents attached will take longer than results with just their meta-data. Set your documentData parameter accordingly.

Scenario 1: No documentData Parameter

This scenario follows this sequence of actions.

  1. Create an Organisation Entity:

  2. Upload a Document Scan:

  3. Complete Ownership Verification:

  4. Perform the business check without specifying any query parameters. The full scanned document will be included in the results.See sample request below:

Sample API request

GET https://api.latest.frankiefinancial.io/compliance/v1.2/business/'entityId'/checks

The check result will contain the full scanned document.

Sample Snippet of API response

...
"identityDocsCheck": [
                       {
                         "idDocument": {
                             "country": "AUS",
                               "docScan": [
                                    {
                                    "scanCreated": "2024-07-22T01:12:57.064Z","scanData": "JVBERi0xLjMKMyAwIG9iago8PC9UeXBlIC9QYWdlCi9QYXJlbnQgMSAwIFIKL1Jlc291cmNlcyAyIDAgUgovQ29udGVudHM
					gNCAwIFI+PgplbmRvYmoKNCAwIG9iago8PC9GaWx0ZXIgL0ZsYXRlRGVjb2RlIC9MZW5ndGggNzQxNzA+PgpzdHJlYW0KeAEEwLnCqKaCAOA
					+T3HKqTJ/cm+SSam4K6Lg3rmhqLgBbk8/388v77efX9NvP7//9c+v+7ef339+fn7Zv/38/vPz82v4TU9+/a9F/+r+7Pq/6H/qf/74+99/6/6
					/zZ/d//3nj3/+7f/+s/v5t/+btv/948+/f/3x9+8/P78S+stMftOTX//54/c//v31z7///f2vf34l3a//kQfE80KyItyf8gadbXWMT266vW1
					ZYDLkfHOuvLdoQ+RVXrGThOLky1MVSqGgHQPlNLY7g9n2tqA688VGeaoubH+heSBX+H1nLs0iDWydXfNYy7iKxonMpigj/4hL4wIXSYSUOc6
					2E7AjjkXjXVajSjs/jVhL8KsLVhfle4wFqPtplbEPzPpOLrnWh5zGiQ40I6eX98pkOoGjCsvZzr1Jn6ItnGTr0Mx0bQu7JVeg7uU0uomDjv5
					UT+R/+qMW/a3hI0bb25Zw5cToy8IOYX8jV7LV+opUv/i0cBHWyrbT1A/mqTmzNWzAg0L6wIc6hhWpw4rT5UlQydYQBXNeqeE6rbt2vXFzpoa
					IdcmBmu937egy+5SeqcPk5Xu9/yx6kEanbYxxQI5ivSs0RC7ZrJvPWEdTDUledG4/F56A0R7JTaWHW+iOw2AwaeZguCbItTfOPZvxFRTPdMh
					MOTjdj7PEHa8s8DkQtaOzm+c6PAMYRj4ZQTPp0/nkAt8p1MPI3Ms+WM3o405fONdjcQobJ14z1h1X1uTXUBieXFDRbGKhbrR4psJNCkmCvvs
					diGrGIn6mjt9nM7ihl1f+pAf4fkkdWCdtLe+xtX1HmD7t4s5XZDzST/I3D8p2jx6194FIWNhwgHJQx3iqDhguF0E6p7To50Ycl7vO/p7dLqn
					7OG7bqkh0qHpn527keE8BCkNw69TySg/LpF+q/SNVFoXzghkxokGcznKv79zCs3aDKt0hEfxVQymCx4vSt7fMBhb5Y4jiq2RvN4nAaRuRrcj
					UlNjP1Kd0AU64hbZ5RHtUnf6UmaNjD4Ktp7xAdxs32OoW1dKn9hOLky6ddqtHFA5ieVbsdwi0dHf6eoxLu7GcZjT56BVVH+tf6JTsGDpPdTG
					wvOkUOAwWibTk1u3kMObiungt4cj6C4bHLTffXkods+p9fBUWnSpz6ntrzoN+utuGAyPcXssQ6VTtQWwb5v6a1zEPqrASzs+DidAs7JMtw72
					vujCeRC/xlUY+s64bJ1NAgFM8Tdhhbmre+U17n3f3V5Lm2AP9jXiCEnh//TngtU9XrDXnEfdleOoxS2oLgC6cp3rInE92YwA7+My9/mSUfQh
					1JS/9sJRGXi4vSJqnoumjv10e9JXgVmcpDI38aexHPYdr1zMf1m8Ur2bvfrros+A0y/Vz8MY4zy7Ke1S/16wSbtnghs4d75ytNx0W/CoK3ns
					qqkmEilymaXvD497uJVRec2LzKjEPo3DfIa7CD2+ZOwQt7d9Tw1pURUYyealcD10p45FJqMhgr94+I45xkTjrFcflKagzbaF570MbRTQRKib
					t57sy5TU63RRbX4+5MVIrM3arTE9VVDsKwqWR62Y/trlpTEY8jUSYpdu8pb42H+iLg3iy+oBBelWSEvQc+X06Qy9B4vavkFp5dv216ZVaNhe
					xN0YziVk9HBfwmIu+R+W3Hn19r0Mxpt/+6CLRsshQSnxzdtigb/3UYXZgUjESnvLa38vurJLNqVxyroVXQU4c3VEw9256udR9ZCkazDEu3Po
...

Scenario 2: documentData Parameter = full

This scenario follows this sequence of actions.

  1. Create an Organisation Entity:

  2. Upload a Document Scan:

  3. Complete Ownership Verification:

  4. Perform the business check specifying documentData=full. The full scanned document will be included in the results.See sample request below:


Sample API request

GET https://api.latest.frankiefinancial.io/compliance/v1.2/business/'entityId'/checks?documentData=full

Sample Snippet of API response

...
"identityDocsCheck": [
                       {
                         "idDocument": {
                             "country": "AUS",
                               "docScan": [
                                    {
                                    "scanCreated": "2024-07-22T01:12:57.064Z","scanData": "JVBERi0xLjMKMyAwIG9iago8PC9UeXBlIC9QYWdlCi9QYXJlbnQgMSAwIFIKL1Jlc291cmNlcyAyIDAgUgovQ29udGVudHM
					gNCAwIFI+PgplbmRvYmoKNCAwIG9iago8PC9GaWx0ZXIgL0ZsYXRlRGVjb2RlIC9MZW5ndGggNzQxNzA+PgpzdHJlYW0KeAEEwLnCqKaCAOA
					+T3HKqTJ/cm+SSam4K6Lg3rmhqLgBbk8/388v77efX9NvP7//9c+v+7ef339+fn7Zv/38/vPz82v4TU9+/a9F/+r+7Pq/6H/qf/74+99/6/6
					/zZ/d//3nj3/+7f/+s/v5t/+btv/948+/f/3x9+8/P78S+stMftOTX//54/c//v31z7///f2vf34l3a//kQfE80KyItyf8gadbXWMT266vW1
					ZYDLkfHOuvLdoQ+RVXrGThOLky1MVSqGgHQPlNLY7g9n2tqA688VGeaoubH+heSBX+H1nLs0iDWydXfNYy7iKxonMpigj/4hL4wIXSYSUOc6
					2E7AjjkXjXVajSjs/jVhL8KsLVhfle4wFqPtplbEPzPpOLrnWh5zGiQ40I6eX98pkOoGjCsvZzr1Jn6ItnGTr0Mx0bQu7JVeg7uU0uomDjv5
					UT+R/+qMW/a3hI0bb25Zw5cToy8IOYX8jV7LV+opUv/i0cBHWyrbT1A/mqTmzNWzAg0L6wIc6hhWpw4rT5UlQydYQBXNeqeE6rbt2vXFzpoa
					IdcmBmu937egy+5SeqcPk5Xu9/yx6kEanbYxxQI5ivSs0RC7ZrJvPWEdTDUledG4/F56A0R7JTaWHW+iOw2AwaeZguCbItTfOPZvxFRTPdMh
					MOTjdj7PEHa8s8DkQtaOzm+c6PAMYRj4ZQTPp0/nkAt8p1MPI3Ms+WM3o405fONdjcQobJ14z1h1X1uTXUBieXFDRbGKhbrR4psJNCkmCvvs
					diGrGIn6mjt9nM7ihl1f+pAf4fkkdWCdtLe+xtX1HmD7t4s5XZDzST/I3D8p2jx6194FIWNhwgHJQx3iqDhguF0E6p7To50Ycl7vO/p7dLqn
					7OG7bqkh0qHpn527keE8BCkNw69TySg/LpF+q/SNVFoXzghkxokGcznKv79zCs3aDKt0hEfxVQymCx4vSt7fMBhb5Y4jiq2RvN4nAaRuRrcj
					UlNjP1Kd0AU64hbZ5RHtUnf6UmaNjD4Ktp7xAdxs32OoW1dKn9hOLky6ddqtHFA5ieVbsdwi0dHf6eoxLu7GcZjT56BVVH+tf6JTsGDpPdTG
					wvOkUOAwWibTk1u3kMObiungt4cj6C4bHLTffXkods+p9fBUWnSpz6ntrzoN+utuGAyPcXssQ6VTtQWwb5v6a1zEPqrASzs+DidAs7JMtw72
					vujCeRC/xlUY+s64bJ1NAgFM8Tdhhbmre+U17n3f3V5Lm2AP9jXiCEnh//TngtU9XrDXnEfdleOoxS2oLgC6cp3rInE92YwA7+My9/mSUfQh
					1JS/9sJRGXi4vSJqnoumjv10e9JXgVmcpDI38aexHPYdr1zMf1m8Ur2bvfrros+A0y/Vz8MY4zy7Ke1S/16wSbtnghs4d75ytNx0W/CoK3ns
					qqkmEilymaXvD497uJVRec2LzKjEPo3DfIa7CD2+ZOwQt7d9Tw1pURUYyealcD10p45FJqMhgr94+I45xkTjrFcflKagzbaF570MbRTQRKib
					t57sy5TU63RRbX4+5MVIrM3arTE9VVDsKwqWR62Y/trlpTEY8jUSYpdu8pb42H+iLg3iy+oBBelWSEvQc+X06Qy9B4vavkFp5dv216ZVaNhe
					xN0YziVk9HBfwmIu+R+W3Hn19r0Mxpt/+6CLRsshQSnxzdtigb/3UYXZgUjESnvLa38vurJLNqVxyroVXQU4c3VEw9256udR9ZCkazDEu3Po
...

Scenario 3: documentData Parameter = meta

This scenario follows this sequence of actions.

  1. Create an Organisation Entity:

  2. Upload a Document Scan:

  3. Complete Ownership Verification:

  4. Perform the business check with the documentData parameter set to meta to receive the result with the metadata only, not including the scanned document.

Sample API request

GET https://api.latest.frankiefinancial.io/compliance/v1.2/business/'entityId'/checks?documentData=meta

Sample snippet of API response

...
          "identityDocs": [
            {
              "country": "AUS",
              "docScan": [
                {
                  "scanCreated": "2024-07-22T01:13:08.870Z",
                  "scanDataRetrievalState": "EXCLUDED",
                  "scanDocId": "0b67b920-be98-ec15-26c6-88f375621fa4",
                  "scanMIME": "application/pdf",
                  "scanType": "PDF"
                }
              ],
              "documentId": "8d347ce0-5870-9d03-2b82-6d3eadf0f365",
              "idExpiry": "0001-01-01",
              "idIssued": "0001-01-01",
              "idType": "OTHER"
            }
          ],
...

Updated 5 months ago