@onfido/api/dist/esm/api.d.ts

Node.js library for the Onfido API

/**
 * Onfido API v3.6
 * The Onfido 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
 */
export interface Address {
    /**
     * The flat number of this address
     * @type {string}
     * @memberof Address
     */
    'flat_number'?: string;
    /**
     * The building number of this address
     * @type {string}
     * @memberof Address
     */
    'building_number'?: string;
    /**
     * The building name of this address
     * @type {string}
     * @memberof Address
     */
    'building_name'?: string;
    /**
     * The street of the applicant\'s address
     * @type {string}
     * @memberof Address
     */
    'street'?: string;
    /**
     * The sub-street of the applicant\'s address
     * @type {string}
     * @memberof Address
     */
    'sub_street'?: string;
    /**
     * The town of the applicant\'s address
     * @type {string}
     * @memberof Address
     */
    'town'?: string;
    /**
     * The postcode or ZIP of the applicant\'s address
     * @type {string}
     * @memberof Address
     */
    'postcode': string;
    /**
     * The 3 character ISO country code of this address. For example, GBR is the country code for the United Kingdom
     * @type {CountryCodes}
     * @memberof Address
     */
    'country': CountryCodes;
    /**
     * The address state. US states must use the USPS abbreviation (see also ISO 3166-2:US), for example AK, CA, or TX.
     * @type {string}
     * @memberof Address
     */
    'state'?: string;
    /**
     * Line 1 of the applicant\'s address
     * @type {string}
     * @memberof Address
     */
    'line1'?: string | null;
    /**
     * Line 2 of the applicant\'s address
     * @type {string}
     * @memberof Address
     */
    'line2'?: string | null;
    /**
     * Line 3 of the applicant\'s address
     * @type {string}
     * @memberof Address
     */
    'line3'?: string | null;
}
/**
 *
 * @export
 * @interface AddressBuilder
 */
export interface AddressBuilder {
    /**
     * The flat number of this address
     * @type {string}
     * @memberof AddressBuilder
     */
    'flat_number'?: string;
    /**
     * The building number of this address
     * @type {string}
     * @memberof AddressBuilder
     */
    'building_number'?: string;
    /**
     * The building name of this address
     * @type {string}
     * @memberof AddressBuilder
     */
    'building_name'?: string;
    /**
     * The street of the applicant\'s address
     * @type {string}
     * @memberof AddressBuilder
     */
    'street'?: string;
    /**
     * The sub-street of the applicant\'s address
     * @type {string}
     * @memberof AddressBuilder
     */
    'sub_street'?: string;
    /**
     * The town of the applicant\'s address
     * @type {string}
     * @memberof AddressBuilder
     */
    'town'?: string;
    /**
     * The postcode or ZIP of the applicant\'s address
     * @type {string}
     * @memberof AddressBuilder
     */
    'postcode': string;
    /**
     * The 3 character ISO country code of this address. For example, GBR is the country code for the United Kingdom
     * @type {CountryCodes}
     * @memberof AddressBuilder
     */
    'country': CountryCodes;
    /**
     * The address state. US states must use the USPS abbreviation (see also ISO 3166-2:US), for example AK, CA, or TX.
     * @type {string}
     * @memberof AddressBuilder
     */
    'state'?: string;
    /**
     * Line 1 of the applicant\'s address
     * @type {string}
     * @memberof AddressBuilder
     */
    'line1'?: string | null;
    /**
     * Line 2 of the applicant\'s address
     * @type {string}
     * @memberof AddressBuilder
     */
    'line2'?: string | null;
    /**
     * Line 3 of the applicant\'s address
     * @type {string}
     * @memberof AddressBuilder
     */
    'line3'?: string | null;
}
/**
 *
 * @export
 * @interface AddressShared
 */
export interface AddressShared {
    /**
     * The flat number of this address
     * @type {string}
     * @memberof AddressShared
     */
    'flat_number'?: string;
    /**
     * The building number of this address
     * @type {string}
     * @memberof AddressShared
     */
    'building_number'?: string;
    /**
     * The building name of this address
     * @type {string}
     * @memberof AddressShared
     */
    'building_name'?: string;
    /**
     * The street of the applicant\'s address
     * @type {string}
     * @memberof AddressShared
     */
    'street'?: string;
    /**
     * The sub-street of the applicant\'s address
     * @type {string}
     * @memberof AddressShared
     */
    'sub_street'?: string;
    /**
     * The town of the applicant\'s address
     * @type {string}
     * @memberof AddressShared
     */
    'town'?: string;
    /**
     * The postcode or ZIP of the applicant\'s address
     * @type {string}
     * @memberof AddressShared
     */
    'postcode': string;
    /**
     * The 3 character ISO country code of this address. For example, GBR is the country code for the United Kingdom
     * @type {CountryCodes}
     * @memberof AddressShared
     */
    'country': CountryCodes;
    /**
     * The address state. US states must use the USPS abbreviation (see also ISO 3166-2:US), for example AK, CA, or TX.
     * @type {string}
     * @memberof AddressShared
     */
    'state'?: string;
    /**
     * Line 1 of the applicant\'s address
     * @type {string}
     * @memberof AddressShared
     */
    'line1'?: string | null;
    /**
     * Line 2 of the applicant\'s address
     * @type {string}
     * @memberof AddressShared
     */
    'line2'?: string | null;
    /**
     * Line 3 of the applicant\'s address
     * @type {string}
     * @memberof AddressShared
     */
    'line3'?: string | null;
}
/**
 *
 * @export
 * @interface AddressesList
 */
export interface AddressesList {
    /**
     *
     * @type {Array<Address>}
     * @memberof AddressesList
     */
    'addresses'?: Array<Address>;
}
/**
 *
 * @export
 * @interface Applicant
 */
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`.
     * @type {string}
     * @memberof Applicant
     */
    'email'?: string;
    /**
     * The applicant\'s date of birth
     * @type {string}
     * @memberof Applicant
     */
    'dob'?: string;
    /**
     *
     * @type {Array<IdNumber>}
     * @memberof Applicant
     */
    'id_numbers'?: Array<IdNumber>;
    /**
     * The applicant\'s phone number
     * @type {string}
     * @memberof Applicant
     */
    'phone_number'?: string;
    /**
     * The applicant\'s first name
     * @type {string}
     * @memberof Applicant
     */
    'first_name'?: string;
    /**
     * The applicant\'s surname
     * @type {string}
     * @memberof Applicant
     */
    'last_name'?: string;
    /**
     * The unique identifier for the applicant.
     * @type {string}
     * @memberof Applicant
     */
    'id': string;
    /**
     * The date and time when this applicant was created.
     * @type {string}
     * @memberof Applicant
     */
    'created_at'?: string;
    /**
     * The date and time when this applicant is scheduled to be deleted.
     * @type {string}
     * @memberof Applicant
     */
    'delete_at'?: string;
    /**
     * The uri of this resource.
     * @type {string}
     * @memberof Applicant
     */
    'href'?: string;
    /**
     *
     * @type {boolean}
     * @memberof Applicant
     */
    'sandbox'?: boolean;
    /**
     *
     * @type {Address}
     * @memberof Applicant
     */
    'address'?: Address;
    /**
     *
     * @type {Location}
     * @memberof Applicant
     */
    'location'?: Location;
}
/**
 *
 * @export
 * @interface ApplicantBuilder
 */
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`.
     * @type {string}
     * @memberof ApplicantBuilder
     */
    'email'?: string;
    /**
     * The applicant\'s date of birth
     * @type {string}
     * @memberof ApplicantBuilder
     */
    'dob'?: string;
    /**
     *
     * @type {Array<IdNumber>}
     * @memberof ApplicantBuilder
     */
    'id_numbers'?: Array<IdNumber>;
    /**
     * The applicant\'s phone number
     * @type {string}
     * @memberof ApplicantBuilder
     */
    'phone_number'?: string;
    /**
     * The applicant\'s consents
     * @type {Array<ApplicantConsentBuilder>}
     * @memberof ApplicantBuilder
     */
    'consents'?: Array<ApplicantConsentBuilder>;
    /**
     *
     * @type {AddressBuilder}
     * @memberof ApplicantBuilder
     */
    'address'?: AddressBuilder;
    /**
     *
     * @type {LocationBuilder}
     * @memberof ApplicantBuilder
     */
    'location'?: LocationBuilder;
    /**
     * The applicant\'s first name
     * @type {string}
     * @memberof ApplicantBuilder
     */
    'first_name': string;
    /**
     * The applicant\'s surname
     * @type {string}
     * @memberof ApplicantBuilder
     */
    'last_name': string;
}
/**
 *
 * @export
 * @interface ApplicantConsent
 */
export interface ApplicantConsent {
    /**
     *
     * @type {ApplicantConsentName}
     * @memberof ApplicantConsent
     */
    'name': ApplicantConsentName;
    /**
     *
     * @type {boolean}
     * @memberof ApplicantConsent
     */
    'granted': boolean;
    /**
     * The date and time when this applicant consent was granted, if not granted the value is nil.
     * @type {string}
     * @memberof ApplicantConsent
     */
    'granted_at': string | null;
}
/**
 *
 * @export
 * @interface ApplicantConsentBuilder
 */
export interface ApplicantConsentBuilder {
    /**
     *
     * @type {ApplicantConsentName}
     * @memberof ApplicantConsentBuilder
     */
    'name': ApplicantConsentName;
    /**
     *
     * @type {boolean}
     * @memberof ApplicantConsentBuilder
     */
    'granted': boolean;
}
/**
 *
 * @export
 * @enum {string}
 */
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
 */
export interface ApplicantCreate {
    /**
     * The applicant\'s first name
     * @type {string}
     * @memberof ApplicantCreate
     */
    'first_name': string;
    /**
     * The applicant\'s surname
     * @type {string}
     * @memberof ApplicantCreate
     */
    'last_name': string;
}
/**
 *
 * @export
 * @interface ApplicantRequest
 */
export interface ApplicantRequest {
    /**
     * The applicant\'s consents
     * @type {Array<ApplicantConsentBuilder>}
     * @memberof ApplicantRequest
     */
    'consents'?: Array<ApplicantConsentBuilder>;
    /**
     *
     * @type {AddressBuilder}
     * @memberof ApplicantRequest
     */
    'address'?: AddressBuilder;
    /**
     *
     * @type {LocationBuilder}
     * @memberof ApplicantRequest
     */
    'location'?: LocationBuilder;
}
/**
 *
 * @export
 * @interface ApplicantResponse
 */
export interface ApplicantResponse {
    /**
     * The applicant\'s first name
     * @type {string}
     * @memberof ApplicantResponse
     */
    'first_name'?: string;
    /**
     * The applicant\'s surname
     * @type {string}
     * @memberof ApplicantResponse
     */
    'last_name'?: string;
    /**
     * The unique identifier for the applicant.
     * @type {string}
     * @memberof ApplicantResponse
     */
    'id': string;
    /**
     * The date and time when this applicant was created.
     * @type {string}
     * @memberof ApplicantResponse
     */
    'created_at'?: string;
    /**
     * The date and time when this applicant is scheduled to be deleted.
     * @type {string}
     * @memberof ApplicantResponse
     */
    'delete_at'?: string;
    /**
     * The uri of this resource.
     * @type {string}
     * @memberof ApplicantResponse
     */
    'href'?: string;
    /**
     *
     * @type {boolean}
     * @memberof ApplicantResponse
     */
    'sandbox'?: boolean;
    /**
     *
     * @type {Address}
     * @memberof ApplicantResponse
     */
    'address'?: Address;
    /**
     *
     * @type {Location}
     * @memberof ApplicantResponse
     */
    'location'?: Location;
}
/**
 *
 * @export
 * @interface ApplicantShared
 */
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`.
     * @type {string}
     * @memberof ApplicantShared
     */
    'email'?: string;
    /**
     * The applicant\'s date of birth
     * @type {string}
     * @memberof ApplicantShared
     */
    'dob'?: string;
    /**
     *
     * @type {Array<IdNumber>}
     * @memberof ApplicantShared
     */
    'id_numbers'?: Array<IdNumber>;
    /**
     * The applicant\'s phone number
     * @type {string}
     * @memberof ApplicantShared
     */
    'phone_number'?: string;
}
/**
 *
 * @export
 * @interface ApplicantUpdate
 */
export interface ApplicantUpdate {
    /**
     * The applicant\'s first name
     * @type {string}
     * @memberof ApplicantUpdate
     */
    'first_name'?: string;
    /**
     * The applicant\'s surname
     * @type {string}
     * @memberof ApplicantUpdate
     */
    'last_name'?: string;
}
/**
 *
 * @export
 * @interface ApplicantUpdater
 */
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`.
     * @type {string}
     * @memberof ApplicantUpdater
     */
    'email'?: string;
    /**
     * The applicant\'s date of birth
     * @type {string}
     * @memberof ApplicantUpdater
     */
    'dob'?: string;
    /**
     *
     * @type {Array<IdNumber>}
     * @memberof ApplicantUpdater
     */
    'id_numbers'?: Array<IdNumber>;
    /**
     * The applicant\'s phone number
     * @type {string}
     * @memberof ApplicantUpdater
     */
    'phone_number'?: string;
    /**
     * The applicant\'s consents
     * @type {Array<ApplicantConsentBuilder>}
     * @memberof ApplicantUpdater
     */
    'consents'?: Array<ApplicantConsentBuilder>;
    /**
     *
     * @type {AddressBuilder}
     * @memberof ApplicantUpdater
     */
    'address'?: AddressBuilder;
    /**
     *
     * @type {LocationBuilder}
     * @memberof ApplicantUpdater
     */
    'location'?: LocationBuilder;
    /**
     * The applicant\'s first name
     * @type {string}
     * @memberof ApplicantUpdater
     */
    'first_name'?: string;
    /**
     * The applicant\'s surname
     * @type {string}
     * @memberof ApplicantUpdater
     */
    'last_name'?: string;
}
/**
 *
 * @export
 * @interface ApplicantsList
 */
export interface ApplicantsList {
    /**
     *
     * @type {Array<Applicant>}
     * @memberof ApplicantsList
     */
    'applicants': Array<Applicant>;
}
/**
 *
 * @export
 * @interface Check
 */
export interface Check {
    /**
     * An array of webhook ids describing which webhooks to trigger for this check.
     * @type {Array<string>}
     * @memberof Check
     */
    'webhook_ids'?: Array<string>;
    /**
     * The ID of the applicant to do the check on.
     * @type {string}
     * @memberof Check
     */
    'applicant_id': string;
    /**
     * Send an applicant form to applicant to complete to proceed with check. Defaults to false.
     * @type {boolean}
     * @memberof Check
     */
    'applicant_provides_data'?: boolean;
    /**
     * Array of tags being assigned to this check.
     * @type {Array<string>}
     * @memberof Check
     */
    'tags'?: Array<string>;
    /**
     * For checks where `applicant_provides_data` is `true`, redirect to this URI when the applicant has submitted their data.
     * @type {string}
     * @memberof Check
     */
    'redirect_uri'?: string;
    /**
     *
     * @type {boolean}
     * @memberof Check
     */
    'privacy_notices_read_consent_given'?: boolean;
    /**
     * The unique identifier for the check.
     * @type {string}
     * @memberof Check
     */
    'id': string;
    /**
     * The date and time when this check was created.
     * @type {string}
     * @memberof Check
     */
    'created_at'?: string;
    /**
     * The uri of this resource.
     * @type {string}
     * @memberof Check
     */
    'href'?: string;
    /**
     *
     * @type {CheckStatus}
     * @memberof Check
     */
    'status'?: CheckStatus;
    /**
     * The overall result of the check, based on the results of the constituent reports.
     * @type {string}
     * @memberof Check
     */
    'result'?: CheckResultEnum;
    /**
     * A link to the applicant form, if `applicant_provides_data` is `true`.
     * @type {string}
     * @memberof Check
     */
    'form_uri'?: string;
    /**
     * A link to the corresponding results page on the Onfido dashboard.
     * @type {string}
     * @memberof Check
     */
    'results_uri'?: string;
    /**
     * An array of report ids.
     * @type {Array<string>}
     * @memberof Check
     */
    'report_ids'?: Array<string>;
    /**
     * Indicates whether the object was created in the sandbox or not.
     * @type {boolean}
     * @memberof Check
     */
    'sandbox'?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof Check
     */
    'paused'?: boolean;
    /**
     *
     * @type {string}
     * @memberof Check
     */
    '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
 */
export interface CheckBuilder {
    /**
     * An array of webhook ids describing which webhooks to trigger for this check.
     * @type {Array<string>}
     * @memberof CheckBuilder
     */
    'webhook_ids'?: Array<string>;
    /**
     * The ID of the applicant to do the check on.
     * @type {string}
     * @memberof CheckBuilder
     */
    'applicant_id': string;
    /**
     * Send an applicant form to applicant to complete to proceed with check. Defaults to false.
     * @type {boolean}
     * @memberof CheckBuilder
     */
    'applicant_provides_data'?: boolean;
    /**
     * Array of tags being assigned to this check.
     * @type {Array<string>}
     * @memberof CheckBuilder
     */
    'tags'?: Array<string>;
    /**
     * For checks where `applicant_provides_data` is `true`, redirect to this URI when the applicant has submitted their data.
     * @type {string}
     * @memberof CheckBuilder
     */
    'redirect_uri'?: string;
    /**
     *
     * @type {boolean}
     * @memberof CheckBuilder
     */
    'privacy_notices_read_consent_given'?: boolean;
    /**
     * An array of report names (strings).
     * @type {Array<ReportName>}
     * @memberof CheckBuilder
     */
    '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.
     * @type {Array<string>}
     * @memberof CheckBuilder
     */
    '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.
     * @type {boolean}
     * @memberof CheckBuilder
     */
    '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.
     * @type {boolean}
     * @memberof CheckBuilder
     */
    'suppress_form_emails'?: boolean;
    /**
     * Triggers responses for particular sub-results for sandbox Document reports.
     * @type {string}
     * @memberof CheckBuilder
     */
    'sub_result'?: string;
    /**
     * Array of names of particular reports to return consider as their results. This is a feature available in sandbox testing
     * @type {Array<ReportName>}
     * @memberof CheckBuilder
     */
    'consider'?: Array<ReportName>;
    /**
     *
     * @type {UsDrivingLicenceBuilder}
     * @memberof CheckBuilder
     */
    'us_driving_licence'?: UsDrivingLicenceBuilder;
    /**
     *
     * @type {ReportConfiguration}
     * @memberof CheckBuilder
     * @deprecated
     */
    'report_configuration'?: ReportConfiguration;
}
/**
 *
 * @export
 * @interface CheckRequest
 */
export interface CheckRequest {
    /**
     * An array of report names (strings).
     * @type {Array<ReportName>}
     * @memberof CheckRequest
     */
    '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.
     * @type {Array<string>}
     * @memberof CheckRequest
     */
    'document_ids'?: Array<string>;
    /**
     * Send an applicant form to applicant to complete to proceed with check. Defaults to false.
     * @type {boolean}
     * @memberof CheckRequest
     */
    '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.
     * @type {boolean}
     * @memberof CheckRequest
     */
    '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.
     * @type {boolean}
     * @memberof CheckRequest
     */
    'suppress_form_emails'?: boolean;
    /**
     * Triggers responses for particular sub-results for sandbox Document reports.
     * @type {string}
     * @memberof CheckRequest
     */
    'sub_result'?: string;
    /**
     * Array of names of particular reports to return consider as their results. This is a feature available in sandbox testing
     * @type {Array<ReportName>}
     * @memberof CheckRequest
     */
    'consider'?: Array<ReportName>;
    /**
     *
     * @type {UsDrivingLicenceBuilder}
     * @memberof CheckRequest
     */
    'us_driving_licence'?: UsDrivingLicenceBuilder;
    /**
     *
     * @type {ReportConfiguration}
     * @memberof CheckRequest
     * @deprecated
     */
    'report_configuration'?: ReportConfiguration;
}
/**
 *
 * @export
 * @interface CheckResponse
 */
export interface CheckResponse {
    /**
     * The unique identifier for the check.
     * @type {string}
     * @memberof CheckResponse
     */
    'id': string;
    /**
     * The date and time when this check was created.
     * @type {string}
     * @memberof CheckResponse
     */
    'created_at'?: string;
    /**
     * The uri of this resource.
     * @type {string}
     * @memberof CheckResponse
     */
    'href'?: string;
    /**
     *
     * @type {CheckStatus}
     * @memberof CheckResponse
     */
    'status'?: CheckStatus;
    /**
     * The overall result of the check, based on the results of the constituent reports.
     * @type {string}
     * @memberof CheckResponse
     */
    'result'?: CheckResponseResultEnum;
    /**
     * A link to the applicant form, if `applicant_provides_data` is `true`.
     * @type {string}
     * @memberof CheckResponse
     */
    'form_uri'?: string;
    /**
     * A link to the corresponding results page on the Onfido dashboard.
     * @type {string}
     * @memberof CheckResponse
     */
    'results_uri'?: string;
    /**
     * An array of report ids.
     * @type {Array<string>}
     * @memberof CheckResponse
     */
    'report_ids'?: Array<string>;
    /**
     * Indicates whether the object was created in the sandbox or not.
     * @type {boolean}
     * @memberof CheckResponse
     */
    'sandbox'?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof CheckResponse
     */
    'paused'?: boolean;
    /**
     *
     * @type {string}
     * @memberof CheckResponse
     */
    '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
 */
export interface CheckShared {
    /**
     * An array of webhook ids describing which webhooks to trigger for this check.
     * @type {Array<string>}
     * @memberof CheckShared
     */
    'webhook_ids'?: Array<string>;
    /**
     * The ID of the applicant to do the check on.
     * @type {string}
     * @memberof CheckShared
     */
    'applicant_id': string;
    /**
     * Send an applicant form to applicant to complete to proceed with check. Defaults to false.
     * @type {boolean}
     * @memberof CheckShared
     */
    'applicant_provides_data'?: boolean;
    /**
     * Array of tags being assigned to this check.
     * @type {Array<string>}
     * @memberof CheckShared
     */
    'tags'?: Array<string>;
    /**
     * For checks where `applicant_provides_data` is `true`, redirect to this URI when the applicant has submitted their data.
     * @type {string}
     * @memberof CheckShared
     */
    'redirect_uri'?: string;
    /**
     *
     * @type {boolean}
     * @memberof CheckShared
     */
    'privacy_notices_read_consent_given'?: boolean;
}
/**
 * The current state of the check in the checking process.
 * @export
 * @enum {string}
 */
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
 */
export interface ChecksList {
    /**
     *
     * @type {Array<Check>}
     * @memberof ChecksList
     */
    'checks': Array<Check>;
}
/**
 *
 * @export
 * @interface CompleteTaskBuilder
 */
export interface CompleteTaskBuilder {
    /**
     *
     * @type {CompleteTaskDataBuilder}
     * @memberof CompleteTaskBuilder
     */
    'data': CompleteTaskDataBuilder;
}
/**
 * @type CompleteTaskDataBuilder
 * The Task completion payload.
 * @export
 */
export type CompleteTaskDataBuilder = Array<object> | object;
/**
 *
 * @export
 * @enum {string}
 */
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
 */
export interface DeviceIntelligenceBreakdown {
    /**
     *
     * @type {DeviceIntelligenceBreakdownDevice}
     * @memberof DeviceIntelligenceBreakdown
     */
    'device'?: DeviceIntelligenceBreakdownDevice;
    /**
     *
     * @type {DeviceIntelligenceBreakdownBreakdown}
     * @memberof DeviceIntelligenceBreakdown
     * @deprecated
     */
    'breakdown'?: DeviceIntelligenceBreakdownBreakdown;
    /**
     *
     * @type {DeviceIntelligenceBreakdownProperties}
     * @memberof DeviceIntelligenceBreakdown
     * @deprecated
     */
    'properties'?: DeviceIntelligenceBreakdownProperties;
}
/**
 *
 * @export
 * @interface DeviceIntelligenceBreakdownBreakdown
 */
export interface DeviceIntelligenceBreakdownBreakdown {
    /**
     *
     * @type {DeviceIntelligenceBreakdownDevice}
     * @memberof DeviceIntelligenceBreakdownBreakdown
     */
    'device'?: DeviceIntelligenceBreakdownDevice;
}
/**
 * Asserts whether the device used to upload the media is trustworthy, i.e. it is a real, physical device.
 * @export
 * @interface DeviceIntelligenceBreakdownDevice
 */
export interface DeviceIntelligenceBreakdownDevice {
    /**
     *
     * @type {DeviceIntelligenceBreakdownDeviceBreakdown}
     * @memberof DeviceIntelligenceBreakdownDevice
     */
    'breakdown'?: DeviceIntelligenceBreakdownDeviceBreakdown;
}
/**
 *
 * @export
 * @interface DeviceIntelligenceBreakdownDeviceBreakdown
 */
export interface DeviceIntelligenceBreakdownDeviceBreakdown {
    /**
     *
     * @type {DocumentBreakdownDataComparisonBreakdownIssuingCountry}
     * @memberof DeviceIntelligenceBreakdownDeviceBreakdown
     */
    'application_authenticity'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    /**
     *
     * @type {DocumentBreakdownDataComparisonBreakdownIssuingCountry}
     * @memberof DeviceIntelligenceBreakdownDeviceBreakdown
     */
    'device_integrity'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
    /**
     *
     * @type {DocumentBreakdownDataComparisonBreakdownIssuingCountry}
     * @memberof DeviceIntelligenceBreakdownDeviceBreakdown
     */
    'device_reputation'?: DocumentBreakdownDataComparisonBreakdownIssuingCountry;
}
/**
 *
 * @export
 * @interface DeviceIntelligenceBreakdownProperties
 */
export interface DeviceIntelligenceBreakdownProperties {
    /**
     *
     * @type {DeviceIntelligenceBreakdownPropertiesDevice}
     * @memberof DeviceIntelligenceBreakdownProperties
     */
    'device'?: DeviceIntelligenceBreakdownPropertiesDevice;
    /**
     *
     * @type {DeviceIntelligenceBreakdownPropertiesIp}
     * @memberof DeviceIntelligenceBreakdownProperties
     */
    'ip'?: DeviceIntelligenceBreakdownPropertiesIp;
    /**
     *
     * @type {DeviceIntelligenceBreakdownPropertiesGeolocation}
     * @memberof DeviceIntelligenceBreakdownProperties
     */
    'geolocation'?: DeviceIntelligenceBreakdownPropertiesGeolocation;
}
/**
 *
 * @export
 * @interface DeviceIntelligenceBreakdownPropertiesDevice
 */
export interface DeviceIntelligenceBreakdownPropertiesDevice {
    /**
     * The SDK version that was used.
     * @type {string}
     * @memberof DeviceIntelligenceBreakdownPropertiesDevice
     */
    'sdk_version'?: string;
    /**
     * The SDK used to upload the media.
     * @type {string}
     * @memberof DeviceIntelligenceBreakdownPropertiesDevice
     */
    'sdk_source'?: DeviceIntelligenceBreakdownPropertiesDeviceSdkSourceEnum;
    /**
     * The token used to authenticate the request.
     * @type {string}
     * @memberof DeviceIntelligenceBreakdownPropertiesDevice
     */
    'authentication_type'?: DeviceIntelligenceBreakdownPropertiesDeviceAuthenticationTypeEnum;
    /**
     * 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.
     * @type {string}
     * @memberof DeviceIntelligenceBreakdownPropertiesDevice
     */
    '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).
     * @type {string}
     * @memberof DeviceIntelligenceBreakdownPropertiesDevice
     */
    'os'?: string;
    /**
     * The browser name reported by the browser\'s user agent.
     * @type {string}
     * @memberof DeviceIntelligenceBreakdownPropertiesDevice
     */
    'browser'?: string;
    /**
     * Whether the device is an emulator.
     * @type {boolean}
     * @memberof DeviceIntelligenceBreakdownPropertiesDevice
     */
    'emulator'?: boolean;
    /**
     * Whether the device is providing false randomized device and network information.
     * @type {boolean}
     * @memberof DeviceIntelligenceBreakdownPropertiesDevice
     */
    'randomized_device'?: boolean;
    /**
     * Whether device is using stolen security tokens to send the network information.
     * @type {boolean}
     * @memberof DeviceIntelligenceBreakdownPropertiesDevice
     */
    '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.
     * @type {string}
     * @memberof DeviceIntelligenceBreakdownPropertiesDevice
     */
    'ip_reputation'?: DeviceIntelligenceBreakdownPropertiesDeviceIpReputationEnum;
    /**
     * 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.
     * @type {number}
     * @memberof DeviceIntelligenceBreakdownPropertiesDevice
     */
    'device_fingerprint_reuse'?: number;
    /**
     * Whether the document or biometric media were uploaded from a single device.
     * @type {boolean}
     * @memberof DeviceIntelligenceBreakdownPropertiesDevice
     */
    'single_device_used'?: boolean | null;
    /**
     * Whether the document media were live captured from the device camera.
     * @type {string}
     * @memberof DeviceIntelligenceBreakdownPropertiesDevice
     */
    'document_capture'?: DeviceIntelligenceBreakdownPropertiesDeviceDocumentCaptureEnum;
    /**
     * Whether the biometric media were live captured from the device camera.
     * @type {string}
     * @memberof DeviceIntelligenceBreakdownPropertiesDevice
     */
    'biometric_capture'?: DeviceIntelligenceBreakdownPropertiesDeviceBiometricCaptureEnum;
}
export declare const DeviceIntelligenceBreakdownPropertiesDeviceSdkSourceEnum: {
    readonly AndroidSdk: "onfido-android-sdk";
    readonly IosSdk: "onfido-ios-sdk";
    readonly WebSdk: "onfido-web-sdk";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type DeviceIntelligenceBreakdownPropertiesDeviceSdkSourceEnum = typeof DeviceIntelligenceBreakdownPropertiesDeviceSdkSourceEnum[keyof typeof DeviceIntelligenceBreakdownPropertiesDeviceSdkSourceEnum];
export declare const DeviceIntelligenceBreakdownPropertiesDeviceAuthenticationTypeEnum: {
    readonly SdkToken: "sdk_token";
    readonly MobileToken: "mobile_token";
    readonly ApiToken: "api_token";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type DeviceIntelligenceBreakdownPropertiesDeviceAuthenticationTypeEnum = typeof DeviceIntelligenceBreakdownPropertiesDeviceAuthenticationTypeEnum[keyof typeof DeviceIntelligenceBreakdownPropertiesDeviceAuthenticationTypeEnum];
export declare const DeviceIntelligenceBreakdownPropertiesDeviceIpReputationEnum: {
    readonly NotEnoughData: "NOT_ENOUGH_DATA";
    readonly HighRisk: "HIGH_RISK";
    readonly LowRisk: "LOW_RISK";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type DeviceIntelligenceBreakdownPropertiesDeviceIpReputationEnum = typeof DeviceIntelligenceBreakdownPropertiesDeviceIpReputationEnum[keyof typeof DeviceIntelligenceBreakdownPropertiesDeviceIpReputationEnum];
export declare const DeviceIntelligenceBreakdownPropertiesDeviceDocumentCaptureEnum: {
    readonly Live: "live";
    readonly UnknownMethod: "unknown_method";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type DeviceIntelligenceBreakdownPropertiesDeviceDocumentCaptureEnum = typeof DeviceIntelligenceBreakdownPropertiesDeviceDocumentCaptureEnum[keyof typeof DeviceIntelligenceBreakdownPropertiesDeviceDocumentCaptureEnum];
export declare const DeviceIntelligenceBreakdownPropertiesDeviceBiometricCaptureEnum: {
    readonly Live: "live";
    readonly UnknownMethod: "unknown_method";
    readonly UnknownDefaultOpenApi: "11184809";
};
export type DeviceIntelligenceBreakdownPropertiesDeviceBiometricCaptureEnum = typeof DeviceIntelligenceBreakdownPropertiesDeviceBiometricCaptureEnum[keyof typeof DeviceIntelligenceBreakdownPropertiesDeviceBiometricCaptureEnum];
/**
 *
 * @export
 * @interface DeviceIntelligenceBreakdownPropertiesGeolocation
 */
export interface DeviceIntelligenceBreakdownPropertiesGeolocation {
    /**
     * City location of the IP address.
     * @type {string}
     * @memberof DeviceIntelligenceBreakdownPropertiesGeolocation
     */
    'city'?: string;
    /**
     * Region location of the IP address.
     * @type {string}
     * @memberof DeviceIntelligenceBreakdownPropertiesGeolocation
     */
    'region'?: string;
    /**
     * Country location of the IP address in a three letter format.
     * @type {CountryCodes}
     * @memberof DeviceIntelligenceBreakdownPropertiesGeolocation
     */
    'country'?: CountryCodes;
}
/**
 *
 * @export
 * @interface DeviceIntelligenceBreakdownPropertiesIp
 */
export interface DeviceIntelligenceBreakdownPropertiesIp {
    /**
     * The IP address that uploaded the media.
     * @type {string}
     * @memberof DeviceIntelligenceBreakdownPropertiesIp
     */
    'address'?: string;
}
/**
 *
 * @export
 * @interface DeviceIntelligenceProperties
 */
export interface DeviceIntelligenceProperties {
    /**
     *
     * @type {DeviceIntelligenceBreakdownPropertiesDevice}
     * @memberof DeviceIntelligenceProperties
     */
    'device'?: DeviceIntelligenceBreakdownPropertiesDevice;
    /**
     *
     * @type {DeviceIntelligenceBreakdownPropertiesIp}
     * @memberof DeviceIntelligenceProperties
     */
    'ip'?: DeviceIntelligenceBreakdownPropertiesIp;
    /**
     *
     * @type {DeviceIntelligenceBreakdownPropertiesGeolocation}
     * @memberof DeviceIntelligenceProperties
     */
    'geolocation'?: DeviceIntelligenceBreakdownPropertiesGeolocation;
}
/**
 *
 * @export
 * @interface DeviceIntelligenceReport
 */
export interface DeviceIntelligenceReport {
    /**
     * The unique identifier for the report. Read-only.
     * @type {string}
     * @memberof DeviceIntelligenceReport
     */
    'id': string;
    /**
     * The date and time at which the report was first initiated. Read-only.
     * @type {string}
     * @memberof DeviceIntelligenceReport
     */
    'created_at'?: string;
    /**
     * The API endpoint to retrieve the report. Read-only.
     * @type {string}
     * @memberof DeviceIntelligenceReport
     */
    'href'?: string;
    /**
     *
     * @type {ReportStatus}
     * @memberof DeviceIntelligenceReport
     */
    'status'?: ReportStatus;
    /**
     *
     * @type {ReportResult}
     * @memberof DeviceIntelligenceReport
     */
    'result'?: ReportResult;
    /**
     *
     * @type {ReportSubResult}
     * @memberof DeviceIntelligenceReport
     */
    'sub_result'?: ReportSubResult;
    /**
     * The ID of the check to which the report belongs. Read-only.
     * @type {string}
     * @memberof DeviceIntelligenceReport
     */
    'check_id'?: string;
    /**
     *
     * @type {ReportName}
     * @memberof DeviceIntelligenceReport
     */
    'name': ReportName;
    /**
     *
     * @type {DeviceIntelligenceBreakdown}
     * @memberof DeviceIntelligenceReport
     */
    'breakdown'?: DeviceIntelligenceBreakdown;
    /**
     *
     * @type {DeviceIntelligenceProperties}
     * @memberof DeviceIntelligenceReport
     */
    'properties'?: DeviceIntelligenceProperties;
}
/**
 *
 * @export
 * @interface Document
 */
export interface Document {
    /**
     * The file type of the uploaded file
     * @type {string}
     * @memberof Document
     */
    'file_type'?: string;
    /**
     * The type of document
     * @type {DocumentTypes}
     * @memberof Document
     */
    'type'?: DocumentTypes;
    /**
     * The side of the document, if applicable. The possible values are front and back
     * @type {string}
     * @memberof Document
     */
    'side'?: DocumentSideEnum;
    /**
     * The issuing country of the document, a 3-letter ISO code.
     * @type {CountryCodes}
     * @memberof Document
     */
    'issuing_country'?: CountryCodes;
    /**
     * The ID of the applicant whose document is being uploaded.
     * @type {string}
     * @memberof Document
     */
    'applicant_id'?: string;
    /**
     * The unique identifier for the document
     * @type {string}
     * @memberof Document
     */
    'id': string;
    /**
     * The date and time at which the document was uploaded
     * @type {string}
     * @memberof Document
     */
    'created_at'?: string;
    /**
     * The uri of this resource
     * @type {string}
     * @memberof Document
     */
    'href'?: string;
    /**
     * The uri that can be used to download the document
     * @type {string}
     * @memberof Document
     */
    'download_href'?: string;
    /**
     * The name of the uploaded file
     * @type {string}
     * @memberof Document
     */
    'file_name'?: string;
    /**
     * The size of the file in bytes
     * @type {number}
     * @memberof Document
     */
    '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
 */
export interface DocumentBreakdown {
    /**
     *
     * @type {DocumentBreakdownDataComparison}
     * @memberof DocumentBreakdown
     */
    'data_comparison'?: DocumentBreakdownDataComparison;
    /**
     *
     * @type {DocumentBreakdownDataValidation}
     * @memberof DocumentBreakdown
     */
    'data_validation'?: DocumentBreakdownDataValidation;
    /**
     *
     * @type {DocumentBreakdownImageIntegrity}
     * @memberof DocumentBreakdown
     */
    'image_integrity'?: DocumentBreakdownImageIntegrity;
    /**
     *
     * @type {DocumentBreakdownVisualAuthenticity}
     * @memberof DocumentBreakdown
     */
    'visual_authenticity'?: DocumentBreakdownVisualAuthenticity;
    /**
     *
     * @type {DocumentBreakdownDataConsistency}
     * @memberof DocumentBreakdown
     */
    'data_consistency'?: DocumentBreakdownDataConsistency;
    /**
     *
     * @type {DocumentBreakdownPoliceRecord}
     * @memberof DocumentBreakdown
     */
    'police_record'?: DocumentBreakdownPoliceRecord;
    /**
     *
     * @type {DocumentBreakdownCompromisedDocument}
     * @memberof DocumentBreakdown
     */
    'compromised_document'?: DocumentBreakdownCompromisedDocument;
    /**
     *
     * @type {DocumentBreakdownAgeValidation}
     * @memberof DocumentBreakdown
     */
    'age_validation'?: DocumentBreakdownAgeValidation;
    /**
     *
     * @type {DocumentBreakdownIssuingAuthority}
     * @memberof DocumentBreakdown
     */
    '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
 */
export interface DocumentBreakdownAgeValidation {
    /**
     *
     * @type {string}
     * @memberof DocumentBreakdownAgeValidation
     */
    'result'?: string;
    /**