The Document Object - frankieone

Guide to the API

KYC API Endpoints

Fraud & AML API Endpoints

IDV API Endpoints

KYB Trust Agent

KYB V2 API - Preview

A document object represents various types of information or documentation, such as:

Identity documents (driver’s licenses, passports)
Contact information (phone numbers, email addresses)
Official documents (utility bills, reports)
Collections of related data

Key Characteristic

Every document object must include a country attribute, which is mandatory for all document types.

Document Object Structure

Here’s an example of a document object with detailed annotations:

{
  // Mandatory field indicating the document's country of origin
  "country": "AUS",

  // Indicates if the document was created from a scanned source
  "createdFromScan": true,

  // Array containing scan-related information
  "docScan": [
    {
      "ScanDelete": true,
      "scanCreated": "2020-06-02",
      // Base64 encoded scan data
      "scanData": "VGhpcyBpcyBzb21lIGV4YW1wbGUgZGF0YS4...",
      "scanDataRetrievalState": "NORMAL",
      "scanDocId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
      "scanFilename": "Important Document - ID1234567.pdf",
      "scanMIME": "image/png",
      "scanPageNum": 1,
      "scanSide": "F",
      "scanType": "PDF"
    }
  ],

  // Unique identifier for the document
  "documentId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
  "documentStatus": "DOC_SCANNED",

  // Additional metadata stored as key-value pairs
  "extraData": [
    {
      "kvpKey": "Extra.Information",
      "kvpType": "general.string",
      "kvpValue": "123-456-789A"
    }
  ],

  // Document-specific dates and identifiers
  "idExpiry": "2020-02-01",
  "idIssued": "1972-11-04",
  "idNumber": "123456789",
  "idSubType": "string",
  "idType": "DRIVERS_LICENCE",
  "manuallyModified": "false",
  "region": "VIC"
}

Managing Scanned Documents in Business Checks

The inclusion of scanned documents in business check results depends on the documentData parameter. Here’s how to control it:

Default Behavior (No Parameter)

Includes the complete scanned document
Use when you need full document access

GET https://api.frankie.one/compliance/v1.2/business/'entityId'/checks

Full Document (documentData=full)

Explicitly requests complete scanned document
Identical to default behavior curl GET https://api.frankie.one/compliance/v1.2/business/‘entityId’/checks?documentData=full

</Accordion>

<Accordion title="Metadata Only (documentData=meta)">
  - Excludes scanned document data
  - Returns only metadata
  - Faster response times
  ```curl
  GET https://api.frankie.one/compliance/v1.2/business/'entityId'/checks?documentData=meta

Performance Consideration

Including full scanned documents increases response times. Use documentData=meta when you only need metadata for faster results.

Implementation Steps

Create Organization Entity

Create an organization entity using the Create Entity API

Upload Document Scan

Upload the document scan using the Create Document API

Verify Ownership

Complete ownership verification using the Business Ownership Query API

Perform Business Check

Execute the business check with your desired documentData parameter

Object IDs The Entity Object

⌘I

Key Characteristic

​Document Object Structure

​Managing Scanned Documents in Business Checks

Performance Consideration

​Implementation Steps

Document Object Structure

Managing Scanned Documents in Business Checks

Implementation Steps