@frankieone/one-sdk 0.3.2-rc.0 → 0.3.2-rc.2

package/dist/cjs/modules/common/shared/models/Admin.d.ts

@@ -0,0 +1,1295 @@
+/**
+ * This file was auto-generated by swagger-to-ts.
+ * Do not make direct changes to the file.
+ */
+export declare interface Admin {
+    /**
+     * Valid ID types
+     *   - "OTHER": Generic document type. Unspecified.
+     *   - "DRIVERS_LICENCE": Driver's licence.
+     *   - "PASSPORT": Passport
+     *   - "VISA": Visa document (not Visa payment card)
+     *   - "IMMIGRATION": Immigration card
+     *   - "NATIONAL_ID": Any national ID card
+     *   - "TAX_ID": Any national tax identifier
+     *   - "NATIONAL_HEALTH_ID": Any national health program ID card (e.g. Medicare, NHS)
+     *   - "CONCESSION": State issued concession card
+     *   - "HEALTH_CONCESSION": State issued health specific concession card
+     *   - "PENSION": State issued pension ID
+     *   - "MILITARY_ID": Military ID
+     *   - "BIRTH_CERT": Birth certificate
+     *   - "CITIZENSHIP": Citizenship certificate
+     *   - "MARRIAGE_CERT": Marriage certificate
+     *   - "DEATH_CERT": Death certificate
+     *   - "NAME_CHANGE": Name chage confirmation
+     *   - "UTILITY_BILL": Regulated utility bill, such as electricity, gas, etc
+     *   - "BANK_STATEMENT": Bank/card statement
+     *   - "INTENT_PROOF": A proof of intent. Generally a photo/video, or a scanned letter
+     *   - "ATTESTATION": A document of attestation (e.g. Statutory Declaration)
+     *   - "SELF_IMAGE": A "selfie" used for comparisions
+     *   - "EMAIL_ADDRESS": An email address
+     *   - "MSISDN": A mobile phone number
+     *   - "DEVICE": A device ID
+     *   - "VEHICLE_REGISTRATION": Vehicle registration number
+     * Business related documentation
+     *   - "EXTERNAL_ADMIN": Details of appointed administrator.
+     *   - "CHARGES":
+     *   - "PRE_ASIC":
+     *   - "ANNUAL_RETURN":
+     *   - "REPORT":
+     */
+    enumIdType: "OTHER" | "DRIVERS_LICENCE" | "PASSPORT" | "VISA" | "IMMIGRATION" | "NATIONAL_ID" | "TAX_ID" | "NATIONAL_HEALTH_ID" | "CONCESSION" | "HEALTH_CONCESSION" | "PENSION" | "MILITARY_ID" | "BIRTH_CERT" | "CITIZENSHIP" | "MARRIAGE_CERT" | "DEATH_CERT" | "NAME_CHANGE" | "MOBILE_PHONE" | "UTILITY_BILL" | "BANK_STATEMENT" | "INTENT_PROOF" | "ATTESTATION" | "SELF_IMAGE" | "EMAIL_ADDRESS" | "MSISDN" | "DEVICE" | "VEHICLE_REGISTRATION" | "EXTERNAL_ADMIN" | "CHARGES" | "PRE_ASIC" | "ANNUAL_RETURN" | "REPORT";
+    /**
+     * Used to describe the contents of the KVP data.
+     *
+     * The general.* and raw.* types are pretty much what they say on the tin.
+     *
+     * All raw.* fields will be base64 encoded so as to not interfere with JSON structuring. These are useful for returning/storing large quantities of data that doesn't necessarily require processing now, or may be useful to a calling client.
+     *
+     * The id.* and pii.* are used to indicate that this is data that can be used to create new document objects, or entities. They should also be treated with the utmost care and attention when it comes to securing them too.
+     *
+     * id.external can be used to capture an object's ID on an external service, and can potentially be searchable in the index
+     * Note - This is different from a result.id.
+     *
+     * defunct is used to mark an existing KVP deleted when the value must be retained, for example for audit purposes.
+     *
+     * result.* are used to capture response codes and transaction IDs from external services
+     *
+     * error.* types can be used when processing a document that returns an error, but doesn't necessarily require a full blown error response.
+     */
+    enumKVPType: "defunct" | "general.string" | "general.integer" | "general.float" | "general.bool" | "general.date" | "general.datetime" | "raw.json.base64" | "raw.xml.base64" | "raw.base64" | "error.code" | "error.message" | "result.code" | "result.id" | "id.external" | "id.number.primary" | "id.number.additional" | "id.msisdn" | "id.email" | "id.device" | "pii.name.full" | "pii.name.familyname" | "pii.name.givenname" | "pii.name.middlename" | "pii.gender" | "pii.address.longform" | "pii.address.street1" | "pii.address.street2" | "pii.address.postalcode" | "pii.address.town" | "pii.address.suburb" | "pii.address.region" | "pii.address.state" | "pii.address.country" | "pii.dob";
+    /**
+     * Valid ID document scan general types.
+     * - "PHOTO": Any photo
+     * - "VIDEO": Any video
+     * - "AUDIO": Any audio
+     * - "PDF":   PDF or PS (may contain text, images or both)
+     * - "DOC":   Word doc, RTF, etc
+     * - "ZIP":   Any compressed file(s)
+     */
+    enumScanType: "PHOTO" | "VIDEO" | "AUDIO" | "PDF" | "DOC" | "ZIP";
+    /**
+     * Describes if a scan is of the "F"ront or "B"ack of an ID. If not supplied, Front is always assumed.
+     */
+    enumScanSide: "F" | "B";
+    /**
+     * Used to indicate of the entity in question is:
+     * - "M"ale
+     * - "F"emale
+     * - "U"nspecified
+     * - "O"ther (for want of a better option)
+     */
+    enumGender: "U" | "F" | "M" | "O";
+    /**
+     * The standard MIME type of the file being uploaded. We'll double-check to be certain, but this can help speed things up
+     */
+    enumMIMEType: "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";
+    /**
+     * The reason why the scanData in a response is missing.
+     * - "NORMAL": The scanData was retrieved and is included. If it is empty then it was never provided or was provided empty.
+     * - "EXCLUDED": The retrieval request was not for 'full' data, or the object has 'ScanDelete' set so the scanData is not included
+     * - "FAILED": The scanData could not be retrieved from the secure document store.
+     *
+     * The enumScanDataRetrievalState will not usually be set in a request. If a ScannedDocumentObject in a response has a 'FAILED' retrieval state then that object should not be sent back in a future possible update. It should either be omitted or the original data should be resent if it is available from another source. However it is safe to send the object in an update with the state received in a response. Any state other than 'NORMAL' (or '') will cause the blank scanData to be ignored, but other fields in the object will be updated if needed.
+     */
+    enumScanDataRetrievalState: "NORMAL" | "EXCLUDED" | "FAILED";
+    /**
+     * Used to indicate what sort address this is, such as residential, business, postal, etc.
+     *
+     * RESIDENTIAL1-4 can be used to indicate the reverse chronological order of addresses.
+     * RESIDENTIAL or RESIDENTIAL1 is the current address
+     * RESIDENTIAL2 is the previous address, and so on.
+     */
+    enumAddressType: "OTHER" | "RESIDENTIAL" | "RESIDENTIAL1" | "RESIDENTIAL2" | "RESIDENTIAL3" | "RESIDENTIAL4" | "BUSINESS" | "POSTAL" | "REGISTERED_OFFICE" | "PLACE_OF_BUSINESS" | "OFFICIAL_CORRESPONDANCE";
+    /**
+     * Current status of a document.
+     * - "INITIALISING": the state whilst you're uploading and updating
+     * - "SCAN_IN_PROGRESS": the state whilst it's being scanned.
+     * - "DOC_SCANNED": the document has been scanned and data extracted as best as possible. It's still possible to update the details and add more scans if you wish.
+     * - "DOC_CHECKED": the document has been used as part of a check that has been finalised in some way. You can no longer update this document and any attempt will generate an error.
+     */
+    enumDocumentStatus: "INITIALISING" | "SCAN_IN_PROGRESS" | "DOC_SCANNED" | "DOC_CHECKED";
+    /**
+     * Check state for an individual data point
+     * - "UNCHECKED": Check has not yet been performed
+     * - "NOT_SUPPORTED": the requested check type or industry function is not supported by this connector.
+     * - "CHECKING": Checks are underway.
+     * - "UNPROCESSABLE": The data supplied was unprocessable.
+     * - "NO_MATCH": All checks complete, no records found that matched the details supplied
+     * - "CHECKED_PARTIAL_SUCCESS": All checks complete, but only some succeeded.
+     * - "CHECKED_SUCCESS_WITH_NOTES": All checks complete, but there are some notes (e.g. PEP or sanctions).
+     * - "CHECKED_SUCCESS_CLEAR": All checks complete, no additional notes
+     * - "CHECKED_FAILED": All checks complete, but all failed.
+     */
+    enumCheckResultState: "UNCHECKED" | "CHECKING" | "UNPROCESSABLE" | "NOT_SUPPORTED" | "NO_MATCH" | "CHECKED_PARTIAL_SUCCESS" | "CHECKED_SUCCESS_WITH_NOTES" | "CHECKED_SUCCESS_CLEAR" | "CHECKED_FAILED";
+    /**
+     * Different types of checks available.
+     * Note: WATCHLIST can also cover PEP and/or SANCTION as well, depending on source provider used. GROUP is an internal 'meta-check' to store the group details for an AMLResultSet.
+     */
+    enumBackgroundCheckType: "PEP" | "SANCTION" | "WATCHLIST" | "MEDIA" | "GROUP";
+    /**
+     * Current state, based on the most recent check.
+     * - "CLEAR": The no checks have ever turned up results
+     * - "PAST_HITS": Past checks have returned hits, but now they're clear.
+     * - "POSSIBLE_HIT": The most recent checks turned up some results that may be relevant
+     * - "ACTIVE_HITS": The current checks are returning definitive hits.
+     */
+    enumBackgroundCheckState: "CLEAR" | "PAST_HITS" | "POSSIBLE_HIT" | "ACTIVE_HITS";
+    /**
+     * How often these checks run.
+     */
+    enumBackgroundCheckFrequency: "ADHOC" | "YEARLY" | "QUARTERLY" | "MONTHY" | "WEEKLY" | "DAILY";
+    /**
+     * channel the transaction was initiated on
+     */
+    enumChannel: "api" | "batch" | "push" | "portal";
+    /**
+     * transaction disposition based on risk, confidence and final check status
+     */
+    enumTransactionStatusKYC: "PASS" | "REFER" | "FAIL" | "PASS_MANUAL" | "WAIT" | "FAIL_MANUAL" | "BLOCK" | "UNCHECKED" | "ARCHIVED" | "INACTIVE";
+    /**
+     * Indicates the type of an entity.
+     * - "INDIVIDUAL": An individual.
+     * - "TRUST": A trust.
+     * - "ORGANISATION": An organisation.
+     */
+    enumEntityType: "INDIVIDUAL" | "TRUST" | "ORGANISATION";
+    /**
+     * All valid customers get a puppy. Otherwise, no puppy for you!
+     */
+    PuppyObject: {
+        puppy: boolean;
+    };
+    /**
+     * Individual key-value pair
+     */
+    KeyValuePairObject: {
+        /**
+         * Name of the data
+         */
+        kvpKey?: string;
+        /**
+         * Value of the data
+         */
+        kvpValue?: string;
+        kvpType?: Admin["enumKVPType"];
+    };
+    /**
+     * Unique identifier for every request. Can be used for tracking down answers with technical support.
+     *
+     * Uses the ULID format (a time-based, sortable UUID)
+     *
+     * Note: this will be different for every request.
+     */
+    RequestIDObject: string;
+    /**
+     * Unique identifier for every check/comparison/verification. Make sure you reference this ID whenever updating check details. This ID will also be used when pushing check results back to you.
+     */
+    CheckIDObject: string;
+    ErrorObject: {
+        requestId: Admin["RequestIDObject"];
+        /**
+         * Deprecated:
+         * HTTP status code. Same as what is passed back in the header.
+         */
+        httpStatusCode?: number;
+        /**
+         * Frankie error code
+         */
+        errorCode: string;
+        /**
+         * Will describe the error
+         */
+        errorMsg: string;
+        issues?: {
+            /**
+             * Will describe the field or data location of the issue
+             */
+            issueLocation: string;
+            /**
+             * Description of the problem
+             */
+            issue?: string;
+        }[];
+    };
+    /**
+     * Wraps up a PRO with its internal ID.
+     */
+    ProcessResultObjectContainer: {
+        /**
+         * Internal ID of this PRO. Use this if you need to set the status.
+         */
+        id?: string;
+        pro?: Admin["ProcessResultObject"];
+    };
+    /**
+     * Collection of fraud check results for the entity.
+     *
+     * Contains fraud list and/or background result arrays. Other fraud check types will appear over time
+     */
+    FraudCheckResultObject: {
+        fraudListResults?: Admin["ProcessResultObject"][];
+        fraudBackgroundCheckResults?: Admin["ProcessResultObject"][];
+    };
+    /**
+     * Stores the generic results of a process (check, scan, compare, verify, etc)
+     */
+    ProcessResultObject: {
+        checkId?: Admin["CheckIDObject"];
+        /**
+         * Short indication of the type of check that was done.
+         *
+         * When used as a summary, it will the the checkType that was requested
+         *
+         * For granular results, it will be the individual check performed.
+         */
+        checkType?: string;
+        resultState?: Admin["enumCheckResultState"];
+        /**
+         * Any additional notes that may relate to the state. These are returned as typed KVPs
+         */
+        resultNotes?: Admin["KeyValuePairObject"][];
+        /**
+         * The date and time the item was checked to provide this result.
+         */
+        checkDate?: string;
+        /**
+         * Confidence in the result on a scale of 0 (no match) to 100 (strong/identical match). Whole integers only.
+         *
+         * Negative values are used to indicate untrusted results.
+         */
+        confidenceLevel?: number;
+        /**
+         * Only supplied in a summary result. Used to indicate the ovall risk score for the entity at this point in time, based on:
+         *
+         *   * Current level of ID checks passed
+         *   * Device ID scores
+         *   * Current PEP/Sanctions/etc checks
+         *
+         * In this case a higher score is a bad thing. General rule of thumb:
+         *
+         *   * 0 - 40 = Low Risk
+         *   * 41 - 70 = Medium Risk
+         *   * 70 - 90 = High Risk
+         *   * 91+ = Super risky
+         *
+         * This does *NOT* factor in product offering
+         */
+        riskLevel?: number;
+        /**
+         * Service provider that performed the check. Basically the name of the connector, without the leading con_
+         */
+        checkPerformedBy?: string;
+        /**
+         * Code that can be used to determine the underlying nature or data source of the checks performed. This may or may not be known by the connector, or may be a provider specific type (e.g. type "O")
+         */
+        checkSource?: string;
+        /**
+         * The service provider will give us a receipt, transaction id, check number, or some such that gives us a unique id on their side that we can reconcile with
+         */
+        providerCheckID?: string;
+    };
+    /**
+     * Wraps up a BCRO with its internal ID.
+     */
+    backgroundCheckResultObjectContainer: {
+        /**
+         * Internal ID of this BCRO. Use this if you need to set the status.
+         */
+        id?: string;
+        bcro?: Admin["backgroundCheckResultObject"];
+    };
+    /**
+     * Contains the details of a background check for a given entity. Background checks include Politically Exposed Person (PEP), sanctions lists, watchlists and adverse media.
+     */
+    backgroundCheckResultObject: {
+        checkId?: Admin["CheckIDObject"];
+        backgroundCheckType?: Admin["enumBackgroundCheckType"];
+        currentState?: Admin["enumBackgroundCheckState"];
+        /**
+         * The date and time the item was first checked.
+         */
+        firstCheckDate?: string;
+        /**
+         * The date and time the item was last checked to provide this result.
+         */
+        latestCheckDate?: string;
+        checkFrequency?: Admin["enumBackgroundCheckFrequency"];
+        /**
+         * Confidence in the current results on a scale of 0 (none) to 100 (as certain as possible). Whole integers only.
+         */
+        confidenceLevel?: number;
+        /**
+         * Service provider that performed the check. Basically the name of the connector, without the leading con_
+         */
+        checkPerformedBy?: string;
+        /**
+         * Code that can be used to determine the underlying nature or data source of the checks performed. This may or may not be known by the connector, or may be a provider specific type (e.g. type "O")
+         */
+        checkSource?: string;
+        /**
+         * Any additional notes that may relate to the state. Free form notes that may contain JSON blobs needing further interpretation.
+         */
+        checkDetails?: Admin["KeyValuePairObject"][];
+    };
+    /**
+     * Object to contain all the details needed for an audit trail record.
+     */
+    AuditRecordObject: {
+        requestID?: Admin["RequestIDObject"];
+        /**
+         * email address of the user performing this function.
+         */
+        username?: string;
+        /**
+         * short description of the function being performed.
+         */
+        functionName?: string;
+        /**
+         * Unique document identifier.
+         */
+        documentId?: string;
+        /**
+         * Unique entity identifier.
+         */
+        entityId?: string;
+        /**
+         * Unique identifier for every check/comparison/verification.
+         */
+        checkId?: string;
+        channel?: Admin["enumChannel"];
+        /**
+         * Set of key-value pairs that provide additional data.
+         *
+         * Although the KVP types support PII types, PLEASE DO NO PUT PII/SENSITIVE DATA IN HERE.
+         */
+        extraData?: Admin["KeyValuePairObject"][];
+    };
+    /**
+     * Acknowledges acceptance of an audit trail record
+     */
+    AcceptedAuditRecordObject: {
+        requestId?: Admin["RequestIDObject"];
+    };
+    /**
+     * Plain response with just a request ID.
+     */
+    GenericResponseObject: {
+        requestId?: Admin["RequestIDObject"];
+    };
+    /**
+     * Line item details of transaction record for display in the portal
+     */
+    TransactionRecord: {
+        /**
+         * The date and time the transaction occurred.
+         */
+        timestamp?: string;
+        requestId?: Admin["RequestIDObject"];
+        parentRequestId?: Admin["RequestIDObject"];
+        /**
+         * Unique document identifier.
+         */
+        documentId?: string;
+        /**
+         * Unique entity identifier.
+         */
+        entityId?: string;
+        /**
+         * Unique identifier for every check/comparison/verification.
+         */
+        checkId?: string;
+        channel?: Admin["enumChannel"];
+        /**
+         * Name of the function that created this transaction.
+         */
+        functionName?: string;
+        /**
+         * Name of the document/entity associated with this transaction.
+         */
+        entityName?: string;
+        /**
+         * Portal user responsible for this entity.
+         */
+        assignee?: string;
+        /**
+         * Portal user responsible for this check.
+         */
+        username?: string;
+        /**
+         * Only supplied in a summary result. Used to indicate the ovall risk score for the entity at this point in time, based on:
+         */
+        riskLevel?: number;
+        /**
+         * Confidence in the result on a scale of 0 (no match) to 100 (strong/identical match). Whole integers only.
+         */
+        confidenceLevel?: number;
+        transactionStatus?: Admin["enumTransactionStatusKYC"];
+        /**
+         * Comma-separated list of alerts associated with this monitoring alert.
+         *
+         * List of possible alerts supported:
+         *
+         * * PEP
+         * * SANCTION
+         * * WATCHLIST
+         * * MEDIA
+         * * DEATH
+         * * CRIME
+         * * BLACKLIST
+         * * IDTHEFT
+         */
+        alertList?: string;
+        /**
+         * Set of key-value pairs that provide additional data.
+         */
+        extraData?: Admin["KeyValuePairObject"][];
+    };
+    TransactionBlocklistRecord: {
+        /**
+         * The date and time the transaction occurred.
+         */
+        entityData?: Admin['EntityObject'];
+        timestamp?: string;
+        requestId?: Admin["RequestIDObject"];
+        parentRequestId?: Admin["RequestIDObject"];
+        /**
+         * Unique document identifier.
+         */
+        documentId?: string;
+        /**
+         * Unique entity identifier.
+         */
+        entityId?: string;
+        /**
+         * Unique identifier for every check/comparison/verification.
+         */
+        checkId?: string;
+        channel?: Admin["enumChannel"];
+        /**
+         * Name of the function that created this transaction.
+         */
+        functionName?: string;
+        /**
+         * Name of the document/entity associated with this transaction.
+         */
+        entityName?: string;
+        /**
+         * Portal user responsible for this entity.
+         */
+        assignee?: string;
+        /**
+         * Portal user responsible for this check.
+         */
+        username?: string;
+        /**
+         * Only supplied in a summary result. Used to indicate the ovall risk score for the entity at this point in time, based on:
+         */
+        riskLevel?: number;
+        /**
+         * Confidence in the result on a scale of 0 (no match) to 100 (strong/identical match). Whole integers only.
+         */
+        confidenceLevel?: number;
+        transactionStatus?: Admin["enumTransactionStatusKYC"];
+        /**
+         * Comma-separated list of alerts associated with this monitoring alert.
+         *
+         * List of possible alerts supported:
+         *
+         * * PEP
+         * * SANCTION
+         * * WATCHLIST
+         * * MEDIA
+         * * DEATH
+         * * CRIME
+         * * BLACKLIST
+         * * IDTHEFT
+         */
+        alertList?: string;
+        /**
+         * Set of key-value pairs that provide additional data.
+         */
+        extraData?: Admin["KeyValuePairObject"][];
+    };
+    /**
+     * contains the search parameters and result summary.
+     */
+    RecordsBlocklistList: {
+        'requestId'?: Admin['RequestIDObject'];
+        /**
+        * The start date (defaults to 30 days ago) (input parameter)
+        */
+        'startDate': Date;
+        /**
+        * The end date (defaults to today) (input parameter)
+        */
+        'endDate': Date;
+        /**
+        * Flag to pass to the list call to continue retrieving data from this point on.  If this is empty, then there is no more data to retrieve.
+        */
+        'nextPageMarker'?: string;
+        /**
+        * Ordered list of KYC/Onboarding transactions.
+        */
+        'records'?: Array<Admin['TransactionRecord'] & Admin['EntityObject']>;
+    };
+    RecordsOnboardingList: {
+        /**
+         * The start date (defaults to 30 days ago) (input parameter)
+         */
+        startDate: string;
+        /**
+         * The end date (defaults to today) (input parameter)
+         */
+        endDate: string;
+        /**
+         * Flag to pass to the list call to continue retrieving data from this point on.
+         *
+         * If this is empty, then there is no more data to retrieve.
+         */
+        nextPageMarker?: string;
+        /**
+         * Ordered list of KYC/Onboarding transactions.
+         */
+        records?: Admin["TransactionRecord"][];
+    };
+    /**
+     * contains the search parameters and result summary.
+     */
+    RecordsMonitoringList: {
+        /**
+         * The start date (defaults to 30 days ago) (input parameter)
+         */
+        startDate: string;
+        /**
+         * The end date (defaults to today) (input parameter)
+         */
+        endDate: string;
+        /**
+         * Flag to pass to the list call to continue retrieving data from this point on.
+         *
+         * If this is empty, then there is no more data to retrieve.
+         */
+        nextPageMarker?: string;
+        /**
+         * The total number of records available in the date range
+         */
+        totalRecords: number;
+        /**
+         * Ordered list of Monitoring/Alert transactions.
+         */
+        records?: Admin["TransactionRecord"][];
+    };
+    /**
+     * the document to be attached and optionally scanned (if supported)
+     */
+    ScannedDocumentObject: {
+        /**
+         * When an document scan is created/uploaded, it is assigned a scanDocId. You'll see this in a successful response or successfully accepted response. This can then be referenced in subsequent calls if you're uploading more/updated data.
+         */
+        scanDocId?: string;
+        scanType?: Admin["enumScanType"];
+        scanSide?: Admin["enumScanSide"];
+        /**
+         * If you're uploading a file where it's important to keep the original filename, then you can provide that here. Otherwise the Frankie service will assign an arbitrary name and an extension based on the MIME type
+         */
+        scanFilename?: string;
+        /**
+         * If uploading multiple pages - it's handy to keep a track of these. There is no enforcement of these numbers at all. You can have 10 page 1's and a page 29 if you wish.
+         */
+        scanPageNum?: number;
+        scanMIME?: Admin["enumMIMEType"];
+        /**
+         * Used as a way of indicating to the service that the original scanned document is not to be kept after it has been processed. We will retain any metadata and the results of processing (where required by regulation or the customer), but the original file uploaded will eventually be remnoved once processing is complete.
+         * If ScanDelete is set to true, any call with /full at the end will still not return the file contents, regardless of whether the file has been deleted yet (the deletion process is a background task that can take a few minutes to occur)
+         */
+        ScanDelete?: boolean;
+        /**
+         * Base64 encoded string of a photo or scan of an ID document to be verified. If supplied and of a supported type, the Frankie service will attempt to use OCR tech to extract the data from the scanned doc/image.
+         * In a result message, this field will be left blank, unless the "full" action is requested.
+         */
+        scanData?: string;
+        scanDataRetrievalState?: Admin["enumScanDataRetrievalState"];
+        /**
+         * The date and time the scan was created. Not the date of the scanned document, which should be in the idIssued attribute of the document that owns this scan.
+         */
+        scanCreated?: string;
+    };
+    IdentityDocumentObject: {
+        /**
+         * When an ID document is created/uploaded, it is assigned a documentId. You'll see this in a successful response or successfully accepted response. This can then be referenced in subsequent calls if you're uploading more/updated data.
+         */
+        documentId?: string;
+        idType: Admin["enumIdType"];
+        /**
+         * The sub-type of identity document. Very document specific.
+         */
+        idSubType?: string;
+        /**
+         * The ISO country code of the issuing national. Once set, this cannot be changed.
+         */
+        country: string;
+        /**
+         * Regional variant of the ID (e.g. VIC drivers licence)
+         */
+        region?: string;
+        /**
+         * The ID number of the document (if known).
+         */
+        idNumber?: string;
+        /**
+         * The expiry data of the document (if known) in YYYY-MM-DD format.
+         */
+        idExpiry?: string;
+        /**
+         * The issued date of the document (if known) in YYYY-MM-DD format.
+         */
+        idIssued?: string;
+        documentStatus?: Admin["enumDocumentStatus"];
+        /**
+         * This document's data was initially created from scanned and processed images. The value cannot be set manually and any attempt to do so will just be ignored.
+         */
+        createdFromScan?: boolean;
+        /**
+         * If this document was originally populated from scanned data, then manually adjusted (e.g. if the scan's results weren't 100% correct or data was missing), then this will be set to true. The value cannot be set manually and any attempt to do so will just be ignored.
+         */
+        manuallyModified?: boolean;
+        /**
+         * Set of key-value pairs that provide ID type-specific data. If updating an existing document, then existing values with the same name will be overwritten. New values will be added.
+         * If this document is scanned through OCR or similar processes, then extracted data will be found here (Some may be used to populate other fields like idNumber and idExpiry as well)
+         */
+        extraData?: Admin["KeyValuePairObject"][];
+        /**
+         * Collection of one or more objects that describe scan(s) that need to be put through OCR or facial recognition. These should all be from the one ID document, such as front/back, or page 1, 2, 3, etc. You can upload multiple scans in a single call, or in multiple calls.
+         *   Note: if you do upload over multiple calls, make sure you include the documentId (see above), and indicate that this is happening with a "more_data" checkAction
+         */
+        docScan?: Admin["ScannedDocumentObject"][];
+    };
+    /**
+     * Similar to a KVP, the flag has a key (the flag you're indicating) and an integer value.
+     *
+     * Values are tied to the specific flag (see table below). Generally they're true (1)/false(0) indicators.
+     *
+     *     | flag | values | Description |
+     *     | ------- | -------- | -------- |
+     *     | ongoing_pep | 0, 1, 2 | 0 = no, 1 = pep/sanctions, 2 = 1+media |
+     *     |  |  |  |
+     */
+    EntityFlagObject: {
+        /**
+         * Name of the flag
+         */
+        flag?: string;
+        /**
+         * flag value.
+         */
+        value?: number;
+    };
+    PersonalNameObject: {
+        /**
+         * Mr/Ms/Dr/Dame/Dato/etc.
+         */
+        honourific?: string;
+        /**
+         * Family name / Surname of the individual.
+         */
+        familyName: string;
+        /**
+         * First / Given name
+         */
+        givenName?: string;
+        /**
+         * Middle name(s) / Initials
+         */
+        middleName?: string;
+        /**
+         * In some cases, the name will need to be supplied in "long form", such as when it is determined from a document scan, or is un-parsable in some way.
+         * The service will attempt to convert it to it's constituent parts where possible.
+         */
+        displayName?: string;
+    };
+    DOBObject: {
+        /**
+         * Year of birth or "unknown". This will be autoextracted if dateOfBirth is supplied.
+         */
+        yearOfBirth?: string;
+        /**
+         * Date of Birth in YYYY-MM-DD format
+         */
+        dateOfBirth?: string;
+        /**
+         * Place of birth other than country If locality is given, then country must also be provided.
+         */
+        locality?: string;
+        /**
+         * ISO-3166-1 code for the country of birth. You must use the alpha3 country code (e.g. AUS, USA, IDR, KOR, etc) We'll convert as needed.
+         * See https://en.wikipedia.org/wiki/ISO_3166-1
+         */
+        country?: string;
+    };
+    AddressObject: {
+        /**
+         * As addresses are added to an entity, they're assigned an id to assist with tracking.
+         *
+         * If you're adjusting an address, you will need to include the addressId so as to be able to reference it correctly in the list.
+         */
+        addressId?: string;
+        addressType?: Admin["enumAddressType"];
+        /**
+         * The date this address first because active. Used mostly with business addresses.
+         */
+        startDate?: string;
+        /**
+         * The date this address was no longer used (if available). Used mostly with business addresses.
+         */
+        endDate?: string;
+        /**
+         * Individual or business name at this address if not the same as the name of the entity to which this address belongs.
+         */
+        careOf?: string;
+        /**
+         * Unit/Apartment/Flat/Suite/etc number
+         */
+        unitNumber?: string;
+        /**
+         * The number on the street. Generally a number, but can also be alphanumeric (e.g. 3A)
+         */
+        streetNumber?: string;
+        /**
+         * The name of the street (do not include number or St/Rd/Ave/etc - these go in related fields)
+         */
+        streetName?: string;
+        /**
+         * The street "type" - e.g. Road, St, Ave, Circuit, etc
+         */
+        streetType?: string;
+        /**
+         * The name of the building, apartment block, condo, etc
+         */
+        buildingName?: string;
+        /**
+         * The suburb in the town/city. Only use this if you require a suburb AND a town/city, otherwise, just use the "town" parameter.
+         */
+        suburb?: string;
+        /**
+         * The town/village/suburb/city
+         */
+        town?: string;
+        /**
+         * The county, province, cantonment
+         */
+        region?: string;
+        /**
+         * The state. Use local abbreviations, such as VIC(toria) or TX (Texas)
+         */
+        state?: string;
+        /**
+         * The ISO-3166-1 country. You must use the alpha3 country code (e.g. AUS, USA, IDR, KOR, etc) We'll convert as needed.
+         *
+         * See: https://en.wikipedia.org/wiki/ISO_3166-1
+         */
+        country: string;
+        /**
+         * The post code of the address.
+         */
+        postalCode?: string;
+        /**
+         * In some cases, the address will need to be supplied in "long form", such as when it is determined from a document scan, or is un-parsable in some way.
+         * The service will attempt to convert it to it's constituent parts where possible.
+         * WARNING: Use of longForm is not guaranteed to produce perfect results, due to the variety of potential formats. You've been warned.
+         */
+        longForm?: string;
+        extraData?: Admin["KeyValuePairObject"][];
+    };
+    /**
+     * Describes all of the data being used to verify an entity.
+     */
+    EntityObject: {
+        /**
+         * When an entity is first created, it is assigned an ID. When updating an entity, make sure you set the entityId
+         * One exception to this is when an entity is created from a document object. It is expected that this object would be passed into a /check or /entity call to set it.
+         */
+        entityId?: string;
+        entityType?: Admin["enumEntityType"];
+        /**
+         * If the entity is using the new profiles feature, then their profile name will be found here.
+         *
+         * Note: If setting a profile, you must ensure that the profile matches a known configuration.
+         *
+         * Please contact Frankie developer support if you're unsure as to what valid values are.
+         */
+        entityProfile?: string;
+        name?: Admin["PersonalNameObject"];
+        dateOfBirth?: Admin["DOBObject"];
+        gender?: Admin["enumGender"];
+        /**
+         * Collection of address objects.
+         */
+        addresses?: Admin["AddressObject"][];
+        /**
+         * Used to set additional information flags with regards to this entity and for ongoing processing.
+         *
+         * Flags might include having the entity (not) participate in regular pep/sanctions screening
+         * Others will follow over time.
+         */
+        flags?: Admin["EntityFlagObject"][];
+        /**
+         * Set of key-value pairs that provide arbitrary additional type-specific data. You can use these fields to store external IDs, or other non-identity related items if you need to.
+         * If updating an existing entity, then existing values with the same name will be overwritten. New values will be added.
+         */
+        extraData?: Admin["KeyValuePairObject"][];
+        /**
+         * Collection of identity documents (photos, scans, selfies, etc)
+         */
+        identityDocs?: Admin["IdentityDocumentObject"][];
+        organisationData?: Admin["OrganisationDataObject"];
+    };
+    IdentityDocumentCheckResultListObject: {
+        /**
+         * When an ID document is created/uploaded, it is assigned a documentId. You'll see this in a successful response or successfully accepted response. This can then be referenced in subsequent calls if you're uploading more/updated data.
+         */
+        documentId?: string;
+        checkResults?: Admin["ProcessResultObject"][];
+    };
+    /**
+     * Full details of a given check for a specific entity.
+     */
+    EntityCheckDetails: {
+        requestId?: Admin["RequestIDObject"];
+        checkId?: Admin["CheckIDObject"];
+        entityData?: Admin["EntityObject"];
+        entityProfileResult?: Admin["EntityProfileResultObject"];
+        checkSummary?: Admin["ProcessResultObject"];
+        checkResultsListSummaries?: Admin["ProcessResultObject"][];
+        checkRisk?: Admin["ProcessResultObject"];
+        checkResultsListEntity?: Admin["ProcessResultObject"][];
+        checkResultsListDocument?: Admin["IdentityDocumentCheckResultListObject"][];
+        checkResultsListDevice?: Admin["ProcessResultObject"][];
+        checkResultsListDuplicate?: Admin["ProcessResultObjectContainer"][];
+        checkResultsListBlacklist?: Admin["ProcessResultObjectContainer"][];
+        checkResultsListManual?: Admin["ProcessResultObjectContainer"][];
+        checkResultsListFraud?: Admin["FraudCheckResultObject"][];
+        amlResultSets?: Admin["AMLResultSet"][];
+    };
+    /**
+     * Wrapper object to contain a single set of AML check results.
+     */
+    AMLResultSet: {
+        groupDetails?: Admin["backgroundCheckResultObjectContainer"];
+        /**
+         * Collection of check results for the entity being a Politically Exposed Person
+         *
+         * An array sorted by type, then reverse chronological order of some/all background checks done on this entity. Older checks may have been previously done by you or another institution, and if so, these will be listed and appropriately anonymised/obfuscated.
+         */
+        checkResultsListPEP?: Admin["backgroundCheckResultObjectContainer"][];
+        /**
+         * Collection of check results for the entity being on a sanctions list
+         *
+         * An array sorted by type, then reverse chronological order of some/all background checks done on this entity. Older checks may have been previously done by you or another institution, and if so, these will be listed and appropriately anonymised/obfuscated.
+         */
+        checkResultsListSanctions?: Admin["backgroundCheckResultObjectContainer"][];
+        /**
+         * Collection of check results for the entity being on a watchlist
+         *
+         * An array sorted by type, then reverse chronological order of some/all background checks done on this entity. Older checks may have been previously done by you or another institution, and if so, these will be listed and appropriately anonymised/obfuscated.
+         */
+        checkResultsListWatchlists?: Admin["backgroundCheckResultObjectContainer"][];
+        /**
+         * Collection of check results for the entity being found in any adverse media
+         *
+         * An array sorted by type, then reverse chronological order of some/all background checks done on this entity. Older checks may have been previously done by you or another institution, and if so, these will be listed and appropriately anonymised/obfuscated.
+         */
+        checkResultsListMedia?: Admin["backgroundCheckResultObjectContainer"][];
+    };
+    /**
+     * Contains the results of a check against an entity profile.
+     *
+     * The entityProfileResult will be returned instead of a checkSummary to provide the full details of the verification process.
+     */
+    EntityProfileResultObject: {
+        /**
+         * Unique ID for the entity.
+         */
+        latestCheckDate?: string;
+        entityId?: string;
+        checkId?: Admin["CheckIDObject"];
+        /**
+         * The name of the profile used for this check.
+         */
+        profileName?: string;
+        /**
+         * Comma separated list of checks required for the entity profile.
+         */
+        checkType?: string;
+        /**
+         * The basic result for each check type required for the profile.
+         *
+         * The results are listed in the order they are run so you can also see how far progressed through a check process you are.
+         */
+        checkResults?: Admin["EntityProfileCheckResultMessage"][];
+        /**
+         * The recommended onboarding action for this entity after the profile check this result refers to. The action can also be an entity state set by you.
+         * - UNCHECKED: New entity with no checks applied
+         * - PASS
+         * - FAIL
+         * - PASS_MANUAL: Manual intervention was applied to achieve a pass
+         * - FAIL_MANUAL: Manual intervention was applied but the entity still fails
+         * - REFER: Manual intervention required
+         * - WAIT: Externally applied state, waiting for more entity details
+         * - ARCHIVED: Externally applied state, entity hidden from on onboarding list
+         * - INACTIVE: Externally applied state, entity hidden from on onboarding list, indexes and further changes will be blocked.
+         */
+        actionRecommended?: string;
+        issueList?: string[];
+        /**
+         * Indicates if any manual actions have been involved in the check result.
+         */
+        manualIntervention?: boolean;
+        /**
+         * List of vendors from failed credit header sources.
+         */
+        creditHeaderFailures?: string[];
+        /**
+         * Risk level. One of:
+         * - LOW,
+         * - MEDIUM,
+         * - HIGH,
+         * - UACCEPTABLE
+         * - or UNKNOWN
+         */
+        riskLevel?: string;
+        /**
+         * Risk policy. Contents depend on account configuration but would typically be one of:
+         * - SDD,
+         * - CDD,
+         * - EDD
+         * - or FAIL
+         */
+        riskPolicy?: string;
+        /**
+         * Summary of KYC match counts.
+         */
+        kycResults?: Admin["EntityProfileKYCMatchResultObject"][];
+        /**
+         * KYC match counts fodocumentResultsr each checked document, whether matched or not. The keys in this map are the document IDs. The match type in the value will be either "gov_id" or "other_id". The resultant structure would look like:
+         *
+         * documentResults: {
+         *     "documentId" : {
+         *       "matchType": "gov_id",
+         *       "matchCount": 5,
+         *       "verified": true
+         *     },
+         *     "documentId": {
+         *       "matchType": "other_id",
+         *       "matchCount": 5,
+         *       "verified": true
+         *     }
+         * }
+         */
+        documentResults?: {
+            [key: string]: Admin["EntityProfileKYCMatchResultObjectMatchTypes"];
+        };
+        /**
+         * KYC match counts for each checked address, whether matched or not. The keys in this map are the address IDs. The match type in the value will be either "curr_addr" or "prev_addr". The resultant structure would look like:
+         *
+         *     "addressResults": {
+         *       "addressId": {
+         *         "matchType": "curr_addr",
+         *         "matchCount": 5,
+         *         "verified": true
+         *       },
+         *       "addressId": {
+         *         "matchType": "prev_addr",
+         *         "matchCount": 5,
+         *         "verified": true
+         *       }
+         *     }
+         */
+        addressResults?: {
+            [key: string]: Admin["EntityProfileKYCMatchResultObjectMatchTypes"];
+        };
+        alternativeKycResults?: Admin["EntityProfileAlternativeKYCMatchResultObject"][];
+    };
+    EntityProfileCheckResultMessage: {
+        /**
+         * A single check type that this result message applies to.
+         */
+        checkType?: string;
+        /**
+         * The current state of the check. One of:
+         * - PASS
+         * - FAIL
+         * - UNCHECKED: Not attempted or service not available. For example AML not attempted if KYC fails.
+         * - NA: Not required. For example Visa check when there is no visa document and your account configuration indicates the check can be skipped.
+         */
+        result?: string;
+        /**
+         * Short description of why not passed
+         */
+        message?: string;
+        /**
+         * Alphanumeric code that is unique for each failure message to simplify result processing and display. Values to be decided.
+         */
+        code?: string;
+    };
+    /**
+     * Match summary for a single checked address or document
+     */
+    EntityProfileItemMatchResultObject: {
+        /**
+         * The match type that this count and result refer to. For document matches this will be "gov_id" or "other_id". For addresses ir will be "curr_addr" or "prev_addr" depending on the status of the address at the time of the check.
+         */
+        matchType?: string;
+        /**
+         * The number of distinct sources that matched this address or document
+         */
+        matchCount?: number;
+        /**
+         * True if there is at least one match
+         */
+        verified?: boolean;
+        checked?: boolean;
+    };
+    /**
+     * Summary of all KYC matches
+     */
+    matchType: {
+        "matchCount": number;
+        "checked": boolean;
+        "verified": boolean;
+    };
+    /**
+    * Summary of all KYC matches for different rulesets
+    */
+    EntityProfileAlternativeKYCMatchResultObject: {
+        kycResults?: Admin["EntityProfileKYCMatchResultObject"][];
+        /**
+        * Name of the ruleset
+        */
+        name: string;
+        /**
+         * Order of the ruleset in ascending
+         */
+        order: number;
+        /**
+         * Overall KYC result of the ruleset
+         */
+        result: string;
+    };
+    EntityProfileKYCMatchResultObject: {
+        /**
+    * The match types that this overall count and result refer to. Currently one or more of:   - name   - address   - dob   - gender   - gov_id   - other_id    These will be keys in a map whose values hold the values for the individual match types. The resultant structure would look like the following. Here dob has zero matches and is not verfied but it was check, so other than the checked flag the value object is simply empty. A completely empty object would imply that match type was not checked.          \"matchTypes\": {         \"address\": {           \"matchCount\": 1,           \"matchSources\": [ \"au-elec-roll\" ],           \"checked\": true,           \"verified\": true         },         \"dob\": {           \"checked\": true         }       }    So for a one_plus KYC check there will be two EntityProfileKYCMatchResultObject records. One for 'name' and one for 'address, dob' (like the sample above).
+      * The match types that this overall count and result refer to. Currently one or more of:   - name   - address   - dob   - gender   - gov_id   - other_id    These will be keys in a map whose values hold the values for the individual match types. The resultant structure would look like the following. Here dob has zero matches and is not verfied but it was check, so other than the checked flag the value object is simply empty. A completely empty object would imply that match type was not checked.          \"matchTypes\": {         \"address\": {           \"matchCount\": 1,           \"matchSources\": [ \"au-elec-roll\" ],           \"checked\": true,           \"verified\": true         },         \"dob\": {           \"checked\": true         }       }    So for a one_plus KYC check there will be two EntityProfileKYCMatchResultObject records. One for 'name' and one for 'address, dob' (like the sample above).
+    * The match types that this overall count and result refer to. Currently one or more of:   - name   - address   - dob   - gender   - gov_id   - other_id    These will be keys in a map whose values hold the values for the individual match types. The resultant structure would look like the following. Here dob has zero matches and is not verfied but it was check, so other than the checked flag the value object is simply empty. A completely empty object would imply that match type was not checked.          \"matchTypes\": {         \"address\": {           \"matchCount\": 1,           \"matchSources\": [ \"au-elec-roll\" ],           \"checked\": true,           \"verified\": true         },         \"dob\": {           \"checked\": true         }       }    So for a one_plus KYC check there will be two EntityProfileKYCMatchResultObject records. One for 'name' and one for 'address, dob' (like the sample above).
+      */
+        'matchTypes'?: {
+            [key: string]: Admin['EntityProfileKYCMatchResultObjectMatchTypes'];
+        };
+        /**
+      * Number of matches for this set of match types. In other words the sum of the matchCounts in the matchTypes map. Note that for match sets that include government ID (gov_id) this will not neccessaily be the count of matched sources.
+        * Number of matches for this set of match types. In other words the sum of the matchCounts in the matchTypes map. Note that for match sets that include government ID (gov_id) this will not neccessaily be the count of matched sources.
+      * Number of matches for this set of match types. In other words the sum of the matchCounts in the matchTypes map. Note that for match sets that include government ID (gov_id) this will not neccessaily be the count of matched sources.
+        * Number of matches for this set of match types. In other words the sum of the matchCounts in the matchTypes map. Note that for match sets that include government ID (gov_id) this will not neccessaily be the count of matched sources.
+      * Number of matches for this set of match types. In other words the sum of the matchCounts in the matchTypes map. Note that for match sets that include government ID (gov_id) this will not neccessaily be the count of matched sources.
+        * Number of matches for this set of match types. In other words the sum of the matchCounts in the matchTypes map. Note that for match sets that include government ID (gov_id) this will not neccessaily be the count of matched sources.
+      * Number of matches for this set of match types. In other words the sum of the matchCounts in the matchTypes map. Note that for match sets that include government ID (gov_id) this will not neccessaily be the count of matched sources.
+        * Number of matches for this set of match types. In other words the sum of the matchCounts in the matchTypes map. Note that for match sets that include government ID (gov_id) this will not neccessaily be the count of matched sources.
+      * Number of matches for this set of match types. In other words the sum of the matchCounts in the matchTypes map. Note that for match sets that include government ID (gov_id) this will not neccessaily be the count of matched sources.
+        * Number of matches for this set of match types. In other words the sum of the matchCounts in the matchTypes map. Note that for match sets that include government ID (gov_id) this will not neccessaily be the count of matched sources.
+      * Number of matches for this set of match types. In other words the sum of the matchCounts in the matchTypes map. Note that for match sets that include government ID (gov_id) this will not neccessaily be the count of matched sources.
+        * Number of matches for this set of match types. In other words the sum of the matchCounts in the matchTypes map. Note that for match sets that include government ID (gov_id) this will not neccessaily be the count of matched sources.
+      * Number of matches for this set of match types. In other words the sum of the matchCounts in the matchTypes map. Note that for match sets that include government ID (gov_id) this will not neccessaily be the count of matched sources.
+        */
+        'matchCount'?: number;
+        /**
+      * Number of distinct matches (sources and/or matched government ID documents) required for this set of match types.
+        * Number of distinct matches (sources and/or matched government ID documents) required for this set of match types.
+      * Number of distinct matches (sources and/or matched government ID documents) required for this set of match types.
+        * Number of distinct matches (sources and/or matched government ID documents) required for this set of match types.
+      * Number of distinct matches (sources and/or matched government ID documents) required for this set of match types.
+        */
+        'matchCountRequired'?: number;
+        /**
+        * True if there are enough matches to meet the requirement
+        */
+        'verified'?: boolean;
+    };
+    EntityProfileKYCMatchResultObjectMatchTypes: {
+        /**
+       * Number of distinct matches for this match type. Note that for government ID (gov_id) this is the count of matched documents, not sources.
+       */
+        'matchCount'?: number;
+        /**
+        * List of sources that matched. Note that the matchCount is not always a count of the matchSources. Particularly for gov_id, the count is the number of distinct documents matched, not the number of sources.
+        */
+        'matchSources'?: Array<string>;
+        /**
+        * True if an attempt was made to verify
+        */
+        'checked'?: boolean;
+        /**
+        * True if there is at least one match
+        */
+        'verified'?: boolean;
+    };
+    /**
+     * Raw data.
+     */
+    DocScanDetails: string;
+    /**
+     * Details of a case.
+     */
+    CaseRecord: {
+        /**
+         * Unique entity identifier.
+         */
+        entityId?: string;
+        entityType?: Admin["enumEntityType"];
+        /**
+         * Name of the entity.
+         */
+        entityName?: string;
+        /**
+         * Portal user responsible for this case.
+         */
+        assignee?: string;
+        /**
+         * Set of key-value pairs that provide additional data. This is *not* the extra data from the entity.
+         */
+        extraData?: Admin["KeyValuePairObject"][];
+        /**
+         * Additional information flags with regards to this entity and for ongoing processing. This *is* the flag data from the entity.
+         */
+        entityFlags?: Admin["EntityFlagObject"][];
+        createdRequestId?: Admin["RequestIDObject"];
+        /**
+         * The date and time the entity was created.
+         */
+        createdTimestamp?: string;
+        deletedRequestId?: Admin["RequestIDObject"];
+        /**
+         * The date and time the entity was deleted.
+         */
+        deletedTimestamp?: string;
+        updatedRequestId?: Admin["RequestIDObject"];
+        /**
+         * The date and time the entity was updated.
+         */
+        updatedTimestamp?: string;
+        transactionRequestId?: Admin["RequestIDObject"];
+        transactionParentRequestId?: Admin["RequestIDObject"];
+        /**
+         * Portal user responsible for this check.
+         */
+        transactionUsername?: string;
+        /**
+         * The date and time of the latest transaction.
+         */
+        transactionTimestamp?: string;
+        transactionStatus?: Admin["enumTransactionStatusKYC"];
+        /**
+         * Only supplied in a summary result. Used to indicate the ovall risk score for the entity at this point in time.
+         */
+        riskLevel?: number;
+        /**
+         * Confidence in the result on a scale of 0 (no match) to 100 (strong/identical match). Whole integers only.
+         */
+        confidenceLevel?: number;
+        /**
+         * Comma-separated list of alerts associated with this monitoring alert.
+         *
+         * List of possible alerts supported:
+         *
+         * * PEP
+         * * SANCTION
+         * * WATCHLIST
+         * * MEDIA
+         * * DEATH
+         * * CRIME
+         * * BLACKLIST
+         * * IDTHEFT
+         */
+        alertList?: string;
+        checkSummary?: Admin["ProcessResultObject"];
+        checkRisk?: Admin["ProcessResultObject"];
+    };
+    /**
+     * A configuration item. Representing any type but will be an object (map) with one entry where the key is the item name that was requested and the value is the corresponding configuration.
+     */
+    ConfigItem: {
+        [key: string]: object;
+    };
+    /**
+     * A common pairing of a short code and a long description.
+     */
+    CodeDescription: {
+        code?: string;
+        description?: string;
+    };
+    /**
+     * Describes a collection of shares of a particular type and their attributes,
+     * One or more ShareStructures make up a company's shares that are then parcelled out as shareholdings.
+     */
+    ShareStructureObject: {
+        status?: string;
+        docNumber?: string;
+        docNumberQualifier?: string;
+        classCode?: string;
+        classTitle?: string;
+        sharesIssued?: number;
+        amountPaid?: number;
+        amountDue?: number;
+    };
+    /**
+     * Organisation details for entities. Returned from an ASIC report.
+     */
+    OrganisationDataObject: {
+        registeredName?: string;
+        registration?: {
+            state?: string;
+            previousNumber?: string;
+            date?: string;
+        };
+        type?: Admin["CodeDescription"];
+        class?: Admin["CodeDescription"];
+        subclass?: Admin["CodeDescription"];
+        status?: Admin["CodeDescription"];
+        shareStructure?: Admin["ShareStructureObject"][];
+        disclosingEntityIndicator?: boolean;
+        kycCustomerType?: string;
+        includesNonBeneficiallyHeld?: boolean;
+        lastCheckDate?: string;
+        ownershipResolved?: boolean;
+        adverseCreditDataPresent?: boolean;
+        startDate?: string;
+    };
+    /**
+     * Container object that holds authentication credentials. Really only used by code generators and not part of the actual API spec.
+     */
+    AuthCredentials: {
+        /**
+         * API key issued by Frankie Financial. Copied from the Header.
+         */
+        ApiKey?: string;
+        /**
+         * Tracking number used throughout this service.
+         */
+        RequestID?: string;
+        /**
+         * Will the function be backgrounded? Copied from Header.
+         */
+        Background?: boolean;
+        /**
+         * Customer ID issued by Frankie Financial. Copied from the Header.
+         */
+        CustomerID?: string;
+        /**
+         * Child ID belongs to the Customer. Still issued by Frankie Financial. Copied from the Header. api_key is tied to the combination of CustomerID + CustomerID
+         */
+        CustomerChildID?: string;
+        /**
+         * Copy of the X-Frankie-* fields that will be copied back to any reply to the customer.
+         */
+        ReturnFields?: string[];
+    };
+}