@onfido/api
Version:
Node.js library for the Onfido API
1,259 lines • 322 kB
JavaScript
/* tslint:disable */
/* eslint-disable */
/**
* 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.
*/
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
import globalAxios from 'axios';
// URLSearchParams not necessarily used
// @ts-ignore
import { URL } from 'url';
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
// @ts-ignore
import { BASE_PATH, BaseAPI, operationServerMap } from './base';
import { FileTransfer } from './file-transfer';
import { AxiosHeaders } from 'axios';
globalAxios.interceptors.response.use((response) => __awaiter(void 0, void 0, void 0, function* () {
if (response.headers instanceof AxiosHeaders && response.headers['content-type']) {
if (!response.headers['content-type'].toString().includes('application/json')) {
const contentDisposition = response.headers['content-disposition'];
var filename = "";
if (contentDisposition && contentDisposition != "") {
const matcher = contentDisposition.match(/filename=['\"]?([^'\"\s]+)['\"]?/);
if (matcher != null) {
filename = matcher[1].replace(/.*[/\\\\]/g, "");
}
}
response.data = new FileTransfer(response.data, filename);
}
}
return response;
}));
/**
*
* @export
* @enum {string}
*/
export const ApplicantConsentName = {
PrivacyNoticesRead: 'privacy_notices_read',
SsnVerification: 'ssn_verification',
PhoneNumberVerification: 'phone_number_verification',
UnknownDefaultOpenApi: '11184809'
};
export const CheckResultEnum = {
Clear: 'clear',
Consider: 'consider',
UnknownDefaultOpenApi: '11184809'
};
export const CheckResponseResultEnum = {
Clear: 'clear',
Consider: 'consider',
UnknownDefaultOpenApi: '11184809'
};
/**
* The current state of the check in the checking process.
* @export
* @enum {string}
*/
export const CheckStatus = {
InProgress: 'in_progress',
AwaitingApplicant: 'awaiting_applicant',
Complete: 'complete',
Withdrawn: 'withdrawn',
Paused: 'paused',
Reopened: 'reopened',
UnknownDefaultOpenApi: '11184809'
};
/**
*
* @export
* @enum {string}
*/
export const CountryCodes = {
Abw: 'ABW',
Afg: 'AFG',
Ago: 'AGO',
Aia: 'AIA',
Ala: 'ALA',
Alb: 'ALB',
And: 'AND',
Are: 'ARE',
Arg: 'ARG',
Arm: 'ARM',
Asm: 'ASM',
Ata: 'ATA',
Atf: 'ATF',
Atg: 'ATG',
Aus: 'AUS',
Aut: 'AUT',
Aze: 'AZE',
Bdi: 'BDI',
Bel: 'BEL',
Ben: 'BEN',
Bes: 'BES',
Bfa: 'BFA',
Bgd: 'BGD',
Bgr: 'BGR',
Bhr: 'BHR',
Bhs: 'BHS',
Bih: 'BIH',
Blm: 'BLM',
Blr: 'BLR',
Blz: 'BLZ',
Bmu: 'BMU',
Bol: 'BOL',
Bra: 'BRA',
Brb: 'BRB',
Brn: 'BRN',
Btn: 'BTN',
Bvt: 'BVT',
Bwa: 'BWA',
Caf: 'CAF',
Can: 'CAN',
Cck: 'CCK',
Che: 'CHE',
Chl: 'CHL',
Chn: 'CHN',
Civ: 'CIV',
Cmr: 'CMR',
Cod: 'COD',
Cog: 'COG',
Cok: 'COK',
Col: 'COL',
Com: 'COM',
Cpv: 'CPV',
Cri: 'CRI',
Cub: 'CUB',
Cuw: 'CUW',
Cxr: 'CXR',
Cym: 'CYM',
Cyp: 'CYP',
Cze: 'CZE',
Deu: 'DEU',
Dji: 'DJI',
Dma: 'DMA',
Dnk: 'DNK',
Dom: 'DOM',
Dza: 'DZA',
Ecu: 'ECU',
Egy: 'EGY',
Eri: 'ERI',
Esh: 'ESH',
Esp: 'ESP',
Est: 'EST',
Eth: 'ETH',
Fin: 'FIN',
Fji: 'FJI',
Flk: 'FLK',
Fra: 'FRA',
Fro: 'FRO',
Fsm: 'FSM',
Gab: 'GAB',
Gbr: 'GBR',
Geo: 'GEO',
Ggy: 'GGY',
Gha: 'GHA',
Gib: 'GIB',
Gin: 'GIN',
Glp: 'GLP',
Gmb: 'GMB',
Gnb: 'GNB',
Gnq: 'GNQ',
Grc: 'GRC',
Grd: 'GRD',
Grl: 'GRL',
Gtm: 'GTM',
Guf: 'GUF',
Gum: 'GUM',
Guy: 'GUY',
Hkg: 'HKG',
Hmd: 'HMD',
Hnd: 'HND',
Hrv: 'HRV',
Hti: 'HTI',
Hun: 'HUN',
Idn: 'IDN',
Imn: 'IMN',
Ind: 'IND',
Iot: 'IOT',
Irl: 'IRL',
Irn: 'IRN',
Irq: 'IRQ',
Isl: 'ISL',
Isr: 'ISR',
Ita: 'ITA',
Jam: 'JAM',
Jey: 'JEY',
Jor: 'JOR',
Jpn: 'JPN',
Kaz: 'KAZ',
Ken: 'KEN',
Kgz: 'KGZ',
Khm: 'KHM',
Kir: 'KIR',
Kna: 'KNA',
Kor: 'KOR',
Kwt: 'KWT',
Lao: 'LAO',
Lbn: 'LBN',
Lbr: 'LBR',
Lby: 'LBY',
Lca: 'LCA',
Lie: 'LIE',
Lka: 'LKA',
Lso: 'LSO',
Ltu: 'LTU',
Lux: 'LUX',
Lva: 'LVA',
Mac: 'MAC',
Maf: 'MAF',
Mar: 'MAR',
Mco: 'MCO',
Mda: 'MDA',
Mdg: 'MDG',
Mdv: 'MDV',
Mex: 'MEX',
Mhl: 'MHL',
Mkd: 'MKD',
Mli: 'MLI',
Mlt: 'MLT',
Mmr: 'MMR',
Mne: 'MNE',
Mng: 'MNG',
Mnp: 'MNP',
Moz: 'MOZ',
Mrt: 'MRT',
Msr: 'MSR',
Mtq: 'MTQ',
Mus: 'MUS',
Mwi: 'MWI',
Mys: 'MYS',
Myt: 'MYT',
Nam: 'NAM',
Ncl: 'NCL',
Ner: 'NER',
Nfk: 'NFK',
Nga: 'NGA',
Nic: 'NIC',
Niu: 'NIU',
Nld: 'NLD',
Nor: 'NOR',
Npl: 'NPL',
Nru: 'NRU',
Nzl: 'NZL',
Omn: 'OMN',
Pak: 'PAK',
Pan: 'PAN',
Pcn: 'PCN',
Per: 'PER',
Phl: 'PHL',
Plw: 'PLW',
Png: 'PNG',
Pol: 'POL',
Pri: 'PRI',
Prk: 'PRK',
Prt: 'PRT',
Pry: 'PRY',
Pse: 'PSE',
Pyf: 'PYF',
Qat: 'QAT',
Reu: 'REU',
Rks: 'RKS',
Rou: 'ROU',
Rus: 'RUS',
Rwa: 'RWA',
Sau: 'SAU',
Sdn: 'SDN',
Sen: 'SEN',
Sgp: 'SGP',
Sgs: 'SGS',
Shn: 'SHN',
Sjm: 'SJM',
Slb: 'SLB',
Sle: 'SLE',
Slv: 'SLV',
Smr: 'SMR',
Som: 'SOM',
Spm: 'SPM',
Srb: 'SRB',
Ssd: 'SSD',
Stp: 'STP',
Sur: 'SUR',
Svk: 'SVK',
Svn: 'SVN',
Swe: 'SWE',
Swz: 'SWZ',
Sxm: 'SXM',
Syc: 'SYC',
Syr: 'SYR',
Tca: 'TCA',
Tcd: 'TCD',
Tgo: 'TGO',
Tha: 'THA',
Tjk: 'TJK',
Tkl: 'TKL',
Tkm: 'TKM',
Tls: 'TLS',
Ton: 'TON',
Tto: 'TTO',
Tun: 'TUN',
Tur: 'TUR',
Tuv: 'TUV',
Twn: 'TWN',
Tza: 'TZA',
Uga: 'UGA',
Ukr: 'UKR',
Umi: 'UMI',
Ury: 'URY',
Usa: 'USA',
Uzb: 'UZB',
Vat: 'VAT',
Vct: 'VCT',
Ven: 'VEN',
Vgb: 'VGB',
Vir: 'VIR',
Vnm: 'VNM',
Vut: 'VUT',
Wlf: 'WLF',
Wsm: 'WSM',
Yem: 'YEM',
Zaf: 'ZAF',
Zmb: 'ZMB',
Zwe: 'ZWE',
UnknownDefaultOpenApi: '11184809'
};
export const DeviceIntelligenceBreakdownPropertiesDeviceSdkSourceEnum = {
AndroidSdk: 'onfido-android-sdk',
IosSdk: 'onfido-ios-sdk',
WebSdk: 'onfido-web-sdk',
UnknownDefaultOpenApi: '11184809'
};
export const DeviceIntelligenceBreakdownPropertiesDeviceAuthenticationTypeEnum = {
SdkToken: 'sdk_token',
MobileToken: 'mobile_token',
ApiToken: 'api_token',
UnknownDefaultOpenApi: '11184809'
};
export const DeviceIntelligenceBreakdownPropertiesDeviceIpReputationEnum = {
NotEnoughData: 'NOT_ENOUGH_DATA',
HighRisk: 'HIGH_RISK',
LowRisk: 'LOW_RISK',
UnknownDefaultOpenApi: '11184809'
};
export const DeviceIntelligenceBreakdownPropertiesDeviceDocumentCaptureEnum = {
Live: 'live',
UnknownMethod: 'unknown_method',
UnknownDefaultOpenApi: '11184809'
};
export const DeviceIntelligenceBreakdownPropertiesDeviceBiometricCaptureEnum = {
Live: 'live',
UnknownMethod: 'unknown_method',
UnknownDefaultOpenApi: '11184809'
};
export const DocumentSideEnum = {
Front: 'front',
Back: 'back',
UnknownDefaultOpenApi: '11184809'
};
export const DocumentPropertiesNistIdentityEvidenceStrengthEnum = {
Superior: 'superior',
Strong: 'strong',
Fair: 'fair',
Weak: 'weak',
Unacceptable: 'unacceptable',
UnspecifiedIdentityEvidenceStrength: 'unspecified_identity_evidence_strength',
UnknownDefaultOpenApi: '11184809'
};
export const DocumentPropertiesHasIssuanceConfirmationEnum = {
True: 'true',
False: 'false',
Unspecified: 'unspecified',
UnknownDefaultOpenApi: '11184809'
};
export const DocumentPropertiesSecurityTierEnum = {
Tier1: 'tier_1',
Tier2: 'tier_2',
Tier3: 'tier_3',
Tier4: 'tier_4',
Tier5: 'tier_5',
UnspecifiedSecurityTier: 'unspecified_security_tier',
UnknownDefaultOpenApi: '11184809'
};
export const DocumentSharedSideEnum = {
Front: 'front',
Back: 'back',
UnknownDefaultOpenApi: '11184809'
};
/**
*
* @export
* @enum {string}
*/
export const DocumentTypes = {
Passport: 'passport',
DrivingLicence: 'driving_licence',
NationalIdentityCard: 'national_identity_card',
ResidencePermit: 'residence_permit',
PassportCard: 'passport_card',
TaxId: 'tax_id',
Visa: 'visa',
VoterId: 'voter_id',
ResidenceStatusDocument: 'residence_status_document',
PostalIdentityCard: 'postal_identity_card',
SocialSecurityCard: 'social_security_card',
WorkPermit: 'work_permit',
AsylumRegistrationCard: 'asylum_registration_card',
NationalHealthInsuranceCard: 'national_health_insurance_card',
MunicipalityIdentityCard: 'municipality_identity_card',
PrivateOperatorsCard: 'private_operators_card',
ProofOfCitizenship: 'proof_of_citizenship',
ServiceIdCard: 'service_id_card',
ImmigrationStatusDocument: 'immigration_status_document',
IndigenousCard: 'indigenous_card',
VehicleRegistrationCard: 'vehicle_registration_card',
CertificateOfNaturalisation: 'certificate_of_naturalisation',
ProfessionalQualificationCard: 'professional_qualification_card',
ConsularId: 'consular_id',
InternationalDrivingLicence: 'international_driving_licence',
HomeOfficeLetter: 'home_office_letter',
BirthCertificate: 'birth_certificate',
VehicleRegistrationCertificate: 'vehicle_registration_certificate',
FormForAffixingTheVisa: 'form_for_affixing_the_visa',
IdentificationNumberDocument: 'identification_number_document',
AdoptionCertificate: 'adoption_certificate',
BankBuildingSocietyStatement: 'bank_building_society_statement',
BankStatement: 'bank_statement',
BenefitLetters: 'benefit_letters',
Cbt: 'cbt',
CertificateOfSponsorship: 'certificate_of_sponsorship',
CharacterReference: 'character_reference',
CivilPartnershipCertificate: 'civil_partnership_certificate',
CouncilTax: 'council_tax',
CreditCardStatement: 'credit_card_statement',
DeedPoll: 'deed_poll',
DivorceAbsoluteDecree: 'divorce_absolute_decree',
EducationalStatement: 'educational_statement',
ElectricityBill: 'electricity_bill',
GasBill: 'gas_bill',
GovernmentLetter: 'government_letter',
InternetBill: 'internet_bill',
MarriageCertificate: 'marriage_certificate',
MotorcycleInsurance: 'motorcycle_insurance',
NationalInsuranceCard: 'national_insurance_card',
NaturalisationCertificate: 'naturalisation_certificate',
NonUkDrivingLicence: 'non_uk_driving_licence',
P45P60: 'p45_p60',
Payslip: 'payslip',
PhoneBill: 'phone_bill',
ProfessionalIdentificationCard: 'professional_identification_card',
RightToWorkShareCodeResult: 'right_to_work_share_code_result',
StatementFact: 'statement_fact',
T4StudentUniversityTermDatesEvidence: 't4_student_university_term_dates_evidence',
UkBiometricResidencePermit: 'uk_biometric_residence_permit',
UkDrivingLicence: 'uk_driving_licence',
Unknown: 'unknown',
UtilityBill: 'utility_bill',
UtilityBillElectric: 'utility_bill_electric',
UtilityBillGas: 'utility_bill_gas',
UtilityBillOther: 'utility_bill_other',
WaterBill: 'water_bill',
AddressCertificate: 'address_certificate',
GeneralLetter: 'general_letter',
InsuranceStatement: 'insurance_statement',
PensionPropertyStatementLetter: 'pension_property_statement_letter',
MortgageStatement: 'mortgage_statement',
MobilePhoneBill: 'mobile_phone_bill',
IdentityDocumentWithAddress: 'identity_document_with_address',
ExchangeHouseStatement: 'exchange_house_statement',
AccommodationTenancyCertificate: 'accommodation_tenancy_certificate',
UnknownDefaultOpenApi: '11184809'
};
export const DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum = {
Superior: 'superior',
Strong: 'strong',
Fair: 'fair',
Weak: 'weak',
Unacceptable: 'unacceptable',
UnspecifiedIdentityEvidenceStrength: 'unspecified_identity_evidence_strength',
UnknownDefaultOpenApi: '11184809'
};
export const DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum = {
True: 'true',
False: 'false',
Unspecified: 'unspecified',
UnknownDefaultOpenApi: '11184809'
};
export const DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum = {
Tier1: 'tier_1',
Tier2: 'tier_2',
Tier3: 'tier_3',
Tier4: 'tier_4',
Tier5: 'tier_5',
UnspecifiedSecurityTier: 'unspecified_security_tier',
UnknownDefaultOpenApi: '11184809'
};
export const ExtractionDocumentClassificationSubtypeEnum = {
Full: 'full',
NotFull: 'not_full',
Provisional: 'provisional',
UnknownDefaultOpenApi: '11184809'
};
export const ExtractionExtractedDataGenderEnum = {
Male: 'Male',
Female: 'Female',
UnknownDefaultOpenApi: '11184809'
};
export const IdNumberTypeEnum = {
Ssn: 'ssn',
SocialInsurance: 'social_insurance',
TaxId: 'tax_id',
IdentityCard: 'identity_card',
DrivingLicense: 'driving_license',
DrivingLicence: 'driving_licence',
ShareCode: 'share_code',
VoterId: 'voter_id',
Passport: 'passport',
Other: 'other',
UnknownDefaultOpenApi: '11184809'
};
export const ProofOfAddressPropertiesDocumentTypeEnum = {
BankBuildingSocietyStatement: 'bank_building_society_statement',
UtilityBill: 'utility_bill',
CouncilTax: 'council_tax',
BenefitLetters: 'benefit_letters',
MortgageStatement: 'mortgage_statement',
MobilePhoneBill: 'mobile_phone_bill',
GeneralLetter: 'general_letter',
InsuranceStatement: 'insurance_statement',
PensionPropertyStatementLetter: 'pension_property_statement_letter',
IdentityDocumentWithAddress: 'identity_document_with_address',
ExchangeHouseStatement: 'exchange_house_statement',
UnknownDefaultOpenApi: '11184809'
};
export const RepeatAttemptsListRepeatAttemptsInnerDateOfBirthEnum = {
Match: 'match',
Mismatch: 'mismatch',
UnknownDefaultOpenApi: '11184809'
};
export const RepeatAttemptsListRepeatAttemptsInnerNamesEnum = {
Match: 'match',
Mismatch: 'mismatch',
UnknownDefaultOpenApi: '11184809'
};
export const RepeatAttemptsListRepeatAttemptsInnerResultEnum = {
Clear: 'clear',
Consider: 'consider',
UnknownDefaultOpenApi: '11184809'
};
export const ReportConfigurationFacialSimilarityUseCaseEnum = {
Onboarding: 'onboarding',
Reverification: 'reverification',
UnknownDefaultOpenApi: '11184809'
};
/**
*
* @export
* @enum {string}
*/
export const ReportName = {
Document: 'document',
DocumentVideo: 'document_video',
DocumentVideoWithAddressInformation: 'document_video_with_address_information',
DocumentWithAddressInformation: 'document_with_address_information',
DocumentWithDrivingLicenceInformation: 'document_with_driving_licence_information',
DocumentWithDriverVerification: 'document_with_driver_verification',
FacialSimilarityPhoto: 'facial_similarity_photo',
FacialSimilarityPhotoFullyAuto: 'facial_similarity_photo_fully_auto',
FacialSimilarityVideo: 'facial_similarity_video',
FacialSimilarityMotion: 'facial_similarity_motion',
KnownFaces: 'known_faces',
IdentityEnhanced: 'identity_enhanced',
WatchlistAml: 'watchlist_aml',
WatchlistEnhanced: 'watchlist_enhanced',
WatchlistStandard: 'watchlist_standard',
WatchlistPepsOnly: 'watchlist_peps_only',
WatchlistSanctionsOnly: 'watchlist_sanctions_only',
ProofOfAddress: 'proof_of_address',
UsDrivingLicence: 'us_driving_licence',
DeviceIntelligence: 'device_intelligence',
IndiaPan: 'india_pan',
UnknownDefaultOpenApi: '11184809'
};
/**
* The result of the report. Read-only.
* @export
* @enum {string}
*/
export const ReportResult = {
Clear: 'clear',
Consider: 'consider',
Unidentified: 'unidentified',
UnknownDefaultOpenApi: '11184809'
};
/**
* The current state of the report in the checking process. Read-only.
* @export
* @enum {string}
*/
export const ReportStatus = {
AwaitingData: 'awaiting_data',
AwaitingApproval: 'awaiting_approval',
Cancelled: 'cancelled',
Complete: 'complete',
Withdrawn: 'withdrawn',
UnknownDefaultOpenApi: '11184809'
};
/**
* The sub_result of the report. It gives a more detailed result for document reports only, and will be null otherwise. Read-only.
* @export
* @enum {string}
*/
export const ReportSubResult = {
Clear: 'clear',
Rejected: 'rejected',
Suspected: 'suspected',
Caution: 'caution',
UnknownDefaultOpenApi: '11184809'
};
export const ResultsFeedbackExpectedResultEnum = {
Clear: 'clear',
Consider: 'consider',
UnknownDefaultOpenApi: '11184809'
};
export const UsDrivingLicenceBuilderDocumentCategoryEnum = {
DriverLicense: 'driver license',
DriverPermit: 'driver permit',
IdCard: 'id card',
UnknownDefaultOpenApi: '11184809'
};
export const UsDrivingLicenceBuilderEyeColorCodeEnum = {
Blk: 'BLK',
Blu: 'BLU',
Bro: 'BRO',
Dic: 'DIC',
Gry: 'GRY',
Grn: 'GRN',
Haz: 'HAZ',
Mar: 'MAR',
Pnk: 'PNK',
UnknownDefaultOpenApi: '11184809'
};
export const UsDrivingLicenceBuilderGenderEnum = {
Male: 'Male',
Female: 'Female',
UnknownDefaultOpenApi: '11184809'
};
export const UsDrivingLicenceSharedDocumentCategoryEnum = {
DriverLicense: 'driver license',
DriverPermit: 'driver permit',
IdCard: 'id card',
UnknownDefaultOpenApi: '11184809'
};
export const UsDrivingLicenceSharedEyeColorCodeEnum = {
Blk: 'BLK',
Blu: 'BLU',
Bro: 'BRO',
Dic: 'DIC',
Gry: 'GRY',
Grn: 'GRN',
Haz: 'HAZ',
Mar: 'MAR',
Pnk: 'PNK',
UnknownDefaultOpenApi: '11184809'
};
export const UsDrivingLicenceSharedGenderEnum = {
Male: 'Male',
Female: 'Female',
UnknownDefaultOpenApi: '11184809'
};
export const WatchlistMonitorReportNameEnum = {
Standard: 'watchlist_standard',
Aml: 'watchlist_aml',
UnknownDefaultOpenApi: '11184809'
};
export const WatchlistMonitorBuilderReportNameEnum = {
Standard: 'watchlist_standard',
Aml: 'watchlist_aml',
UnknownDefaultOpenApi: '11184809'
};
export const WatchlistMonitorSharedReportNameEnum = {
Standard: 'watchlist_standard',
Aml: 'watchlist_aml',
UnknownDefaultOpenApi: '11184809'
};
/**
* The current state of the object, if available.
* @export
* @enum {string}
*/
export const WebhookEventObjectStatus = {
Processing: 'processing',
AwaitingInput: 'awaiting_input',
AwaitingClientInput: 'awaiting_client_input',
Approved: 'approved',
Declined: 'declined',
Review: 'review',
Abandoned: 'abandoned',
Error: 'error',
Started: 'started',
Cancelled: 'cancelled',
Completed: 'completed',
AwaitingData: 'awaiting_data',
AwaitingApproval: 'awaiting_approval',
Complete: 'complete',
Withdrawn: 'withdrawn',
InProgress: 'in_progress',
AwaitingApplicant: 'awaiting_applicant',
Paused: 'paused',
Reopened: 'reopened',
UnknownDefaultOpenApi: '11184809'
};
/**
*
* @export
* @enum {string}
*/
export const WebhookEventResourceType = {
Check: 'check',
Report: 'report',
AuditLog: 'audit_log',
WorkflowRun: 'workflow_run',
WorkflowTask: 'workflow_task',
WatchlistMonitor: 'watchlist_monitor',
WorkflowTimelineFile: 'workflow_timeline_file',
WorkflowRunEvidenceFolder: 'workflow_run_evidence_folder',
UnknownDefaultOpenApi: '11184809'
};
/**
*
* @export
* @enum {string}
*/
export const WebhookEventType = {
AuditLogCreated: 'audit_log.created',
WatchlistMonitorMatchesUpdated: 'watchlist_monitor.matches_updated',
WorkflowRunCompleted: 'workflow_run.completed',
WorkflowTaskStarted: 'workflow_task.started',
WorkflowTaskCompleted: 'workflow_task.completed',
CheckStarted: 'check.started',
CheckReopened: 'check.reopened',
CheckWithdrawn: 'check.withdrawn',
CheckCompleted: 'check.completed',
CheckFormCompleted: 'check.form_completed',
ReportWithdrawn: 'report.withdrawn',
ReportResumed: 'report.resumed',
ReportCancelled: 'report.cancelled',
ReportAwaitingApproval: 'report.awaiting_approval',
ReportCompleted: 'report.completed',
WorkflowTimelineFileCreated: 'workflow_timeline_file.created',
WorkflowRunEvidenceFolderCreated: 'workflow_run_evidence_folder.created',
UnknownDefaultOpenApi: '11184809'
};
export const WorkflowRunLinkLanguageEnum = {
EnUs: 'en_US',
DeDe: 'de_DE',
EsEs: 'es_ES',
FrFr: 'fr_FR',
ItIt: 'it_IT',
PtPt: 'pt_PT',
NlNl: 'nl_NL',
UnknownDefaultOpenApi: '11184809'
};
/**
*
* @export
* @enum {string}
*/
export const WorkflowRunStatus = {
Processing: 'processing',
AwaitingInput: 'awaiting_input',
AwaitingClientInput: 'awaiting_client_input',
Approved: 'approved',
Declined: 'declined',
Review: 'review',
Abandoned: 'abandoned',
Error: 'error',
UnknownDefaultOpenApi: '11184809'
};
/**
* DefaultApi - axios parameter creator
* @export
*/
export const DefaultApiAxiosParamCreator = function (configuration) {
return {
/**
* Cancels single paused reports.
* @summary Cancel report
* @param {string} reportId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
cancelReport: (reportId, options = {}) => __awaiter(this, void 0, void 0, function* () {
// verify required parameter 'reportId' is not null or undefined
assertParamExists('cancelReport', 'reportId', reportId);
const localVarPath = `/reports/{report_id}/cancel`
.replace(`{${"report_id"}}`, encodeURIComponent(String(reportId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication Token required
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
* 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, taskId, completeTaskBuilder, options = {}) => __awaiter(this, void 0, void 0, function* () {
// verify required parameter 'workflowRunId' is not null or undefined
assertParamExists('completeTask', 'workflowRunId', workflowRunId);
// verify required parameter 'taskId' is not null or undefined
assertParamExists('completeTask', 'taskId', taskId);
// verify required parameter 'completeTaskBuilder' is not null or undefined
assertParamExists('completeTask', 'completeTaskBuilder', completeTaskBuilder);
const localVarPath = `/workflow_runs/{workflow_run_id}/tasks/{task_id}/complete`
.replace(`{${"workflow_run_id"}}`, encodeURIComponent(String(workflowRunId)))
.replace(`{${"task_id"}}`, encodeURIComponent(String(taskId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication Token required
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = serializeDataIfNeeded(completeTaskBuilder, localVarRequestOptions, configuration);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
* Creates a single applicant. Returns an applicant object.
* @summary Create Applicant
* @param {ApplicantBuilder} applicantBuilder
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createApplicant: (applicantBuilder, options = {}) => __awaiter(this, void 0, void 0, function* () {
// verify required parameter 'applicantBuilder' is not null or undefined
assertParamExists('createApplicant', 'applicantBuilder', applicantBuilder);
const localVarPath = `/applicants`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication Token required
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = serializeDataIfNeeded(applicantBuilder, localVarRequestOptions, configuration);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
* 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, options = {}) => __awaiter(this, void 0, void 0, function* () {
// verify required parameter 'checkBuilder' is not null or undefined
assertParamExists('createCheck', 'checkBuilder', checkBuilder);
const localVarPath = `/checks`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication Token required
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = serializeDataIfNeeded(checkBuilder, localVarRequestOptions, configuration);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
* 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, options = {}) => __awaiter(this, void 0, void 0, function* () {
// verify required parameter 'workflowRunId' is not null or undefined
assertParamExists('createTimelineFile', 'workflowRunId', workflowRunId);
const localVarPath = `/workflow_runs/{workflow_run_id}/timeline_file`
.replace(`{${"workflow_run_id"}}`, encodeURIComponent(String(workflowRunId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication Token required
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
* Creates a new monitor for the applicant
* @summary Create monitor
* @param {WatchlistMonitorBuilder} watchlistMonitorBuilder
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createWatchlistMonitor: (watchlistMonitorBuilder, options = {}) => __awaiter(this, void 0, void 0, function* () {
// verify required parameter 'watchlistMonitorBuilder' is not null or undefined
assertParamExists('createWatchlistMonitor', 'watchlistMonitorBuilder', watchlistMonitorBuilder);
const localVarPath = `/watchlist_monitors`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication Token required
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = serializeDataIfNeeded(watchlistMonitorBuilder, localVarRequestOptions, configuration);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
* Registers a webhook. Returns a webhook object.
* @summary Register webhook
* @param {WebhookBuilder} webhookBuilder
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createWebhook: (webhookBuilder, options = {}) => __awaiter(this, void 0, void 0, function* () {
// verify required parameter 'webhookBuilder' is not null or undefined
assertParamExists('createWebhook', 'webhookBuilder', webhookBuilder);
const localVarPath = `/webhooks`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication Token required
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = serializeDataIfNeeded(webhookBuilder, localVarRequestOptions, configuration);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
* 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, options = {}) => __awaiter(this, void 0, void 0, function* () {
// verify required parameter 'workflowRunBuilder' is not null or undefined
assertParamExists('createWorkflowRun', 'workflowRunBuilder', workflowRunBuilder);
const localVarPath = `/workflow_runs`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication Token required
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = serializeDataIfNeeded(workflowRunBuilder, localVarRequestOptions, configuration);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
* Deletes a single applicant.
* @summary Delete Applicant
* @param {string} applicantId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteApplicant: (applicantId, options = {}) => __awaiter(this, void 0, void 0, function* () {
// verify required parameter 'applicantId' is not null or undefined
assertParamExists('deleteApplicant', 'applicantId', applicantId);
const localVarPath = `/applicants/{applicant_id}`
.replace(`{${"applicant_id"}}`, encodeURIComponent(String(applicantId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication Token required
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
* Deactivates the given monitor
* @summary Delete monitor
* @param {string} monitorId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteWatchlistMonitor: (monitorId, options = {}) => __awaiter(this, void 0, void 0, function* () {
// verify required parameter 'monitorId' is not null or undefined
assertParamExists('deleteWatchlistMonitor', 'monitorId', monitorId);
const localVarPath = `/watchlist_monitors/{monitor_id}`
.replace(`{${"monitor_id"}}`, encodeURIComponent(String(monitorId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication Token required
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
* Deletes a webhook.
* @summary Delete a webhook
* @param {string} webhookId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteWebhook: (webhookId, options = {}) => __awaiter(this, void 0, void 0, function* () {
// verify required parameter 'webhookId' is not null or undefined
assertParamExists('deleteWebhook', 'webhookId', webhookId);
const localVarPath = `/webhooks/{webhook_id}`
.replace(`{${"webhook_id"}}`, encodeURIComponent(String(webhookId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication Token required
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
* 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, id, options = {}) => __awaiter(this, void 0, void 0, function* () {
// verify required parameter 'workflowRunId' is not null or undefined
assertParamExists('downloadAesDocument', 'workflowRunId', workflowRunId);
// verify required parameter 'id' is not null or undefined
assertParamExists('downloadAesDocument', 'id', id);
const localVarPath = `/advanced_electronic_signature/documents`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication Token required
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
if (workflowRunId !== undefined) {
localVarQueryParameter['workflow_run_id'] = workflowRunId;
}
if (id !== undefined) {
localVarQueryParameter['id'] = id;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
* 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, options = {}) => __awaiter(this, void 0, void 0, function* () {
// verify required parameter 'checkId' is not null or undefined
assertParamExists('downloadCheck', 'checkId', checkId);
const localVarPath = `/checks/{check_id}/download`
.replace(`{${"check_id"}}`, encodeURIComponent(String(checkId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication Token required
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
* 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, options = {}) => __awaiter(this, void 0, void 0, function* () {
// verify required parameter 'documentId' is not null or undefined
assertParamExists('downloadDocument', 'documentId', documentId);
const localVarPath = `/documents/{document_id}/download`
.replace(`{${"document_id"}}`, encodeURIComponent(String(documentId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication Token required
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
* Downloads a document video. If successful, the