/**
 * Onfido Public API v3.6
 * The Onfido Public API (v3.6)
 *
 * The version of the OpenAPI document: v3.6
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { Configuration } from './configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import type { RequestArgs } from './base';
import { BaseAPI } from './base';
import { FileTransfer } from './file-transfer';
export interface Address {
    /**
     * The flat number of this address
     */
    'flat_number'?: string;
    /**
     * The building number of this address
     */
    'building_number'?: string;
    /**
     * The building name of this address
     */
    'building_name'?: string;
    /**
     * The street of the applicant\'s address
     */
    'street'?: string;
    /**
     * The sub-street of the applicant\'s address
     */
    'sub_street'?: string;
    /**
     * The town of the applicant\'s address
     */
    'town'?: string;
    /**
     * The postcode or ZIP of the applicant\'s address
     */
    'postcode': string;
    /**
     * The 3 character ISO country code of this address. For example, GBR is the country code for the United Kingdom
     */
    'country': CountryCodes;
    /**
     * The address state. US states must use the USPS abbreviation (see also ISO 3166-2:US), for example AK, CA, or TX.
     */
    'state'?: string;
    /**
     * Line 1 of the applicant\'s address
     */
    'line1'?: string | null;
    /**
     * Line 2 of the applicant\'s address
     */
    'line2'?: string | null;
    /**
     * Line 3 of the applicant\'s address
     */
    'line3'?: string | null;
}
export interface AddressBuilder {
    /**
     * The flat number of this address
     */
    'flat_number'?: string;
    /**
     * The building number of this address
     */
    'building_number'?: string;
    /**
     * The building name of this address
     */
    'building_name'?: string;
    /**
     * The street of the applicant\'s address
     */
    'street'?: string;
    /**
     * The sub-street of the applicant\'s address
     */
    'sub_street'?: string;
    /**
     * The town of the applicant\'s address
     */
    'town'?: string;
    /**
     * The postcode or ZIP of the applicant\'s address
     */
    'postcode': string;
    /**
     * The 3 character ISO country code of this address. For example, GBR is the country code for the United Kingdom
     */
    'country': CountryCodes;
    /**
     * The address state. US states must use the USPS abbreviation (see also ISO 3166-2:US), for example AK, CA, or TX.
     */
    'state'?: string;
    /**
     * Line 1 of the applicant\'s address
     */
    'line1'?: string | null;
    /**
     * Line 2 of the applicant\'s address
     */
    'line2'?: string | null;
    /**
     * Line 3 of the applicant\'s address
     */
    'line3'?: string | null;
}
export interface AddressShared {
    /**
     * The flat number of this address
     */
    'flat_number'?: string;
    /**
     * The building number of this address
     */
    'building_number'?: string;
    /**
     * The building name of this address
     */
    'building_name'?: string;
    /**
     * The street of the applicant\'s address
     */
    'street'?: string;
    /**
     * The sub-street of the applicant\'s address
     */
    'sub_street'?: string;
    /**
     * The town of the applicant\'s address
     */
    'town'?: string;
    /**
     * The postcode or ZIP of the applicant\'s address
     */
    'postcode': string;
    /**
     * The 3 character ISO country code of this address. For example, GBR is the country code for the United Kingdom
     */
    'country': CountryCodes;
    /**
     * The address state. US states must use the USPS abbreviation (see also ISO 3166-2:US), for example AK, CA, or TX.
     */
    'state'?: string;
    /**
     * Line 1 of the applicant\'s address
     */
    'line1'?: string | null;
    /**
     * Line 2 of the applicant\'s address
     */
    'line2'?: string | null;
    /**
     * Line 3 of the applicant\'s address
     */
    'line3'?: string | null;
}
export interface AddressesList {
    'addresses'?: Array<Address>;
}
export interface Applicant {
    /**
     * The applicant\'s email address. Required if doing a US check, or a UK check for which `applicant_provides_data` is `true`.
     */
    'email'?: string;
    /**
     * The applicant\'s date of birth
     */
    'dob'?: string;
    'id_numbers'?: Array<IdNumber>;
    /**
     * The applicant\'s phone number
     */
    'phone_number'?: string;
    /**
     * The applicant\'s first name
     */
    'first_name'?: string;
    /**
     * The applicant\'s surname
     */
    'last_name'?: string;
    /**
     * The unique identifier for the applicant.
     */
    'id': string;
    /**
     * The date and time when this applicant was created.
     */
    'created_at'?: string;
    /**
     * The date and time when this applicant is scheduled to be deleted.
     */
    'delete_at'?: string;
    /**
     * The uri of this resource.
     */
    'href'?: string;
    'sandbox'?: boolean;
    'address'?: Address;
    'location'?: Location;
}
export interface ApplicantBuilder {
    /**
     * The applicant\'s email address. Required if doing a US check, or a UK check for which `applicant_provides_data` is `true`.
     */
    'email'?: string;
    /**
     * The applicant\'s date of birth
     */
    'dob'?: string;
    'id_numbers'?: Array<IdNumber>;
    /**
     * The applicant\'s phone number
     */
    'phone_number'?: string;
    /**
     * The applicant\'s consents
     */
    'consents'?: Array<ApplicantConsentBuilder>;
    'address'?: AddressBuilder;
    'location'?: LocationBuilder;
    /**
     * The applicant\'s first name
     */
    'first_name': string;
    /**
     * The applicant\'s surname
     */
    'last_name': string;
}
export interface ApplicantConsent {
    'name': ApplicantConsentName;
    'granted': boolean;
    /**
     * The date and time when this applicant consent was granted, if not granted the value is nil.
     */
    'granted_at': string | null;
}
export interface ApplicantConsentBuilder {
    'name': ApplicantConsentName;
    'granted': boolean;
}
export declare const ApplicantConsentName: {
    readonly PrivacyNoticesRead: "privacy_notices_read";
    readonly SsnVerification: "ssn_verification";
    readonly PhoneNumberVerification: "phone_number_verification";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type ApplicantConsentName = typeof ApplicantConsentName[keyof typeof ApplicantConsentName];
export interface ApplicantCreate {
    /**
     * The applicant\'s first name
     */
    'first_name': string;
    /**
     * The applicant\'s surname
     */
    'last_name': string;
}
export interface ApplicantRequest {
    /**
     * The applicant\'s consents
     */
    'consents'?: Array<ApplicantConsentBuilder>;
    'address'?: AddressBuilder;
    'location'?: LocationBuilder;
}
export interface ApplicantResponse {
    /**
     * The applicant\'s first name
     */
    'first_name'?: string;
    /**
     * The applicant\'s surname
     */
    'last_name'?: string;
    /**
     * The unique identifier for the applicant.
     */
    'id': string;
    /**
     * The date and time when this applicant was created.
     */
    'created_at'?: string;
    /**
     * The date and time when this applicant is scheduled to be deleted.
     */
    'delete_at'?: string;
    /**
     * The uri of this resource.
     */
    'href'?: string;
    'sandbox'?: boolean;
    'address'?: Address;
    'location'?: Location;
}
export interface ApplicantShared {
    /**
     * The applicant\'s email address. Required if doing a US check, or a UK check for which `applicant_provides_data` is `true`.
     */
    'email'?: string;
    /**
     * The applicant\'s date of birth
     */
    'dob'?: string;
    'id_numbers'?: Array<IdNumber>;
    /**
     * The applicant\'s phone number
     */
    'phone_number'?: string;
}
export interface ApplicantUpdate {
    /**
     * The applicant\'s first name
     */
    'first_name'?: string;
    /**
     * The applicant\'s surname
     */
    'last_name'?: string;
}
export interface ApplicantUpdater {
    /**
     * The applicant\'s email address. Required if doing a US check, or a UK check for which `applicant_provides_data` is `true`.
     */
    'email'?: string;
    /**
     * The applicant\'s date of birth
     */
    'dob'?: string;
    'id_numbers'?: Array<IdNumber>;
    /**
     * The applicant\'s phone number
     */
    'phone_number'?: string;
    /**
     * The applicant\'s consents
     */
    'consents'?: Array<ApplicantConsentBuilder>;
    'address'?: AddressBuilder;
    'location'?: LocationBuilder;
    /**
     * The applicant\'s first name
     */
    'first_name'?: string;
    /**
     * The applicant\'s surname
     */
    'last_name'?: string;
}
export interface ApplicantsList {
    'applicants': Array<Applicant>;
}
export interface Check {
    /**
     * An array of webhook ids describing which webhooks to trigger for this check.
     */
    'webhook_ids'?: Array<string>;
    /**
     * The ID of the applicant to do the check on.
     */
    'applicant_id': string;
    /**
     * Send an applicant form to applicant to complete to proceed with check. Defaults to false.
     */
    'applicant_provides_data'?: boolean;
    /**
     * Array of tags being assigned to this check.
     */
    'tags'?: Array<string>;
    /**
     * For checks where `applicant_provides_data` is `true`, redirect to this URI when the applicant has submitted their data.
     */
    'redirect_uri'?: string;
    'privacy_notices_read_consent_given'?: boolean;
    /**
     * The unique identifier for the check.
     */
    'id': string;
    /**
     * The date and time when this check was created.
     */
    'created_at'?: string;
    /**
     * The uri of this resource.
     */
    'href'?: string;
    'status'?: CheckStatus;
    /**
     * The overall result of the check, based on the results of the constituent reports.
     */
    'result'?: CheckResultEnum;
    /**
     * A link to the applicant form, if `applicant_provides_data` is `true`.
     */
    'form_uri'?: string;
    /**
     * A link to the corresponding results page on the Onfido dashboard.
     */
    'results_uri'?: string;
    /**
     * An array of report ids.
     */
    'report_ids'?: Array<string>;
    /**
     * Indicates whether the object was created in the sandbox or not.
     */
    'sandbox'?: boolean;
    'paused'?: boolean;
    'version'?: string;
}
export declare const CheckResultEnum: {
    readonly Clear: "clear";
    readonly Consider: "consider";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type CheckResultEnum = typeof CheckResultEnum[keyof typeof CheckResultEnum];
export interface CheckBuilder {
    /**
     * An array of webhook ids describing which webhooks to trigger for this check.
     */
    'webhook_ids'?: Array<string>;
    /**
     * The ID of the applicant to do the check on.
     */
    'applicant_id': string;
    /**
     * Send an applicant form to applicant to complete to proceed with check. Defaults to false.
     */
    'applicant_provides_data'?: boolean;
    /**
     * Array of tags being assigned to this check.
     */
    'tags'?: Array<string>;
    /**
     * For checks where `applicant_provides_data` is `true`, redirect to this URI when the applicant has submitted their data.
     */
    'redirect_uri'?: string;
    'privacy_notices_read_consent_given'?: boolean;
    /**
     * An array of report names (strings).
     */
    'report_names': Array<ReportName>;
    /**
     * Optional. An array of document ids, for use with Document reports only. If omitted, the Document report will use the most recently uploaded document by default.
     */
    'document_ids'?: Array<string>;
    /**
     * Defaults to `true`. If set to `false`, you will only receive a response when all reports in your check have completed.
     */
    'asynchronous'?: boolean;
    /**
     * For checks where `applicant_provides_data` is `true`, applicant form will not be automatically sent if `suppress_form_emails` is set to `true`. You can manually send the form at any time after the check has been created, using the link found in the form_uri attribute of the check object. Write-only. Defaults to false.
     */
    'suppress_form_emails'?: boolean;
    /**
     * Triggers responses for particular sub-results for sandbox Document reports.
     */
    'sub_result'?: string;
    /**
     * Array of names of particular reports to return consider as their results. This is a feature available in sandbox testing
     */
    'consider'?: Array<ReportName>;
    'us_driving_licence'?: UsDrivingLicenceBuilder;
    /**
     * @deprecated
     */
    'report_configuration'?: ReportConfiguration;
}
export interface CheckRequest {
    /**
     * An array of report names (strings).
     */
    'report_names': Array<ReportName>;
    /**
     * Optional. An array of document ids, for use with Document reports only. If omitted, the Document report will use the most recently uploaded document by default.
     */
    'document_ids'?: Array<string>;
    /**
     * Send an applicant form to applicant to complete to proceed with check. Defaults to false.
     */
    'applicant_provides_data'?: boolean;
    /**
     * Defaults to `true`. If set to `false`, you will only receive a response when all reports in your check have completed.
     */
    'asynchronous'?: boolean;
    /**
     * For checks where `applicant_provides_data` is `true`, applicant form will not be automatically sent if `suppress_form_emails` is set to `true`. You can manually send the form at any time after the check has been created, using the link found in the form_uri attribute of the check object. Write-only. Defaults to false.
     */
    'suppress_form_emails'?: boolean;
    /**
     * Triggers responses for particular sub-results for sandbox Document reports.
     */
    'sub_result'?: string;
    /**
     * Array of names of particular reports to return consider as their results. This is a feature available in sandbox testing
     */
    'consider'?: Array<ReportName>;
    'us_driving_licence'?: UsDrivingLicenceBuilder;
    /**
     * @deprecated
     */
    'report_configuration'?: ReportConfiguration;
}
export interface CheckResponse {
    /**
     * The unique identifier for the check.
     */
    'id': string;
    /**
     * The date and time when this check was created.
     */
    'created_at'?: string;
    /**
     * The uri of this resource.
     */
    'href'?: string;
    'status'?: CheckStatus;
    /**
     * The overall result of the check, based on the results of the constituent reports.
     */
    'result'?: CheckResponseResultEnum;
    /**
     * A link to the applicant form, if `applicant_provides_data` is `true`.
     */
    'form_uri'?: string;
    /**
     * A link to the corresponding results page on the Onfido dashboard.
     */
    'results_uri'?: string;
    /**
     * An array of report ids.
     */
    'report_ids'?: Array<string>;
    /**
     * Indicates whether the object was created in the sandbox or not.
     */
    'sandbox'?: boolean;
    'paused'?: boolean;
    'version'?: string;
}
export declare const CheckResponseResultEnum: {
    readonly Clear: "clear";
    readonly Consider: "consider";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type CheckResponseResultEnum = typeof CheckResponseResultEnum[keyof typeof CheckResponseResultEnum];
export interface CheckShared {
    /**
     * An array of webhook ids describing which webhooks to trigger for this check.
     */
    'webhook_ids'?: Array<string>;
    /**
     * The ID of the applicant to do the check on.
     */
    'applicant_id': string;
    /**
     * Send an applicant form to applicant to complete to proceed with check. Defaults to false.
     */
    'applicant_provides_data'?: boolean;
    /**
     * Array of tags being assigned to this check.
     */
    'tags'?: Array<string>;
    /**
     * For checks where `applicant_provides_data` is `true`, redirect to this URI when the applicant has submitted their data.
     */
    'redirect_uri'?: string;
    'privacy_notices_read_consent_given'?: boolean;
}
/**
 * The current state of the check in the checking process.
 */
export declare const CheckStatus: {
    readonly InProgress: "in_progress";
    readonly AwaitingApplicant: "awaiting_applicant";
    readonly Complete: "complete";
    readonly Withdrawn: "withdrawn";
    readonly Paused: "paused";
    readonly Reopened: "reopened";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type CheckStatus = typeof CheckStatus[keyof typeof CheckStatus];
export interface ChecksList {
    'checks': Array<Check>;
}
export interface CompleteTaskBuilder {
    'data': CompleteTaskDataBuilder;
}
/**
 * @type CompleteTaskDataBuilder
 * The Task completion payload.
 */
export type CompleteTaskDataBuilder = Array<object> | object;
export declare const CountryCodes: {
    readonly Abw: "ABW";
    readonly Afg: "AFG";
    readonly Ago: "AGO";
    readonly Aia: "AIA";
    readonly Ala: "ALA";
    readonly Alb: "ALB";
    readonly And: "AND";
    readonly Are: "ARE";
    readonly Arg: "ARG";
    readonly Arm: "ARM";
    readonly Asm: "ASM";
    readonly Ata: "ATA";
    readonly Atf: "ATF";
    readonly Atg: "ATG";
    readonly Aus: "AUS";
    readonly Aut: "AUT";
    readonly Aze: "AZE";
    readonly Bdi: "BDI";
    readonly Bel: "BEL";
    readonly Ben: "BEN";
    readonly Bes: "BES";
    readonly Bfa: "BFA";
    readonly Bgd: "BGD";
    readonly Bgr: "BGR";
    readonly Bhr: "BHR";
    readonly Bhs: "BHS";
    readonly Bih: "BIH";
    readonly Blm: "BLM";
    readonly Blr: "BLR";
    readonly Blz: "BLZ";
    readonly Bmu: "BMU";
    readonly Bol: "BOL";
    readonly Bra: "BRA";
    readonly Brb: "BRB";
    readonly Brn: "BRN";
    readonly Btn: "BTN";
    readonly Bvt: "BVT";
    readonly Bwa: "BWA";
    readonly Caf: "CAF";
    readonly Can: "CAN";
    readonly Cck: "CCK";
    readonly Che: "CHE";
    readonly Chl: "CHL";
    readonly Chn: "CHN";
    readonly Civ: "CIV";
    readonly Cmr: "CMR";
    readonly Cod: "COD";
    readonly Cog: "COG";
    readonly Cok: "COK";
    readonly Col: "COL";
    readonly Com: "COM";
    readonly Cpv: "CPV";
    readonly Cri: "CRI";
    readonly Cub: "CUB";
    readonly Cuw: "CUW";
    readonly Cxr: "CXR";
    readonly Cym: "CYM";
    readonly Cyp: "CYP";
    readonly Cze: "CZE";
    readonly Deu: "DEU";
    readonly Dji: "DJI";
    readonly Dma: "DMA";
    readonly Dnk: "DNK";
    readonly Dom: "DOM";
    readonly Dza: "DZA";
    readonly Ecu: "ECU";
    readonly Egy: "EGY";
    readonly Eri: "ERI";
    readonly Esh: "ESH";
    readonly Esp: "ESP";
    readonly Est: "EST";
    readonly Eth: "ETH";
    readonly Fin: "FIN";
    readonly Fji: "FJI";
    readonly Flk: "FLK";
    readonly Fra: "FRA";
    readonly Fro: "FRO";
    readonly Fsm: "FSM";
    readonly Gab: "GAB";
    readonly Gbr: "GBR";
    readonly Geo: "GEO";
    readonly Ggy: "GGY";
    readonly Gha: "GHA";
    readonly Gib: "GIB";
    readonly Gin: "GIN";
    readonly Glp: "GLP";
    readonly Gmb: "GMB";
    readonly Gnb: "GNB";
    readonly Gnq: "GNQ";
    readonly Grc: "GRC";
    readonly Grd: "GRD";
    readonly Grl: "GRL";
    readonly Gtm: "GTM";
    readonly Guf: "GUF";
    readonly Gum: "GUM";
    readonly Guy: "GUY";
    readonly Hkg: "HKG";
    readonly Hmd: "HMD";
    readonly Hnd: "HND";
    readonly Hrv: "HRV";
    readonly Hti: "HTI";
    readonly Hun: "HUN";
    readonly Idn: "IDN";
    readonly Imn: "IMN";
    readonly Ind: "IND";
    readonly Iot: "IOT";
    readonly Irl: "IRL";
    readonly Irn: "IRN";
    readonly Irq: "IRQ";
    readonly Isl: "ISL";
    readonly Isr: "ISR";
    readonly Ita: "ITA";
    readonly Jam: "JAM";
    readonly Jey: "JEY";
    readonly Jor: "JOR";
    readonly Jpn: "JPN";
    readonly Kaz: "KAZ";
    readonly Ken: "KEN";
    readonly Kgz: "KGZ";
    readonly Khm: "KHM";
    readonly Kir: "KIR";
    readonly Kna: "KNA";
    readonly Kor: "KOR";
    readonly Kwt: "KWT";
    readonly Lao: "LAO";
    readonly Lbn: "LBN";
    readonly Lbr: "LBR";
    readonly Lby: "LBY";
    readonly Lca: "LCA";
    readonly Lie: "LIE";
    readonly Lka: "LKA";
    readonly Lso: "LSO";
    readonly Ltu: "LTU";
    readonly Lux: "LUX";
    readonly Lva: "LVA";
    readonly Mac: "MAC";
    readonly Maf: "MAF";
    readonly Mar: "MAR";
    readonly Mco: "MCO";
    readonly Mda: "MDA";
    readonly Mdg: "MDG";
    readonly Mdv: "MDV";
    readonly Mex: "MEX";
    readonly Mhl: "MHL";
    readonly Mkd: "MKD";
    readonly Mli: "MLI";
    readonly Mlt: "MLT";
    readonly Mmr: "MMR";
    readonly Mne: "MNE";
    readonly Mng: "MNG";
    readonly Mnp: "MNP";
    readonly Moz: "MOZ";
    readonly Mrt: "MRT";
    readonly Msr: "MSR";
    readonly Mtq: "MTQ";
    readonly Mus: "MUS";
    readonly Mwi: "MWI";
    readonly Mys: "MYS";
    readonly Myt: "MYT";
    readonly Nam: "NAM";
    readonly Ncl: "NCL";
    readonly Ner: "NER";
    readonly Nfk: "NFK";
    readonly Nga: "NGA";
    readonly Nic: "NIC";
    readonly Niu: "NIU";
    readonly Nld: "NLD";
    readonly Nor: "NOR";
    readonly Npl: "NPL";
    readonly Nru: "NRU";
    readonly Nzl: "NZL";
    readonly Omn: "OMN";
    readonly Pak: "PAK";
    readonly Pan: "PAN";
    readonly Pcn: "PCN";
    readonly Per: "PER";
    readonly Phl: "PHL";
    readonly Plw: "PLW";
    readonly Png: "PNG";
    readonly Pol: "POL";
    readonly Pri: "PRI";
    readonly Prk: "PRK";
    readonly Prt: "PRT";
    readonly Pry: "PRY";
    readonly Pse: "PSE";
    readonly Pyf: "PYF";
    readonly Qat: "QAT";
    readonly Reu: "REU";
    readonly Rks: "RKS";
    readonly Rou: "ROU";
    readonly Rus: "RUS";
    readonly Rwa: "RWA";
    readonly Sau: "SAU";
    readonly Sdn: "SDN";
    readonly Sen: "SEN";
    readonly Sgp: "SGP";
    readonly Sgs: "SGS";
    readonly Shn: "SHN";
    readonly Sjm: "SJM";
    readonly Slb: "SLB";
    readonly Sle: "SLE";
    readonly Slv: "SLV";
    readonly Smr: "SMR";
    readonly Som: "SOM";
    readonly Spm: "SPM";
    readonly Srb: "SRB";
    readonly Ssd: "SSD";
    readonly Stp: "STP";
    readonly Sur: "SUR";
    readonly Svk: "SVK";
    readonly Svn: "SVN";
    readonly Swe: "SWE";
    readonly Swz: "SWZ";
    readonly Sxm: "SXM";
    readonly Syc: "SYC";
    readonly Syr: "SYR";
    readonly Tca: "TCA";
    readonly Tcd: "TCD";
    readonly Tgo: "TGO";
    readonly Tha: "THA";
    readonly Tjk: "TJK";
    readonly Tkl: "TKL";
    readonly Tkm: "TKM";
    readonly Tls: "TLS";
    readonly Ton: "TON";
    readonly Tto: "TTO";
    readonly Tun: "TUN";
    readonly Tur: "TUR";
    readonly Tuv: "TUV";
    readonly Twn: "TWN";
    readonly Tza: "TZA";
    readonly Uga: "UGA";
    readonly Ukr: "UKR";
    readonly Umi: "UMI";
    readonly Ury: "URY";
    readonly Usa: "USA";
    readonly Uzb: "UZB";
    readonly Vat: "VAT";
    readonly Vct: "VCT";
    readonly Ven: "VEN";
    readonly Vgb: "VGB";
    readonly Vir: "VIR";
    readonly Vnm: "VNM";
    readonly Vut: "VUT";
    readonly Wlf: "WLF";
    readonly Wsm: "WSM";
    readonly Yem: "YEM";
    readonly Zaf: "ZAF";
    readonly Zmb: "ZMB";
    readonly Zwe: "ZWE";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type CountryCodes = typeof CountryCodes[keyof typeof CountryCodes];
export interface DeviceIntelligenceBreakdown {
    'device'?: DeviceIntelligenceBreakdownDevice;
}
/**
 * Asserts whether the device used to upload the media is trustworthy, i.e. it is a real, physical device.
 */
export interface DeviceIntelligenceBreakdownDevice {
    'breakdown'?: DeviceIntelligenceBreakdownDeviceBreakdown;
}
export interface DeviceIntelligenceBreakdownDeviceBreakdown {
    'application_authenticity'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'device_integrity'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'device_reputation'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
}
export interface DeviceIntelligenceProperties {
    'device'?: DeviceIntelligencePropertiesDevice;
    'ip'?: DeviceIntelligencePropertiesIp;
    'geolocation'?: DeviceIntelligencePropertiesGeolocation;
}
export interface DeviceIntelligencePropertiesDevice {
    /**
     * The SDK version that was used.
     */
    'sdk_version'?: string;
    /**
     * The SDK used to upload the media.
     */
    'sdk_source'?: DeviceIntelligencePropertiesDeviceSdkSourceEnum;
    /**
     * The token used to authenticate the request.
     */
    'authentication_type'?: DeviceIntelligencePropertiesDeviceAuthenticationTypeEnum;
    /**
     * The model as set by the phone manufacturer (for Android and iOS) or the browser manufacturer (for Web). The model can be presented in name or number form depending on each manufacturer implementation.
     */
    'raw_model'?: string;
    /**
     * The operating system of the device. The value came from manufacturer implementation (for Android and iOS) or browser\'s user agent (for Web).
     */
    'os'?: string;
    /**
     * The browser name reported by the browser\'s user agent.
     */
    'browser'?: string;
    /**
     * Whether the device is an emulator.
     */
    'emulator'?: boolean;
    /**
     * Whether the device is providing false randomized device and network information.
     */
    'randomized_device'?: boolean;
    /**
     * Counts the number of distinct document reports submitted in the last 24 hours that are associated with the applicant’s IP address.
     */
    'number_of_ip_reuse_reports'?: number;
    /**
     * Counts the number of distinct document reports from the last 24 hours associated with the applicant’s IP address that have a result of suspected and other document integrity or authenticity signals have been flagged.
     */
    'number_of_suspected_ip_reuse_reports'?: number;
    /**
     * Whether device is using stolen security tokens to send the network information.
     */
    'fake_network_request'?: boolean;
    /**
     * Whether there is highly suspicious traffic related to the IP address. The risk depends on the overall ratio of clear checks on a given IP.
     */
    'ip_reputation'?: DeviceIntelligencePropertiesDeviceIpReputationEnum;
    /**
     * The number of times the device was used to create a report for a new applicant. A value greater than 1 indicates potential device reuse.
     */
    'device_fingerprint_reuse'?: number;
    /**
     * Whether the document or biometric media were uploaded from a single device.
     */
    'single_device_used'?: boolean | null;
    /**
     * Whether the document media were live captured from the device camera.
     */
    'document_capture'?: DeviceIntelligencePropertiesDeviceDocumentCaptureEnum;
    /**
     * Whether the biometric media were live captured from the device camera.
     */
    'biometric_capture'?: DeviceIntelligencePropertiesDeviceBiometricCaptureEnum;
}
export declare const DeviceIntelligencePropertiesDeviceSdkSourceEnum: {
    readonly AndroidSdk: "onfido-android-sdk";
    readonly IosSdk: "onfido-ios-sdk";
    readonly WebSdk: "onfido-web-sdk";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type DeviceIntelligencePropertiesDeviceSdkSourceEnum = typeof DeviceIntelligencePropertiesDeviceSdkSourceEnum[keyof typeof DeviceIntelligencePropertiesDeviceSdkSourceEnum];
export declare const DeviceIntelligencePropertiesDeviceAuthenticationTypeEnum: {
    readonly SdkToken: "sdk_token";
    readonly MobileToken: "mobile_token";
    readonly ApiToken: "api_token";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type DeviceIntelligencePropertiesDeviceAuthenticationTypeEnum = typeof DeviceIntelligencePropertiesDeviceAuthenticationTypeEnum[keyof typeof DeviceIntelligencePropertiesDeviceAuthenticationTypeEnum];
export declare const DeviceIntelligencePropertiesDeviceIpReputationEnum: {
    readonly NotEnoughData: "NOT_ENOUGH_DATA";
    readonly HighRisk: "HIGH_RISK";
    readonly LowRisk: "LOW_RISK";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type DeviceIntelligencePropertiesDeviceIpReputationEnum = typeof DeviceIntelligencePropertiesDeviceIpReputationEnum[keyof typeof DeviceIntelligencePropertiesDeviceIpReputationEnum];
export declare const DeviceIntelligencePropertiesDeviceDocumentCaptureEnum: {
    readonly Live: "live";
    readonly UnknownMethod: "unknown_method";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type DeviceIntelligencePropertiesDeviceDocumentCaptureEnum = typeof DeviceIntelligencePropertiesDeviceDocumentCaptureEnum[keyof typeof DeviceIntelligencePropertiesDeviceDocumentCaptureEnum];
export declare const DeviceIntelligencePropertiesDeviceBiometricCaptureEnum: {
    readonly Live: "live";
    readonly UnknownMethod: "unknown_method";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type DeviceIntelligencePropertiesDeviceBiometricCaptureEnum = typeof DeviceIntelligencePropertiesDeviceBiometricCaptureEnum[keyof typeof DeviceIntelligencePropertiesDeviceBiometricCaptureEnum];
export interface DeviceIntelligencePropertiesGeolocation {
    /**
     * City location of the IP address.
     */
    'city'?: string;
    /**
     * Region location of the IP address.
     */
    'region'?: string;
    /**
     * Country location of the IP address in a three letter format.
     */
    'country'?: CountryCodes;
}
export interface DeviceIntelligencePropertiesIp {
    /**
     * The IP address that uploaded the media.
     */
    'address'?: string;
}
export interface DeviceIntelligenceReport {
    /**
     * The unique identifier for the report. Read-only.
     */
    'id': string;
    /**
     * The date and time at which the report was first initiated. Read-only.
     */
    'created_at'?: string;
    /**
     * The API endpoint to retrieve the report. Read-only.
     */
    'href'?: string;
    'status'?: ReportStatus;
    'result'?: ReportResult;
    'sub_result'?: ReportSubResult;
    /**
     * The ID of the check to which the report belongs. Read-only.
     */
    'check_id'?: string;
    'name': ReportName;
    'breakdown'?: DeviceIntelligenceBreakdown;
    'properties'?: DeviceIntelligenceProperties;
}
export interface Document {
    /**
     * The file type of the uploaded file
     */
    'file_type'?: string;
    /**
     * The type of document
     */
    'type'?: DocumentTypes;
    /**
     * The side of the document, if applicable. The possible values are front and back
     */
    'side'?: DocumentSideEnum;
    /**
     * The issuing country of the document, a 3-letter ISO code.
     */
    'issuing_country'?: CountryCodes;
    /**
     * The ID of the applicant whose document is being uploaded.
     */
    'applicant_id'?: string;
    /**
     * The unique identifier for the document
     */
    'id': string;
    /**
     * The date and time at which the document was uploaded
     */
    'created_at'?: string;
    /**
     * The uri of this resource
     */
    'href'?: string;
    /**
     * The uri that can be used to download the document
     */
    'download_href'?: string;
    /**
     * The name of the uploaded file
     */
    'file_name'?: string;
    /**
     * The size of the file in bytes
     */
    'file_size'?: number;
}
export declare const DocumentSideEnum: {
    readonly Front: "front";
    readonly Back: "back";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type DocumentSideEnum = typeof DocumentSideEnum[keyof typeof DocumentSideEnum];
export interface DocumentBreakdown {
    'data_comparison'?: DocumentBreakdownDataComparison;
    'data_validation'?: DocumentBreakdownDataValidation;
    'image_integrity'?: DocumentBreakdownImageIntegrity;
    'visual_authenticity'?: DocumentBreakdownVisualAuthenticity;
    'data_consistency'?: DocumentBreakdownDataConsistency;
    'police_record'?: DocumentBreakdownPoliceRecord;
    'compromised_document'?: DocumentBreakdownCompromisedDocument;
    'age_validation'?: DocumentBreakdownAgeValidation;
    'issuing_authority'?: DocumentBreakdownIssuingAuthority;
}
/**
 * Asserts whether the age calculated from the document\'s date of birth data point is greater than or equal to the minimum accepted age.
 */
export interface DocumentBreakdownAgeValidation {
    'result'?: string;
    'breakdown'?: DocumentBreakdownAgeValidationBreakdown;
}
export interface DocumentBreakdownAgeValidationBreakdown {
    'minimum_accepted_age'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
}
/**
 * Asserts whether the image of the document has been found in our internal database or if it was used in a suspicious way.
 */
export interface DocumentBreakdownCompromisedDocument {
    'result'?: string;
    'breakdown'?: DocumentBreakdownCompromisedDocumentBreakdown;
}
export interface DocumentBreakdownCompromisedDocumentBreakdown {
    'document_database'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'repeat_attempts'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
}
/**
 * Asserts whether data on the document is consistent with data provided when creating an applicant through the API.
 */
export interface DocumentBreakdownDataComparison {
    'result'?: string;
    'breakdown'?: DocumentBreakdownDataComparisonBreakdown;
}
export interface DocumentBreakdownDataComparisonBreakdown {
    'issuing_country'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'gender'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'date_of_expiry'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'last_name'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'document_type'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'document_numbers'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'first_name'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'date_of_birth'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
}
export interface DocumentBreakdownDataComparisonBreakdownIssuingCountry {
    'result'?: string;
    'properties'?: object;
}
/**
 * Asserts whether data represented in multiple places on the document is consistent.
 */
export interface DocumentBreakdownDataConsistency {
    'result'?: string;
    'breakdown'?: DocumentBreakdownDataConsistencyBreakdown;
}
export interface DocumentBreakdownDataConsistencyBreakdown {
    'date_of_expiry'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'document_numbers'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'issuing_country'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'document_type'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'date_of_birth'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'gender'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'first_name'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'nationality'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'last_name'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'multiple_data_sources_present'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
}
/**
 * Asserts whether algorithmically validatable elements are correct.
 */
export interface DocumentBreakdownDataValidation {
    'result'?: string;
    'breakdown'?: DocumentBreakdownDataValidationBreakdown;
}
export interface DocumentBreakdownDataValidationBreakdown {
    'gender'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'date_of_birth'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'document_numbers'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'document_expiration'?: DocumentBreakdownDataValidationBreakdownDocumentExpiration;
    'expiry_date'?: DocumentBreakdownDataValidationBreakdownExpiryDate;
    'mrz'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'barcode'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
}
/**
 * If this is flagged, the document has expired.
 */
export interface DocumentBreakdownDataValidationBreakdownDocumentExpiration {
    'result'?: string;
    'properties'?: object;
}
/**
 * If this is flagged, the expiration date has the incorrect format.
 */
export interface DocumentBreakdownDataValidationBreakdownExpiryDate {
    'result'?: string;
    'properties'?: object;
}
/**
 * Asserts if the document is of sufficient quality to verify.
 */
export interface DocumentBreakdownImageIntegrity {
    'result'?: string;
    'breakdown'?: DocumentBreakdownImageIntegrityBreakdown;
}
export interface DocumentBreakdownImageIntegrityBreakdown {
    'image_quality'?: DocumentBreakdownImageIntegrityBreakdownImageQuality;
    'supported_document'?: DocumentBreakdownImageIntegrityBreakdownSupportedDocument;
    'colour_picture'?: DocumentBreakdownImageIntegrityBreakdownColourPicture;
    'conclusive_document_quality'?: DocumentBreakdownImageIntegrityBreakdownConclusiveDocumentQuality;
}
/**
 * Asserts whether the image was a colour one.
 */
export interface DocumentBreakdownImageIntegrityBreakdownColourPicture {
    'result'?: string;
    'properties'?: object;
}
/**
 * Asserts if the document was of enough quality to be able to perform a fraud inspection.
 */
export interface DocumentBreakdownImageIntegrityBreakdownConclusiveDocumentQuality {
    'result'?: string;
    'properties'?: DocumentCDQReasons;
}
/**
 * Asserts whether the quality of the image was sufficient for processing.
 */
export interface DocumentBreakdownImageIntegrityBreakdownImageQuality {
    'result'?: string;
    'properties'?: DocumentIQReasons;
}
/**
 * Asserts whether the submitted document is supported.
 */
export interface DocumentBreakdownImageIntegrityBreakdownSupportedDocument {
    'result'?: string;
    'properties'?: object;
}
/**
 * Asserts whether data on the document matches the issuing authority data.
 */
export interface DocumentBreakdownIssuingAuthority {
    'result'?: string;
    'breakdown'?: DocumentBreakdownIssuingAuthorityBreakdown;
}
export interface DocumentBreakdownIssuingAuthorityBreakdown {
    'nfc_active_authentication'?: DocumentBreakdownIssuingAuthorityBreakdownNfcActiveAuthentication;
    'nfc_passive_authentication'?: DocumentBreakdownIssuingAuthorityBreakdownNfcPassiveAuthentication;
}
/**
 * Asserts whether the document NFC chip is original or cloned.
 */
export interface DocumentBreakdownIssuingAuthorityBreakdownNfcActiveAuthentication {
    'result'?: string;
    'properties'?: object;
}
/**
 * Asserts whether the document NFC chip data was tampered.
 */
export interface DocumentBreakdownIssuingAuthorityBreakdownNfcPassiveAuthentication {
    'result'?: string;
    'properties'?: object;
}
/**
 * Asserts whether the document had been identified as lost, stolen or otherwise compromised.
 */
export interface DocumentBreakdownPoliceRecord {
    'result'?: string;
}
/**
 * Asserts whether visual, non-textual, elements are correct given the type of document.
 */
export interface DocumentBreakdownVisualAuthenticity {
    'result'?: string;
    'breakdown'?: DocumentBreakdownVisualAuthenticityBreakdown;
}
export interface DocumentBreakdownVisualAuthenticityBreakdown {
    'fonts'?: DocumentBreakdownVisualAuthenticityBreakdownFonts;
    'picture_face_integrity'?: DocumentBreakdownVisualAuthenticityBreakdownPictureFaceIntegrity;
    'template'?: DocumentBreakdownVisualAuthenticityBreakdownTemplate;
    'security_features'?: DocumentBreakdownVisualAuthenticityBreakdownSecurityFeatures;
    'original_document_present'?: DocumentBreakdownVisualAuthenticityBreakdownOriginalDocumentPresent;
    'digital_tampering'?: DocumentBreakdownVisualAuthenticityBreakdownDigitalTampering;
    'other'?: DocumentBreakdownVisualAuthenticityBreakdownOther;
    'face_detection'?: DocumentBreakdownVisualAuthenticityBreakdownFaceDetection;
}
/**
 * Indication of digital tampering in the image.
 */
export interface DocumentBreakdownVisualAuthenticityBreakdownDigitalTampering {
    'result'?: string;
    'properties'?: object;
}
/**
 * No face was detected on the document.
 */
export interface DocumentBreakdownVisualAuthenticityBreakdownFaceDetection {
    'result'?: string;
    'properties'?: object;
}
/**
 * Fonts in the document don\'t match the expected ones.
 */
export interface DocumentBreakdownVisualAuthenticityBreakdownFonts {
    'result'?: string;
    'properties'?: object;
}
/**
 * The document was not present when the photo was taken.
 */
export interface DocumentBreakdownVisualAuthenticityBreakdownOriginalDocumentPresent {
    'result'?: string;
    'properties'?: DocumentODPReasons;
}
/**
 * This sub-breakdown is returned for backward compatibility reasons. Its value will be consider when at least one of the other breakdowns is consider, and clear when all the other breakdowns are clear.
 */
export interface DocumentBreakdownVisualAuthenticityBreakdownOther {
    'result'?: string;
    'properties'?: object;
}
/**
 * The pictures of the person identified on the document show signs of tampering or alteration.
 */
export interface DocumentBreakdownVisualAuthenticityBreakdownPictureFaceIntegrity {
    'result'?: string;
    'properties'?: object;
}
/**
 * Security features expected on the document are missing or wrong.
 */
export interface DocumentBreakdownVisualAuthenticityBreakdownSecurityFeatures {
    'result'?: string;
    'properties'?: object;
}
/**
 * The document doesn\'t match the expected template for the document type and country it is from.
 */
export interface DocumentBreakdownVisualAuthenticityBreakdownTemplate {
    'result'?: string;
    'properties'?: object;
}
export interface DocumentCDQReasons {
    /**
     * When data points are obscured to the point that we cannot confirm if the fonts match the expected ones.
     */
    'obscured_data_points'?: string;
    /**
     * When a critical security feature is obscured. This can also refer to when the holder\'s wet signature, necessary for the document to be valid, is not present.
     */
    'obscured_security_features'?: string;
    /**
     * One of 3 reasons (1) OCR Assisted Scans (i.e. when you\'re able to move the mouse and highlight part of text), (2) Severely Washed out Background, (3) Overlapping Text.
     */
    'abnormal_document_features'?: string;
    /**
     * Any digital text or electronic watermarks on the document.
     */
    'watermarks_digital_text_overlay'?: string;
    /**
     * If the corner has been physically cut off. This can be found on some documents that are no longer valid.
     */
    'corner_removed'?: string;
    /**
     * A punched hole is present.
     */
    'punctured_document'?: string;
    /**
     * When the back of a document is needed for processing, but is not available.
     */
    'missing_back'?: string;
    /**
     * When a document has been published digitally, there aren\'t enough security features to review so we cannot perform a full fraud assessment.
     */
    'digital_document'?: string;
}
export interface DocumentIQReasons {
    /**
     * When an image of the document is too dark to be able to see data points.
     */
    'dark_photo'?: string;
    /**
     * When there is light reflecting on the document causing glare to obstruct data points.
     */
    'glare_on_photo'?: string;
    /**
     * When data points are blurred and no reference can be made elsewhere in the document or if the data points are too blurry and \'they could be something else\'.
     */
    'blurred_photo'?: string;
    /**
     * When data points have been covered either by the applicant or by another object such as a sticker.
     */
    'covered_photo'?: string;
    /**
     * Any other reason not listed, such as when holograms are obscuring data points.
     */
    'other_photo_issue'?: string;
    /**
     * When a document is damaged and we are unable to make out data points.
     */
    'damaged_document'?: string;
    /**
     * When the incorrect side of a document has been uploaded, and we have not received the front.
     */
    'incorrect_side'?: string;
    /**
     * When data points are not included in the image due to the document being cut off.
     */
    'cut_off_document'?: string;
    /**
     * If no document has been uploaded or there is a blank image.
     */
    'no_document_in_image'?: string;
    /**
     * When 2 different documents are submitted in the same check.
     */
    'two_documents_uploaded'?: string;
}
export interface DocumentODPReasons {
    /**
     * When the applicant\'s document is on a physical screen or device.
     */
    'photo_of_screen'?: string;
    /**
     * When the applicant has used their mobile phone, tablet, or computer to take a photo within the device.
     */
    'screenshot'?: string;
    /**
     * When the applicant has previously captured an image of the document, printed it out, and has now taken a photo of this print out to upload.
     */
    'document_on_printed_paper'?: string;
    /**
     * When the document has clearly been captured using a scanner and there are visible indicators of this
     */
    'scan'?: string;
}
export interface DocumentProperties {
    'date_of_birth'?: string;
    'date_of_expiry'?: string;
    'personal_number'?: string;
    'document_numbers'?: Array<DocumentPropertiesDocumentNumbersInner>;
    'document_type'?: string;
    'first_name'?: string;
    'middle_name'?: string;
    'last_name'?: string;
    'gender'?: string;
    'issuing_country'?: string;
    'nationality'?: string;
    'issuing_state'?: string;
    'issuing_date'?: string;
    'valid_from'?: string;
    'categorisation'?: string;
    'mrz_line1'?: string;
    'mrz_line2'?: string;
    'mrz_line3'?: string;
    'address'?: string;
    'place_of_birth'?: string;
    'spouse_name'?: string;
    'widow_name'?: string;
    'alias_name'?: string;
    'issuing_authority'?: string;
    'remarks'?: string;
    'civil_state'?: string;
    'expatriation'?: string;
    'father_name'?: string;
    'mother_name'?: string;
    'religion'?: string;
    'type_of_permit'?: string;
    'version_number'?: string;
    'document_subtype'?: string;
    'profession'?: string;
    'security_document_number'?: string;
    'tax_number'?: string;
    'nist_identity_evidence_strength'?: DocumentPropertiesNistIdentityEvidenceStrengthEnum;
    'has_issuance_confirmation'?: DocumentPropertiesHasIssuanceConfirmationEnum;
    'real_id_compliance'?: boolean;
    'security_tier'?: DocumentPropertiesSecurityTierEnum;
    'address_lines'?: DocumentPropertiesAddressLines;
    'barcode'?: Array<DocumentPropertiesBarcodeInner>;
    'nfc'?: DocumentPropertiesNfc;
    'document_classification'?: DocumentPropertiesDocumentClassification;
    'extracted_data'?: DocumentPropertiesExtractedData;
}
export declare const DocumentPropertiesNistIdentityEvidenceStrengthEnum: {
    readonly Superior: "superior";
    readonly Strong: "strong";
    readonly Fair: "fair";
    readonly Weak: "weak";
    readonly Unacceptable: "unacceptable";
    readonly UnspecifiedIdentityEvidenceStrength: "unspecified_identity_evidence_strength";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type DocumentPropertiesNistIdentityEvidenceStrengthEnum = typeof DocumentPropertiesNistIdentityEvidenceStrengthEnum[keyof typeof DocumentPropertiesNistIdentityEvidenceStrengthEnum];
export declare const DocumentPropertiesHasIssuanceConfirmationEnum: {
    readonly True: "true";
    readonly False: "false";
    readonly Unspecified: "unspecified";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type DocumentPropertiesHasIssuanceConfirmationEnum = typeof DocumentPropertiesHasIssuanceConfirmationEnum[keyof typeof DocumentPropertiesHasIssuanceConfirmationEnum];
export declare const DocumentPropertiesSecurityTierEnum: {
    readonly Tier1: "tier_1";
    readonly Tier2: "tier_2";
    readonly Tier3: "tier_3";
    readonly Tier4: "tier_4";
    readonly Tier5: "tier_5";
    readonly UnspecifiedSecurityTier: "unspecified_security_tier";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type DocumentPropertiesSecurityTierEnum = typeof DocumentPropertiesSecurityTierEnum[keyof typeof DocumentPropertiesSecurityTierEnum];
export interface DocumentPropertiesAddressLines {
    'street_address'?: string;
    'state'?: string;
    'postal_code'?: string;
    'country'?: string;
    'city'?: string;
    'country_code'?: string;
}
export interface DocumentPropertiesBarcodeInner {
    'first_name'?: string;
    'middle_name'?: string;
    'last_name'?: string;
    'document_type'?: string;
    'date_of_expiry'?: string;
    'date_of_birth'?: string;
    'issuing_date'?: string;
    'address_line_1'?: string;
    'address_line_2'?: string;
    'address_line_3'?: string;
    'address_line_4'?: string;
    'address_line_5'?: string;
    'issuing_state'?: string;
    'class'?: string;
    'gender'?: string;
    'issuing_country'?: string;
    'document_number'?: string;
    'real_id_classification'?: string;
}
export interface DocumentPropertiesDocumentClassification {
    'issuing_country'?: string;
    'document_type'?: string;
    'issuing_state'?: string;
}
export interface DocumentPropertiesDocumentNumbersInner {
    'value'?: string;
    'type'?: string;
}
export interface DocumentPropertiesDrivingLicenceInformationItem {
    'category'?: string;
    'obtainment_date'?: string;
    'expiry_date'?: string;
    'codes'?: string;
}
export interface DocumentPropertiesExtractedData {
    'document_number'?: string;
    'date_of_birth'?: string;
    'date_of_expiry'?: string;
    'first_name'?: string;
    'last_name'?: string;
    'middle_name'?: string;
    'full_name'?: string;
    'spouse_name'?: string;
    'widow_name'?: string;
    'alias_name'?: string;
    'gender'?: string;
    'mrz_line1'?: string;
    'mrz_line2'?: string;
    'mrz_line3'?: string;
    'nationality'?: string;
    'address_line_1'?: string;
    'address_line_2'?: string;
    'address_line_3'?: string;
    'address_line_4'?: string;
    'address_line_5'?: string;
    'issuing_authority'?: string;
}
export interface DocumentPropertiesNfc {
    'document_type'?: string;
    'issuing_country'?: string;
    'full_name'?: string;
    'document_number'?: string;
    'nationality'?: string;
    'date_of_birth'?: string;
    'gender'?: string;
    'date_of_expiry'?: string;
    'personal_number'?: string;
    'place_of_birth'?: string;
    'address'?: string;
    'issuing_date'?: string;
    'issuing_authority'?: string;
}
export interface DocumentPropertiesWithDrivingLicenceInformation {
    'date_of_birth'?: string;
    'date_of_expiry'?: string;
    'personal_number'?: string;
    'document_numbers'?: Array<DocumentPropertiesDocumentNumbersInner>;
    'document_type'?: string;
    'first_name'?: string;
    'middle_name'?: string;
    'last_name'?: string;
    'gender'?: string;
    'issuing_country'?: string;
    'nationality'?: string;
    'issuing_state'?: string;
    'issuing_date'?: string;
    'valid_from'?: string;
    'categorisation'?: string;
    'mrz_line1'?: string;
    'mrz_line2'?: string;
    'mrz_line3'?: string;
    'address'?: string;
    'place_of_birth'?: string;
    'spouse_name'?: string;
    'widow_name'?: string;
    'alias_name'?: string;
    'issuing_authority'?: string;
    'remarks'?: string;
    'civil_state'?: string;
    'expatriation'?: string;
    'father_name'?: string;
    'mother_name'?: string;
    'religion'?: string;
    'type_of_permit'?: string;
    'version_number'?: string;
    'document_subtype'?: string;
    'profession'?: string;
    'security_document_number'?: string;
    'tax_number'?: string;
    'nist_identity_evidence_strength'?: DocumentPropertiesWithDrivingLicenceInformationNistIdentityEvidenceStrengthEnum;
    'has_issuance_confirmation'?: DocumentPropertiesWithDrivingLicenceInformationHasIssuanceConfirmationEnum;
    'real_id_compliance'?: boolean;
    'security_tier'?: DocumentPropertiesWithDrivingLicenceInformationSecurityTierEnum;
    'address_lines'?: DocumentPropertiesAddressLines;
    'barcode'?: Array<DocumentPropertiesBarcodeInner>;
    'nfc'?: DocumentPropertiesNfc;
    'document_classification'?: DocumentPropertiesDocumentClassification;
    'extracted_data'?: DocumentPropertiesExtractedData;
    'driving_licence_information'?: Array<DocumentPropertiesDrivingLicenceInformationItem>;
}
export declare const DocumentPropertiesWithDrivingLicenceInformationNistIdentityEvidenceStrengthEnum: {
    readonly Superior: "superior";
    readonly Strong: "strong";
    readonly Fair: "fair";
    readonly Weak: "weak";
    readonly Unacceptable: "unacceptable";
    readonly UnspecifiedIdentityEvidenceStrength: "unspecified_identity_evidence_strength";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type DocumentPropertiesWithDrivingLicenceInformationNistIdentityEvidenceStrengthEnum = typeof DocumentPropertiesWithDrivingLicenceInformationNistIdentityEvidenceStrengthEnum[keyof typeof DocumentPropertiesWithDrivingLicenceInformationNistIdentityEvidenceStrengthEnum];
export declare const DocumentPropertiesWithDrivingLicenceInformationHasIssuanceConfirmationEnum: {
    readonly True: "true";
    readonly False: "false";
    readonly Unspecified: "unspecified";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type DocumentPropertiesWithDrivingLicenceInformationHasIssuanceConfirmationEnum = typeof DocumentPropertiesWithDrivingLicenceInformationHasIssuanceConfirmationEnum[keyof typeof DocumentPropertiesWithDrivingLicenceInformationHasIssuanceConfirmationEnum];
export declare const DocumentPropertiesWithDrivingLicenceInformationSecurityTierEnum: {
    readonly Tier1: "tier_1";
    readonly Tier2: "tier_2";
    readonly Tier3: "tier_3";
    readonly Tier4: "tier_4";
    readonly Tier5: "tier_5";
    readonly UnspecifiedSecurityTier: "unspecified_security_tier";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type DocumentPropertiesWithDrivingLicenceInformationSecurityTierEnum = typeof DocumentPropertiesWithDrivingLicenceInformationSecurityTierEnum[keyof typeof DocumentPropertiesWithDrivingLicenceInformationSecurityTierEnum];
export interface DocumentReport {
    /**
     * The unique identifier for the report. Read-only.
     */
    'id': string;
    /**
     * The date and time at which the report was first initiated. Read-only.
     */
    'created_at'?: string;
    /**
     * The API endpoint to retrieve the report. Read-only.
     */
    'href'?: string;
    'status'?: ReportStatus;
    'result'?: ReportResult;
    'sub_result'?: ReportSubResult;
    /**
     * The ID of the check to which the report belongs. Read-only.
     */
    'check_id'?: string;
    'name': ReportName;
    /**
     * Array of objects with document ids that were used in the Onfido engine.
     */
    'documents'?: Array<ReportDocument>;
    'breakdown'?: DocumentBreakdown;
    'properties'?: DocumentProperties;
}
export interface DocumentReportShared {
    /**
     * Array of objects with document ids that were used in the Onfido engine.
     */
    'documents'?: Array<ReportDocument>;
}
export interface DocumentResponse {
    /**
     * The unique identifier for the document
     */
    'id': string;
    /**
     * The date and time at which the document was uploaded
     */
    'created_at'?: string;
    /**
     * The uri of this resource
     */
    'href'?: string;
    /**
     * The uri that can be used to download the document
     */
    'download_href'?: string;
    /**
     * The name of the uploaded file
     */
    'file_name'?: string;
    /**
     * The size of the file in bytes
     */
    'file_size'?: number;
}
export interface DocumentShared {
    /**
     * The file type of the uploaded file
     */
    'file_type'?: string;
    /**
     * The type of document
     */
    'type'?: DocumentTypes;
    /**
     * The side of the document, if applicable. The possible values are front and back
     */
    'side'?: DocumentSharedSideEnum;
    /**
     * The issuing country of the document, a 3-letter ISO code.
     */
    'issuing_country'?: CountryCodes;
    /**
     * The ID of the applicant whose document is being uploaded.
     */
    'applicant_id'?: string;
}
export declare const DocumentSharedSideEnum: {
    readonly Front: "front";
    readonly Back: "back";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type DocumentSharedSideEnum = typeof DocumentSharedSideEnum[keyof typeof DocumentSharedSideEnum];
export declare const DocumentTypes: {
    readonly Passport: "passport";
    readonly DrivingLicence: "driving_licence";
    readonly NationalIdentityCard: "national_identity_card";
    readonly ResidencePermit: "residence_permit";
    readonly PassportCard: "passport_card";
    readonly TaxId: "tax_id";
    readonly Visa: "visa";
    readonly VoterId: "voter_id";
    readonly ResidenceStatusDocument: "residence_status_document";
    readonly PostalIdentityCard: "postal_identity_card";
    readonly SocialSecurityCard: "social_security_card";
    readonly WorkPermit: "work_permit";
    readonly AsylumRegistrationCard: "asylum_registration_card";
    readonly NationalHealthInsuranceCard: "national_health_insurance_card";
    readonly MunicipalityIdentityCard: "municipality_identity_card";
    readonly PrivateOperatorsCard: "private_operators_card";
    readonly ProofOfCitizenship: "proof_of_citizenship";
    readonly ServiceIdCard: "service_id_card";
    readonly ImmigrationStatusDocument: "immigration_status_document";
    readonly IndigenousCard: "indigenous_card";
    readonly VehicleRegistrationCard: "vehicle_registration_card";
    readonly CertificateOfNaturalisation: "certificate_of_naturalisation";
    readonly ProfessionalQualificationCard: "professional_qualification_card";
    readonly ConsularId: "consular_id";
    readonly InternationalDrivingLicence: "international_driving_licence";
    readonly HomeOfficeLetter: "home_office_letter";
    readonly BirthCertificate: "birth_certificate";
    readonly VehicleRegistrationCertificate: "vehicle_registration_certificate";
    readonly FormForAffixingTheVisa: "form_for_affixing_the_visa";
    readonly IdentificationNumberDocument: "identification_number_document";
    readonly AdoptionCertificate: "adoption_certificate";
    readonly BankBuildingSocietyStatement: "bank_building_society_statement";
    readonly BankStatement: "bank_statement";
    readonly BenefitLetters: "benefit_letters";
    readonly Cbt: "cbt";
    readonly CertificateOfSponsorship: "certificate_of_sponsorship";
    readonly CharacterReference: "character_reference";
    readonly CivilPartnershipCertificate: "civil_partnership_certificate";
    readonly CouncilTax: "council_tax";
    readonly CreditCardStatement: "credit_card_statement";
    readonly DeedPoll: "deed_poll";
    readonly DivorceAbsoluteDecree: "divorce_absolute_decree";
    readonly EducationalStatement: "educational_statement";
    readonly ElectricityBill: "electricity_bill";
    readonly GasBill: "gas_bill";
    readonly GovernmentLetter: "government_letter";
    readonly InternetBill: "internet_bill";
    readonly MarriageCertificate: "marriage_certificate";
    readonly MotorcycleInsurance: "motorcycle_insurance";
    readonly NationalInsuranceCard: "national_insurance_card";
    readonly NaturalisationCertificate: "naturalisation_certificate";
    readonly NonUkDrivingLicence: "non_uk_driving_licence";
    readonly P45P60: "p45_p60";
    readonly Payslip: "payslip";
    readonly PhoneBill: "phone_bill";
    readonly ProfessionalIdentificationCard: "professional_identification_card";
    readonly RightToWorkShareCodeResult: "right_to_work_share_code_result";
    readonly StatementFact: "statement_fact";
    readonly T4StudentUniversityTermDatesEvidence: "t4_student_university_term_dates_evidence";
    readonly UkBiometricResidencePermit: "uk_biometric_residence_permit";
    readonly UkDrivingLicence: "uk_driving_licence";
    readonly Unknown: "unknown";
    readonly UtilityBill: "utility_bill";
    readonly UtilityBillElectric: "utility_bill_electric";
    readonly UtilityBillGas: "utility_bill_gas";
    readonly UtilityBillOther: "utility_bill_other";
    readonly WaterBill: "water_bill";
    readonly AddressCertificate: "address_certificate";
    readonly GeneralLetter: "general_letter";
    readonly InsuranceStatement: "insurance_statement";
    readonly PensionPropertyStatementLetter: "pension_property_statement_letter";
    readonly MortgageStatement: "mortgage_statement";
    readonly MobilePhoneBill: "mobile_phone_bill";
    readonly IdentityDocumentWithAddress: "identity_document_with_address";
    readonly ExchangeHouseStatement: "exchange_house_statement";
    readonly AccommodationTenancyCertificate: "accommodation_tenancy_certificate";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type DocumentTypes = typeof DocumentTypes[keyof typeof DocumentTypes];
export interface DocumentVideoReport {
    /**
     * The unique identifier for the report. Read-only.
     */
    'id': string;
    /**
     * The date and time at which the report was first initiated. Read-only.
     */
    'created_at'?: string;
    /**
     * The API endpoint to retrieve the report. Read-only.
     */
    'href'?: string;
    'status'?: ReportStatus;
    'result'?: ReportResult;
    'sub_result'?: ReportSubResult;
    /**
     * The ID of the check to which the report belongs. Read-only.
     */
    'check_id'?: string;
    'name': ReportName;
    /**
     * Array of objects with document ids that were used in the Onfido engine.
     */
    'documents'?: Array<ReportDocument>;
    'breakdown'?: DocumentBreakdown;
    'properties'?: DocumentProperties;
}
export interface DocumentVideoWithAddressInformationReport {
    /**
     * The unique identifier for the report. Read-only.
     */
    'id': string;
    /**
     * The date and time at which the report was first initiated. Read-only.
     */
    'created_at'?: string;
    /**
     * The API endpoint to retrieve the report. Read-only.
     */
    'href'?: string;
    'status'?: ReportStatus;
    'result'?: ReportResult;
    'sub_result'?: ReportSubResult;
    /**
     * The ID of the check to which the report belongs. Read-only.
     */
    'check_id'?: string;
    'name': ReportName;
    /**
     * Array of objects with document ids that were used in the Onfido engine.
     */
    'documents'?: Array<ReportDocument>;
    'breakdown'?: DocumentBreakdown;
    'properties'?: DocumentProperties;
}
export interface DocumentWithAddressInformationReport {
    /**
     * The unique identifier for the report. Read-only.
     */
    'id': string;
    /**
     * The date and time at which the report was first initiated. Read-only.
     */
    'created_at'?: string;
    /**
     * The API endpoint to retrieve the report. Read-only.
     */
    'href'?: string;
    'status'?: ReportStatus;
    'result'?: ReportResult;
    'sub_result'?: ReportSubResult;
    /**
     * The ID of the check to which the report belongs. Read-only.
     */
    'check_id'?: string;
    'name': ReportName;
    /**
     * Array of objects with document ids that were used in the Onfido engine.
     */
    'documents'?: Array<ReportDocument>;
    'breakdown'?: DocumentBreakdown;
    'properties'?: DocumentProperties;
}
export interface DocumentWithDriverVerificationReport {
    /**
     * The unique identifier for the report. Read-only.
     */
    'id': string;
    /**
     * The date and time at which the report was first initiated. Read-only.
     */
    'created_at'?: string;
    /**
     * The API endpoint to retrieve the report. Read-only.
     */
    'href'?: string;
    'status'?: ReportStatus;
    'result'?: ReportResult;
    'sub_result'?: ReportSubResult;
    /**
     * The ID of the check to which the report belongs. Read-only.
     */
    'check_id'?: string;
    'name': ReportName;
    /**
     * Array of objects with document ids that were used in the Onfido engine.
     */
    'documents'?: Array<ReportDocument>;
    'breakdown'?: DocumentBreakdown;
    'properties'?: DocumentWithDriverVerificationReportAllOfProperties;
}
export interface DocumentWithDriverVerificationReportAllOfProperties {
    'date_of_birth'?: string;
    'date_of_expiry'?: string;
    'personal_number'?: string;
    'document_numbers'?: Array<DocumentPropertiesDocumentNumbersInner>;
    'document_type'?: string;
    'first_name'?: string;
    'middle_name'?: string;
    'last_name'?: string;
    'gender'?: string;
    'issuing_country'?: string;
    'nationality'?: string;
    'issuing_state'?: string;
    'issuing_date'?: string;
    'valid_from'?: string;
    'categorisation'?: string;
    'mrz_line1'?: string;
    'mrz_line2'?: string;
    'mrz_line3'?: string;
    'address'?: string;
    'place_of_birth'?: string;
    'spouse_name'?: string;
    'widow_name'?: string;
    'alias_name'?: string;
    'issuing_authority'?: string;
    'remarks'?: string;
    'civil_state'?: string;
    'expatriation'?: string;
    'father_name'?: string;
    'mother_name'?: string;
    'religion'?: string;
    'type_of_permit'?: string;
    'version_number'?: string;
    'document_subtype'?: string;
    'profession'?: string;
    'security_document_number'?: string;
    'tax_number'?: string;
    'nist_identity_evidence_strength'?: DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum;
    'has_issuance_confirmation'?: DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum;
    'real_id_compliance'?: boolean;
    'security_tier'?: DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum;
    'address_lines'?: DocumentPropertiesAddressLines;
    'barcode'?: Array<DocumentPropertiesBarcodeInner>;
    'nfc'?: DocumentPropertiesNfc;
    'document_classification'?: DocumentPropertiesDocumentClassification;
    'extracted_data'?: DocumentPropertiesExtractedData;
    /**
     * True for **non-restricted** driving licences
     */
    'drivers_licence'?: boolean;
    /**
     * True for **limited/restricted** driving license, including learner\'s permits
     */
    'restricted_licence'?: boolean;
    /**
     * Underlying, non-normalised, licence category (e.g. \"Junior operators license\")
     */
    'raw_licence_category'?: string;
    /**
     * Comma-separated vehicle classes that the user is qualified for
     */
    'raw_vehicle_classes'?: string;
    /**
     * True if the user is not qualified to drive a manual transmission
     */
    'manual_transmission_restriction'?: boolean;
    /**
     * Detailed classes/categories information
     */
    'vehicle_class_details'?: Array<DocumentWithDriverVerificationReportAllOfPropertiesAllOfVehicleClassDetailsInner>;
    'passenger_vehicle'?: DocumentWithDriverVerificationReportAllOfPropertiesAllOfPassengerVehicle;
}
export declare const DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum: {
    readonly Superior: "superior";
    readonly Strong: "strong";
    readonly Fair: "fair";
    readonly Weak: "weak";
    readonly Unacceptable: "unacceptable";
    readonly UnspecifiedIdentityEvidenceStrength: "unspecified_identity_evidence_strength";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum = typeof DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum[keyof typeof DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum];
export declare const DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum: {
    readonly True: "true";
    readonly False: "false";
    readonly Unspecified: "unspecified";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum = typeof DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum[keyof typeof DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum];
export declare const DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum: {
    readonly Tier1: "tier_1";
    readonly Tier2: "tier_2";
    readonly Tier3: "tier_3";
    readonly Tier4: "tier_4";
    readonly Tier5: "tier_5";
    readonly UnspecifiedSecurityTier: "unspecified_security_tier";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum = typeof DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum[keyof typeof DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum];
/**
 * Normalised data for passenger cars
 */
export interface DocumentWithDriverVerificationReportAllOfPropertiesAllOfPassengerVehicle {
    /**
     * Whether they are qualified for a passenger car, such as a “B” class in the UK
     */
    'is_qualified'?: boolean;
    /**
     * Date the class qualification was obtained
     */
    'obtainment_date'?: string;
    /**
     * Date the class qualification expires, which may be different to doc expiry
     */
    'expiry_date'?: string;
}
export interface DocumentWithDriverVerificationReportAllOfPropertiesAllOfVehicleClassDetailsInner {
    /**
     * Vehicle class/category
     */
    'category'?: string;
    /**
     * Special conditions driver must meet
     */
    'codes'?: string;
    /**
     * Category obtainment date
     */
    'obtainment_date'?: string;
    /**
     * Category expiry date
     */
    'expiry_date'?: string;
}
export interface DocumentWithDrivingLicenceInformationReport {
    /**
     * The unique identifier for the report. Read-only.
     */
    'id': string;
    /**
     * The date and time at which the report was first initiated. Read-only.
     */
    'created_at'?: string;
    /**
     * The API endpoint to retrieve the report. Read-only.
     */
    'href'?: string;
    'status'?: ReportStatus;
    'result'?: ReportResult;
    'sub_result'?: ReportSubResult;
    /**
     * The ID of the check to which the report belongs. Read-only.
     */
    'check_id'?: string;
    'name': ReportName;
    /**
     * Array of objects with document ids that were used in the Onfido engine.
     */
    'documents'?: Array<ReportDocument>;
    'breakdown'?: DocumentBreakdown;
    'properties'?: DocumentPropertiesWithDrivingLicenceInformation;
}
export interface DocumentsList {
    'documents': Array<Document>;
}
export interface Error1 {
    /**
     * The unique identifier of the uploaded document
     */
    'document_id'?: string;
    'error'?: ErrorProperties1;
}
export interface ErrorProperties {
    'type'?: string;
    'message'?: string;
    'fields'?: {
        [key: string]: any;
    };
}
export interface ErrorProperties1 {
    'type'?: string;
    'message'?: string;
}
export interface ExtractRequest {
    /**
     * The unique identifier of the uploaded document to run extraction on
     */
    'document_id': string;
}
export interface Extraction {
    /**
     * The unique identifier of the uploaded document.
     */
    'document_id'?: string;
    'document_classification'?: ExtractionDocumentClassification;
    'extracted_data'?: ExtractionExtractedData;
}
export interface ExtractionDocumentClassification {
    /**
     * Document country in 3-letter ISO code.
     */
    'issuing_country'?: CountryCodes;
    /**
     * Type of document.
     */
    'document_type'?: DocumentTypes;
    /**
     * The state that issued the document (if available).
     */
    'issuing_state'?: string;
    /**
     * The document subtype (if available).
     */
    'subtype'?: ExtractionDocumentClassificationSubtypeEnum;
    /**
     * The document issuing version (if available).
     */
    'version'?: string;
}
export declare const ExtractionDocumentClassificationSubtypeEnum: {
    readonly Spe: "SPE";
    readonly Ali: "ali";
    readonly Alien: "alien";
    readonly Com: "com";
    readonly Commercial: "commercial";
    readonly Dom: "dom";
    readonly Domestic: "domestic";
    readonly Full: "full";
    readonly NotFull: "not_full";
    readonly FullDrivingLicence: "full driving licence";
    readonly HeavyVehicle: "heavy_vehicle";
    readonly Learner: "learner";
    readonly MinorU21OrU18: "minor (u21 or u18)";
    readonly Mot: "mot";
    readonly Mul: "mul";
    readonly Provisional: "provisional";
    readonly ProvisionalDrivingLicence: "provisional driving licence";
    readonly Ser: "ser";
    readonly Spe2: "spe";
    readonly Special: "special";
    readonly Standard: "standard";
    readonly Tem: "tem";
    readonly U21: "u21";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type ExtractionDocumentClassificationSubtypeEnum = typeof ExtractionDocumentClassificationSubtypeEnum[keyof typeof ExtractionDocumentClassificationSubtypeEnum];
export interface ExtractionExtractedData {
    /**
     * The official document number.
     */
    'document_number'?: string;
    /**
     * First name.
     */
    'first_name'?: string;
    /**
     * Last name.
     */
    'last_name'?: string;
    /**
     * Full name.
     */
    'full_name'?: string;
    /**
     * Spouse name (French documents only).
     */
    'spouse_name'?: string;
    /**
     * Widow name (French documents only).
     */
    'widow_name'?: string;
    /**
     * Alias name (French documents only).
     */
    'alias_name'?: string;
    /**
     * Gender (Valid values are Male and Female).
     */
    'gender'?: ExtractionExtractedDataGenderEnum;
    /**
     * Date of birth in YYYY-MM-DD format.
     */
    'date_of_birth'?: string;
    /**
     * Date of expiry in YYYY-MM-DD format.
     */
    'date_of_expiry'?: string;
    /**
     * Date of expiry in YYYY-MM-DD format.
     */
    'expiry_date'?: string;
    /**
     * Nationality in 3-letter ISO code.
     */
    'nationality'?: string;
    /**
     * Line 1 of the MRZ code.
     */
    'mrz_line_1'?: string;
    /**
     * Line 2 of the MRZ code.
     */
    'mrz_line_2'?: string;
    /**
     * Line 3 of the MRZ code.
     */
    'mrz_line_3'?: string;
    /**
     * Line 1 of the address.
     */
    'address_1'?: string;
    /**
     * Line 2 of the address.
     */
    'address_2'?: string;
    /**
     * Line 3 of the address.
     */
    'address_3'?: string;
    /**
     * Line 4 of the address.
     */
    'address_4'?: string;
    /**
     * Line 5 of the address.
     */
    'address_5'?: string;
    /**
     * Issuing authority.
     */
    'issuing_authority'?: string;
    /**
     * Document country in 3-letter ISO code.
     */
    'issuing_country'?: CountryCodes;
    /**
     * Type of document.
     */
    'document_type'?: DocumentTypes;
    /**
     * Place of birth.
     */
    'place_of_birth'?: string;
    /**
     * The state that issued the document.
     */
    'issuing_state'?: string;
    /**
     * Issuing date in YYYY-MM-DD format.
     */
    'issuing_date'?: string;
    /**
     * The owner\'s unique identification number.
     */
    'personal_number'?: string;
}
export declare const ExtractionExtractedDataGenderEnum: {
    readonly Male: "Male";
    readonly Female: "Female";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type ExtractionExtractedDataGenderEnum = typeof ExtractionExtractedDataGenderEnum[keyof typeof ExtractionExtractedDataGenderEnum];
export interface FacialSimilarityMotionBreakdown {
    'face_comparison'?: FacialSimilarityMotionBreakdownFaceComparison;
    'image_integrity'?: FacialSimilarityMotionBreakdownImageIntegrity;
    'visual_authenticity'?: FacialSimilarityMotionBreakdownVisualAuthenticity;
}
/**
 * Asserts whether the face in the document matches the face in the motion capture.
 */
export interface FacialSimilarityMotionBreakdownFaceComparison {
    'result'?: string;
    'breakdown'?: FacialSimilarityPhotoBreakdownFaceComparisonBreakdown;
}
/**
 * Asserts whether the quality and integrity of the uploaded files were sufficient to perform a face comparison.
 */
export interface FacialSimilarityMotionBreakdownImageIntegrity {
    'result'?: string;
    'breakdown'?: FacialSimilarityMotionBreakdownImageIntegrityBreakdown;
}
export interface FacialSimilarityMotionBreakdownImageIntegrityBreakdown {
    'face_detected'?: FacialSimilarityMotionBreakdownImageIntegrityBreakdownFaceDetected;
    'source_integrity'?: FacialSimilarityMotionBreakdownImageIntegrityBreakdownSourceIntegrity;
}
/**
 * Asserts a single face of good enough quality has been found in both the document image and in the motion capture.
 */
export interface FacialSimilarityMotionBreakdownImageIntegrityBreakdownFaceDetected {
    'result'?: string;
    'properties'?: object;
}
/**
 * Asserts whether the motion capture is trustworthy - e.g. not from a fake webcam.
 */
export interface FacialSimilarityMotionBreakdownImageIntegrityBreakdownSourceIntegrity {
    'result'?: string;
    'properties'?: VideoReasons;
}
/**
 * Asserts whether the person in the motion capture is real (not a spoof) and live.
 */
export interface FacialSimilarityMotionBreakdownVisualAuthenticity {
    'result'?: string;
    'breakdown'?: FacialSimilarityMotionBreakdownVisualAuthenticityBreakdown;
}
export interface FacialSimilarityMotionBreakdownVisualAuthenticityBreakdown {
    'liveness_detected'?: FacialSimilarityVideoBreakdownVisualAuthenticityBreakdownLivenessDetected;
    'spoofing_detection'?: FacialSimilarityMotionBreakdownVisualAuthenticityBreakdownSpoofingDetection;
}
/**
 * Asserts whether the motion capture is not a spoof (such as videos of digital screens).
 */
export interface FacialSimilarityMotionBreakdownVisualAuthenticityBreakdownSpoofingDetection {
    'result'?: string;
    'properties'?: FacialSimilarityPhotoBreakdownVisualAuthenticityBreakdownSpoofingDetectionProperties;
}
export interface FacialSimilarityMotionProperties {
    /**
     * A floating point number between 0 and 1. The closer the score is to 0, the more likely it is to be a spoof (i.e. videos of digital screens, masks or print-outs). Conversely, the closer it is to 1, the less likely it is to be a spoof.
     */
    'score'?: number;
}
export interface FacialSimilarityMotionReport {
    /**
     * The unique identifier for the report. Read-only.
     */
    'id': string;
    /**
     * The date and time at which the report was first initiated. Read-only.
     */
    'created_at'?: string;
    /**
     * The API endpoint to retrieve the report. Read-only.
     */
    'href'?: string;
    'status'?: ReportStatus;
    'result'?: ReportResult;
    'sub_result'?: ReportSubResult;
    /**
     * The ID of the check to which the report belongs. Read-only.
     */
    'check_id'?: string;
    'name': ReportName;
    /**
     * Array of objects with document ids that were used in the Onfido engine.
     */
    'documents'?: Array<ReportDocument>;
    /**
     * Array of objects with live photo ids that were used in the Onfido engine.
     */
    'live_photos'?: Array<FacialSimilarityReportMedia>;
    /**
     * Array of objects with live video ids that were used in the Onfido engine.
     */
    'live_videos'?: Array<FacialSimilarityReportMedia>;
    /**
     * Array of objects with motion capture ids that were used in the Onfido engine.
     */
    'motion_captures'?: Array<FacialSimilarityReportMedia>;
    /**
     * Array of objects with id photo ids that were used in the Onfido engine.
     */
    'id_photos'?: Array<FacialSimilarityReportMedia>;
    'breakdown'?: FacialSimilarityMotionBreakdown;
    'properties'?: FacialSimilarityMotionProperties;
}
export interface FacialSimilarityPhotoBreakdown {
    'face_comparison'?: FacialSimilarityPhotoBreakdownFaceComparison;
    'image_integrity'?: FacialSimilarityPhotoBreakdownImageIntegrity;
    'visual_authenticity'?: FacialSimilarityPhotoBreakdownVisualAuthenticity;
}
/**
 * Asserts whether the face in the document matches the face in the live photo.
 */
export interface FacialSimilarityPhotoBreakdownFaceComparison {
    'result'?: string;
    'breakdown'?: FacialSimilarityPhotoBreakdownFaceComparisonBreakdown;
}
export interface FacialSimilarityPhotoBreakdownFaceComparisonBreakdown {
    'face_match'?: FacialSimilarityPhotoBreakdownFaceComparisonBreakdownFaceMatch;
}
/**
 * Contains a score value under the properties bag.
 */
export interface FacialSimilarityPhotoBreakdownFaceComparisonBreakdownFaceMatch {
    'result'?: string;
    'properties'?: FacialSimilarityPhotoBreakdownFaceComparisonBreakdownFaceMatchProperties;
}
export interface FacialSimilarityPhotoBreakdownFaceComparisonBreakdownFaceMatchProperties {
    /**
     * A floating point number between 0 and 1 that expresses how similar the two faces are, where 1 is a perfect match.
     */
    'score'?: number;
    /**
     * The UUID for the document containing the extracted face that was used for face matching.
     */
    'document_id'?: string;
}
/**
 * Asserts whether the quality and integrity of the uploaded files were sufficient to perform a face comparison.
 */
export interface FacialSimilarityPhotoBreakdownImageIntegrity {
    'result'?: string;
    'breakdown'?: FacialSimilarityPhotoBreakdownImageIntegrityBreakdown;
}
export interface FacialSimilarityPhotoBreakdownImageIntegrityBreakdown {
    'face_detected'?: FacialSimilarityPhotoBreakdownImageIntegrityBreakdownFaceDetected;
    'source_integrity'?: FacialSimilarityPhotoBreakdownImageIntegrityBreakdownSourceIntegrity;
}
/**
 * Asserts a single face of good enough quality has been found in both the document image and the live photo.
 */
export interface FacialSimilarityPhotoBreakdownImageIntegrityBreakdownFaceDetected {
    'result'?: string;
    'properties'?: object;
}
/**
 * Asserts whether the live photo is trustworthy - i.e. not digitally tampered, from a fake webcam, or from other dubious sources.
 */
export interface FacialSimilarityPhotoBreakdownImageIntegrityBreakdownSourceIntegrity {
    'result'?: string;
    'properties'?: PhotoReasons;
}
/**
 * Asserts whether the person in the live photo is real and not a spoof.
 */
export interface FacialSimilarityPhotoBreakdownVisualAuthenticity {
    'result'?: string;
    'breakdown'?: FacialSimilarityPhotoBreakdownVisualAuthenticityBreakdown;
}
export interface FacialSimilarityPhotoBreakdownVisualAuthenticityBreakdown {
    'spoofing_detection'?: FacialSimilarityPhotoBreakdownVisualAuthenticityBreakdownSpoofingDetection;
}
/**
 * Contains a score value under the properties bag.
 */
export interface FacialSimilarityPhotoBreakdownVisualAuthenticityBreakdownSpoofingDetection {
    'result'?: string;
    'properties'?: FacialSimilarityPhotoBreakdownVisualAuthenticityBreakdownSpoofingDetectionProperties;
}
export interface FacialSimilarityPhotoBreakdownVisualAuthenticityBreakdownSpoofingDetectionProperties {
    /**
     * A floating point number between 0 and 1. The closer the score is to 0, the more likely it is to be a spoof.
     */
    'score'?: number;
}
export interface FacialSimilarityPhotoFullyAutoBreakdown {
    'face_comparison'?: FacialSimilarityPhotoBreakdownFaceComparison;
    'image_integrity'?: FacialSimilarityPhotoFullyAutoBreakdownImageIntegrity;
    'visual_authenticity'?: FacialSimilarityPhotoBreakdownVisualAuthenticity;
}
/**
 * Asserts whether the quality and integrity of the uploaded files were sufficient to perform a face comparison.
 */
export interface FacialSimilarityPhotoFullyAutoBreakdownImageIntegrity {
    'result'?: string;
    'breakdown'?: FacialSimilarityPhotoFullyAutoBreakdownImageIntegrityBreakdown;
}
export interface FacialSimilarityPhotoFullyAutoBreakdownImageIntegrityBreakdown {
    'face_detected'?: FacialSimilarityPhotoBreakdownImageIntegrityBreakdownFaceDetected;
    'source_integrity'?: FacialSimilarityPhotoFullyAutoBreakdownImageIntegrityBreakdownSourceIntegrity;
}
/**
 * Asserts whether the live photo is trustworthy - i.e. not digitally tampered, from a fake webcam, or from other dubious sources.
 */
export interface FacialSimilarityPhotoFullyAutoBreakdownImageIntegrityBreakdownSourceIntegrity {
    'result'?: string;
    'properties'?: PhotoAutoReasons;
}
export interface FacialSimilarityPhotoFullyAutoProperties {
    /**
     * A floating point number between 0 and 1. The closer the score is to 0, the more likely it is to be a spoof (i.e. photos of printed photos, or photos of digital screens). Conversely, the closer it is to 1, the less likely it is to be a spoof.
     */
    'score'?: number;
}
export interface FacialSimilarityPhotoFullyAutoReport {
    /**
     * The unique identifier for the report. Read-only.
     */
    'id': string;
    /**
     * The date and time at which the report was first initiated. Read-only.
     */
    'created_at'?: string;
    /**
     * The API endpoint to retrieve the report. Read-only.
     */
    'href'?: string;
    'status'?: ReportStatus;
    'result'?: ReportResult;
    'sub_result'?: ReportSubResult;
    /**
     * The ID of the check to which the report belongs. Read-only.
     */
    'check_id'?: string;
    'name': ReportName;
    /**
     * Array of objects with document ids that were used in the Onfido engine.
     */
    'documents'?: Array<ReportDocument>;
    /**
     * Array of objects with live photo ids that were used in the Onfido engine.
     */
    'live_photos'?: Array<FacialSimilarityReportMedia>;
    /**
     * Array of objects with live video ids that were used in the Onfido engine.
     */
    'live_videos'?: Array<FacialSimilarityReportMedia>;
    /**
     * Array of objects with motion capture ids that were used in the Onfido engine.
     */
    'motion_captures'?: Array<FacialSimilarityReportMedia>;
    /**
     * Array of objects with id photo ids that were used in the Onfido engine.
     */
    'id_photos'?: Array<FacialSimilarityReportMedia>;
    'breakdown'?: FacialSimilarityPhotoFullyAutoBreakdown;
    'properties'?: FacialSimilarityPhotoFullyAutoProperties;
}
export interface FacialSimilarityPhotoProperties {
    /**
     * A floating point number between 0 and 1. The closer the score is to 0, the more likely it is to be a spoof (i.e. photos of printed photos, or photos of digital screens). Conversely, the closer it is to 1, the less likely it is to be a spoof.
     */
    'score'?: number;
}
export interface FacialSimilarityPhotoReport {
    /**
     * The unique identifier for the report. Read-only.
     */
    'id': string;
    /**
     * The date and time at which the report was first initiated. Read-only.
     */
    'created_at'?: string;
    /**
     * The API endpoint to retrieve the report. Read-only.
     */
    'href'?: string;
    'status'?: ReportStatus;
    'result'?: ReportResult;
    'sub_result'?: ReportSubResult;
    /**
     * The ID of the check to which the report belongs. Read-only.
     */
    'check_id'?: string;
    'name': ReportName;
    /**
     * Array of objects with document ids that were used in the Onfido engine.
     */
    'documents'?: Array<ReportDocument>;
    /**
     * Array of objects with live photo ids that were used in the Onfido engine.
     */
    'live_photos'?: Array<FacialSimilarityReportMedia>;
    /**
     * Array of objects with live video ids that were used in the Onfido engine.
     */
    'live_videos'?: Array<FacialSimilarityReportMedia>;
    /**
     * Array of objects with motion capture ids that were used in the Onfido engine.
     */
    'motion_captures'?: Array<FacialSimilarityReportMedia>;
    /**
     * Array of objects with id photo ids that were used in the Onfido engine.
     */
    'id_photos'?: Array<FacialSimilarityReportMedia>;
    'breakdown'?: FacialSimilarityPhotoBreakdown;
    'properties'?: FacialSimilarityPhotoProperties;
}
export interface FacialSimilarityReportMedia {
    /**
     * ID of uploaded biometric media to use.
     */
    'id': string;
}
export interface FacialSimilarityReportShared {
    /**
     * Array of objects with document ids that were used in the Onfido engine.
     */
    'documents'?: Array<ReportDocument>;
    /**
     * Array of objects with live photo ids that were used in the Onfido engine.
     */
    'live_photos'?: Array<FacialSimilarityReportMedia>;
    /**
     * Array of objects with live video ids that were used in the Onfido engine.
     */
    'live_videos'?: Array<FacialSimilarityReportMedia>;
    /**
     * Array of objects with motion capture ids that were used in the Onfido engine.
     */
    'motion_captures'?: Array<FacialSimilarityReportMedia>;
    /**
     * Array of objects with id photo ids that were used in the Onfido engine.
     */
    'id_photos'?: Array<FacialSimilarityReportMedia>;
}
export interface FacialSimilarityVideoBreakdown {
    'face_comparison'?: FacialSimilarityVideoBreakdownFaceComparison;
    'image_integrity'?: FacialSimilarityVideoBreakdownImageIntegrity;
    'visual_authenticity'?: FacialSimilarityVideoBreakdownVisualAuthenticity;
}
/**
 * Asserts whether the face in the document matches the face in the live video.
 */
export interface FacialSimilarityVideoBreakdownFaceComparison {
    'result'?: string;
    'breakdown'?: FacialSimilarityPhotoBreakdownFaceComparisonBreakdown;
}
/**
 * Asserts whether the quality and integrity of the uploaded files were sufficient to perform a face comparison.
 */
export interface FacialSimilarityVideoBreakdownImageIntegrity {
    'result'?: string;
    'breakdown'?: FacialSimilarityVideoBreakdownImageIntegrityBreakdown;
}
export interface FacialSimilarityVideoBreakdownImageIntegrityBreakdown {
    'face_detected'?: FacialSimilarityVideoBreakdownImageIntegrityBreakdownFaceDetected;
    'source_integrity'?: FacialSimilarityVideoBreakdownImageIntegrityBreakdownSourceIntegrity;
}
/**
 * Asserts a single face of good enough quality has been found in both the document image and the live video.
 */
export interface FacialSimilarityVideoBreakdownImageIntegrityBreakdownFaceDetected {
    'result'?: string;
    'properties'?: object;
}
/**
 * Asserts whether the live video is trustworthy - e.g. not from a fake webcam.
 */
export interface FacialSimilarityVideoBreakdownImageIntegrityBreakdownSourceIntegrity {
    'result'?: string;
    'properties'?: VideoReasons;
}
/**
 * Asserts whether the person in the live video is real (not a spoof) and live.
 */
export interface FacialSimilarityVideoBreakdownVisualAuthenticity {
    'result'?: string;
    'breakdown'?: FacialSimilarityVideoBreakdownVisualAuthenticityBreakdown;
}
export interface FacialSimilarityVideoBreakdownVisualAuthenticityBreakdown {
    'liveness_detected'?: FacialSimilarityVideoBreakdownVisualAuthenticityBreakdownLivenessDetected;
    'spoofing_detection'?: FacialSimilarityVideoBreakdownVisualAuthenticityBreakdownSpoofingDetection;
}
/**
 * Asserts whether the numbers and head movements were correctly executed.
 */
export interface FacialSimilarityVideoBreakdownVisualAuthenticityBreakdownLivenessDetected {
    'result'?: string;
    'properties'?: object;
}
/**
 * Asserts whether the live video is not a spoof (such as videos of digital screens).
 */
export interface FacialSimilarityVideoBreakdownVisualAuthenticityBreakdownSpoofingDetection {
    'result'?: string;
    'properties'?: FacialSimilarityPhotoBreakdownVisualAuthenticityBreakdownSpoofingDetectionProperties;
}
export interface FacialSimilarityVideoProperties {
    /**
     * A floating point number between 0 and 1. The closer the score is to 0, the more likely it is to be a spoof (i.e. videos of digital screens, masks or print-outs). Conversely, the closer it is to 1, the less likely it is to be a spoof.
     */
    'score'?: number;
}
export interface FacialSimilarityVideoReport {
    /**
     * The unique identifier for the report. Read-only.
     */
    'id': string;
    /**
     * The date and time at which the report was first initiated. Read-only.
     */
    'created_at'?: string;
    /**
     * The API endpoint to retrieve the report. Read-only.
     */
    'href'?: string;
    'status'?: ReportStatus;
    'result'?: ReportResult;
    'sub_result'?: ReportSubResult;
    /**
     * The ID of the check to which the report belongs. Read-only.
     */
    'check_id'?: string;
    'name': ReportName;
    /**
     * Array of objects with document ids that were used in the Onfido engine.
     */
    'documents'?: Array<ReportDocument>;
    /**
     * Array of objects with live photo ids that were used in the Onfido engine.
     */
    'live_photos'?: Array<FacialSimilarityReportMedia>;
    /**
     * Array of objects with live video ids that were used in the Onfido engine.
     */
    'live_videos'?: Array<FacialSimilarityReportMedia>;
    /**
     * Array of objects with motion capture ids that were used in the Onfido engine.
     */
    'motion_captures'?: Array<FacialSimilarityReportMedia>;
    /**
     * Array of objects with id photo ids that were used in the Onfido engine.
     */
    'id_photos'?: Array<FacialSimilarityReportMedia>;
    'breakdown'?: FacialSimilarityVideoBreakdown;
    'properties'?: FacialSimilarityVideoProperties;
}
export interface IdNumber {
    /**
     * Type of ID number.
     */
    'type'?: IdNumberTypeEnum;
    /**
     * Value of ID number
     */
    'value'?: string;
    /**
     * Two letter code of issuing state (state-issued driving licenses only)
     */
    'state_code'?: string;
}
export declare const IdNumberTypeEnum: {
    readonly Ssn: "ssn";
    readonly SocialInsurance: "social_insurance";
    readonly TaxId: "tax_id";
    readonly IdentityCard: "identity_card";
    readonly DrivingLicense: "driving_license";
    readonly DrivingLicence: "driving_licence";
    readonly ShareCode: "share_code";
    readonly VoterId: "voter_id";
    readonly Passport: "passport";
    readonly Other: "other";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type IdNumberTypeEnum = typeof IdNumberTypeEnum[keyof typeof IdNumberTypeEnum];
export interface IdPhoto {
    /**
     * The unique identifier for the photo.
     */
    'id': string;
    /**
     * The date and time at which the photo was uploaded.
     */
    'created_at'?: string;
    /**
     * The uri of this resource.
     */
    'href'?: string;
    /**
     * The uri that can be used to download the photo.
     */
    'download_href'?: string;
    /**
     * The name of the uploaded file.
     */
    'file_name'?: string;
    /**
     * The file type of the uploaded file.
     */
    'file_type'?: string;
    /**
     * The size of the file in bytes.
     */
    'file_size'?: number;
}
export interface IdPhotoResponse {
    /**
     * The unique identifier for the photo.
     */
    'id': string;
    /**
     * The date and time at which the photo was uploaded.
     */
    'created_at'?: string;
    /**
     * The uri of this resource.
     */
    'href'?: string;
    /**
     * The uri that can be used to download the photo.
     */
    'download_href'?: string;
    /**
     * The name of the uploaded file.
     */
    'file_name'?: string;
    /**
     * The file type of the uploaded file.
     */
    'file_type'?: string;
    /**
     * The size of the file in bytes.
     */
    'file_size'?: number;
}
export interface IdPhotosList {
    'id_photos': Array<IdPhoto>;
}
export interface IdentityEnhancedBreakdown {
    'sources'?: IdentityEnhancedBreakdownSources;
    'address'?: IdentityEnhancedBreakdownAddress;
    'date_of_birth'?: IdentityEnhancedBreakdownDateOfBirth;
    'mortality'?: IdentityEnhancedBreakdownMortality;
    'ssn'?: IdrSsnBreakdown;
    'ssn1'?: IdrSsnBreakdown;
}
/**
 * Asserts if the applicant\'s address matches any sources.
 */
export interface IdentityEnhancedBreakdownAddress {
    'result'?: string;
    'breakdown'?: IdentityEnhancedBreakdownAddressBreakdown;
}
export interface IdentityEnhancedBreakdownAddressBreakdown {
    'credit_agencies'?: IdentityEnhancedBreakdownAddressBreakdownCreditAgencies;
    'telephone_database'?: IdentityEnhancedBreakdownAddressBreakdownTelephoneDatabase;
    'voting_register'?: IdentityEnhancedBreakdownAddressBreakdownVotingRegister;
}
/**
 * The number of address matches against credit agencies.
 */
export interface IdentityEnhancedBreakdownAddressBreakdownCreditAgencies {
    'result'?: string;
    'properties'?: IdentityEnhancedBreakdownAddressBreakdownCreditAgenciesProperties;
}
export interface IdentityEnhancedBreakdownAddressBreakdownCreditAgenciesProperties {
    'number_of_matches'?: string;
}
/**
 * Address match against telephone database.
 */
export interface IdentityEnhancedBreakdownAddressBreakdownTelephoneDatabase {
    'result'?: string;
    'properties'?: object;
}
/**
 * Address match against voting register.
 */
export interface IdentityEnhancedBreakdownAddressBreakdownVotingRegister {
    'result'?: string;
    'properties'?: object;
}
/**
 * Asserts if the applicant\'s date of birth matches any sources.
 */
export interface IdentityEnhancedBreakdownDateOfBirth {
    'result'?: string;
    'breakdown'?: IdentityEnhancedBreakdownDateOfBirthBreakdown;
}
export interface IdentityEnhancedBreakdownDateOfBirthBreakdown {
    'credit_agencies'?: IdentityEnhancedBreakdownDateOfBirthBreakdownCreditAgencies;
    'voting_register'?: IdentityEnhancedBreakdownDateOfBirthBreakdownVotingRegister;
}
/**
 * Date of birth match against credit agencies.
 */
export interface IdentityEnhancedBreakdownDateOfBirthBreakdownCreditAgencies {
    'result'?: string;
    'properties'?: object;
}
/**
 * Date of birth match against voting register.
 */
export interface IdentityEnhancedBreakdownDateOfBirthBreakdownVotingRegister {
    'result'?: string;
    'properties'?: object;
}
/**
 * Asserts if the applicant\'s details match any death records.
 */
export interface IdentityEnhancedBreakdownMortality {
    'result'?: string;
}
/**
 * Asserts if any sources that an applicant\'s details have been verified against have produced a match.
 */
export interface IdentityEnhancedBreakdownSources {
    'result'?: string;
    'breakdown'?: IdentityEnhancedBreakdownSourcesBreakdown;
}
export interface IdentityEnhancedBreakdownSourcesBreakdown {
    'total_sources'?: IdentityEnhancedBreakdownSourcesBreakdownTotalSources;
}
/**
 * The number of sources which produced a match to applicant details.
 */
export interface IdentityEnhancedBreakdownSourcesBreakdownTotalSources {
    'result'?: string;
    'properties'?: IdentityEnhancedBreakdownSourcesBreakdownTotalSourcesProperties;
}
export interface IdentityEnhancedBreakdownSourcesBreakdownTotalSourcesProperties {
    'total_number_of_sources'?: string;
}
export interface IdentityEnhancedProperties {
    /**
     * Returns address number which has been matched.
     */
    'matched_address'?: number;
    /**
     * Returns array of sources which contain matched addresses for the corresponding address number.
     */
    'matched_addresses'?: Array<IdentityEnhancedPropertiesMatchedAddressesInner>;
}
export interface IdentityEnhancedPropertiesMatchedAddressesInner {
    /**
     * The address number.
     */
    'id'?: number;
    /**
     * Sources which contain matched addresses.
     */
    'match_types'?: Array<string>;
}
export interface IdentityEnhancedReport {
    /**
     * The unique identifier for the report. Read-only.
     */
    'id': string;
    /**
     * The date and time at which the report was first initiated. Read-only.
     */
    'created_at'?: string;
    /**
     * The API endpoint to retrieve the report. Read-only.
     */
    'href'?: string;
    'status'?: ReportStatus;
    'result'?: ReportResult;
    'sub_result'?: ReportSubResult;
    /**
     * The ID of the check to which the report belongs. Read-only.
     */
    'check_id'?: string;
    'name': ReportName;
    'breakdown'?: IdentityEnhancedBreakdown;
    'properties'?: IdentityEnhancedProperties;
}
export interface IdrSsnBreakdown {
    'result'?: string;
    'breakdown'?: IdrSsnBreakdownBreakdown;
}
export interface IdrSsnBreakdownBreakdown {
    'last_4_digits_match'?: IdrSsnBreakdownBreakdownLast4DigitsMatch;
    'full_match'?: IdrSsnBreakdownBreakdownFullMatch;
}
/**
 * Social security number fully matches
 */
export interface IdrSsnBreakdownBreakdownFullMatch {
    'result'?: string;
    'properties'?: object;
}
/**
 * Last 4 digits of social security number match
 */
export interface IdrSsnBreakdownBreakdownLast4DigitsMatch {
    'result'?: string;
    'properties'?: object;
}
export interface IndiaPanReport {
    /**
     * The unique identifier for the report. Read-only.
     */
    'id': string;
    /**
     * The date and time at which the report was first initiated. Read-only.
     */
    'created_at'?: string;
    /**
     * The API endpoint to retrieve the report. Read-only.
     */
    'href'?: string;
    'status'?: ReportStatus;
    'result'?: ReportResult;
    'sub_result'?: ReportSubResult;
    /**
     * The ID of the check to which the report belongs. Read-only.
     */
    'check_id'?: string;
    'name': ReportName;
    'breakdown'?: IndiaPanReportAllOfBreakdown;
    'properties'?: IndiaPanReportAllOfProperties;
}
export interface IndiaPanReportAllOfBreakdown {
    'device'?: IndiaPanReportAllOfBreakdownDevice;
}
export interface IndiaPanReportAllOfBreakdownDevice {
    'breakdown'?: IndiaPanReportAllOfBreakdownDeviceBreakdown;
}
export interface IndiaPanReportAllOfBreakdownDeviceBreakdown {
    'pan_valid'?: IndiaPanReportAllOfBreakdownDeviceBreakdownPanValid;
    'name_match'?: IndiaPanReportAllOfBreakdownDeviceBreakdownPanValid;
}
export interface IndiaPanReportAllOfBreakdownDeviceBreakdownPanValid {
    'result'?: string;
}
export interface IndiaPanReportAllOfProperties {
    'device'?: IndiaPanReportAllOfPropertiesDevice;
}
export interface IndiaPanReportAllOfPropertiesDevice {
    /**
     * The applicant\'s PAN (10 digit alphanumeric number).
     */
    'pan'?: string;
    /**
     * The applicant\'s full name.
     */
    'full_name'?: string;
}
export interface KnownFacesBreakdown {
    'previously_seen_faces'?: KnownFacesBreakdownPreviouslySeenFaces;
    'image_integrity'?: KnownFacesBreakdownImageIntegrity;
}
/**
 * Asserts whether the uploaded live photo or live video and the content contained within it were of sufficient quality to perform a face comparison.
 */
export interface KnownFacesBreakdownImageIntegrity {
    'result'?: string;
}
/**
 * Asserts whether the applicant\'s most recent facial media (live photo or live video) matches any other live photos or live videos already in your Onfido account database.
 */
export interface KnownFacesBreakdownPreviouslySeenFaces {
    'result'?: string;
}
export interface KnownFacesProperties {
    /**
     * Returns any matching applicant IDs as entries inside a matches array under a properties bag.
     */
    'matches'?: Array<KnownFacesPropertiesMatchesInner>;
}
export interface KnownFacesPropertiesMatchesInner {
    /**
     * The applicant ID of the matched applicant.
     */
    'applicant_id'?: string;
    /**
     * A floating point number between 0 and 1 that expresses how similar the two faces are, where 1 is a perfect match.
     */
    'score'?: number;
    /**
     * The corresponding UUID for the media type.
     */
    'media_id'?: string;
    /**
     * The media type (for example live_photos or live_videos).
     */
    'media_type'?: string;
    /**
     * Indicates if match is suspected based on fuzzy name matching feature. Dependent on feature being active for account, otherwise defaults to true.
     */
    'suspected'?: boolean;
}
export interface KnownFacesReport {
    /**
     * The unique identifier for the report. Read-only.
     */
    'id': string;
    /**
     * The date and time at which the report was first initiated. Read-only.
     */
    'created_at'?: string;
    /**
     * The API endpoint to retrieve the report. Read-only.
     */
    'href'?: string;
    'status'?: ReportStatus;
    'result'?: ReportResult;
    'sub_result'?: ReportSubResult;
    /**
     * The ID of the check to which the report belongs. Read-only.
     */
    'check_id'?: string;
    'name': ReportName;
    'breakdown'?: KnownFacesBreakdown;
    'properties'?: KnownFacesProperties;
}
export interface LivePhoto {
    /**
     * The unique identifier for the photo.
     */
    'id': string;
    /**
     * The date and time at which the photo was uploaded.
     */
    'created_at'?: string;
    /**
     * The uri of this resource.
     */
    'href'?: string;
    /**
     * The uri that can be used to download the photo.
     */
    'download_href'?: string;
    /**
     * The name of the uploaded file.
     */
    'file_name'?: string;
    /**
     * The file type of the uploaded file.
     */
    'file_type'?: string;
    /**
     * The size of the file in bytes.
     */
    'file_size'?: number;
}
export interface LivePhotoResponse {
    /**
     * The unique identifier for the photo.
     */
    'id': string;
    /**
     * The date and time at which the photo was uploaded.
     */
    'created_at'?: string;
    /**
     * The uri of this resource.
     */
    'href'?: string;
    /**
     * The uri that can be used to download the photo.
     */
    'download_href'?: string;
    /**
     * The name of the uploaded file.
     */
    'file_name'?: string;
    /**
     * The file type of the uploaded file.
     */
    'file_type'?: string;
    /**
     * The size of the file in bytes.
     */
    'file_size'?: number;
}
export interface LivePhotosList {
    'live_photos': Array<LivePhoto>;
}
export interface LiveVideo {
    /**
     * The unique identifier for the video.
     */
    'id'?: string;
    /**
     * The date and time at which the video was uploaded.
     */
    'created_at'?: string;
    /**
     * The uri of this resource.
     */
    'href'?: string;
    /**
     * The uri that can be used to download the video.
     */
    'download_href'?: string;
    /**
     * The name of the uploaded file.
     */
    'file_name'?: string;
    /**
     * The size of the file in bytes.
     */
    'file_size'?: number;
    /**
     * The file type of the uploaded file.
     */
    'file_type'?: string;
    /**
     * Challenge the end user was asked to perform during the video recording.
     */
    'challenge'?: Array<{
        [key: string]: any;
    }>;
}
export interface LiveVideosList {
    'live_videos': Array<LiveVideo>;
}
export interface Location {
    /**
     * The applicant\'s ip address.
     */
    'ip_address'?: string;
    /**
     * The applicant\'s country of residence in 3-letter ISO code.
     */
    'country_of_residence'?: CountryCodes;
}
export interface LocationBuilder {
    /**
     * The applicant\'s ip address.
     */
    'ip_address'?: string;
    /**
     * The applicant\'s country of residence in 3-letter ISO code.
     */
    'country_of_residence'?: CountryCodes;
}
export interface LocationShared {
    /**
     * The applicant\'s ip address.
     */
    'ip_address'?: string;
    /**
     * The applicant\'s country of residence in 3-letter ISO code.
     */
    'country_of_residence'?: CountryCodes;
}
export interface ModelError {
    'error'?: ErrorProperties;
}
export interface MotionCapture {
    /**
     * The unique identifier for the motion capture.
     */
    'id'?: string;
    /**
     * The date and time at which the motion capture was uploaded.
     */
    'created_at'?: string;
    /**
     * The uri of this resource.
     */
    'href'?: string;
    /**
     * The uri that can be used to download the motion capture.
     */
    'download_href'?: string;
    /**
     * The name of the uploaded file.
     */
    'file_name'?: string;
    /**
     * The size of the file in bytes.
     */
    'file_size'?: number;
    /**
     * The file type of the uploaded file.
     */
    'file_type'?: string;
}
export interface MotionCapturesList {
    'motion_captures': Array<MotionCapture>;
}
export interface Passkey {
    /**
     * Passkey identifier.
     */
    'id': string;
    /**
     * domain that the passkey is registered to, the rpId.
     */
    'application_domain': string;
    /**
     * Current passkey state.
     */
    'state': PasskeyStateEnum;
    /**
     * Timestamp when the passkey was created.
     */
    'created_at': string;
    /**
     * Timestamp when the passkey was last used.
     */
    'last_used_at'?: string;
}
export declare const PasskeyStateEnum: {
    readonly Active: "ACTIVE";
    readonly Inactive: "INACTIVE";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type PasskeyStateEnum = typeof PasskeyStateEnum[keyof typeof PasskeyStateEnum];
export interface PasskeyUpdater {
    /**
     * Desired passkey state value.
     */
    'state': PasskeyUpdaterStateEnum;
}
export declare const PasskeyUpdaterStateEnum: {
    readonly Active: "ACTIVE";
    readonly Inactive: "INACTIVE";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type PasskeyUpdaterStateEnum = typeof PasskeyUpdaterStateEnum[keyof typeof PasskeyUpdaterStateEnum];
export interface PasskeysList {
    'passkeys': Array<Passkey>;
}
export interface PhotoAutoReasons {
    /**
     * Flags when evidence is found that the image was manipulated by Photoshop, or other software.
     */
    'digital_tampering'?: string;
    /**
     * Flags when evidence is found that a fake webcam was used.
     */
    'fake_webcam'?: string;
    /**
     * Flags when evidence is found that the live photo was taken more than 24 hours before live photo upload.
     */
    'time_of_capture'?: string;
    /**
     * Flags when evidence is found that an Android emulator was used.
     */
    'emulator'?: string;
    /**
     * Additional comma separated details such as the exact digital tampering software used, or the name of the fake webcam.
     */
    'reasons'?: string;
}
export interface PhotoReasons {
    /**
     * Flags when evidence is found that the image was manipulated by Photoshop, or other software.
     */
    'digital_tampering'?: string;
    /**
     * Flags when evidence is found that a fake webcam was used.
     */
    'fake_webcam'?: string;
    /**
     * Flags when evidence is found that the live photo was taken more than 24 hours before live photo upload.
     */
    'time_of_capture'?: string;
    /**
     * Flags when evidence is found that an Android emulator was used.
     */
    'emulator'?: string;
    /**
     * Additional comma separated details such as the exact digital tampering software used, or the name of the fake webcam.
     */
    'reasons'?: string;
}
export interface ProofOfAddressBreakdown {
    'data_comparison'?: ProofOfAddressBreakdownDataComparison;
    'document_classification'?: ProofOfAddressBreakdownDocumentClassification;
    'image_integrity'?: ProofOfAddressBreakdownImageIntegrity;
}
/**
 * Asserts whether the first name, last name and address provided by the applicant match those on the PoA document.
 */
export interface ProofOfAddressBreakdownDataComparison {
    'result'?: string;
    'breakdown'?: ProofOfAddressBreakdownDataComparisonBreakdown;
}
export interface ProofOfAddressBreakdownDataComparisonBreakdown {
    'address'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'first_name'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'last_name'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
}
/**
 * Asserts whether the document is of a valid type as PoA.
 */
export interface ProofOfAddressBreakdownDocumentClassification {
    'result'?: string;
    'breakdown'?: ProofOfAddressBreakdownDocumentClassificationBreakdown;
}
export interface ProofOfAddressBreakdownDocumentClassificationBreakdown {
    'supported_document'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
}
/**
 * Asserts whether the quality of the uploaded document was sufficient to verify the address.
 */
export interface ProofOfAddressBreakdownImageIntegrity {
    'result'?: string;
    'breakdown'?: ProofOfAddressBreakdownImageIntegrityBreakdown;
}
export interface ProofOfAddressBreakdownImageIntegrityBreakdown {
    'image_quality'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
}
export interface ProofOfAddressProperties {
    /**
     * This property provides the address on the document.
     */
    'address'?: string;
    /**
     * This property provides the document type according to the set of supported documents.
     */
    'document_type'?: ProofOfAddressPropertiesDocumentTypeEnum;
    /**
     * This property provides the first names on the document, including any initials and middle names.
     */
    'first_names'?: string;
    /**
     * This property provided the last names on the document.
     */
    'last_names'?: string;
    /**
     * This property provides the issue date of the document.
     */
    'issue_date'?: string;
    /**
     * This property provides the document issuer (e.g. HSBC, British Gas).
     */
    'issuer'?: string;
    /**
     * This property provides the summary period start date.
     */
    'summary_period_start'?: string;
    /**
     * This property provides the summary period end date.
     */
    'summary_period_end'?: string;
}
export declare const ProofOfAddressPropertiesDocumentTypeEnum: {
    readonly BankBuildingSocietyStatement: "bank_building_society_statement";
    readonly UtilityBill: "utility_bill";
    readonly CouncilTax: "council_tax";
    readonly BenefitLetters: "benefit_letters";
    readonly MortgageStatement: "mortgage_statement";
    readonly MobilePhoneBill: "mobile_phone_bill";
    readonly GeneralLetter: "general_letter";
    readonly InsuranceStatement: "insurance_statement";
    readonly PensionPropertyStatementLetter: "pension_property_statement_letter";
    readonly IdentityDocumentWithAddress: "identity_document_with_address";
    readonly ExchangeHouseStatement: "exchange_house_statement";
    readonly AccommodationTenancyCertificate: "accommodation_tenancy_certificate";
    readonly AddressCertificate: "address_certificate";
    readonly ElectricityBill: "electricity_bill";
    readonly GasBill: "gas_bill";
    readonly InternetBill: "internet_bill";
    readonly PhoneBill: "phone_bill";
    readonly WaterBill: "water_bill";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type ProofOfAddressPropertiesDocumentTypeEnum = typeof ProofOfAddressPropertiesDocumentTypeEnum[keyof typeof ProofOfAddressPropertiesDocumentTypeEnum];
export interface ProofOfAddressReport {
    /**
     * The unique identifier for the report. Read-only.
     */
    'id': string;
    /**
     * The date and time at which the report was first initiated. Read-only.
     */
    'created_at'?: string;
    /**
     * The API endpoint to retrieve the report. Read-only.
     */
    'href'?: string;
    'status'?: ReportStatus;
    'result'?: ReportResult;
    'sub_result'?: ReportSubResult;
    /**
     * The ID of the check to which the report belongs. Read-only.
     */
    'check_id'?: string;
    'name': ReportName;
    'breakdown'?: ProofOfAddressBreakdown;
    'properties'?: ProofOfAddressProperties;
}
export interface RepeatAttemptsList {
    /**
     * The unique identifier of the completed Document report.
     */
    'report_id'?: string;
    /**
     * An array of repeat attempt objects. If no repeat attempts were found, the array will be empty. The number of objects returned can increase over time if more matches are received.
     */
    'repeat_attempts': Array<RepeatAttemptsListRepeatAttemptsInner>;
    /**
     * The total number of attempts using the same document, including the current report under assessment.
     */
    'attempts_count'?: number;
    /**
     * A number between 0 and 1 which indicates the proportion of attempts that have been cleared, including the current report under assessment.
     */
    'attempts_clear_rate'?: number;
    /**
     * The number of unique entries in the repeat_attempts field for which at least one of the fields is a mismatch.
     */
    'unique_mismatches_count'?: number;
}
export interface RepeatAttemptsListRepeatAttemptsInner {
    /**
     * The unique identifier of the matching Document report.
     */
    'report_id'?: string;
    /**
     * The unique identifier of the applicant for the matching Document report.
     */
    'applicant_id'?: string;
    /**
     * Whether the dates of birth are exactly the same or are different.
     */
    'date_of_birth'?: RepeatAttemptsListRepeatAttemptsInnerDateOfBirthEnum;
    /**
     * Whether the names are exactly the same or are different.
     */
    'names'?: RepeatAttemptsListRepeatAttemptsInnerNamesEnum;
    /**
     * The report result of this attempt.
     */
    'result'?: RepeatAttemptsListRepeatAttemptsInnerResultEnum;
    /**
     * When the matching report was created.
     */
    'created_at'?: string;
    /**
     * When the matching report was completed.
     */
    'completed_at'?: string;
}
export declare const RepeatAttemptsListRepeatAttemptsInnerDateOfBirthEnum: {
    readonly Match: "match";
    readonly Mismatch: "mismatch";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type RepeatAttemptsListRepeatAttemptsInnerDateOfBirthEnum = typeof RepeatAttemptsListRepeatAttemptsInnerDateOfBirthEnum[keyof typeof RepeatAttemptsListRepeatAttemptsInnerDateOfBirthEnum];
export declare const RepeatAttemptsListRepeatAttemptsInnerNamesEnum: {
    readonly Match: "match";
    readonly Mismatch: "mismatch";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type RepeatAttemptsListRepeatAttemptsInnerNamesEnum = typeof RepeatAttemptsListRepeatAttemptsInnerNamesEnum[keyof typeof RepeatAttemptsListRepeatAttemptsInnerNamesEnum];
export declare const RepeatAttemptsListRepeatAttemptsInnerResultEnum: {
    readonly Clear: "clear";
    readonly Consider: "consider";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type RepeatAttemptsListRepeatAttemptsInnerResultEnum = typeof RepeatAttemptsListRepeatAttemptsInnerResultEnum[keyof typeof RepeatAttemptsListRepeatAttemptsInnerResultEnum];
/**
 * @type Report
 */
export type Report = {
    name: 'device_intelligence';
} & DeviceIntelligenceReport | {
    name: 'document';
} & DocumentReport | {
    name: 'document_video';
} & DocumentVideoReport | {
    name: 'document_video_with_address_information';
} & DocumentVideoWithAddressInformationReport | {
    name: 'document_with_address_information';
} & DocumentWithAddressInformationReport | {
    name: 'document_with_driver_verification';
} & DocumentWithDriverVerificationReport | {
    name: 'document_with_driving_licence_information';
} & DocumentWithDrivingLicenceInformationReport | {
    name: 'facial_similarity_motion';
} & FacialSimilarityMotionReport | {
    name: 'facial_similarity_photo';
} & FacialSimilarityPhotoReport | {
    name: 'facial_similarity_photo_fully_auto';
} & FacialSimilarityPhotoFullyAutoReport | {
    name: 'facial_similarity_video';
} & FacialSimilarityVideoReport | {
    name: 'identity_enhanced';
} & IdentityEnhancedReport | {
    name: 'india_pan';
} & IndiaPanReport | {
    name: 'known_faces';
} & KnownFacesReport | {
    name: 'proof_of_address';
} & ProofOfAddressReport | {
    name: 'us_driving_licence';
} & UsDrivingLicenceReport | {
    name: 'watchlist_aml';
} & WatchlistAmlReport | {
    name: 'watchlist_enhanced';
} & WatchlistEnhancedReport | {
    name: 'watchlist_peps_only';
} & WatchlistPepsOnlyReport | {
    name: 'watchlist_sanctions_only';
} & WatchlistSanctionsOnlyReport | {
    name: 'watchlist_standard';
} & WatchlistStandardReport;
/**
 * Defines configuration options for facial similarity checks used to distinguish between onboarding and reverification scenarios.
 */
export interface ReportConfiguration {
    'facial_similarity_photo'?: ReportConfigurationFacialSimilarity;
    'facial_similarity_photo_fully_auto'?: ReportConfigurationFacialSimilarity;
    'facial_similarity_video'?: ReportConfigurationFacialSimilarity;
    'facial_similarity_motion'?: ReportConfigurationFacialSimilarity;
}
export interface ReportConfigurationFacialSimilarity {
    /**
     * You should set it to \"reverification\" on a post-onboarding scenario (e.g. ongoing authentication).
     */
    'use_case'?: ReportConfigurationFacialSimilarityUseCaseEnum;
}
export declare const ReportConfigurationFacialSimilarityUseCaseEnum: {
    readonly Onboarding: "onboarding";
    readonly Reverification: "reverification";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type ReportConfigurationFacialSimilarityUseCaseEnum = typeof ReportConfigurationFacialSimilarityUseCaseEnum[keyof typeof ReportConfigurationFacialSimilarityUseCaseEnum];
export interface ReportDocument {
    /**
     * ID of uploaded document to use.
     */
    'id': string;
}
export declare const ReportName: {
    readonly Document: "document";
    readonly DocumentVideo: "document_video";
    readonly DocumentVideoWithAddressInformation: "document_video_with_address_information";
    readonly DocumentWithAddressInformation: "document_with_address_information";
    readonly DocumentWithDrivingLicenceInformation: "document_with_driving_licence_information";
    readonly DocumentWithDriverVerification: "document_with_driver_verification";
    readonly FacialSimilarityPhoto: "facial_similarity_photo";
    readonly FacialSimilarityPhotoFullyAuto: "facial_similarity_photo_fully_auto";
    readonly FacialSimilarityVideo: "facial_similarity_video";
    readonly FacialSimilarityMotion: "facial_similarity_motion";
    readonly KnownFaces: "known_faces";
    readonly IdentityEnhanced: "identity_enhanced";
    readonly WatchlistAml: "watchlist_aml";
    readonly WatchlistEnhanced: "watchlist_enhanced";
    readonly WatchlistStandard: "watchlist_standard";
    readonly WatchlistPepsOnly: "watchlist_peps_only";
    readonly WatchlistSanctionsOnly: "watchlist_sanctions_only";
    readonly ProofOfAddress: "proof_of_address";
    readonly UsDrivingLicence: "us_driving_licence";
    readonly DeviceIntelligence: "device_intelligence";
    readonly IndiaPan: "india_pan";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type ReportName = typeof ReportName[keyof typeof ReportName];
/**
 * The result of the report. Read-only.
 */
export declare const ReportResult: {
    readonly Clear: "clear";
    readonly Consider: "consider";
    readonly Unidentified: "unidentified";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type ReportResult = typeof ReportResult[keyof typeof ReportResult];
export interface ReportShared {
    /**
     * The unique identifier for the report. Read-only.
     */
    'id': string;
    /**
     * The date and time at which the report was first initiated. Read-only.
     */
    'created_at'?: string;
    /**
     * The API endpoint to retrieve the report. Read-only.
     */
    'href'?: string;
    'status'?: ReportStatus;
    'result'?: ReportResult;
    'sub_result'?: ReportSubResult;
    /**
     * The ID of the check to which the report belongs. Read-only.
     */
    'check_id'?: string;
    'name': ReportName;
}
/**
 * The current state of the report in the checking process. Read-only.
 */
export declare const ReportStatus: {
    readonly AwaitingData: "awaiting_data";
    readonly AwaitingApproval: "awaiting_approval";
    readonly Cancelled: "cancelled";
    readonly Complete: "complete";
    readonly Withdrawn: "withdrawn";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type ReportStatus = typeof ReportStatus[keyof typeof ReportStatus];
/**
 * The sub_result of the report. It gives a more detailed result for document reports only, and will be null otherwise. Read-only.
 */
export declare const ReportSubResult: {
    readonly Clear: "clear";
    readonly Rejected: "rejected";
    readonly Suspected: "suspected";
    readonly Caution: "caution";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type ReportSubResult = typeof ReportSubResult[keyof typeof ReportSubResult];
export interface ReportsList {
    'reports': Array<Report>;
}
export interface ResultsFeedback {
    /**
     * The expected result for the check or report.
     */
    'expected_result'?: ResultsFeedbackExpectedResultEnum;
    /**
     * The ID of the check (only if report_id is not provided).
     */
    'check_id'?: string;
    /**
     * The ID of the check (only if check_id is not provided).
     */
    'report_id'?: string;
    /**
     * Any additional information or feedback.
     */
    'feedback_notes'?: string;
}
export declare const ResultsFeedbackExpectedResultEnum: {
    readonly Clear: "clear";
    readonly Consider: "consider";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type ResultsFeedbackExpectedResultEnum = typeof ResultsFeedbackExpectedResultEnum[keyof typeof ResultsFeedbackExpectedResultEnum];
export interface SdkToken {
    /**
     * The generated SDK token
     */
    'token': string;
}
export interface SdkTokenBuilder {
    /**
     * The unique identifier of the applicant
     */
    'applicant_id': string;
    /**
     * The referrer URL pattern
     */
    'referrer'?: string;
    /**
     * The application ID (iOS or Android)
     */
    'application_id'?: string;
    /**
     * The URL to be used by the Web SDK for the cross device flow.
     */
    'cross_device_url'?: string;
}
export interface SdkTokenRequest {
    /**
     * The unique identifier of the applicant
     */
    'applicant_id': string;
    /**
     * The referrer URL pattern
     */
    'referrer'?: string;
    /**
     * The application ID (iOS or Android)
     */
    'application_id'?: string;
    /**
     * The URL to be used by the Web SDK for the cross device flow.
     */
    'cross_device_url'?: string;
}
export interface SdkTokenResponse {
    /**
     * The generated SDK token
     */
    'token': string;
}
export interface SigningDocument {
    /**
     * The ID of the applicant whose signing document is being uploaded.
     */
    'applicant_id'?: string;
    /**
     * The unique identifier for the signing document
     */
    'id': string;
    /**
     * The date and time at which the signing document was uploaded
     */
    'created_at'?: string;
    /**
     * The uri of this resource
     */
    'href'?: string;
    /**
     * The uri that can be used to download the signing document
     */
    'download_href'?: string;
    /**
     * The file type of the uploaded file
     */
    'file_type'?: string;
    /**
     * The name of the uploaded file
     */
    'file_name'?: string;
    /**
     * The size of the file in bytes
     */
    'file_size'?: number;
}
export interface SigningDocumentResponse {
    /**
     * The unique identifier for the signing document
     */
    'id': string;
    /**
     * The date and time at which the signing document was uploaded
     */
    'created_at'?: string;
    /**
     * The uri of this resource
     */
    'href'?: string;
    /**
     * The uri that can be used to download the signing document
     */
    'download_href'?: string;
    /**
     * The file type of the uploaded file
     */
    'file_type'?: string;
    /**
     * The name of the uploaded file
     */
    'file_name'?: string;
    /**
     * The size of the file in bytes
     */
    'file_size'?: number;
}
export interface SigningDocumentShared {
    /**
     * The ID of the applicant whose signing document is being uploaded.
     */
    'applicant_id'?: string;
}
export interface SigningDocumentsList {
    'signing_documents': Array<SigningDocument>;
}
export interface Task {
    /**
     * The identifier for the Task.
     */
    'id'?: string;
    /**
     * The workflow run id the task belongs to.
     */
    'workflow_run_id'?: string;
    /**
     * The identifier for the Task Definition.
     */
    'task_def_id'?: string;
    /**
     * The task definition version.
     */
    'task_def_version'?: string | null;
    /**
     * Input object with the fields used by the Task to execute.
     */
    'input'?: object;
    /**
     * Value field (it can be an Object, List, etc.) with the fields produced by the Task execution.
     */
    'output'?: object | null;
    /**
     * The date and time when the Task was created.
     */
    'created_at'?: string;
    /**
     * The date and time when the Task was last updated.
     */
    'updated_at'?: string;
}
export interface TaskItem {
    /**
     * The identifier for the Task.
     */
    'id'?: string;
    /**
     * The workflow run id the task belongs to.
     */
    'workflow_run_id'?: string;
    /**
     * The identifier for the Task Definition.
     */
    'task_def_id'?: string;
    /**
     * The task definition version.
     */
    'task_def_version'?: string | null;
    /**
     * The date and time when the Task was created.
     */
    'created_at'?: string;
    /**
     * The date and time when the Task was last updated.
     */
    'updated_at'?: string;
}
export interface TimelineFileReference {
    /**
     * The unique identifier for the Timefile File that will be created.
     */
    'workflow_timeline_file_id': string;
    /**
     * Link to access the Timefile File that will be created.
     */
    'href': string;
}
export interface UsDrivingLicenceBreakdown {
    'document'?: UsDrivingLicenceBreakdownDocument;
    'address'?: UsDrivingLicenceBreakdownAddress;
    'personal'?: UsDrivingLicenceBreakdownPersonal;
}
/**
 * Asserts whether the address data provided matches a real driving license in the DMV driver\'s license database.
 */
export interface UsDrivingLicenceBreakdownAddress {
    'result'?: string;
    'breakdown'?: UsDrivingLicenceBreakdownAddressBreakdown;
}
export interface UsDrivingLicenceBreakdownAddressBreakdown {
    'city'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'line_1'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'line_2'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'state_code'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'zip4'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'zip5'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
}
/**
 * Asserts whether the document data provided matches a real driving license in the DMV driver\'s license database.
 */
export interface UsDrivingLicenceBreakdownDocument {
    'result'?: string;
    'breakdown'?: UsDrivingLicenceBreakdownDocumentBreakdown;
}
export interface UsDrivingLicenceBreakdownDocumentBreakdown {
    'category'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'expiration_date'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'issue_date'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'document_number'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
}
/**
 * Asserts whether the personal data provided matches a real driving license in the DMV driver\'s license database.
 */
export interface UsDrivingLicenceBreakdownPersonal {
    'result'?: string;
    'breakdown'?: UsDrivingLicenceBreakdownPersonalBreakdown;
}
export interface UsDrivingLicenceBreakdownPersonalBreakdown {
    'first_name'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'name_suffix'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'height'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'weight'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'sex_code'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'eye_color'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'date_of_birth'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'last_name'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'middle_name'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'first_name_fuzzy'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'middle_name_fuzzy'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'last_name_fuzzy'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    'middle_initial'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
}
export interface UsDrivingLicenceBuilder {
    /**
     * Driving licence ID number
     */
    'id_number': string;
    /**
     * Two letter code of issuing state (state-issued driving licenses only)
     */
    'issue_state': string;
    /**
     * Line 1 of the address
     */
    'address_line_1'?: string;
    /**
     * Line 2 of the address
     */
    'address_line_2'?: string;
    /**
     * The city of the owner\'s address
     */
    'city'?: string;
    /**
     * Date of birth in yyyy-mm-dd format
     */
    'date_of_birth'?: string;
    /**
     * Document category.
     */
    'document_category'?: UsDrivingLicenceBuilderDocumentCategoryEnum;
    /**
     * Expiration date of the driving licence in yyyy-mm-dd format
     */
    'expiration_date'?: string;
    /**
     * Eye color code.
     */
    'eye_color_code'?: UsDrivingLicenceBuilderEyeColorCodeEnum;
    /**
     * The owner\'s first name
     */
    'first_name'?: string;
    'gender'?: UsDrivingLicenceBuilderGenderEnum;
    /**
     * Issue date in yyyy-mm-dd format
     */
    'issue_date'?: string;
    /**
     * The owner\'s surname
     */
    'last_name'?: string;
    /**
     * The owner\'s middle name
     */
    'middle_name'?: string;
    /**
     * The owner\'s name suffix
     */
    'name_suffix'?: string;
    /**
     * The postcode or ZIP of the owner\'s address
     */
    'postal_code'?: string;
    /**
     * 2-characters state code
     */
    'state'?: string;
    /**
     * Weight in pounds
     */
    'weight_measure'?: number;
}
export declare const UsDrivingLicenceBuilderDocumentCategoryEnum: {
    readonly DriverLicense: "driver license";
    readonly DriverPermit: "driver permit";
    readonly IdCard: "id card";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type UsDrivingLicenceBuilderDocumentCategoryEnum = typeof UsDrivingLicenceBuilderDocumentCategoryEnum[keyof typeof UsDrivingLicenceBuilderDocumentCategoryEnum];
export declare const UsDrivingLicenceBuilderEyeColorCodeEnum: {
    readonly Blk: "BLK";
    readonly Blu: "BLU";
    readonly Bro: "BRO";
    readonly Dic: "DIC";
    readonly Gry: "GRY";
    readonly Grn: "GRN";
    readonly Haz: "HAZ";
    readonly Mar: "MAR";
    readonly Pnk: "PNK";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type UsDrivingLicenceBuilderEyeColorCodeEnum = typeof UsDrivingLicenceBuilderEyeColorCodeEnum[keyof typeof UsDrivingLicenceBuilderEyeColorCodeEnum];
export declare const UsDrivingLicenceBuilderGenderEnum: {
    readonly Male: "Male";
    readonly Female: "Female";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type UsDrivingLicenceBuilderGenderEnum = typeof UsDrivingLicenceBuilderGenderEnum[keyof typeof UsDrivingLicenceBuilderGenderEnum];
export interface UsDrivingLicenceReport {
    /**
     * The unique identifier for the report. Read-only.
     */
    'id': string;
    /**
     * The date and time at which the report was first initiated. Read-only.
     */
    'created_at'?: string;
    /**
     * The API endpoint to retrieve the report. Read-only.
     */
    'href'?: string;
    'status'?: ReportStatus;
    'result'?: ReportResult;
    'sub_result'?: ReportSubResult;
    /**
     * The ID of the check to which the report belongs. Read-only.
     */
    'check_id'?: string;
    'name': ReportName;
    'breakdown'?: UsDrivingLicenceBreakdown;
    'properties'?: DocumentProperties;
}
/**
 * An object that contains all accepted fields for the Driver\'s License Data Verification report.
 */
export interface UsDrivingLicenceShared {
    /**
     * Driving licence ID number
     */
    'id_number': string;
    /**
     * Two letter code of issuing state (state-issued driving licenses only)
     */
    'issue_state': string;
    /**
     * Line 1 of the address
     */
    'address_line_1'?: string;
    /**
     * Line 2 of the address
     */
    'address_line_2'?: string;
    /**
     * The city of the owner\'s address
     */
    'city'?: string;
    /**
     * Date of birth in yyyy-mm-dd format
     */
    'date_of_birth'?: string;
    /**
     * Document category.
     */
    'document_category'?: UsDrivingLicenceSharedDocumentCategoryEnum;
    /**
     * Expiration date of the driving licence in yyyy-mm-dd format
     */
    'expiration_date'?: string;
    /**
     * Eye color code.
     */
    'eye_color_code'?: UsDrivingLicenceSharedEyeColorCodeEnum;
    /**
     * The owner\'s first name
     */
    'first_name'?: string;
    'gender'?: UsDrivingLicenceSharedGenderEnum;
    /**
     * Issue date in yyyy-mm-dd format
     */
    'issue_date'?: string;
    /**
     * The owner\'s surname
     */
    'last_name'?: string;
    /**
     * The owner\'s middle name
     */
    'middle_name'?: string;
    /**
     * The owner\'s name suffix
     */
    'name_suffix'?: string;
    /**
     * The postcode or ZIP of the owner\'s address
     */
    'postal_code'?: string;
    /**
     * 2-characters state code
     */
    'state'?: string;
    /**
     * Weight in pounds
     */
    'weight_measure'?: number;
}
export declare const UsDrivingLicenceSharedDocumentCategoryEnum: {
    readonly DriverLicense: "driver license";
    readonly DriverPermit: "driver permit";
    readonly IdCard: "id card";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type UsDrivingLicenceSharedDocumentCategoryEnum = typeof UsDrivingLicenceSharedDocumentCategoryEnum[keyof typeof UsDrivingLicenceSharedDocumentCategoryEnum];
export declare const UsDrivingLicenceSharedEyeColorCodeEnum: {
    readonly Blk: "BLK";
    readonly Blu: "BLU";
    readonly Bro: "BRO";
    readonly Dic: "DIC";
    readonly Gry: "GRY";
    readonly Grn: "GRN";
    readonly Haz: "HAZ";
    readonly Mar: "MAR";
    readonly Pnk: "PNK";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type UsDrivingLicenceSharedEyeColorCodeEnum = typeof UsDrivingLicenceSharedEyeColorCodeEnum[keyof typeof UsDrivingLicenceSharedEyeColorCodeEnum];
export declare const UsDrivingLicenceSharedGenderEnum: {
    readonly Male: "Male";
    readonly Female: "Female";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type UsDrivingLicenceSharedGenderEnum = typeof UsDrivingLicenceSharedGenderEnum[keyof typeof UsDrivingLicenceSharedGenderEnum];
export interface VideoReasons {
    /**
     * Flags when evidence is found that a fake webcam was used.
     */
    'fake_webcam'?: string;
    /**
     * Flags when evidence is found that the video was uploaded in an attempt to circumvent the randomness of the speaking and head turn challenges
     */
    'challenge_reuse'?: string;
    /**
     * Flags when evidence is found that an Android emulator was used.
     */
    'emulator'?: string;
    /**
     * Additional comma separated details such as the name of the fake webcam.
     */
    'reasons'?: string;
}
export interface WatchlistAmlBreakdown {
    'sanction'?: WatchlistAmlBreakdownSanction;
    'politically_exposed_person'?: WatchlistAmlBreakdownPoliticallyExposedPerson;
    'legal_and_regulatory_warnings'?: WatchlistAmlBreakdownLegalAndRegulatoryWarnings;
    'adverse_media'?: WatchlistAmlBreakdownAdverseMedia;
}
/**
 * Asserts if there are any records found of negative events reported by publicly and generally available media sources.
 */
export interface WatchlistAmlBreakdownAdverseMedia {
    'result'?: string;
}
/**
 * Asserts if there are any records found in Law-Enforcement and Regulatory bodies Monitored Lists (including Terrorism, Money Laundering and Most Wanted lists).
 */
export interface WatchlistAmlBreakdownLegalAndRegulatoryWarnings {
    'result'?: string;
}
/**
 * Asserts if there are any records found in the proprietary database of Politically Exposed Persons sourced from government lists, websites and other media sources.
 */
export interface WatchlistAmlBreakdownPoliticallyExposedPerson {
    'result'?: string;
}
/**
 * Asserts if there are any records found in Government and International Organisations Sanctions Lists.
 */
export interface WatchlistAmlBreakdownSanction {
    'result'?: string;
}
export interface WatchlistAmlProperties {
    /**
     * Returns any matches including, but not limited to, name and date of birth of match, aliases and associates, and relevant events and sources.
     * @deprecated
     */
    'records'?: Array<object>;
}
export interface WatchlistAmlReport {
    /**
     * The unique identifier for the report. Read-only.
     */
    'id': string;
    /**
     * The date and time at which the report was first initiated. Read-only.
     */
    'created_at'?: string;
    /**
     * The API endpoint to retrieve the report. Read-only.
     */
    'href'?: string;
    'status'?: ReportStatus;
    'result'?: ReportResult;
    'sub_result'?: ReportSubResult;
    /**
     * The ID of the check to which the report belongs. Read-only.
     */
    'check_id'?: string;
    'name': ReportName;
    'breakdown'?: WatchlistAmlBreakdown;
    'properties'?: WatchlistAmlProperties;
}
export interface WatchlistEnhancedBreakdown {
    'politically_exposed_person'?: WatchlistAmlBreakdownPoliticallyExposedPerson;
    'sanction'?: WatchlistAmlBreakdownSanction;
    'adverse_media'?: WatchlistAmlBreakdownAdverseMedia;
    'monitored_lists'?: WatchlistAmlBreakdownLegalAndRegulatoryWarnings;
}
export interface WatchlistEnhancedProperties {
    /**
     * Returns any matches including, but not limited to, name and date of birth of match, aliases and associates, and relevant events and sources.
     */
    'records'?: Array<WatchlistEnhancedPropertiesRecordsInner>;
}
export interface WatchlistEnhancedPropertiesRecordsInner {
    /**
     * All addresses on file.
     */
    'address'?: Array<WatchlistEnhancedPropertiesRecordsInnerAddressInner>;
    /**
     * Any names that the person is also known as.
     */
    'alias'?: Array<WatchlistEnhancedPropertiesRecordsInnerAliasInner>;
    /**
     * Any linked persons, for example family relatives or business partners.
     */
    'associate'?: Array<WatchlistEnhancedPropertiesRecordsInnerAssociateInner>;
    /**
     * Information about the person, for example hair color or nationality.
     */
    'attribute'?: Array<WatchlistEnhancedPropertiesRecordsInnerAttributeInner>;
    /**
     * All the date of births on file.
     */
    'date_of_birth'?: Array<string>;
    /**
     * Information about events that have occurred to the person, for example deportation or arrest.
     */
    'event'?: Array<WatchlistEnhancedPropertiesRecordsInnerEventInner>;
    /**
     * The name on file
     */
    'full_name'?: string;
    /**
     * The role, country and date of each position.
     */
    'position'?: Array<string>;
    /**
     * Details about where the information was obtained.
     */
    'source'?: Array<WatchlistEnhancedPropertiesRecordsInnerSourceInner>;
}
export interface WatchlistEnhancedPropertiesRecordsInnerAddressInner {
    'address_line1'?: string;
    'country'?: CountryCodes;
    'postal_code'?: string;
    'state_province'?: string;
    'town'?: string;
    'locator_type'?: string;
}
export interface WatchlistEnhancedPropertiesRecordsInnerAliasInner {
    'alias_name'?: string;
    'alias_type'?: string;
}
export interface WatchlistEnhancedPropertiesRecordsInnerAssociateInner {
    'entity_name'?: string;
    'relationship_direction'?: string;
    'relationship_type'?: string;
}
export interface WatchlistEnhancedPropertiesRecordsInnerAttributeInner {
    'attribute_type'?: string;
    'attribute_value'?: string;
}
export interface WatchlistEnhancedPropertiesRecordsInnerEventInner {
    'category'?: string;
    'event_date'?: string;
    'event_description'?: string;
    'source'?: WatchlistEnhancedPropertiesRecordsInnerEventInnerSource;
    'sub_category'?: string;
}
export interface WatchlistEnhancedPropertiesRecordsInnerEventInnerSource {
    'source_date'?: string;
    'source_format'?: string;
    'source_name'?: string;
    'source_url'?: string;
}
export interface WatchlistEnhancedPropertiesRecordsInnerSourceInner {
    'source_headline'?: string;
    'source_name'?: string;
    'source_url'?: string;
    'source_format'?: string;
}
export interface WatchlistEnhancedReport {
    /**
     * The unique identifier for the report. Read-only.
     */
    'id': string;
    /**
     * The date and time at which the report was first initiated. Read-only.
     */
    'created_at'?: string;
    /**
     * The API endpoint to retrieve the report. Read-only.
     */
    'href'?: string;
    'status'?: ReportStatus;
    'result'?: ReportResult;
    'sub_result'?: ReportSubResult;
    /**
     * The ID of the check to which the report belongs. Read-only.
     */
    'check_id'?: string;
    'name': ReportName;
    'breakdown'?: WatchlistEnhancedBreakdown;
    'properties'?: WatchlistEnhancedProperties;
}
export interface WatchlistMonitor {
    /**
     * The ID for the applicant associated with the monitor.
     */
    'applicant_id': string;
    /**
     * The name of the report type the monitor creates.
     */
    'report_name': WatchlistMonitorReportNameEnum;
    /**
     * A list of tags associated with this monitor. These tags will be applied to each check this monitor creates.
     */
    'tags'?: Array<string>;
    /**
     * The unique identifier for the monitor.
     */
    'id': string;
    /**
     * The date and time at which the monitor was created.
     */
    'created_at'?: string;
    /**
     * The date and time at which the monitor was deleted. If the monitor is still active, this field will be null.
     */
    'deleted_at'?: string;
    /**
     * Indicates whether the object was created in the sandbox or not.
     */
    'is_sandbox'?: boolean;
}
export declare const WatchlistMonitorReportNameEnum: {
    readonly Standard: "watchlist_standard";
    readonly Aml: "watchlist_aml";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type WatchlistMonitorReportNameEnum = typeof WatchlistMonitorReportNameEnum[keyof typeof WatchlistMonitorReportNameEnum];
export interface WatchlistMonitorBuilder {
    /**
     * The ID for the applicant associated with the monitor.
     */
    'applicant_id': string;
    /**
     * The name of the report type the monitor creates.
     */
    'report_name': WatchlistMonitorBuilderReportNameEnum;
    /**
     * A list of tags associated with this monitor. These tags will be applied to each check this monitor creates.
     */
    'tags'?: Array<string>;
}
export declare const WatchlistMonitorBuilderReportNameEnum: {
    readonly Standard: "watchlist_standard";
    readonly Aml: "watchlist_aml";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type WatchlistMonitorBuilderReportNameEnum = typeof WatchlistMonitorBuilderReportNameEnum[keyof typeof WatchlistMonitorBuilderReportNameEnum];
export interface WatchlistMonitorMatch {
    /**
     * Monitor ID
     */
    'id'?: string;
    /**
     * Monitor status
     */
    'enabled'?: boolean;
}
export interface WatchlistMonitorMatchesList {
    'matches': Array<WatchlistMonitorMatch>;
}
export interface WatchlistMonitorMatchesUpdater {
    'enable'?: Array<string>;
    'disable'?: Array<string>;
}
export interface WatchlistMonitorResponse {
    /**
     * The unique identifier for the monitor.
     */
    'id': string;
    /**
     * The date and time at which the monitor was created.
     */
    'created_at'?: string;
    /**
     * The date and time at which the monitor was deleted. If the monitor is still active, this field will be null.
     */
    'deleted_at'?: string;
    /**
     * Indicates whether the object was created in the sandbox or not.
     */
    'is_sandbox'?: boolean;
}
export interface WatchlistMonitorShared {
    /**
     * The ID for the applicant associated with the monitor.
     */
    'applicant_id': string;
    /**
     * The name of the report type the monitor creates.
     */
    'report_name': WatchlistMonitorSharedReportNameEnum;
    /**
     * A list of tags associated with this monitor. These tags will be applied to each check this monitor creates.
     */
    'tags'?: Array<string>;
}
export declare const WatchlistMonitorSharedReportNameEnum: {
    readonly Standard: "watchlist_standard";
    readonly Aml: "watchlist_aml";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type WatchlistMonitorSharedReportNameEnum = typeof WatchlistMonitorSharedReportNameEnum[keyof typeof WatchlistMonitorSharedReportNameEnum];
export interface WatchlistMonitorsList {
    'monitors': Array<WatchlistMonitor>;
}
export interface WatchlistPepsOnlyReport {
    /**
     * The unique identifier for the report. Read-only.
     */
    'id': string;
    /**
     * The date and time at which the report was first initiated. Read-only.
     */
    'created_at'?: string;
    /**
     * The API endpoint to retrieve the report. Read-only.
     */
    'href'?: string;
    'status'?: ReportStatus;
    'result'?: ReportResult;
    'sub_result'?: ReportSubResult;
    /**
     * The ID of the check to which the report belongs. Read-only.
     */
    'check_id'?: string;
    'name': ReportName;
    'breakdown'?: WatchlistStandardBreakdown;
    'properties'?: WatchlistStandardProperties;
}
export interface WatchlistSanctionsOnlyReport {
    /**
     * The unique identifier for the report. Read-only.
     */
    'id': string;
    /**
     * The date and time at which the report was first initiated. Read-only.
     */
    'created_at'?: string;
    /**
     * The API endpoint to retrieve the report. Read-only.
     */
    'href'?: string;
    'status'?: ReportStatus;
    'result'?: ReportResult;
    'sub_result'?: ReportSubResult;
    /**
     * The ID of the check to which the report belongs. Read-only.
     */
    'check_id'?: string;
    'name': ReportName;
    'breakdown'?: WatchlistStandardBreakdown;
    'properties'?: WatchlistStandardProperties;
}
export interface WatchlistStandardBreakdown {
    'sanction'?: WatchlistAmlBreakdownSanction;
    'politically_exposed_person'?: WatchlistAmlBreakdownPoliticallyExposedPerson;
    'legal_and_regulatory_warnings'?: WatchlistAmlBreakdownLegalAndRegulatoryWarnings;
}
export interface WatchlistStandardProperties {
    /**
     * Returns any matches including, but not limited to, name and date of birth of match, aliases and associates, and relevant events and sources.
     * @deprecated
     */
    'records'?: Array<object>;
}
export interface WatchlistStandardReport {
    /**
     * The unique identifier for the report. Read-only.
     */
    'id': string;
    /**
     * The date and time at which the report was first initiated. Read-only.
     */
    'created_at'?: string;
    /**
     * The API endpoint to retrieve the report. Read-only.
     */
    'href'?: string;
    'status'?: ReportStatus;
    'result'?: ReportResult;
    'sub_result'?: ReportSubResult;
    /**
     * The ID of the check to which the report belongs. Read-only.
     */
    'check_id'?: string;
    'name': ReportName;
    'breakdown'?: WatchlistStandardBreakdown;
    'properties'?: WatchlistStandardProperties;
}
export interface Webhook {
    /**
     * Determine if the webhook is active.
     */
    'enabled'?: boolean;
    /**
     * The events that will be published to the webhook. If the events parameter is omitted all the events will be subscribed.
     */
    'events'?: Array<WebhookEventType>;
    /**
     * The environments from which the webhook will receive events. Allowed values are “sandbox” and “live”. If the environments parameter is omitted the webhook will receive events from both environments.
     */
    'environments'?: Array<string>;
    /**
     * Webhook version used to control the payload object when sending webhooks.
     */
    'payload_version'?: number;
    /**
     * Determines if the webhook will fetch OAuth access tokens to send in the Authorization header.
     */
    'oauth_enabled'?: boolean;
    /**
     * The url to fetch the OAuth access token using client credentials grant.
     */
    'oauth_server_url'?: string;
    /**
     * The client id to authenticate the client credentials grant.
     */
    'oauth_server_client_id'?: string;
    /**
     * The client secret to authenticate the client credentials grant.
     */
    'oauth_server_client_secret'?: string;
    /**
     * The scopes to be sent when requesting the access token.
     */
    'oauth_server_scope'?: string;
    /**
     * The unique identifier of the webhook.
     */
    'id': string;
    /**
     * The url that will listen to notifications (must be https).
     */
    'url'?: string;
    /**
     * Webhook secret token used to sign the webhook\'s payload.
     */
    'token'?: string;
    /**
     * The API endpoint to retrieve the webhook.
     */
    'href'?: string;
}
export interface WebhookBuilder {
    /**
     * Determine if the webhook is active.
     */
    'enabled'?: boolean;
    /**
     * The events that will be published to the webhook. If the events parameter is omitted all the events will be subscribed.
     */
    'events'?: Array<WebhookEventType>;
    /**
     * The environments from which the webhook will receive events. Allowed values are “sandbox” and “live”. If the environments parameter is omitted the webhook will receive events from both environments.
     */
    'environments'?: Array<string>;
    /**
     * Webhook version used to control the payload object when sending webhooks.
     */
    'payload_version'?: number;
    /**
     * Determines if the webhook will fetch OAuth access tokens to send in the Authorization header.
     */
    'oauth_enabled'?: boolean;
    /**
     * The url to fetch the OAuth access token using client credentials grant.
     */
    'oauth_server_url'?: string;
    /**
     * The client id to authenticate the client credentials grant.
     */
    'oauth_server_client_id'?: string;
    /**
     * The client secret to authenticate the client credentials grant.
     */
    'oauth_server_client_secret'?: string;
    /**
     * The scopes to be sent when requesting the access token.
     */
    'oauth_server_scope'?: string;
    /**
     * The url that will listen to notifications (must be https).
     */
    'url': string;
}
export interface WebhookCreate {
    /**
     * The url that will listen to notifications (must be https).
     */
    'url': string;
}
export interface WebhookEvent {
    'payload'?: WebhookEventPayload;
}
/**
 * The current state of the object, if available.
 */
export declare const WebhookEventObjectStatus: {
    readonly Processing: "processing";
    readonly AwaitingInput: "awaiting_input";
    readonly AwaitingClientInput: "awaiting_client_input";
    readonly Approved: "approved";
    readonly Declined: "declined";
    readonly Review: "review";
    readonly Abandoned: "abandoned";
    readonly Error: "error";
    readonly Started: "started";
    readonly Cancelled: "cancelled";
    readonly Completed: "completed";
    readonly AwaitingData: "awaiting_data";
    readonly AwaitingApproval: "awaiting_approval";
    readonly Complete: "complete";
    readonly Withdrawn: "withdrawn";
    readonly InProgress: "in_progress";
    readonly AwaitingApplicant: "awaiting_applicant";
    readonly Paused: "paused";
    readonly Reopened: "reopened";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type WebhookEventObjectStatus = typeof WebhookEventObjectStatus[keyof typeof WebhookEventObjectStatus];
export interface WebhookEventPayload {
    /**
     * Indicates the resource affected by this event.
     */
    'resource_type': WebhookEventResourceType;
    /**
     * The event that triggered this webhook.
     */
    'action'?: WebhookEventType;
    'object'?: WebhookEventPayloadObject;
    'resource'?: WebhookEventPayloadResource;
}
/**
 * The object affected by this event.
 */
export interface WebhookEventPayloadObject {
    /**
     * The unique identifier of the resource.
     */
    'id': string;
    'status'?: WebhookEventObjectStatus;
    /**
     * The date and time when the operation was started, if available.
     */
    'started_at_iso8601'?: string;
    /**
     * The date and time when the operation was completed, if available.
     */
    'completed_at_iso8601'?: string;
    /**
     * The uri of the resource.
     */
    'href'?: string;
}
/**
 * The resource affected by this event.
 */
export interface WebhookEventPayloadResource {
    /**
     * The identifier of the resource.
     */
    'id'?: string;
    /**
     * The unique identifier for the Applicant.
     */
    'applicant_id'?: string;
    'status'?: WebhookEventResourceStatus;
    /**
     * The date and time when the resource was created.
     */
    'created_at'?: string;
    /**
     * The date and time when the resource was last updated.
     */
    'updated_at'?: string;
    /**
     * The URL for viewing the resource on Onfido Dashboard.
     */
    'dashboard_url'?: string;
    /**
     * The unique identifier for the Workflow.
     */
    'workflow_id'?: string;
    'workflow_run_id'?: string;
    /**
     * The identifier for the Workflow version.
     */
    'workflow_version_id'?: number;
    /**
     * The identifier for the Task Definition.
     */
    'task_def_id'?: string;
    /**
     * The task definition version.
     */
    'task_def_version'?: string | null;
    /**
     * Input object with the fields used by the Task execution.
     */
    'input'?: object;
    /**
     * Value field (it can be an Object, List, etc.) with the fields produced by the Task execution.
     */
    'output'?: object | null;
    /**
     * The reasons the Workflow Run outcome was reached. Configurable when creating the Workflow Version.
     */
    'reasons'?: Array<string>;
    /**
     * A list of tags associated with the Workflow Run.
     */
    'tags'?: Array<string>;
    /**
     * Object for the configuration of the Workflow Run link.
     */
    'link'?: WorkflowRunLink;
    /**
     * Error object that details why a Workflow Run is in Error status.
     */
    'error'?: WorkflowRunError;
    /**
     * Customer-provided user identifier.
     */
    'customer_user_id'?: string;
    /**
     * Pre-signed URL to download the timeline file for the Workflow Run.
     */
    'timeline_file_download_url'?: string;
}
/**
 * The current state of the reference, if available.
 */
export declare const WebhookEventResourceStatus: {
    readonly Processing: "processing";
    readonly AwaitingInput: "awaiting_input";
    readonly AwaitingClientInput: "awaiting_client_input";
    readonly Approved: "approved";
    readonly Declined: "declined";
    readonly Review: "review";
    readonly Abandoned: "abandoned";
    readonly Error: "error";
    readonly Started: "started";
    readonly Cancelled: "cancelled";
    readonly Completed: "completed";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type WebhookEventResourceStatus = typeof WebhookEventResourceStatus[keyof typeof WebhookEventResourceStatus];
export declare const WebhookEventResourceType: {
    readonly Check: "check";
    readonly Report: "report";
    readonly AuditLog: "audit_log";
    readonly WorkflowRun: "workflow_run";
    readonly WorkflowTask: "workflow_task";
    readonly WatchlistMonitor: "watchlist_monitor";
    readonly WorkflowTimelineFile: "workflow_timeline_file";
    readonly WorkflowRunEvidenceFolder: "workflow_run_evidence_folder";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type WebhookEventResourceType = typeof WebhookEventResourceType[keyof typeof WebhookEventResourceType];
export declare const WebhookEventType: {
    readonly AuditLogCreated: "audit_log.created";
    readonly WatchlistMonitorMatchesUpdated: "watchlist_monitor.matches_updated";
    readonly WorkflowRunCompleted: "workflow_run.completed";
    readonly WorkflowTaskStarted: "workflow_task.started";
    readonly WorkflowTaskCompleted: "workflow_task.completed";
    readonly CheckStarted: "check.started";
    readonly CheckReopened: "check.reopened";
    readonly CheckWithdrawn: "check.withdrawn";
    readonly CheckCompleted: "check.completed";
    readonly CheckFormCompleted: "check.form_completed";
    readonly ReportWithdrawn: "report.withdrawn";
    readonly ReportResumed: "report.resumed";
    readonly ReportCancelled: "report.cancelled";
    readonly ReportAwaitingApproval: "report.awaiting_approval";
    readonly ReportCompleted: "report.completed";
    readonly WorkflowTimelineFileCreated: "workflow_timeline_file.created";
    readonly WorkflowRunEvidenceFolderCreated: "workflow_run_evidence_folder.created";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type WebhookEventType = typeof WebhookEventType[keyof typeof WebhookEventType];
export interface WebhookResend {
    'data'?: Array<WebhooksResendItem>;
}
export interface WebhookResponse {
    /**
     * The unique identifier of the webhook.
     */
    'id': string;
    /**
     * The url that will listen to notifications (must be https).
     */
    'url'?: string;
    /**
     * Webhook secret token used to sign the webhook\'s payload.
     */
    'token'?: string;
    /**
     * The API endpoint to retrieve the webhook.
     */
    'href'?: string;
}
export interface WebhookShared {
    /**
     * Determine if the webhook is active.
     */
    'enabled'?: boolean;
    /**
     * The events that will be published to the webhook. If the events parameter is omitted all the events will be subscribed.
     */
    'events'?: Array<WebhookEventType>;
    /**
     * The environments from which the webhook will receive events. Allowed values are “sandbox” and “live”. If the environments parameter is omitted the webhook will receive events from both environments.
     */
    'environments'?: Array<string>;
    /**
     * Webhook version used to control the payload object when sending webhooks.
     */
    'payload_version'?: number;
    /**
     * Determines if the webhook will fetch OAuth access tokens to send in the Authorization header.
     */
    'oauth_enabled'?: boolean;
    /**
     * The url to fetch the OAuth access token using client credentials grant.
     */
    'oauth_server_url'?: string;
    /**
     * The client id to authenticate the client credentials grant.
     */
    'oauth_server_client_id'?: string;
    /**
     * The client secret to authenticate the client credentials grant.
     */
    'oauth_server_client_secret'?: string;
    /**
     * The scopes to be sent when requesting the access token.
     */
    'oauth_server_scope'?: string;
}
export interface WebhookUpdate {
    /**
     * The url that will listen to notifications (must be https).
     */
    'url'?: string;
}
export interface WebhookUpdater {
    /**
     * Determine if the webhook is active.
     */
    'enabled'?: boolean;
    /**
     * The events that will be published to the webhook. If the events parameter is omitted all the events will be subscribed.
     */
    'events'?: Array<WebhookEventType>;
    /**
     * The environments from which the webhook will receive events. Allowed values are “sandbox” and “live”. If the environments parameter is omitted the webhook will receive events from both environments.
     */
    'environments'?: Array<string>;
    /**
     * Webhook version used to control the payload object when sending webhooks.
     */
    'payload_version'?: number;
    /**
     * Determines if the webhook will fetch OAuth access tokens to send in the Authorization header.
     */
    'oauth_enabled'?: boolean;
    /**
     * The url to fetch the OAuth access token using client credentials grant.
     */
    'oauth_server_url'?: string;
    /**
     * The client id to authenticate the client credentials grant.
     */
    'oauth_server_client_id'?: string;
    /**
     * The client secret to authenticate the client credentials grant.
     */
    'oauth_server_client_secret'?: string;
    /**
     * The scopes to be sent when requesting the access token.
     */
    'oauth_server_scope'?: string;
    /**
     * The url that will listen to notifications (must be https).
     */
    'url'?: string;
}
export interface WebhooksList {
    'webhooks': Array<Webhook>;
}
export interface WebhooksResendItem {
    /**
     * ID of the resource whose webhooks are to be retriggered.
     */
    'resource_id': string;
    /**
     * The events that should retrigger webhooks. Accepts values check.completed.
     */
    'event': WebhookEventType;
}
export interface WorkflowRun {
    /**
     * The unique identifier for the Applicant.
     */
    'applicant_id': string;
    /**
     * The unique identifier for the Workflow.
     */
    'workflow_id': string;
    /**
     * Tags or labels assigned to the workflow run.
     */
    'tags'?: Array<string> | null;
    /**
     * Customer-provided user identifier.
     */
    'customer_user_id'?: string;
    /**
     * Object for the configuration of the Workflow Run link.
     */
    'link'?: WorkflowRunLink;
    /**
     * The date and time when the Workflow Run was created.
     */
    'created_at'?: string;
    /**
     * The date and time when the Workflow Run was last updated.
     */
    'updated_at'?: string;
    /**
     * The unique identifier for the Workflow Run.
     */
    'id': string;
    /**
     * The identifier for the Workflow version.
     */
    'workflow_version_id'?: number;
    /**
     * The URL for viewing the Workflow Run results on your Onfido Dashboard.
     */
    'dashboard_url'?: string;
    /**
     * The status of the Workflow Run.
     */
    'status'?: WorkflowRunStatus;
    /**
     * Output object contains all of the properties configured on the Workflow version.
     */
    'output'?: object;
    /**
     * The reasons the Workflow Run outcome was reached. Configurable when creating the Workflow version.
     */
    'reasons'?: Array<string>;
    /**
     * Error object. Only set when the Workflow Run status is \'error\'.
     */
    'error'?: WorkflowRunError;
    /**
     * Client token to use when loading this workflow run in the Onfido SDK.
     */
    'sdk_token'?: string | null;
}
export interface WorkflowRunBuilder {
    /**
     * The unique identifier for the Applicant.
     */
    'applicant_id': string;
    /**
     * The unique identifier for the Workflow.
     */
    'workflow_id': string;
    /**
     * Tags or labels assigned to the workflow run.
     */
    'tags'?: Array<string> | null;
    /**
     * Customer-provided user identifier.
     */
    'customer_user_id'?: string;
    /**
     * Object for the configuration of the Workflow Run link.
     */
    'link'?: WorkflowRunLink;
    /**
     * The date and time when the Workflow Run was created.
     */
    'created_at'?: string;
    /**
     * The date and time when the Workflow Run was last updated.
     */
    'updated_at'?: string;
    /**
     * Object with Custom Input Data to be used in the Workflow Run.
     */
    'custom_data'?: {
        [key: string]: any;
    };
}
export interface WorkflowRunError {
    /**
     * The type of error.
     */
    'type'?: string;
    /**
     * A textual description of the error.
     */
    'message'?: string;
}
export interface WorkflowRunLink {
    /**
     * Link to access the Workflow Run without the need to integrate with Onfido\'s SDKs.
     */
    'url'?: string;
    /**
     * When the interactive section of the Workflow Run has completed successfully, the user will be redirected to this URL instead of seeing the default Onfido \'thank you\' page.
     */
    'completed_redirect_url'?: string | null;
    /**
     * When the link has expired, the user will be immediately redirected to this URL instead of seeing the default Onfido error message.
     */
    'expired_redirect_url'?: string | null;
    /**
     * Date and time when the link will expire.
     */
    'expires_at'?: string | null;
    /**
     * The code for the language when the workflow run is acessed using the link.
     */
    'language'?: WorkflowRunLinkLanguageEnum | null;
}
export declare const WorkflowRunLinkLanguageEnum: {
    readonly EnUs: "en_US";
    readonly DeDe: "de_DE";
    readonly EsEs: "es_ES";
    readonly FrFr: "fr_FR";
    readonly ItIt: "it_IT";
    readonly PtPt: "pt_PT";
    readonly NlNl: "nl_NL";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type WorkflowRunLinkLanguageEnum = typeof WorkflowRunLinkLanguageEnum[keyof typeof WorkflowRunLinkLanguageEnum];
export interface WorkflowRunRequest {
    /**
     * Object with Custom Input Data to be used in the Workflow Run.
     */
    'custom_data'?: {
        [key: string]: any;
    };
}
export interface WorkflowRunResponse {
    /**
     * The unique identifier for the Workflow Run.
     */
    'id': string;
    /**
     * The identifier for the Workflow version.
     */
    'workflow_version_id'?: number;
    /**
     * The URL for viewing the Workflow Run results on your Onfido Dashboard.
     */
    'dashboard_url'?: string;
    /**
     * The status of the Workflow Run.
     */
    'status'?: WorkflowRunStatus;
    /**
     * Output object contains all of the properties configured on the Workflow version.
     */
    'output'?: object;
    /**
     * The reasons the Workflow Run outcome was reached. Configurable when creating the Workflow version.
     */
    'reasons'?: Array<string>;
    /**
     * Error object. Only set when the Workflow Run status is \'error\'.
     */
    'error'?: WorkflowRunError;
    /**
     * Client token to use when loading this workflow run in the Onfido SDK.
     */
    'sdk_token'?: string | null;
}
export interface WorkflowRunShared {
    /**
     * The unique identifier for the Applicant.
     */
    'applicant_id': string;
    /**
     * The unique identifier for the Workflow.
     */
    'workflow_id': string;
    /**
     * Tags or labels assigned to the workflow run.
     */
    'tags'?: Array<string> | null;
    /**
     * Customer-provided user identifier.
     */
    'customer_user_id'?: string;
    /**
     * Object for the configuration of the Workflow Run link.
     */
    'link'?: WorkflowRunLink;
    /**
     * The date and time when the Workflow Run was created.
     */
    'created_at'?: string;
    /**
     * The date and time when the Workflow Run was last updated.
     */
    'updated_at'?: string;
}
export declare const WorkflowRunStatus: {
    readonly Processing: "processing";
    readonly AwaitingInput: "awaiting_input";
    readonly AwaitingClientInput: "awaiting_client_input";
    readonly Approved: "approved";
    readonly Declined: "declined";
    readonly Review: "review";
    readonly Abandoned: "abandoned";
    readonly Error: "error";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type WorkflowRunStatus = typeof WorkflowRunStatus[keyof typeof WorkflowRunStatus];
/**
 * DefaultApi - axios parameter creator
 */
export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Cancels single paused reports.
     * @summary Cancel report
     * @param {string} reportId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    cancelReport: (reportId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Completes a Send / Receive Data Task.
     * @summary Complete Task
     * @param {string} workflowRunId The unique identifier of the Workflow Run to which the Task belongs.
     * @param {string} taskId The identifier of the Task you want to complete.
     * @param {CompleteTaskBuilder} completeTaskBuilder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    completeTask: (workflowRunId: string, taskId: string, completeTaskBuilder: CompleteTaskBuilder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Creates a single applicant. Returns an applicant object.
     * @summary Create Applicant
     * @param {ApplicantBuilder} applicantBuilder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createApplicant: (applicantBuilder: ApplicantBuilder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Initiates a check for an applicant, which can contain one or more reports. Returns a check object.
     * @summary Create a check
     * @param {CheckBuilder} checkBuilder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createCheck: (checkBuilder: CheckBuilder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Triggers the generation of the Timeline File for the designated Workflow Run.
     * @summary Create Timeline File for Workflow Run
     * @param {string} workflowRunId The unique identifier of the Workflow Run.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createTimelineFile: (workflowRunId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Creates a new monitor for the applicant
     * @summary Create monitor
     * @param {WatchlistMonitorBuilder} watchlistMonitorBuilder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createWatchlistMonitor: (watchlistMonitorBuilder: WatchlistMonitorBuilder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Registers a webhook. Returns a webhook object.
     * @summary Register webhook
     * @param {WebhookBuilder} webhookBuilder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createWebhook: (webhookBuilder: WebhookBuilder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Creates and starts a Workflow Run. Returns a Workflow Run object.
     * @summary Create a Workflow Run
     * @param {WorkflowRunBuilder} workflowRunBuilder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createWorkflowRun: (workflowRunBuilder: WorkflowRunBuilder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Deletes a single applicant.
     * @summary Delete Applicant
     * @param {string} applicantId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteApplicant: (applicantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Deletes a passkey.
     * @summary Delete passkey
     * @param {string} username Username that owns the passkey.
     * @param {string} passkeyId Passkey ID.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deletePasskey: (username: string, passkeyId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Removes every passkey for the username.
     * @summary Delete passkeys
     * @param {string} username Username whose passkeys will be deleted.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deletePasskeys: (username: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Deactivates the given monitor
     * @summary Delete monitor
     * @param {string} monitorId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteWatchlistMonitor: (monitorId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Deletes a webhook.
     * @summary Delete a webhook
     * @param {string} webhookId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteWebhook: (webhookId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Retrieves the signed document or signing transaction receipt depending on the id provided.
     * @summary Retrieves the signed document or signing transaction receipt
     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
     * @param {string} id The unique identifier of the file which you want to retrieve.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadAesDocument: (workflowRunId: string, id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.
     * @summary Download check
     * @param {string} checkId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadCheck: (checkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Downloads specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
     * @summary Download document
     * @param {string} documentId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadDocument: (documentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Downloads a document video. If successful, the response will be the binary data representing the video.
     * @summary Download document video
     * @param {string} documentId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadDocumentVideo: (documentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Retrieves the evidence folder for the designated Workflow Run
     * @summary Retrieve Workflow Run Evidence Folder
     * @param {string} workflowRunId Workflow Run ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadEvidenceFolder: (workflowRunId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * ID photos are downloaded using this endpoint.
     * @summary Download ID photo
     * @param {string} idPhotoId The ID photo\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadIdPhoto: (idPhotoId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Live photos are downloaded using this endpoint.
     * @summary Download live photo
     * @param {string} livePhotoId The live photo\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadLivePhoto: (livePhotoId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Live videos are downloaded using this endpoint.
     * @summary Download live video
     * @param {string} liveVideoId The live video\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadLiveVideo: (liveVideoId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Returns the binary data representing a single frame from a live video.
     * @summary Download live video frame
     * @param {string} liveVideoId The live video\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadLiveVideoFrame: (liveVideoId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Motion captures are downloaded using this endpoint.
     * @summary Download motion capture
     * @param {string} motionCaptureId The motion capture\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadMotionCapture: (motionCaptureId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Instead of the whole capture binary, a single frame can be downloaded using this endpoint. Returns the binary data representing the frame.
     * @summary Download motion capture frame
     * @param {string} motionCaptureId The motion capture\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadMotionCaptureFrame: (motionCaptureId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Downloads digital photos extracted from specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
     * @summary Download NFC face
     * @param {string} documentId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadNfcFace: (documentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Retrieves the signed document or application form depending on the file_id provided.
     * @summary Retrieves the signed document or application form
     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
     * @param {string} fileId The unique identifier of the file which you want to retrieve.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadQesDocument: (workflowRunId: string, fileId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Retrieves the signed document or signing transaction receipt depending on the id provided.
     * @summary Retrieves the signed document or signing transaction receipt
     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
     * @param {string} id The unique identifier of the file which you want to retrieve.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadSesDocument: (workflowRunId: string, id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Retrieves the signed evidence file for the designated Workflow Run
     * @summary Retrieve Workflow Run Evidence Summary File
     * @param {string} workflowRunId Workflow Run ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadSignedEvidenceFile: (workflowRunId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Downloads specific signing documents belonging to an applicant. If successful, the response will be the binary data representing the pdf.
     * @summary Download signing document
     * @param {string} signingDocumentId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadSigningDocument: (signingDocumentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Extract information from a document
     * @summary Autofill
     * @param {ExtractRequest} extractRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    extract: (extractRequest: ExtractRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Search for addresses by postcode
     * @summary Address Picker
     * @param {string} postcode
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findAddresses: (postcode: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Retrieves a single applicant. Returns an applicant object.
     * @summary Retrieve Applicant
     * @param {string} applicantId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findApplicant: (applicantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Retrieves consents for single applicant.
     * @summary Retrieve Applicant Consents
     * @param {string} applicantId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findApplicantConsents: (applicantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Retrieves a single check. Returns a check object.
     * @summary Retrieve a Check
     * @param {string} checkId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findCheck: (checkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * A single document can be retrieved by calling this endpoint with the document\'s unique identifier.
     * @summary Retrieve document
     * @param {string} documentId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findDocument: (documentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Retrieves a single ID photo. Returns a ID photo object.
     * @summary Retrieve ID photo
     * @param {string} idPhotoId The ID photo\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findIdPhoto: (idPhotoId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Retrieves a single live photo. Returns a live photo object.
     * @summary Retrieve live photo
     * @param {string} livePhotoId The live photo\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findLivePhoto: (livePhotoId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Retrieves a single live video. Returns the corresponding live video object.
     * @summary Retrieve live video
     * @param {string} liveVideoId The live video\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findLiveVideo: (liveVideoId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Retrieves a single motion capture. Returns the corresponding motion capture object.
     * @summary Retrieve motion capture
     * @param {string} motionCaptureId The motion capture\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findMotionCapture: (motionCaptureId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Returns a passkey\'s details.
     * @summary Retrieve passkey
     * @param {string} username Username that owns the passkey.
     * @param {string} passkeyId Passkey ID.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findPasskey: (username: string, passkeyId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * A single report can be retrieved using this endpoint with the corresponding unique identifier.
     * @summary Retrieve report
     * @param {string} reportId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findReport: (reportId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * A single signing document can be retrieved by calling this endpoint with the signing document\'s unique identifier.
     * @summary Retrieve signing document
     * @param {string} signingDocumentId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findSigningDocument: (signingDocumentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.
     * @summary Retrieve Task
     * @param {string} workflowRunId The unique identifier of the Workflow Run to which the Task belongs.
     * @param {string} taskId The identifier of the Task you want to retrieve.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findTask: (workflowRunId: string, taskId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Retrieves the Timeline File for the designated Workflow Run.
     * @summary Retrieve Timeline File for Workflow Run
     * @param {string} workflowRunId The unique identifier of the Workflow Run.
     * @param {string} timelineFileId The unique identifier for the Timefile File.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findTimelineFile: (workflowRunId: string, timelineFileId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Retrieves a single monitor
     * @summary Retrieve monitor
     * @param {string} monitorId The watchlist monitor\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findWatchlistMonitor: (monitorId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Retrieves a single webhook. Returns a webhook object.
     * @summary Retrieve a Webhook
     * @param {string} webhookId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findWebhook: (webhookId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * A single workflow run can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
     * @summary Retrieve Workflow Run
     * @param {string} workflowRunId The unique identifier of the Workflow Run.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findWorkflowRun: (workflowRunId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Triggers a new check with an updated report to be generated by the monitor, as if the monitor had received an update.
     * @summary Force new report creation (BETA)
     * @param {string} monitorId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    forceReportCreationFromWatchlistMonitor: (monitorId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Generates an SDK token. Returns a token object containing the SDK token.
     * @summary Generate a SDK token
     * @param {SdkTokenBuilder} sdkTokenBuilder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    generateSdkToken: (sdkTokenBuilder: SdkTokenBuilder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Lists all applicants you\'ve created, sorted by creation date in descending order.
     * @summary List Applicants
     * @param {number} [page] The page to return. The first page is &#x60;page&#x3D;1&#x60;
     * @param {number} [perPage] The number of objects per page.
     * @param {boolean} [includeDeleted] Whether to also include applicants scheduled for deletion.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listApplicants: (page?: number, perPage?: number, includeDeleted?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Retrieves a single check. Returns a check object.
     * @summary Retrieve Checks
     * @param {string} applicantId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listChecks: (applicantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * All documents belonging to an applicant can be listed from this endpoint
     * @summary List documents
     * @param {string} applicantId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listDocuments: (applicantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Lists the ID photos that belong to an applicant.
     * @summary List ID photos
     * @param {string} applicantId The id of the applicant the ID photos belong to.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listIdPhotos: (applicantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Lists the live photos that belong to an applicant.
     * @summary List live photos
     * @param {string} applicantId The id of the applicant the live photos belong to.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listLivePhotos: (applicantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Lists all the live videos that belong to an applicant.
     * @summary List live videos
     * @param {string} applicantId The id of the applicant the live videos belong to.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listLiveVideos: (applicantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Lists all the motion captures that belong to an applicant.
     * @summary List motion captures
     * @param {string} applicantId The id of the applicant the motion captures belong to.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listMotionCaptures: (applicantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Returns every passkey registered under the supplied username.
     * @summary List passkeys
     * @param {string} username Username that owns the passkeys.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listPasskeys: (username: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Returns all repeat attempts for a given Document report
     * @summary Retrieve repeat attempts
     * @param {string} reportId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listRepeatAttempts: (reportId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * All the reports belonging to a particular check can be listed from this endpoint.
     * @summary List reports
     * @param {string} checkId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listReports: (checkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * All signing documents belonging to an applicant can be listed from this endpoint
     * @summary List signing documents
     * @param {string} applicantId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listSigningDocuments: (applicantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
     * @summary List Tasks
     * @param {string} workflowRunId The unique identifier of the Workflow Run to which the Tasks belong.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listTasks: (workflowRunId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * List match IDs on this monitor, as well as their enabled/disabled status
     * @summary List matches (BETA)
     * @param {string} monitorId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listWatchlistMonitorMatches: (monitorId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * List all available monitors for an applicant
     * @summary List monitors
     * @param {string} applicantId The id of the applicant the watchlist monitors belong to. If omitted, all monitors for the account will be listed.
     * @param {boolean} [includeDeleted] Whether to also include deleted (inactive) monitors.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listWatchlistMonitors: (applicantId: string, includeDeleted?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Lists all webhooks you\'ve created.
     * @summary List webhooks
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listWebhooks: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Retrieves the Workflow Runs of the client. Returns a list of Workflow Run objects.
     * @summary List Workflow Runs
     * @param {number} [page] The number of the page to be retrieved. If not specified, defaults to 1.
     * @param {string} [status] A list of comma separated status values to filter the results. Possible values are \&#39;processing\&#39;, \&#39;awaiting_input\&#39;, \&#39;approved\&#39;, \&#39;declined\&#39;, \&#39;review\&#39;, \&#39;abandoned\&#39; and \&#39;error\&#39;.
     * @param {string} [createdAtGt] A ISO-8601 date to filter results with a created date greater than (after) the one provided.
     * @param {string} [createdAtLt] A ISO-8601 date to filter results with a created date less than (before) the one provided.
     * @param {ListWorkflowRunsSortEnum} [sort] A string with the value \&#39;desc\&#39; or \&#39;asc\&#39; that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to \&#39;desc\&#39;.
     * @param {string} [applicantId] the applicant\&#39;s id.
     * @param {Array<string>} [tags] A list of tags to filter the results.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listWorkflowRuns: (page?: number, status?: string, createdAtGt?: string, createdAtLt?: string, sort?: ListWorkflowRunsSortEnum, applicantId?: string, tags?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Run a health check on the Onfido API
     * @summary Ping
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    ping: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Create Feedback on checks and reports
     * @summary Fraud reporting (ALPHA)
     * @param {ResultsFeedback} resultsFeedback
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postResultsFeedback: (resultsFeedback: ResultsFeedback, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Resends events to all webhooks registered with a matching environment in your account.
     * @summary Resends webhooks
     * @param {WebhookResend} webhookResend
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    resendWebhooks: (webhookResend: WebhookResend, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Restores a single applicant scheduled for deletion.
     * @summary Restore Applicant
     * @param {string} applicantId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    restoreApplicant: (applicantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Resumes a paused check.
     * @summary Resume a Check
     * @param {string} checkId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    resumeCheck: (checkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Resumes a single paused report.
     * @summary Resume report
     * @param {string} reportId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    resumeReport: (reportId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Allows updating applicant\'s information before any checks is created. - Partial updates - Addresses and ID numbers present will replace existing ones - Same applicant validations to create applicant
     * @summary Update Applicant
     * @param {string} applicantId
     * @param {ApplicantUpdater} applicantUpdater
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateApplicant: (applicantId: string, applicantUpdater: ApplicantUpdater, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Updates a passkey\'s state.
     * @summary Update passkey
     * @param {string} username Username that owns the passkey.
     * @param {string} passkeyId Passkey ID.
     * @param {PasskeyUpdater} passkeyUpdater Passkey update payload.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updatePasskey: (username: string, passkeyId: string, passkeyUpdater: PasskeyUpdater, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Update the status of the given matches
     * @summary Set match status (BETA)
     * @param {string} monitorId
     * @param {WatchlistMonitorMatchesUpdater} watchlistMonitorMatchesUpdater
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateWatchlistMonitorMatch: (monitorId: string, watchlistMonitorMatchesUpdater: WatchlistMonitorMatchesUpdater, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Edits a webhook. Returns the updated webhook object.
     * @summary Edit a webhook
     * @param {string} webhookId
     * @param {WebhookUpdater} webhookUpdater
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateWebhook: (webhookId: string, webhookUpdater: WebhookUpdater, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB.
     * @summary Upload a document
     * @param {DocumentTypes} type The type of document
     * @param {string} applicantId The ID of the applicant whose document is being uploaded.
     * @param {FileTransfer} file The file to be uploaded.
     * @param {string} [fileType] The file type of the uploaded file
     * @param {UploadDocumentSideEnum} [side] The side of the document, if applicable. The possible values are front and back
     * @param {CountryCodes} [issuingCountry] The issuing country of the document, a 3-letter ISO code.
     * @param {boolean} [validateImageQuality] Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds.
     * @param {LocationBuilder} [location]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    uploadDocument: (type: DocumentTypes, applicantId: string, file: FileTransfer, fileType?: string, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB.
     * @summary Upload ID photo
     * @param {string} [applicantId] The ID of the applicant whose ID photo is being uploaded.
     * @param {FileTransfer} [file] The file to be uploaded.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    uploadIdPhoto: (applicantId?: string, file?: FileTransfer, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * You can upload live photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. Live photos are validated at the point of upload to check that they contain exactly one face. This validation can be disabled by setting the advanced_validation argument to false.
     * @summary Upload live photo
     * @param {string} [applicantId] The ID of the applicant whose live photo is being uploaded.
     * @param {FileTransfer} [file] The file to be uploaded.
     * @param {boolean} [advancedValidation] Validates that the live photo contains exactly one face.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    uploadLivePhoto: (applicantId?: string, file?: FileTransfer, advancedValidation?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Signing documents are uploaded using this endpoint. Signing documents must be uploaded as a multipart form. The only valid file type is pdf. The file size must be between 2KB and 3MB.
     * @summary Upload a signing document
     * @param {string} applicantId The ID of the applicant whose signing document is being uploaded.
     * @param {FileTransfer} file The file to be uploaded.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    uploadSigningDocument: (applicantId: string, file: FileTransfer, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * DefaultApi - functional programming interface
 */
export declare const DefaultApiFp: (configuration?: Configuration) => {
    /**
     * Cancels single paused reports.
     * @summary Cancel report
     * @param {string} reportId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    cancelReport(reportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     * Completes a Send / Receive Data Task.
     * @summary Complete Task
     * @param {string} workflowRunId The unique identifier of the Workflow Run to which the Task belongs.
     * @param {string} taskId The identifier of the Task you want to complete.
     * @param {CompleteTaskBuilder} completeTaskBuilder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    completeTask(workflowRunId: string, taskId: string, completeTaskBuilder: CompleteTaskBuilder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     * Creates a single applicant. Returns an applicant object.
     * @summary Create Applicant
     * @param {ApplicantBuilder} applicantBuilder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createApplicant(applicantBuilder: ApplicantBuilder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Applicant>>;
    /**
     * Initiates a check for an applicant, which can contain one or more reports. Returns a check object.
     * @summary Create a check
     * @param {CheckBuilder} checkBuilder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createCheck(checkBuilder: CheckBuilder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Check>>;
    /**
     * Triggers the generation of the Timeline File for the designated Workflow Run.
     * @summary Create Timeline File for Workflow Run
     * @param {string} workflowRunId The unique identifier of the Workflow Run.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createTimelineFile(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TimelineFileReference>>;
    /**
     * Creates a new monitor for the applicant
     * @summary Create monitor
     * @param {WatchlistMonitorBuilder} watchlistMonitorBuilder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createWatchlistMonitor(watchlistMonitorBuilder: WatchlistMonitorBuilder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WatchlistMonitor>>;
    /**
     * Registers a webhook. Returns a webhook object.
     * @summary Register webhook
     * @param {WebhookBuilder} webhookBuilder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createWebhook(webhookBuilder: WebhookBuilder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Webhook>>;
    /**
     * Creates and starts a Workflow Run. Returns a Workflow Run object.
     * @summary Create a Workflow Run
     * @param {WorkflowRunBuilder} workflowRunBuilder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createWorkflowRun(workflowRunBuilder: WorkflowRunBuilder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowRun>>;
    /**
     * Deletes a single applicant.
     * @summary Delete Applicant
     * @param {string} applicantId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteApplicant(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     * Deletes a passkey.
     * @summary Delete passkey
     * @param {string} username Username that owns the passkey.
     * @param {string} passkeyId Passkey ID.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deletePasskey(username: string, passkeyId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     * Removes every passkey for the username.
     * @summary Delete passkeys
     * @param {string} username Username whose passkeys will be deleted.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deletePasskeys(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     * Deactivates the given monitor
     * @summary Delete monitor
     * @param {string} monitorId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteWatchlistMonitor(monitorId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     * Deletes a webhook.
     * @summary Delete a webhook
     * @param {string} webhookId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteWebhook(webhookId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     * Retrieves the signed document or signing transaction receipt depending on the id provided.
     * @summary Retrieves the signed document or signing transaction receipt
     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
     * @param {string} id The unique identifier of the file which you want to retrieve.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadAesDocument(workflowRunId: string, id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
    /**
     * Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.
     * @summary Download check
     * @param {string} checkId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadCheck(checkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
    /**
     * Downloads specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
     * @summary Download document
     * @param {string} documentId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
    /**
     * Downloads a document video. If successful, the response will be the binary data representing the video.
     * @summary Download document video
     * @param {string} documentId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadDocumentVideo(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
    /**
     * Retrieves the evidence folder for the designated Workflow Run
     * @summary Retrieve Workflow Run Evidence Folder
     * @param {string} workflowRunId Workflow Run ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadEvidenceFolder(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
    /**
     * ID photos are downloaded using this endpoint.
     * @summary Download ID photo
     * @param {string} idPhotoId The ID photo\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadIdPhoto(idPhotoId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
    /**
     * Live photos are downloaded using this endpoint.
     * @summary Download live photo
     * @param {string} livePhotoId The live photo\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadLivePhoto(livePhotoId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
    /**
     * Live videos are downloaded using this endpoint.
     * @summary Download live video
     * @param {string} liveVideoId The live video\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadLiveVideo(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
    /**
     * Returns the binary data representing a single frame from a live video.
     * @summary Download live video frame
     * @param {string} liveVideoId The live video\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadLiveVideoFrame(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
    /**
     * Motion captures are downloaded using this endpoint.
     * @summary Download motion capture
     * @param {string} motionCaptureId The motion capture\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadMotionCapture(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
    /**
     * Instead of the whole capture binary, a single frame can be downloaded using this endpoint. Returns the binary data representing the frame.
     * @summary Download motion capture frame
     * @param {string} motionCaptureId The motion capture\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
    /**
     * Downloads digital photos extracted from specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
     * @summary Download NFC face
     * @param {string} documentId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadNfcFace(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
    /**
     * Retrieves the signed document or application form depending on the file_id provided.
     * @summary Retrieves the signed document or application form
     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
     * @param {string} fileId The unique identifier of the file which you want to retrieve.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadQesDocument(workflowRunId: string, fileId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
    /**
     * Retrieves the signed document or signing transaction receipt depending on the id provided.
     * @summary Retrieves the signed document or signing transaction receipt
     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
     * @param {string} id The unique identifier of the file which you want to retrieve.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadSesDocument(workflowRunId: string, id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
    /**
     * Retrieves the signed evidence file for the designated Workflow Run
     * @summary Retrieve Workflow Run Evidence Summary File
     * @param {string} workflowRunId Workflow Run ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadSignedEvidenceFile(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
    /**
     * Downloads specific signing documents belonging to an applicant. If successful, the response will be the binary data representing the pdf.
     * @summary Download signing document
     * @param {string} signingDocumentId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadSigningDocument(signingDocumentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
    /**
     * Extract information from a document
     * @summary Autofill
     * @param {ExtractRequest} extractRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    extract(extractRequest: ExtractRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Extraction>>;
    /**
     * Search for addresses by postcode
     * @summary Address Picker
     * @param {string} postcode
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findAddresses(postcode: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddressesList>>;
    /**
     * Retrieves a single applicant. Returns an applicant object.
     * @summary Retrieve Applicant
     * @param {string} applicantId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findApplicant(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Applicant>>;
    /**
     * Retrieves consents for single applicant.
     * @summary Retrieve Applicant Consents
     * @param {string} applicantId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findApplicantConsents(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ApplicantConsent>>>;
    /**
     * Retrieves a single check. Returns a check object.
     * @summary Retrieve a Check
     * @param {string} checkId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findCheck(checkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Check>>;
    /**
     * A single document can be retrieved by calling this endpoint with the document\'s unique identifier.
     * @summary Retrieve document
     * @param {string} documentId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Document>>;
    /**
     * Retrieves a single ID photo. Returns a ID photo object.
     * @summary Retrieve ID photo
     * @param {string} idPhotoId The ID photo\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findIdPhoto(idPhotoId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IdPhoto>>;
    /**
     * Retrieves a single live photo. Returns a live photo object.
     * @summary Retrieve live photo
     * @param {string} livePhotoId The live photo\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findLivePhoto(livePhotoId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LivePhoto>>;
    /**
     * Retrieves a single live video. Returns the corresponding live video object.
     * @summary Retrieve live video
     * @param {string} liveVideoId The live video\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findLiveVideo(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LiveVideo>>;
    /**
     * Retrieves a single motion capture. Returns the corresponding motion capture object.
     * @summary Retrieve motion capture
     * @param {string} motionCaptureId The motion capture\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findMotionCapture(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionCapture>>;
    /**
     * Returns a passkey\'s details.
     * @summary Retrieve passkey
     * @param {string} username Username that owns the passkey.
     * @param {string} passkeyId Passkey ID.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findPasskey(username: string, passkeyId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Passkey>>;
    /**
     * A single report can be retrieved using this endpoint with the corresponding unique identifier.
     * @summary Retrieve report
     * @param {string} reportId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findReport(reportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Report>>;
    /**
     * A single signing document can be retrieved by calling this endpoint with the signing document\'s unique identifier.
     * @summary Retrieve signing document
     * @param {string} signingDocumentId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findSigningDocument(signingDocumentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SigningDocument>>;
    /**
     * A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.
     * @summary Retrieve Task
     * @param {string} workflowRunId The unique identifier of the Workflow Run to which the Task belongs.
     * @param {string} taskId The identifier of the Task you want to retrieve.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findTask(workflowRunId: string, taskId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Task>>;
    /**
     * Retrieves the Timeline File for the designated Workflow Run.
     * @summary Retrieve Timeline File for Workflow Run
     * @param {string} workflowRunId The unique identifier of the Workflow Run.
     * @param {string} timelineFileId The unique identifier for the Timefile File.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findTimelineFile(workflowRunId: string, timelineFileId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
    /**
     * Retrieves a single monitor
     * @summary Retrieve monitor
     * @param {string} monitorId The watchlist monitor\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findWatchlistMonitor(monitorId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WatchlistMonitor>>;
    /**
     * Retrieves a single webhook. Returns a webhook object.
     * @summary Retrieve a Webhook
     * @param {string} webhookId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findWebhook(webhookId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Webhook>>;
    /**
     * A single workflow run can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
     * @summary Retrieve Workflow Run
     * @param {string} workflowRunId The unique identifier of the Workflow Run.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findWorkflowRun(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowRun>>;
    /**
     * Triggers a new check with an updated report to be generated by the monitor, as if the monitor had received an update.
     * @summary Force new report creation (BETA)
     * @param {string} monitorId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    forceReportCreationFromWatchlistMonitor(monitorId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     * Generates an SDK token. Returns a token object containing the SDK token.
     * @summary Generate a SDK token
     * @param {SdkTokenBuilder} sdkTokenBuilder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    generateSdkToken(sdkTokenBuilder: SdkTokenBuilder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SdkToken>>;
    /**
     * Lists all applicants you\'ve created, sorted by creation date in descending order.
     * @summary List Applicants
     * @param {number} [page] The page to return. The first page is &#x60;page&#x3D;1&#x60;
     * @param {number} [perPage] The number of objects per page.
     * @param {boolean} [includeDeleted] Whether to also include applicants scheduled for deletion.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listApplicants(page?: number, perPage?: number, includeDeleted?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApplicantsList>>;
    /**
     * Retrieves a single check. Returns a check object.
     * @summary Retrieve Checks
     * @param {string} applicantId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listChecks(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChecksList>>;
    /**
     * All documents belonging to an applicant can be listed from this endpoint
     * @summary List documents
     * @param {string} applicantId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listDocuments(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentsList>>;
    /**
     * Lists the ID photos that belong to an applicant.
     * @summary List ID photos
     * @param {string} applicantId The id of the applicant the ID photos belong to.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listIdPhotos(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IdPhotosList>>;
    /**
     * Lists the live photos that belong to an applicant.
     * @summary List live photos
     * @param {string} applicantId The id of the applicant the live photos belong to.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listLivePhotos(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LivePhotosList>>;
    /**
     * Lists all the live videos that belong to an applicant.
     * @summary List live videos
     * @param {string} applicantId The id of the applicant the live videos belong to.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listLiveVideos(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LiveVideosList>>;
    /**
     * Lists all the motion captures that belong to an applicant.
     * @summary List motion captures
     * @param {string} applicantId The id of the applicant the motion captures belong to.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listMotionCaptures(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MotionCapturesList>>;
    /**
     * Returns every passkey registered under the supplied username.
     * @summary List passkeys
     * @param {string} username Username that owns the passkeys.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listPasskeys(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PasskeysList>>;
    /**
     * Returns all repeat attempts for a given Document report
     * @summary Retrieve repeat attempts
     * @param {string} reportId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listRepeatAttempts(reportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RepeatAttemptsList>>;
    /**
     * All the reports belonging to a particular check can be listed from this endpoint.
     * @summary List reports
     * @param {string} checkId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listReports(checkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportsList>>;
    /**
     * All signing documents belonging to an applicant can be listed from this endpoint
     * @summary List signing documents
     * @param {string} applicantId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listSigningDocuments(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SigningDocumentsList>>;
    /**
     * The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
     * @summary List Tasks
     * @param {string} workflowRunId The unique identifier of the Workflow Run to which the Tasks belong.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listTasks(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TaskItem>>>;
    /**
     * List match IDs on this monitor, as well as their enabled/disabled status
     * @summary List matches (BETA)
     * @param {string} monitorId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listWatchlistMonitorMatches(monitorId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WatchlistMonitorMatchesList>>;
    /**
     * List all available monitors for an applicant
     * @summary List monitors
     * @param {string} applicantId The id of the applicant the watchlist monitors belong to. If omitted, all monitors for the account will be listed.
     * @param {boolean} [includeDeleted] Whether to also include deleted (inactive) monitors.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listWatchlistMonitors(applicantId: string, includeDeleted?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WatchlistMonitorsList>>;
    /**
     * Lists all webhooks you\'ve created.
     * @summary List webhooks
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listWebhooks(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WebhooksList>>;
    /**
     * Retrieves the Workflow Runs of the client. Returns a list of Workflow Run objects.
     * @summary List Workflow Runs
     * @param {number} [page] The number of the page to be retrieved. If not specified, defaults to 1.
     * @param {string} [status] A list of comma separated status values to filter the results. Possible values are \&#39;processing\&#39;, \&#39;awaiting_input\&#39;, \&#39;approved\&#39;, \&#39;declined\&#39;, \&#39;review\&#39;, \&#39;abandoned\&#39; and \&#39;error\&#39;.
     * @param {string} [createdAtGt] A ISO-8601 date to filter results with a created date greater than (after) the one provided.
     * @param {string} [createdAtLt] A ISO-8601 date to filter results with a created date less than (before) the one provided.
     * @param {ListWorkflowRunsSortEnum} [sort] A string with the value \&#39;desc\&#39; or \&#39;asc\&#39; that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to \&#39;desc\&#39;.
     * @param {string} [applicantId] the applicant\&#39;s id.
     * @param {Array<string>} [tags] A list of tags to filter the results.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listWorkflowRuns(page?: number, status?: string, createdAtGt?: string, createdAtLt?: string, sort?: ListWorkflowRunsSortEnum, applicantId?: string, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<WorkflowRun>>>;
    /**
     * Run a health check on the Onfido API
     * @summary Ping
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    ping(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
    /**
     * Create Feedback on checks and reports
     * @summary Fraud reporting (ALPHA)
     * @param {ResultsFeedback} resultsFeedback
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postResultsFeedback(resultsFeedback: ResultsFeedback, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResultsFeedback>>;
    /**
     * Resends events to all webhooks registered with a matching environment in your account.
     * @summary Resends webhooks
     * @param {WebhookResend} webhookResend
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    resendWebhooks(webhookResend: WebhookResend, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     * Restores a single applicant scheduled for deletion.
     * @summary Restore Applicant
     * @param {string} applicantId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    restoreApplicant(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     * Resumes a paused check.
     * @summary Resume a Check
     * @param {string} checkId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    resumeCheck(checkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     * Resumes a single paused report.
     * @summary Resume report
     * @param {string} reportId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    resumeReport(reportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     * Allows updating applicant\'s information before any checks is created. - Partial updates - Addresses and ID numbers present will replace existing ones - Same applicant validations to create applicant
     * @summary Update Applicant
     * @param {string} applicantId
     * @param {ApplicantUpdater} applicantUpdater
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateApplicant(applicantId: string, applicantUpdater: ApplicantUpdater, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Applicant>>;
    /**
     * Updates a passkey\'s state.
     * @summary Update passkey
     * @param {string} username Username that owns the passkey.
     * @param {string} passkeyId Passkey ID.
     * @param {PasskeyUpdater} passkeyUpdater Passkey update payload.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updatePasskey(username: string, passkeyId: string, passkeyUpdater: PasskeyUpdater, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Passkey>>;
    /**
     * Update the status of the given matches
     * @summary Set match status (BETA)
     * @param {string} monitorId
     * @param {WatchlistMonitorMatchesUpdater} watchlistMonitorMatchesUpdater
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateWatchlistMonitorMatch(monitorId: string, watchlistMonitorMatchesUpdater: WatchlistMonitorMatchesUpdater, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WatchlistMonitorMatchesList>>;
    /**
     * Edits a webhook. Returns the updated webhook object.
     * @summary Edit a webhook
     * @param {string} webhookId
     * @param {WebhookUpdater} webhookUpdater
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateWebhook(webhookId: string, webhookUpdater: WebhookUpdater, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Webhook>>;
    /**
     * Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB.
     * @summary Upload a document
     * @param {DocumentTypes} type The type of document
     * @param {string} applicantId The ID of the applicant whose document is being uploaded.
     * @param {FileTransfer} file The file to be uploaded.
     * @param {string} [fileType] The file type of the uploaded file
     * @param {UploadDocumentSideEnum} [side] The side of the document, if applicable. The possible values are front and back
     * @param {CountryCodes} [issuingCountry] The issuing country of the document, a 3-letter ISO code.
     * @param {boolean} [validateImageQuality] Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds.
     * @param {LocationBuilder} [location]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    uploadDocument(type: DocumentTypes, applicantId: string, file: FileTransfer, fileType?: string, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Document>>;
    /**
     * You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB.
     * @summary Upload ID photo
     * @param {string} [applicantId] The ID of the applicant whose ID photo is being uploaded.
     * @param {FileTransfer} [file] The file to be uploaded.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    uploadIdPhoto(applicantId?: string, file?: FileTransfer, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IdPhoto>>;
    /**
     * You can upload live photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. Live photos are validated at the point of upload to check that they contain exactly one face. This validation can be disabled by setting the advanced_validation argument to false.
     * @summary Upload live photo
     * @param {string} [applicantId] The ID of the applicant whose live photo is being uploaded.
     * @param {FileTransfer} [file] The file to be uploaded.
     * @param {boolean} [advancedValidation] Validates that the live photo contains exactly one face.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    uploadLivePhoto(applicantId?: string, file?: FileTransfer, advancedValidation?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LivePhoto>>;
    /**
     * Signing documents are uploaded using this endpoint. Signing documents must be uploaded as a multipart form. The only valid file type is pdf. The file size must be between 2KB and 3MB.
     * @summary Upload a signing document
     * @param {string} applicantId The ID of the applicant whose signing document is being uploaded.
     * @param {FileTransfer} file The file to be uploaded.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    uploadSigningDocument(applicantId: string, file: FileTransfer, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SigningDocument>>;
};
/**
 * DefaultApi - factory interface
 */
export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Cancels single paused reports.
     * @summary Cancel report
     * @param {string} reportId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    cancelReport(reportId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     * Completes a Send / Receive Data Task.
     * @summary Complete Task
     * @param {string} workflowRunId The unique identifier of the Workflow Run to which the Task belongs.
     * @param {string} taskId The identifier of the Task you want to complete.
     * @param {CompleteTaskBuilder} completeTaskBuilder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    completeTask(workflowRunId: string, taskId: string, completeTaskBuilder: CompleteTaskBuilder, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     * Creates a single applicant. Returns an applicant object.
     * @summary Create Applicant
     * @param {ApplicantBuilder} applicantBuilder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createApplicant(applicantBuilder: ApplicantBuilder, options?: RawAxiosRequestConfig): AxiosPromise<Applicant>;
    /**
     * Initiates a check for an applicant, which can contain one or more reports. Returns a check object.
     * @summary Create a check
     * @param {CheckBuilder} checkBuilder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createCheck(checkBuilder: CheckBuilder, options?: RawAxiosRequestConfig): AxiosPromise<Check>;
    /**
     * Triggers the generation of the Timeline File for the designated Workflow Run.
     * @summary Create Timeline File for Workflow Run
     * @param {string} workflowRunId The unique identifier of the Workflow Run.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createTimelineFile(workflowRunId: string, options?: RawAxiosRequestConfig): AxiosPromise<TimelineFileReference>;
    /**
     * Creates a new monitor for the applicant
     * @summary Create monitor
     * @param {WatchlistMonitorBuilder} watchlistMonitorBuilder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createWatchlistMonitor(watchlistMonitorBuilder: WatchlistMonitorBuilder, options?: RawAxiosRequestConfig): AxiosPromise<WatchlistMonitor>;
    /**
     * Registers a webhook. Returns a webhook object.
     * @summary Register webhook
     * @param {WebhookBuilder} webhookBuilder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createWebhook(webhookBuilder: WebhookBuilder, options?: RawAxiosRequestConfig): AxiosPromise<Webhook>;
    /**
     * Creates and starts a Workflow Run. Returns a Workflow Run object.
     * @summary Create a Workflow Run
     * @param {WorkflowRunBuilder} workflowRunBuilder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createWorkflowRun(workflowRunBuilder: WorkflowRunBuilder, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowRun>;
    /**
     * Deletes a single applicant.
     * @summary Delete Applicant
     * @param {string} applicantId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteApplicant(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     * Deletes a passkey.
     * @summary Delete passkey
     * @param {string} username Username that owns the passkey.
     * @param {string} passkeyId Passkey ID.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deletePasskey(username: string, passkeyId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     * Removes every passkey for the username.
     * @summary Delete passkeys
     * @param {string} username Username whose passkeys will be deleted.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deletePasskeys(username: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     * Deactivates the given monitor
     * @summary Delete monitor
     * @param {string} monitorId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteWatchlistMonitor(monitorId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     * Deletes a webhook.
     * @summary Delete a webhook
     * @param {string} webhookId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteWebhook(webhookId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     * Retrieves the signed document or signing transaction receipt depending on the id provided.
     * @summary Retrieves the signed document or signing transaction receipt
     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
     * @param {string} id The unique identifier of the file which you want to retrieve.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadAesDocument(workflowRunId: string, id: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
    /**
     * Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.
     * @summary Download check
     * @param {string} checkId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadCheck(checkId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
    /**
     * Downloads specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
     * @summary Download document
     * @param {string} documentId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadDocument(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
    /**
     * Downloads a document video. If successful, the response will be the binary data representing the video.
     * @summary Download document video
     * @param {string} documentId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadDocumentVideo(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
    /**
     * Retrieves the evidence folder for the designated Workflow Run
     * @summary Retrieve Workflow Run Evidence Folder
     * @param {string} workflowRunId Workflow Run ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadEvidenceFolder(workflowRunId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
    /**
     * ID photos are downloaded using this endpoint.
     * @summary Download ID photo
     * @param {string} idPhotoId The ID photo\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadIdPhoto(idPhotoId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
    /**
     * Live photos are downloaded using this endpoint.
     * @summary Download live photo
     * @param {string} livePhotoId The live photo\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadLivePhoto(livePhotoId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
    /**
     * Live videos are downloaded using this endpoint.
     * @summary Download live video
     * @param {string} liveVideoId The live video\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadLiveVideo(liveVideoId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
    /**
     * Returns the binary data representing a single frame from a live video.
     * @summary Download live video frame
     * @param {string} liveVideoId The live video\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadLiveVideoFrame(liveVideoId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
    /**
     * Motion captures are downloaded using this endpoint.
     * @summary Download motion capture
     * @param {string} motionCaptureId The motion capture\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadMotionCapture(motionCaptureId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
    /**
     * Instead of the whole capture binary, a single frame can be downloaded using this endpoint. Returns the binary data representing the frame.
     * @summary Download motion capture frame
     * @param {string} motionCaptureId The motion capture\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
    /**
     * Downloads digital photos extracted from specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
     * @summary Download NFC face
     * @param {string} documentId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadNfcFace(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
    /**
     * Retrieves the signed document or application form depending on the file_id provided.
     * @summary Retrieves the signed document or application form
     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
     * @param {string} fileId The unique identifier of the file which you want to retrieve.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadQesDocument(workflowRunId: string, fileId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
    /**
     * Retrieves the signed document or signing transaction receipt depending on the id provided.
     * @summary Retrieves the signed document or signing transaction receipt
     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
     * @param {string} id The unique identifier of the file which you want to retrieve.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadSesDocument(workflowRunId: string, id: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
    /**
     * Retrieves the signed evidence file for the designated Workflow Run
     * @summary Retrieve Workflow Run Evidence Summary File
     * @param {string} workflowRunId Workflow Run ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadSignedEvidenceFile(workflowRunId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
    /**
     * Downloads specific signing documents belonging to an applicant. If successful, the response will be the binary data representing the pdf.
     * @summary Download signing document
     * @param {string} signingDocumentId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadSigningDocument(signingDocumentId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
    /**
     * Extract information from a document
     * @summary Autofill
     * @param {ExtractRequest} extractRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    extract(extractRequest: ExtractRequest, options?: RawAxiosRequestConfig): AxiosPromise<Extraction>;
    /**
     * Search for addresses by postcode
     * @summary Address Picker
     * @param {string} postcode
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findAddresses(postcode: string, options?: RawAxiosRequestConfig): AxiosPromise<AddressesList>;
    /**
     * Retrieves a single applicant. Returns an applicant object.
     * @summary Retrieve Applicant
     * @param {string} applicantId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findApplicant(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<Applicant>;
    /**
     * Retrieves consents for single applicant.
     * @summary Retrieve Applicant Consents
     * @param {string} applicantId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findApplicantConsents(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ApplicantConsent>>;
    /**
     * Retrieves a single check. Returns a check object.
     * @summary Retrieve a Check
     * @param {string} checkId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findCheck(checkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Check>;
    /**
     * A single document can be retrieved by calling this endpoint with the document\'s unique identifier.
     * @summary Retrieve document
     * @param {string} documentId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findDocument(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<Document>;
    /**
     * Retrieves a single ID photo. Returns a ID photo object.
     * @summary Retrieve ID photo
     * @param {string} idPhotoId The ID photo\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findIdPhoto(idPhotoId: string, options?: RawAxiosRequestConfig): AxiosPromise<IdPhoto>;
    /**
     * Retrieves a single live photo. Returns a live photo object.
     * @summary Retrieve live photo
     * @param {string} livePhotoId The live photo\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findLivePhoto(livePhotoId: string, options?: RawAxiosRequestConfig): AxiosPromise<LivePhoto>;
    /**
     * Retrieves a single live video. Returns the corresponding live video object.
     * @summary Retrieve live video
     * @param {string} liveVideoId The live video\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findLiveVideo(liveVideoId: string, options?: RawAxiosRequestConfig): AxiosPromise<LiveVideo>;
    /**
     * Retrieves a single motion capture. Returns the corresponding motion capture object.
     * @summary Retrieve motion capture
     * @param {string} motionCaptureId The motion capture\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findMotionCapture(motionCaptureId: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionCapture>;
    /**
     * Returns a passkey\'s details.
     * @summary Retrieve passkey
     * @param {string} username Username that owns the passkey.
     * @param {string} passkeyId Passkey ID.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findPasskey(username: string, passkeyId: string, options?: RawAxiosRequestConfig): AxiosPromise<Passkey>;
    /**
     * A single report can be retrieved using this endpoint with the corresponding unique identifier.
     * @summary Retrieve report
     * @param {string} reportId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findReport(reportId: string, options?: RawAxiosRequestConfig): AxiosPromise<Report>;
    /**
     * A single signing document can be retrieved by calling this endpoint with the signing document\'s unique identifier.
     * @summary Retrieve signing document
     * @param {string} signingDocumentId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findSigningDocument(signingDocumentId: string, options?: RawAxiosRequestConfig): AxiosPromise<SigningDocument>;
    /**
     * A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.
     * @summary Retrieve Task
     * @param {string} workflowRunId The unique identifier of the Workflow Run to which the Task belongs.
     * @param {string} taskId The identifier of the Task you want to retrieve.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findTask(workflowRunId: string, taskId: string, options?: RawAxiosRequestConfig): AxiosPromise<Task>;
    /**
     * Retrieves the Timeline File for the designated Workflow Run.
     * @summary Retrieve Timeline File for Workflow Run
     * @param {string} workflowRunId The unique identifier of the Workflow Run.
     * @param {string} timelineFileId The unique identifier for the Timefile File.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findTimelineFile(workflowRunId: string, timelineFileId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
    /**
     * Retrieves a single monitor
     * @summary Retrieve monitor
     * @param {string} monitorId The watchlist monitor\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findWatchlistMonitor(monitorId: string, options?: RawAxiosRequestConfig): AxiosPromise<WatchlistMonitor>;
    /**
     * Retrieves a single webhook. Returns a webhook object.
     * @summary Retrieve a Webhook
     * @param {string} webhookId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findWebhook(webhookId: string, options?: RawAxiosRequestConfig): AxiosPromise<Webhook>;
    /**
     * A single workflow run can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
     * @summary Retrieve Workflow Run
     * @param {string} workflowRunId The unique identifier of the Workflow Run.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findWorkflowRun(workflowRunId: string, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowRun>;
    /**
     * Triggers a new check with an updated report to be generated by the monitor, as if the monitor had received an update.
     * @summary Force new report creation (BETA)
     * @param {string} monitorId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    forceReportCreationFromWatchlistMonitor(monitorId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     * Generates an SDK token. Returns a token object containing the SDK token.
     * @summary Generate a SDK token
     * @param {SdkTokenBuilder} sdkTokenBuilder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    generateSdkToken(sdkTokenBuilder: SdkTokenBuilder, options?: RawAxiosRequestConfig): AxiosPromise<SdkToken>;
    /**
     * Lists all applicants you\'ve created, sorted by creation date in descending order.
     * @summary List Applicants
     * @param {number} [page] The page to return. The first page is &#x60;page&#x3D;1&#x60;
     * @param {number} [perPage] The number of objects per page.
     * @param {boolean} [includeDeleted] Whether to also include applicants scheduled for deletion.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listApplicants(page?: number, perPage?: number, includeDeleted?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<ApplicantsList>;
    /**
     * Retrieves a single check. Returns a check object.
     * @summary Retrieve Checks
     * @param {string} applicantId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listChecks(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<ChecksList>;
    /**
     * All documents belonging to an applicant can be listed from this endpoint
     * @summary List documents
     * @param {string} applicantId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listDocuments(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<DocumentsList>;
    /**
     * Lists the ID photos that belong to an applicant.
     * @summary List ID photos
     * @param {string} applicantId The id of the applicant the ID photos belong to.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listIdPhotos(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<IdPhotosList>;
    /**
     * Lists the live photos that belong to an applicant.
     * @summary List live photos
     * @param {string} applicantId The id of the applicant the live photos belong to.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listLivePhotos(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<LivePhotosList>;
    /**
     * Lists all the live videos that belong to an applicant.
     * @summary List live videos
     * @param {string} applicantId The id of the applicant the live videos belong to.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listLiveVideos(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<LiveVideosList>;
    /**
     * Lists all the motion captures that belong to an applicant.
     * @summary List motion captures
     * @param {string} applicantId The id of the applicant the motion captures belong to.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listMotionCaptures(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<MotionCapturesList>;
    /**
     * Returns every passkey registered under the supplied username.
     * @summary List passkeys
     * @param {string} username Username that owns the passkeys.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listPasskeys(username: string, options?: RawAxiosRequestConfig): AxiosPromise<PasskeysList>;
    /**
     * Returns all repeat attempts for a given Document report
     * @summary Retrieve repeat attempts
     * @param {string} reportId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listRepeatAttempts(reportId: string, options?: RawAxiosRequestConfig): AxiosPromise<RepeatAttemptsList>;
    /**
     * All the reports belonging to a particular check can be listed from this endpoint.
     * @summary List reports
     * @param {string} checkId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listReports(checkId: string, options?: RawAxiosRequestConfig): AxiosPromise<ReportsList>;
    /**
     * All signing documents belonging to an applicant can be listed from this endpoint
     * @summary List signing documents
     * @param {string} applicantId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listSigningDocuments(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<SigningDocumentsList>;
    /**
     * The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
     * @summary List Tasks
     * @param {string} workflowRunId The unique identifier of the Workflow Run to which the Tasks belong.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listTasks(workflowRunId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<TaskItem>>;
    /**
     * List match IDs on this monitor, as well as their enabled/disabled status
     * @summary List matches (BETA)
     * @param {string} monitorId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listWatchlistMonitorMatches(monitorId: string, options?: RawAxiosRequestConfig): AxiosPromise<WatchlistMonitorMatchesList>;
    /**
     * List all available monitors for an applicant
     * @summary List monitors
     * @param {string} applicantId The id of the applicant the watchlist monitors belong to. If omitted, all monitors for the account will be listed.
     * @param {boolean} [includeDeleted] Whether to also include deleted (inactive) monitors.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listWatchlistMonitors(applicantId: string, includeDeleted?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<WatchlistMonitorsList>;
    /**
     * Lists all webhooks you\'ve created.
     * @summary List webhooks
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listWebhooks(options?: RawAxiosRequestConfig): AxiosPromise<WebhooksList>;
    /**
     * Retrieves the Workflow Runs of the client. Returns a list of Workflow Run objects.
     * @summary List Workflow Runs
     * @param {number} [page] The number of the page to be retrieved. If not specified, defaults to 1.
     * @param {string} [status] A list of comma separated status values to filter the results. Possible values are \&#39;processing\&#39;, \&#39;awaiting_input\&#39;, \&#39;approved\&#39;, \&#39;declined\&#39;, \&#39;review\&#39;, \&#39;abandoned\&#39; and \&#39;error\&#39;.
     * @param {string} [createdAtGt] A ISO-8601 date to filter results with a created date greater than (after) the one provided.
     * @param {string} [createdAtLt] A ISO-8601 date to filter results with a created date less than (before) the one provided.
     * @param {ListWorkflowRunsSortEnum} [sort] A string with the value \&#39;desc\&#39; or \&#39;asc\&#39; that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to \&#39;desc\&#39;.
     * @param {string} [applicantId] the applicant\&#39;s id.
     * @param {Array<string>} [tags] A list of tags to filter the results.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listWorkflowRuns(page?: number, status?: string, createdAtGt?: string, createdAtLt?: string, sort?: ListWorkflowRunsSortEnum, applicantId?: string, tags?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<WorkflowRun>>;
    /**
     * Run a health check on the Onfido API
     * @summary Ping
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    ping(options?: RawAxiosRequestConfig): AxiosPromise<string>;
    /**
     * Create Feedback on checks and reports
     * @summary Fraud reporting (ALPHA)
     * @param {ResultsFeedback} resultsFeedback
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postResultsFeedback(resultsFeedback: ResultsFeedback, options?: RawAxiosRequestConfig): AxiosPromise<ResultsFeedback>;
    /**
     * Resends events to all webhooks registered with a matching environment in your account.
     * @summary Resends webhooks
     * @param {WebhookResend} webhookResend
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    resendWebhooks(webhookResend: WebhookResend, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     * Restores a single applicant scheduled for deletion.
     * @summary Restore Applicant
     * @param {string} applicantId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    restoreApplicant(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     * Resumes a paused check.
     * @summary Resume a Check
     * @param {string} checkId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    resumeCheck(checkId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     * Resumes a single paused report.
     * @summary Resume report
     * @param {string} reportId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    resumeReport(reportId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     * Allows updating applicant\'s information before any checks is created. - Partial updates - Addresses and ID numbers present will replace existing ones - Same applicant validations to create applicant
     * @summary Update Applicant
     * @param {string} applicantId
     * @param {ApplicantUpdater} applicantUpdater
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateApplicant(applicantId: string, applicantUpdater: ApplicantUpdater, options?: RawAxiosRequestConfig): AxiosPromise<Applicant>;
    /**
     * Updates a passkey\'s state.
     * @summary Update passkey
     * @param {string} username Username that owns the passkey.
     * @param {string} passkeyId Passkey ID.
     * @param {PasskeyUpdater} passkeyUpdater Passkey update payload.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updatePasskey(username: string, passkeyId: string, passkeyUpdater: PasskeyUpdater, options?: RawAxiosRequestConfig): AxiosPromise<Passkey>;
    /**
     * Update the status of the given matches
     * @summary Set match status (BETA)
     * @param {string} monitorId
     * @param {WatchlistMonitorMatchesUpdater} watchlistMonitorMatchesUpdater
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateWatchlistMonitorMatch(monitorId: string, watchlistMonitorMatchesUpdater: WatchlistMonitorMatchesUpdater, options?: RawAxiosRequestConfig): AxiosPromise<WatchlistMonitorMatchesList>;
    /**
     * Edits a webhook. Returns the updated webhook object.
     * @summary Edit a webhook
     * @param {string} webhookId
     * @param {WebhookUpdater} webhookUpdater
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateWebhook(webhookId: string, webhookUpdater: WebhookUpdater, options?: RawAxiosRequestConfig): AxiosPromise<Webhook>;
    /**
     * Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB.
     * @summary Upload a document
     * @param {DocumentTypes} type The type of document
     * @param {string} applicantId The ID of the applicant whose document is being uploaded.
     * @param {FileTransfer} file The file to be uploaded.
     * @param {string} [fileType] The file type of the uploaded file
     * @param {UploadDocumentSideEnum} [side] The side of the document, if applicable. The possible values are front and back
     * @param {CountryCodes} [issuingCountry] The issuing country of the document, a 3-letter ISO code.
     * @param {boolean} [validateImageQuality] Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds.
     * @param {LocationBuilder} [location]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    uploadDocument(type: DocumentTypes, applicantId: string, file: FileTransfer, fileType?: string, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: RawAxiosRequestConfig): AxiosPromise<Document>;
    /**
     * You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB.
     * @summary Upload ID photo
     * @param {string} [applicantId] The ID of the applicant whose ID photo is being uploaded.
     * @param {FileTransfer} [file] The file to be uploaded.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    uploadIdPhoto(applicantId?: string, file?: FileTransfer, options?: RawAxiosRequestConfig): AxiosPromise<IdPhoto>;
    /**
     * You can upload live photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. Live photos are validated at the point of upload to check that they contain exactly one face. This validation can be disabled by setting the advanced_validation argument to false.
     * @summary Upload live photo
     * @param {string} [applicantId] The ID of the applicant whose live photo is being uploaded.
     * @param {FileTransfer} [file] The file to be uploaded.
     * @param {boolean} [advancedValidation] Validates that the live photo contains exactly one face.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    uploadLivePhoto(applicantId?: string, file?: FileTransfer, advancedValidation?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<LivePhoto>;
    /**
     * Signing documents are uploaded using this endpoint. Signing documents must be uploaded as a multipart form. The only valid file type is pdf. The file size must be between 2KB and 3MB.
     * @summary Upload a signing document
     * @param {string} applicantId The ID of the applicant whose signing document is being uploaded.
     * @param {FileTransfer} file The file to be uploaded.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    uploadSigningDocument(applicantId: string, file: FileTransfer, options?: RawAxiosRequestConfig): AxiosPromise<SigningDocument>;
};
/**
 * DefaultApi - object-oriented interface
 */
export declare class DefaultApi extends BaseAPI {
    /**
     * Cancels single paused reports.
     * @summary Cancel report
     * @param {string} reportId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    cancelReport(reportId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
    /**
     * Completes a Send / Receive Data Task.
     * @summary Complete Task
     * @param {string} workflowRunId The unique identifier of the Workflow Run to which the Task belongs.
     * @param {string} taskId The identifier of the Task you want to complete.
     * @param {CompleteTaskBuilder} completeTaskBuilder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    completeTask(workflowRunId: string, taskId: string, completeTaskBuilder: CompleteTaskBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
    /**
     * Creates a single applicant. Returns an applicant object.
     * @summary Create Applicant
     * @param {ApplicantBuilder} applicantBuilder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createApplicant(applicantBuilder: ApplicantBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Applicant, any, {}>>;
    /**
     * Initiates a check for an applicant, which can contain one or more reports. Returns a check object.
     * @summary Create a check
     * @param {CheckBuilder} checkBuilder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createCheck(checkBuilder: CheckBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Check, any, {}>>;
    /**
     * Triggers the generation of the Timeline File for the designated Workflow Run.
     * @summary Create Timeline File for Workflow Run
     * @param {string} workflowRunId The unique identifier of the Workflow Run.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createTimelineFile(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TimelineFileReference, any, {}>>;
    /**
     * Creates a new monitor for the applicant
     * @summary Create monitor
     * @param {WatchlistMonitorBuilder} watchlistMonitorBuilder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createWatchlistMonitor(watchlistMonitorBuilder: WatchlistMonitorBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitor, any, {}>>;
    /**
     * Registers a webhook. Returns a webhook object.
     * @summary Register webhook
     * @param {WebhookBuilder} webhookBuilder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createWebhook(webhookBuilder: WebhookBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Webhook, any, {}>>;
    /**
     * Creates and starts a Workflow Run. Returns a Workflow Run object.
     * @summary Create a Workflow Run
     * @param {WorkflowRunBuilder} workflowRunBuilder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createWorkflowRun(workflowRunBuilder: WorkflowRunBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowRun, any, {}>>;
    /**
     * Deletes a single applicant.
     * @summary Delete Applicant
     * @param {string} applicantId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteApplicant(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
    /**
     * Deletes a passkey.
     * @summary Delete passkey
     * @param {string} username Username that owns the passkey.
     * @param {string} passkeyId Passkey ID.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deletePasskey(username: string, passkeyId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
    /**
     * Removes every passkey for the username.
     * @summary Delete passkeys
     * @param {string} username Username whose passkeys will be deleted.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deletePasskeys(username: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
    /**
     * Deactivates the given monitor
     * @summary Delete monitor
     * @param {string} monitorId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteWatchlistMonitor(monitorId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
    /**
     * Deletes a webhook.
     * @summary Delete a webhook
     * @param {string} webhookId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteWebhook(webhookId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
    /**
     * Retrieves the signed document or signing transaction receipt depending on the id provided.
     * @summary Retrieves the signed document or signing transaction receipt
     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
     * @param {string} id The unique identifier of the file which you want to retrieve.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadAesDocument(workflowRunId: string, id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
    /**
     * Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.
     * @summary Download check
     * @param {string} checkId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadCheck(checkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
    /**
     * Downloads specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
     * @summary Download document
     * @param {string} documentId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
    /**
     * Downloads a document video. If successful, the response will be the binary data representing the video.
     * @summary Download document video
     * @param {string} documentId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadDocumentVideo(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
    /**
     * Retrieves the evidence folder for the designated Workflow Run
     * @summary Retrieve Workflow Run Evidence Folder
     * @param {string} workflowRunId Workflow Run ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadEvidenceFolder(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
    /**
     * ID photos are downloaded using this endpoint.
     * @summary Download ID photo
     * @param {string} idPhotoId The ID photo\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadIdPhoto(idPhotoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
    /**
     * Live photos are downloaded using this endpoint.
     * @summary Download live photo
     * @param {string} livePhotoId The live photo\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadLivePhoto(livePhotoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
    /**
     * Live videos are downloaded using this endpoint.
     * @summary Download live video
     * @param {string} liveVideoId The live video\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadLiveVideo(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
    /**
     * Returns the binary data representing a single frame from a live video.
     * @summary Download live video frame
     * @param {string} liveVideoId The live video\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadLiveVideoFrame(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
    /**
     * Motion captures are downloaded using this endpoint.
     * @summary Download motion capture
     * @param {string} motionCaptureId The motion capture\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadMotionCapture(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
    /**
     * Instead of the whole capture binary, a single frame can be downloaded using this endpoint. Returns the binary data representing the frame.
     * @summary Download motion capture frame
     * @param {string} motionCaptureId The motion capture\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadMotionCaptureFrame(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
    /**
     * Downloads digital photos extracted from specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
     * @summary Download NFC face
     * @param {string} documentId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadNfcFace(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
    /**
     * Retrieves the signed document or application form depending on the file_id provided.
     * @summary Retrieves the signed document or application form
     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
     * @param {string} fileId The unique identifier of the file which you want to retrieve.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadQesDocument(workflowRunId: string, fileId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
    /**
     * Retrieves the signed document or signing transaction receipt depending on the id provided.
     * @summary Retrieves the signed document or signing transaction receipt
     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
     * @param {string} id The unique identifier of the file which you want to retrieve.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadSesDocument(workflowRunId: string, id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
    /**
     * Retrieves the signed evidence file for the designated Workflow Run
     * @summary Retrieve Workflow Run Evidence Summary File
     * @param {string} workflowRunId Workflow Run ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadSignedEvidenceFile(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
    /**
     * Downloads specific signing documents belonging to an applicant. If successful, the response will be the binary data representing the pdf.
     * @summary Download signing document
     * @param {string} signingDocumentId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    downloadSigningDocument(signingDocumentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
    /**
     * Extract information from a document
     * @summary Autofill
     * @param {ExtractRequest} extractRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    extract(extractRequest: ExtractRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Extraction, any, {}>>;
    /**
     * Search for addresses by postcode
     * @summary Address Picker
     * @param {string} postcode
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findAddresses(postcode: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AddressesList, any, {}>>;
    /**
     * Retrieves a single applicant. Returns an applicant object.
     * @summary Retrieve Applicant
     * @param {string} applicantId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findApplicant(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Applicant, any, {}>>;
    /**
     * Retrieves consents for single applicant.
     * @summary Retrieve Applicant Consents
     * @param {string} applicantId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findApplicantConsents(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicantConsent[], any, {}>>;
    /**
     * Retrieves a single check. Returns a check object.
     * @summary Retrieve a Check
     * @param {string} checkId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findCheck(checkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Check, any, {}>>;
    /**
     * A single document can be retrieved by calling this endpoint with the document\'s unique identifier.
     * @summary Retrieve document
     * @param {string} documentId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findDocument(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Document, any, {}>>;
    /**
     * Retrieves a single ID photo. Returns a ID photo object.
     * @summary Retrieve ID photo
     * @param {string} idPhotoId The ID photo\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findIdPhoto(idPhotoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IdPhoto, any, {}>>;
    /**
     * Retrieves a single live photo. Returns a live photo object.
     * @summary Retrieve live photo
     * @param {string} livePhotoId The live photo\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findLivePhoto(livePhotoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LivePhoto, any, {}>>;
    /**
     * Retrieves a single live video. Returns the corresponding live video object.
     * @summary Retrieve live video
     * @param {string} liveVideoId The live video\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findLiveVideo(liveVideoId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LiveVideo, any, {}>>;
    /**
     * Retrieves a single motion capture. Returns the corresponding motion capture object.
     * @summary Retrieve motion capture
     * @param {string} motionCaptureId The motion capture\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findMotionCapture(motionCaptureId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionCapture, any, {}>>;
    /**
     * Returns a passkey\'s details.
     * @summary Retrieve passkey
     * @param {string} username Username that owns the passkey.
     * @param {string} passkeyId Passkey ID.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findPasskey(username: string, passkeyId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Passkey, any, {}>>;
    /**
     * A single report can be retrieved using this endpoint with the corresponding unique identifier.
     * @summary Retrieve report
     * @param {string} reportId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findReport(reportId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Report, any, {}>>;
    /**
     * A single signing document can be retrieved by calling this endpoint with the signing document\'s unique identifier.
     * @summary Retrieve signing document
     * @param {string} signingDocumentId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findSigningDocument(signingDocumentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SigningDocument, any, {}>>;
    /**
     * A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run.
     * @summary Retrieve Task
     * @param {string} workflowRunId The unique identifier of the Workflow Run to which the Task belongs.
     * @param {string} taskId The identifier of the Task you want to retrieve.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findTask(workflowRunId: string, taskId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Task, any, {}>>;
    /**
     * Retrieves the Timeline File for the designated Workflow Run.
     * @summary Retrieve Timeline File for Workflow Run
     * @param {string} workflowRunId The unique identifier of the Workflow Run.
     * @param {string} timelineFileId The unique identifier for the Timefile File.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findTimelineFile(workflowRunId: string, timelineFileId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any, {}>>;
    /**
     * Retrieves a single monitor
     * @summary Retrieve monitor
     * @param {string} monitorId The watchlist monitor\&#39;s unique identifier.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findWatchlistMonitor(monitorId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitor, any, {}>>;
    /**
     * Retrieves a single webhook. Returns a webhook object.
     * @summary Retrieve a Webhook
     * @param {string} webhookId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findWebhook(webhookId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Webhook, any, {}>>;
    /**
     * A single workflow run can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
     * @summary Retrieve Workflow Run
     * @param {string} workflowRunId The unique identifier of the Workflow Run.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    findWorkflowRun(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowRun, any, {}>>;
    /**
     * Triggers a new check with an updated report to be generated by the monitor, as if the monitor had received an update.
     * @summary Force new report creation (BETA)
     * @param {string} monitorId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    forceReportCreationFromWatchlistMonitor(monitorId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
    /**
     * Generates an SDK token. Returns a token object containing the SDK token.
     * @summary Generate a SDK token
     * @param {SdkTokenBuilder} sdkTokenBuilder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    generateSdkToken(sdkTokenBuilder: SdkTokenBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SdkToken, any, {}>>;
    /**
     * Lists all applicants you\'ve created, sorted by creation date in descending order.
     * @summary List Applicants
     * @param {number} [page] The page to return. The first page is &#x60;page&#x3D;1&#x60;
     * @param {number} [perPage] The number of objects per page.
     * @param {boolean} [includeDeleted] Whether to also include applicants scheduled for deletion.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listApplicants(page?: number, perPage?: number, includeDeleted?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicantsList, any, {}>>;
    /**
     * Retrieves a single check. Returns a check object.
     * @summary Retrieve Checks
     * @param {string} applicantId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listChecks(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ChecksList, any, {}>>;
    /**
     * All documents belonging to an applicant can be listed from this endpoint
     * @summary List documents
     * @param {string} applicantId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listDocuments(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentsList, any, {}>>;
    /**
     * Lists the ID photos that belong to an applicant.
     * @summary List ID photos
     * @param {string} applicantId The id of the applicant the ID photos belong to.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listIdPhotos(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IdPhotosList, any, {}>>;
    /**
     * Lists the live photos that belong to an applicant.
     * @summary List live photos
     * @param {string} applicantId The id of the applicant the live photos belong to.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listLivePhotos(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LivePhotosList, any, {}>>;
    /**
     * Lists all the live videos that belong to an applicant.
     * @summary List live videos
     * @param {string} applicantId The id of the applicant the live videos belong to.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listLiveVideos(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LiveVideosList, any, {}>>;
    /**
     * Lists all the motion captures that belong to an applicant.
     * @summary List motion captures
     * @param {string} applicantId The id of the applicant the motion captures belong to.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listMotionCaptures(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MotionCapturesList, any, {}>>;
    /**
     * Returns every passkey registered under the supplied username.
     * @summary List passkeys
     * @param {string} username Username that owns the passkeys.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listPasskeys(username: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PasskeysList, any, {}>>;
    /**
     * Returns all repeat attempts for a given Document report
     * @summary Retrieve repeat attempts
     * @param {string} reportId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listRepeatAttempts(reportId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RepeatAttemptsList, any, {}>>;
    /**
     * All the reports belonging to a particular check can be listed from this endpoint.
     * @summary List reports
     * @param {string} checkId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listReports(checkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportsList, any, {}>>;
    /**
     * All signing documents belonging to an applicant can be listed from this endpoint
     * @summary List signing documents
     * @param {string} applicantId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listSigningDocuments(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SigningDocumentsList, any, {}>>;
    /**
     * The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run.
     * @summary List Tasks
     * @param {string} workflowRunId The unique identifier of the Workflow Run to which the Tasks belong.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listTasks(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TaskItem[], any, {}>>;
    /**
     * List match IDs on this monitor, as well as their enabled/disabled status
     * @summary List matches (BETA)
     * @param {string} monitorId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listWatchlistMonitorMatches(monitorId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitorMatchesList, any, {}>>;
    /**
     * List all available monitors for an applicant
     * @summary List monitors
     * @param {string} applicantId The id of the applicant the watchlist monitors belong to. If omitted, all monitors for the account will be listed.
     * @param {boolean} [includeDeleted] Whether to also include deleted (inactive) monitors.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listWatchlistMonitors(applicantId: string, includeDeleted?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitorsList, any, {}>>;
    /**
     * Lists all webhooks you\'ve created.
     * @summary List webhooks
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listWebhooks(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WebhooksList, any, {}>>;
    /**
     * Retrieves the Workflow Runs of the client. Returns a list of Workflow Run objects.
     * @summary List Workflow Runs
     * @param {number} [page] The number of the page to be retrieved. If not specified, defaults to 1.
     * @param {string} [status] A list of comma separated status values to filter the results. Possible values are \&#39;processing\&#39;, \&#39;awaiting_input\&#39;, \&#39;approved\&#39;, \&#39;declined\&#39;, \&#39;review\&#39;, \&#39;abandoned\&#39; and \&#39;error\&#39;.
     * @param {string} [createdAtGt] A ISO-8601 date to filter results with a created date greater than (after) the one provided.
     * @param {string} [createdAtLt] A ISO-8601 date to filter results with a created date less than (before) the one provided.
     * @param {ListWorkflowRunsSortEnum} [sort] A string with the value \&#39;desc\&#39; or \&#39;asc\&#39; that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to \&#39;desc\&#39;.
     * @param {string} [applicantId] the applicant\&#39;s id.
     * @param {Array<string>} [tags] A list of tags to filter the results.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listWorkflowRuns(page?: number, status?: string, createdAtGt?: string, createdAtLt?: string, sort?: ListWorkflowRunsSortEnum, applicantId?: string, tags?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowRun[], any, {}>>;
    /**
     * Run a health check on the Onfido API
     * @summary Ping
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    ping(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
    /**
     * Create Feedback on checks and reports
     * @summary Fraud reporting (ALPHA)
     * @param {ResultsFeedback} resultsFeedback
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postResultsFeedback(resultsFeedback: ResultsFeedback, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ResultsFeedback, any, {}>>;
    /**
     * Resends events to all webhooks registered with a matching environment in your account.
     * @summary Resends webhooks
     * @param {WebhookResend} webhookResend
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    resendWebhooks(webhookResend: WebhookResend, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
    /**
     * Restores a single applicant scheduled for deletion.
     * @summary Restore Applicant
     * @param {string} applicantId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    restoreApplicant(applicantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
    /**
     * Resumes a paused check.
     * @summary Resume a Check
     * @param {string} checkId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    resumeCheck(checkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
    /**
     * Resumes a single paused report.
     * @summary Resume report
     * @param {string} reportId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    resumeReport(reportId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
    /**
     * Allows updating applicant\'s information before any checks is created. - Partial updates - Addresses and ID numbers present will replace existing ones - Same applicant validations to create applicant
     * @summary Update Applicant
     * @param {string} applicantId
     * @param {ApplicantUpdater} applicantUpdater
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateApplicant(applicantId: string, applicantUpdater: ApplicantUpdater, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Applicant, any, {}>>;
    /**
     * Updates a passkey\'s state.
     * @summary Update passkey
     * @param {string} username Username that owns the passkey.
     * @param {string} passkeyId Passkey ID.
     * @param {PasskeyUpdater} passkeyUpdater Passkey update payload.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updatePasskey(username: string, passkeyId: string, passkeyUpdater: PasskeyUpdater, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Passkey, any, {}>>;
    /**
     * Update the status of the given matches
     * @summary Set match status (BETA)
     * @param {string} monitorId
     * @param {WatchlistMonitorMatchesUpdater} watchlistMonitorMatchesUpdater
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateWatchlistMonitorMatch(monitorId: string, watchlistMonitorMatchesUpdater: WatchlistMonitorMatchesUpdater, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WatchlistMonitorMatchesList, any, {}>>;
    /**
     * Edits a webhook. Returns the updated webhook object.
     * @summary Edit a webhook
     * @param {string} webhookId
     * @param {WebhookUpdater} webhookUpdater
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateWebhook(webhookId: string, webhookUpdater: WebhookUpdater, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Webhook, any, {}>>;
    /**
     * Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB.
     * @summary Upload a document
     * @param {DocumentTypes} type The type of document
     * @param {string} applicantId The ID of the applicant whose document is being uploaded.
     * @param {FileTransfer} file The file to be uploaded.
     * @param {string} [fileType] The file type of the uploaded file
     * @param {UploadDocumentSideEnum} [side] The side of the document, if applicable. The possible values are front and back
     * @param {CountryCodes} [issuingCountry] The issuing country of the document, a 3-letter ISO code.
     * @param {boolean} [validateImageQuality] Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds.
     * @param {LocationBuilder} [location]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    uploadDocument(type: DocumentTypes, applicantId: string, file: FileTransfer, fileType?: string, side?: UploadDocumentSideEnum, issuingCountry?: CountryCodes, validateImageQuality?: boolean, location?: LocationBuilder, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Document, any, {}>>;
    /**
     * You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB.
     * @summary Upload ID photo
     * @param {string} [applicantId] The ID of the applicant whose ID photo is being uploaded.
     * @param {FileTransfer} [file] The file to be uploaded.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    uploadIdPhoto(applicantId?: string, file?: FileTransfer, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IdPhoto, any, {}>>;
    /**
     * You can upload live photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. Live photos are validated at the point of upload to check that they contain exactly one face. This validation can be disabled by setting the advanced_validation argument to false.
     * @summary Upload live photo
     * @param {string} [applicantId] The ID of the applicant whose live photo is being uploaded.
     * @param {FileTransfer} [file] The file to be uploaded.
     * @param {boolean} [advancedValidation] Validates that the live photo contains exactly one face.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    uploadLivePhoto(applicantId?: string, file?: FileTransfer, advancedValidation?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LivePhoto, any, {}>>;
    /**
     * Signing documents are uploaded using this endpoint. Signing documents must be uploaded as a multipart form. The only valid file type is pdf. The file size must be between 2KB and 3MB.
     * @summary Upload a signing document
     * @param {string} applicantId The ID of the applicant whose signing document is being uploaded.
     * @param {FileTransfer} file The file to be uploaded.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    uploadSigningDocument(applicantId: string, file: FileTransfer, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SigningDocument, any, {}>>;
}
export declare const ListWorkflowRunsSortEnum: {
    readonly Desc: "desc";
    readonly Asc: "asc";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type ListWorkflowRunsSortEnum = typeof ListWorkflowRunsSortEnum[keyof typeof ListWorkflowRunsSortEnum];
export declare const UploadDocumentSideEnum: {
    readonly Front: "front";
    readonly Back: "back";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type UploadDocumentSideEnum = typeof UploadDocumentSideEnum[keyof typeof UploadDocumentSideEnum];