Module: Onfido

Defined in:

lib/onfido/version.rb,
lib/onfido.rb,
lib/onfido/api_error.rb,
lib/onfido/api_client.rb,
lib/onfido/models/task.rb,
lib/onfido/models/check.rb,
lib/onfido/models/error.rb,
lib/onfido/configuration.rb,
lib/onfido/models/error1.rb,
lib/onfido/models/report.rb,
lib/onfido/models/address.rb,
lib/onfido/models/webhook.rb,
lib/onfido/api/default_api.rb,
lib/onfido/models/document.rb,
lib/onfido/models/id_photo.rb,
lib/onfido/models/location.rb,
lib/onfido/models/applicant.rb,
lib/onfido/models/id_number.rb,
lib/onfido/models/sdk_token.rb,
lib/onfido/models/task_item.rb,
lib/onfido/models/extraction.rb,
lib/onfido/models/live_photo.rb,
lib/onfido/models/live_video.rb,
lib/onfido/models/checks_list.rb,
lib/onfido/models/report_name.rb,
lib/onfido/models/check_shared.rb,
lib/onfido/models/check_status.rb,
lib/onfido/models/reports_list.rb,
lib/onfido/models/workflow_run.rb,
lib/onfido/models/check_builder.rb,
lib/onfido/models/check_request.rb,
lib/onfido/models/country_codes.rb,
lib/onfido/models/photo_reasons.rb,
lib/onfido/models/report_result.rb,
lib/onfido/models/report_shared.rb,
lib/onfido/models/report_status.rb,
lib/onfido/models/video_reasons.rb,
lib/onfido/models/webhook_event.rb,
lib/onfido/models/webhooks_list.rb,
lib/onfido/models/address_shared.rb,
lib/onfido/models/addresses_list.rb,
lib/onfido/models/check_response.rb,
lib/onfido/models/document_types.rb,
lib/onfido/models/documents_list.rb,
lib/onfido/models/id_photos_list.rb,
lib/onfido/models/motion_capture.rb,
lib/onfido/models/webhook_create.rb,
lib/onfido/models/webhook_resend.rb,
lib/onfido/models/webhook_shared.rb,
lib/onfido/models/webhook_update.rb,
lib/onfido/models/address_builder.rb,
lib/onfido/models/applicants_list.rb,
lib/onfido/models/document_report.rb,
lib/onfido/models/document_shared.rb,
lib/onfido/models/extract_request.rb,
lib/onfido/models/location_shared.rb,
lib/onfido/models/report_document.rb,
lib/onfido/models/webhook_builder.rb,
lib/onfido/models/webhook_updater.rb,
lib/onfido/webhook_event_verifier.rb,
lib/onfido/models/applicant_create.rb,
lib/onfido/models/applicant_shared.rb,
lib/onfido/models/applicant_update.rb,
lib/onfido/models/error_properties.rb,
lib/onfido/models/india_pan_report.rb,
lib/onfido/models/live_photos_list.rb,
lib/onfido/models/live_videos_list.rb,
lib/onfido/models/location_builder.rb,
lib/onfido/models/results_feedback.rb,
lib/onfido/models/webhook_response.rb,
lib/onfido/models/applicant_builder.rb,
lib/onfido/models/applicant_request.rb,
lib/onfido/models/applicant_updater.rb,
lib/onfido/models/document_response.rb,
lib/onfido/models/error_properties1.rb,
lib/onfido/models/id_photo_response.rb,
lib/onfido/models/report_sub_result.rb,
lib/onfido/models/sdk_token_builder.rb,
lib/onfido/models/sdk_token_request.rb,
lib/onfido/models/watchlist_monitor.rb,
lib/onfido/models/workflow_run_link.rb,
lib/onfido/models/applicant_response.rb,
lib/onfido/models/document_breakdown.rb,
lib/onfido/models/known_faces_report.rb,
lib/onfido/models/photo_auto_reasons.rb,
lib/onfido/models/sdk_token_response.rb,
lib/onfido/models/webhook_event_type.rb,
lib/onfido/models/workflow_run_error.rb,
lib/onfido/models/document_iq_reasons.rb,
lib/onfido/models/document_properties.rb,
lib/onfido/models/live_photo_response.rb,
lib/onfido/models/workflow_run_shared.rb,
lib/onfido/models/workflow_run_status.rb,
lib/onfido/models/document_cdq_reasons.rb,
lib/onfido/models/document_odp_reasons.rb,
lib/onfido/models/motion_captures_list.rb,
lib/onfido/models/repeat_attempts_list.rb,
lib/onfido/models/watchlist_aml_report.rb,
lib/onfido/models/webhooks_resend_item.rb,
lib/onfido/models/workflow_run_builder.rb,
lib/onfido/models/workflow_run_request.rb,
lib/onfido/models/complete_task_builder.rb,
lib/onfido/models/document_video_report.rb,
lib/onfido/models/known_faces_breakdown.rb,
lib/onfido/models/webhook_event_payload.rb,
lib/onfido/models/workflow_run_response.rb,
lib/onfido/models/applicant_consent_name.rb,
lib/onfido/models/known_faces_properties.rb,
lib/onfido/models/document_properties_nfc.rb,
lib/onfido/models/proof_of_address_report.rb,
lib/onfido/models/timeline_file_reference.rb,
lib/onfido/models/watchlist_aml_breakdown.rb,
lib/onfido/models/watchlist_monitor_match.rb,
lib/onfido/models/watchlist_monitors_list.rb,
lib/onfido/models/identity_enhanced_report.rb,
lib/onfido/models/watchlist_aml_properties.rb,
lib/onfido/models/watchlist_monitor_shared.rb,
lib/onfido/models/applicant_consent_builder.rb,
lib/onfido/models/extraction_extracted_data.rb,
lib/onfido/models/us_driving_licence_report.rb,
lib/onfido/models/us_driving_licence_shared.rb,
lib/onfido/models/watchlist_enhanced_report.rb,
lib/onfido/models/watchlist_monitor_builder.rb,
lib/onfido/models/watchlist_standard_report.rb,
lib/onfido/models/complete_task_data_builder.rb,
lib/onfido/models/device_intelligence_report.rb,
lib/onfido/models/proof_of_address_breakdown.rb,
lib/onfido/models/us_driving_licence_builder.rb,
lib/onfido/models/watchlist_monitor_response.rb,
lib/onfido/models/watchlist_peps_only_report.rb,
lib/onfido/models/document_properties_barcode.rb,
lib/onfido/models/identity_enhanced_breakdown.rb,
lib/onfido/models/proof_of_address_properties.rb,
lib/onfido/models/webhook_event_object_status.rb,
lib/onfido/models/webhook_event_resource_type.rb,
lib/onfido/models/identity_enhanced_properties.rb,
lib/onfido/models/us_driving_licence_breakdown.rb,
lib/onfido/models/watchlist_enhanced_breakdown.rb,
lib/onfido/models/watchlist_standard_breakdown.rb,
lib/onfido/models/webhook_event_payload_object.rb,
lib/onfido/models/device_intelligence_breakdown.rb,
lib/onfido/models/watchlist_enhanced_properties.rb,
lib/onfido/models/watchlist_standard_properties.rb,
lib/onfido/models/facial_similarity_photo_report.rb,
lib/onfido/models/facial_similarity_report_media.rb,
lib/onfido/models/facial_similarity_video_report.rb,
lib/onfido/models/watchlist_monitor_matches_list.rb,
lib/onfido/models/webhook_event_payload_resource.rb,
lib/onfido/models/facial_similarity_motion_report.rb,
lib/onfido/models/facial_similarity_report_shared.rb,
lib/onfido/models/watchlist_sanctions_only_report.rb,
lib/onfido/models/document_breakdown_police_record.rb,
lib/onfido/models/watchlist_aml_breakdown_sanction.rb,
lib/onfido/models/document_breakdown_age_validation.rb,
lib/onfido/models/document_properties_address_lines.rb,
lib/onfido/models/facial_similarity_photo_breakdown.rb,
lib/onfido/models/facial_similarity_video_breakdown.rb,
lib/onfido/models/india_pan_report_all_of_breakdown.rb,
lib/onfido/models/watchlist_monitor_matches_updater.rb,
lib/onfido/models/document_breakdown_data_comparison.rb,
lib/onfido/models/document_breakdown_data_validation.rb,
lib/onfido/models/document_breakdown_image_integrity.rb,
lib/onfido/models/document_properties_extracted_data.rb,
lib/onfido/models/extraction_document_classification.rb,
lib/onfido/models/facial_similarity_motion_breakdown.rb,
lib/onfido/models/facial_similarity_photo_properties.rb,
lib/onfido/models/facial_similarity_video_properties.rb,
lib/onfido/models/india_pan_report_all_of_properties.rb,
lib/onfido/models/document_breakdown_data_consistency.rb,
lib/onfido/models/facial_similarity_motion_properties.rb,
lib/onfido/models/identity_enhanced_breakdown_address.rb,
lib/onfido/models/identity_enhanced_breakdown_sources.rb,
lib/onfido/models/document_breakdown_issuing_authority.rb,
lib/onfido/models/known_faces_properties_matches_inner.rb,
lib/onfido/models/us_driving_licence_breakdown_address.rb,
lib/onfido/models/identity_enhanced_breakdown_mortality.rb,
lib/onfido/models/known_faces_breakdown_image_integrity.rb,
lib/onfido/models/us_driving_licence_breakdown_document.rb,
lib/onfido/models/us_driving_licence_breakdown_personal.rb,
lib/onfido/models/watchlist_aml_breakdown_adverse_media.rb,
lib/onfido/models/document_breakdown_visual_authenticity.rb,
lib/onfido/models/device_intelligence_breakdown_breakdown.rb,
lib/onfido/models/document_breakdown_compromised_document.rb,
lib/onfido/models/device_intelligence_breakdown_properties.rb,
lib/onfido/models/document_with_address_information_report.rb,
lib/onfido/models/document_with_driver_verification_report.rb,
lib/onfido/models/india_pan_report_all_of_breakdown_device.rb,
lib/onfido/models/facial_similarity_photo_fully_auto_report.rb,
lib/onfido/models/identity_enhanced_breakdown_date_of_birth.rb,
lib/onfido/models/india_pan_report_all_of_properties_device.rb,
lib/onfido/models/document_properties_document_numbers_inner.rb,
lib/onfido/models/proof_of_address_breakdown_data_comparison.rb,
lib/onfido/models/proof_of_address_breakdown_image_integrity.rb,
lib/onfido/models/repeat_attempts_list_repeat_attempts_inner.rb,
lib/onfido/models/device_intelligence_breakdown_properties_ip.rb,
lib/onfido/models/document_breakdown_age_validation_breakdown.rb,
lib/onfido/models/document_properties_document_classification.rb,
lib/onfido/models/known_faces_breakdown_previously_seen_faces.rb,
lib/onfido/models/watchlist_enhanced_properties_records_inner.rb,
lib/onfido/models/document_breakdown_data_comparison_breakdown.rb,
lib/onfido/models/document_breakdown_data_validation_breakdown.rb,
lib/onfido/models/document_breakdown_image_integrity_breakdown.rb,
lib/onfido/models/facial_similarity_photo_fully_auto_breakdown.rb,
lib/onfido/models/document_breakdown_data_consistency_breakdown.rb,
lib/onfido/models/facial_similarity_photo_fully_auto_properties.rb,
lib/onfido/models/identity_enhanced_breakdown_address_breakdown.rb,
lib/onfido/models/identity_enhanced_breakdown_sources_breakdown.rb,
lib/onfido/models/device_intelligence_breakdown_breakdown_device.rb,
lib/onfido/models/document_breakdown_issuing_authority_breakdown.rb,
lib/onfido/models/document_video_with_address_information_report.rb,
lib/onfido/models/us_driving_licence_breakdown_address_breakdown.rb,
lib/onfido/models/device_intelligence_breakdown_properties_device.rb,
lib/onfido/models/document_properties_driving_licence_information.rb,
lib/onfido/models/us_driving_licence_breakdown_document_breakdown.rb,
lib/onfido/models/us_driving_licence_breakdown_personal_breakdown.rb,
lib/onfido/models/document_breakdown_visual_authenticity_breakdown.rb,
lib/onfido/models/document_with_driving_licence_information_report.rb,
lib/onfido/models/document_breakdown_compromised_document_breakdown.rb,
lib/onfido/models/facial_similarity_photo_breakdown_face_comparison.rb,
lib/onfido/models/facial_similarity_photo_breakdown_image_integrity.rb,
lib/onfido/models/facial_similarity_video_breakdown_face_comparison.rb,
lib/onfido/models/facial_similarity_video_breakdown_image_integrity.rb,
lib/onfido/models/facial_similarity_motion_breakdown_face_comparison.rb,
lib/onfido/models/facial_similarity_motion_breakdown_image_integrity.rb,
lib/onfido/models/india_pan_report_all_of_breakdown_device_breakdown.rb,
lib/onfido/models/proof_of_address_breakdown_document_classification.rb,
lib/onfido/models/watchlist_aml_breakdown_politically_exposed_person.rb,
lib/onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown.rb,
lib/onfido/models/device_intelligence_breakdown_properties_geolocation.rb,
lib/onfido/models/identity_enhanced_properties_matched_addresses_inner.rb,
lib/onfido/models/proof_of_address_breakdown_data_comparison_breakdown.rb,
lib/onfido/models/proof_of_address_breakdown_image_integrity_breakdown.rb,
lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity.rb,
lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity.rb,
lib/onfido/models/watchlist_aml_breakdown_legal_and_regulatory_warnings.rb,
lib/onfido/models/document_breakdown_visual_authenticity_breakdown_fonts.rb,
lib/onfido/models/document_breakdown_visual_authenticity_breakdown_other.rb,
lib/onfido/models/facial_similarity_motion_breakdown_visual_authenticity.rb,
lib/onfido/models/watchlist_enhanced_properties_records_inner_alias_inner.rb,
lib/onfido/models/watchlist_enhanced_properties_records_inner_event_inner.rb,
lib/onfido/models/device_intelligence_breakdown_breakdown_device_breakdown.rb,
lib/onfido/models/document_breakdown_data_validation_breakdown_expiry_date.rb,
lib/onfido/models/watchlist_enhanced_properties_records_inner_source_inner.rb,
lib/onfido/models/document_breakdown_visual_authenticity_breakdown_template.rb,
lib/onfido/models/watchlist_enhanced_properties_records_inner_address_inner.rb,
lib/onfido/models/document_breakdown_image_integrity_breakdown_image_quality.rb,
lib/onfido/models/document_with_driver_verification_report_all_of_properties.rb,
lib/onfido/models/document_breakdown_image_integrity_breakdown_colour_picture.rb,
lib/onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown.rb,
lib/onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown.rb,
lib/onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown.rb,
lib/onfido/models/identity_enhanced_breakdown_sources_breakdown_total_sources.rb,
lib/onfido/models/watchlist_enhanced_properties_records_inner_associate_inner.rb,
lib/onfido/models/watchlist_enhanced_properties_records_inner_attribute_inner.rb,
lib/onfido/models/document_breakdown_data_comparison_breakdown_issuing_country.rb,
lib/onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown.rb,
lib/onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity.rb,
lib/onfido/models/india_pan_report_all_of_breakdown_device_breakdown_pan_valid.rb,
lib/onfido/models/proof_of_address_breakdown_document_classification_breakdown.rb,
lib/onfido/models/identity_enhanced_breakdown_address_breakdown_credit_agencies.rb,
lib/onfido/models/identity_enhanced_breakdown_address_breakdown_voting_register.rb,
lib/onfido/models/watchlist_enhanced_properties_records_inner_event_inner_source.rb,
lib/onfido/models/document_breakdown_image_integrity_breakdown_supported_document.rb,
lib/onfido/models/document_breakdown_visual_authenticity_breakdown_face_detection.rb,
lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown.rb,
lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown.rb,
lib/onfido/models/document_breakdown_data_validation_breakdown_document_expiration.rb,
lib/onfido/models/facial_similarity_motion_breakdown_visual_authenticity_breakdown.rb,
lib/onfido/models/identity_enhanced_breakdown_address_breakdown_telephone_database.rb,
lib/onfido/models/document_breakdown_visual_authenticity_breakdown_digital_tampering.rb,
lib/onfido/models/document_breakdown_visual_authenticity_breakdown_security_features.rb,
lib/onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown_credit_agencies.rb,
lib/onfido/models/identity_enhanced_breakdown_date_of_birth_breakdown_voting_register.rb,
lib/onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown_face_match.rb,
lib/onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity_breakdown.rb,
lib/onfido/models/identity_enhanced_breakdown_sources_breakdown_total_sources_properties.rb,
lib/onfido/models/document_breakdown_visual_authenticity_breakdown_picture_face_integrity.rb,
lib/onfido/models/document_breakdown_image_integrity_breakdown_conclusive_document_quality.rb,
lib/onfido/models/document_breakdown_issuing_authority_breakdown_nfc_active_authentication.rb,
lib/onfido/models/identity_enhanced_breakdown_address_breakdown_credit_agencies_properties.rb,
lib/onfido/models/document_breakdown_issuing_authority_breakdown_nfc_passive_authentication.rb,
lib/onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown_face_detected.rb,
lib/onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown_face_detected.rb,
lib/onfido/models/document_breakdown_visual_authenticity_breakdown_original_document_present.rb,
lib/onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown_face_detected.rb,
lib/onfido/models/facial_similarity_photo_breakdown_image_integrity_breakdown_source_integrity.rb,
lib/onfido/models/facial_similarity_video_breakdown_image_integrity_breakdown_source_integrity.rb,
lib/onfido/models/facial_similarity_motion_breakdown_image_integrity_breakdown_source_integrity.rb,
lib/onfido/models/facial_similarity_photo_breakdown_face_comparison_breakdown_face_match_properties.rb,
lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown_liveness_detected.rb,
lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown_spoofing_detection.rb,
lib/onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown_spoofing_detection.rb,
lib/onfido/models/document_with_driver_verification_report_all_of_properties_all_of_passenger_vehicle.rb,
lib/onfido/models/facial_similarity_motion_breakdown_visual_authenticity_breakdown_spoofing_detection.rb,
lib/onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity_breakdown_source_integrity.rb,
lib/onfido/models/document_with_driver_verification_report_all_of_properties_all_of_vehicle_class_details_inner.rb,
lib/onfido/models/facial_similarity_photo_breakdown_visual_authenticity_breakdown_spoofing_detection_properties.rb

Overview

#Onfido API v3.6

#The Onfido API (v3.6)

The version of the OpenAPI document: v3.6

Generated by: openapi-generator.tech Generator version: 7.9.0

Defined Under Namespace

Modules: CompleteTaskDataBuilder, Report Classes: Address, AddressBuilder, AddressShared, AddressesList, ApiClient, ApiError, Applicant, ApplicantBuilder, ApplicantConsentBuilder, ApplicantConsentName, ApplicantCreate, ApplicantRequest, ApplicantResponse, ApplicantShared, ApplicantUpdate, ApplicantUpdater, ApplicantsList, Check, CheckBuilder, CheckRequest, CheckResponse, CheckShared, CheckStatus, ChecksList, CompleteTaskBuilder, Configuration, CountryCodes, DefaultApi, DeviceIntelligenceBreakdown, DeviceIntelligenceBreakdownBreakdown, DeviceIntelligenceBreakdownBreakdownDevice, DeviceIntelligenceBreakdownBreakdownDeviceBreakdown, DeviceIntelligenceBreakdownProperties, DeviceIntelligenceBreakdownPropertiesDevice, DeviceIntelligenceBreakdownPropertiesGeolocation, DeviceIntelligenceBreakdownPropertiesIp, DeviceIntelligenceReport, Document, DocumentBreakdown, DocumentBreakdownAgeValidation, DocumentBreakdownAgeValidationBreakdown, DocumentBreakdownCompromisedDocument, DocumentBreakdownCompromisedDocumentBreakdown, DocumentBreakdownDataComparison, DocumentBreakdownDataComparisonBreakdown, DocumentBreakdownDataComparisonBreakdownIssuingCountry, DocumentBreakdownDataConsistency, DocumentBreakdownDataConsistencyBreakdown, DocumentBreakdownDataValidation, DocumentBreakdownDataValidationBreakdown, DocumentBreakdownDataValidationBreakdownDocumentExpiration, DocumentBreakdownDataValidationBreakdownExpiryDate, DocumentBreakdownImageIntegrity, DocumentBreakdownImageIntegrityBreakdown, DocumentBreakdownImageIntegrityBreakdownColourPicture, DocumentBreakdownImageIntegrityBreakdownConclusiveDocumentQuality, DocumentBreakdownImageIntegrityBreakdownImageQuality, DocumentBreakdownImageIntegrityBreakdownSupportedDocument, DocumentBreakdownIssuingAuthority, DocumentBreakdownIssuingAuthorityBreakdown, DocumentBreakdownIssuingAuthorityBreakdownNfcActiveAuthentication, DocumentBreakdownIssuingAuthorityBreakdownNfcPassiveAuthentication, DocumentBreakdownPoliceRecord, DocumentBreakdownVisualAuthenticity, DocumentBreakdownVisualAuthenticityBreakdown, DocumentBreakdownVisualAuthenticityBreakdownDigitalTampering, DocumentBreakdownVisualAuthenticityBreakdownFaceDetection, DocumentBreakdownVisualAuthenticityBreakdownFonts, DocumentBreakdownVisualAuthenticityBreakdownOriginalDocumentPresent, DocumentBreakdownVisualAuthenticityBreakdownOther, DocumentBreakdownVisualAuthenticityBreakdownPictureFaceIntegrity, DocumentBreakdownVisualAuthenticityBreakdownSecurityFeatures, DocumentBreakdownVisualAuthenticityBreakdownTemplate, DocumentCDQReasons, DocumentIQReasons, DocumentODPReasons, DocumentProperties, DocumentPropertiesAddressLines, DocumentPropertiesBarcode, DocumentPropertiesDocumentClassification, DocumentPropertiesDocumentNumbersInner, DocumentPropertiesDrivingLicenceInformation, DocumentPropertiesExtractedData, DocumentPropertiesNfc, DocumentReport, DocumentResponse, DocumentShared, DocumentTypes, DocumentVideoReport, DocumentVideoWithAddressInformationReport, DocumentWithAddressInformationReport, DocumentWithDriverVerificationReport, DocumentWithDriverVerificationReportAllOfProperties, DocumentWithDriverVerificationReportAllOfPropertiesAllOfPassengerVehicle, DocumentWithDriverVerificationReportAllOfPropertiesAllOfVehicleClassDetailsInner, DocumentWithDrivingLicenceInformationReport, DocumentsList, Error, Error1, ErrorProperties, ErrorProperties1, ExtractRequest, Extraction, ExtractionDocumentClassification, ExtractionExtractedData, FacialSimilarityMotionBreakdown, FacialSimilarityMotionBreakdownFaceComparison, FacialSimilarityMotionBreakdownImageIntegrity, FacialSimilarityMotionBreakdownImageIntegrityBreakdown, FacialSimilarityMotionBreakdownImageIntegrityBreakdownFaceDetected, FacialSimilarityMotionBreakdownImageIntegrityBreakdownSourceIntegrity, FacialSimilarityMotionBreakdownVisualAuthenticity, FacialSimilarityMotionBreakdownVisualAuthenticityBreakdown, FacialSimilarityMotionBreakdownVisualAuthenticityBreakdownSpoofingDetection, FacialSimilarityMotionProperties, FacialSimilarityMotionReport, FacialSimilarityPhotoBreakdown, FacialSimilarityPhotoBreakdownFaceComparison, FacialSimilarityPhotoBreakdownFaceComparisonBreakdown, FacialSimilarityPhotoBreakdownFaceComparisonBreakdownFaceMatch, FacialSimilarityPhotoBreakdownFaceComparisonBreakdownFaceMatchProperties, FacialSimilarityPhotoBreakdownImageIntegrity, FacialSimilarityPhotoBreakdownImageIntegrityBreakdown, FacialSimilarityPhotoBreakdownImageIntegrityBreakdownFaceDetected, FacialSimilarityPhotoBreakdownImageIntegrityBreakdownSourceIntegrity, FacialSimilarityPhotoBreakdownVisualAuthenticity, FacialSimilarityPhotoBreakdownVisualAuthenticityBreakdown, FacialSimilarityPhotoBreakdownVisualAuthenticityBreakdownSpoofingDetection, FacialSimilarityPhotoBreakdownVisualAuthenticityBreakdownSpoofingDetectionProperties, FacialSimilarityPhotoFullyAutoBreakdown, FacialSimilarityPhotoFullyAutoBreakdownImageIntegrity, FacialSimilarityPhotoFullyAutoBreakdownImageIntegrityBreakdown, FacialSimilarityPhotoFullyAutoBreakdownImageIntegrityBreakdownSourceIntegrity, FacialSimilarityPhotoFullyAutoProperties, FacialSimilarityPhotoFullyAutoReport, FacialSimilarityPhotoProperties, FacialSimilarityPhotoReport, FacialSimilarityReportMedia, FacialSimilarityReportShared, FacialSimilarityVideoBreakdown, FacialSimilarityVideoBreakdownFaceComparison, FacialSimilarityVideoBreakdownImageIntegrity, FacialSimilarityVideoBreakdownImageIntegrityBreakdown, FacialSimilarityVideoBreakdownImageIntegrityBreakdownFaceDetected, FacialSimilarityVideoBreakdownImageIntegrityBreakdownSourceIntegrity, FacialSimilarityVideoBreakdownVisualAuthenticity, FacialSimilarityVideoBreakdownVisualAuthenticityBreakdown, FacialSimilarityVideoBreakdownVisualAuthenticityBreakdownLivenessDetected, FacialSimilarityVideoBreakdownVisualAuthenticityBreakdownSpoofingDetection, FacialSimilarityVideoProperties, FacialSimilarityVideoReport, IdNumber, IdPhoto, IdPhotoResponse, IdPhotosList, IdentityEnhancedBreakdown, IdentityEnhancedBreakdownAddress, IdentityEnhancedBreakdownAddressBreakdown, IdentityEnhancedBreakdownAddressBreakdownCreditAgencies, IdentityEnhancedBreakdownAddressBreakdownCreditAgenciesProperties, IdentityEnhancedBreakdownAddressBreakdownTelephoneDatabase, IdentityEnhancedBreakdownAddressBreakdownVotingRegister, IdentityEnhancedBreakdownDateOfBirth, IdentityEnhancedBreakdownDateOfBirthBreakdown, IdentityEnhancedBreakdownDateOfBirthBreakdownCreditAgencies, IdentityEnhancedBreakdownDateOfBirthBreakdownVotingRegister, IdentityEnhancedBreakdownMortality, IdentityEnhancedBreakdownSources, IdentityEnhancedBreakdownSourcesBreakdown, IdentityEnhancedBreakdownSourcesBreakdownTotalSources, IdentityEnhancedBreakdownSourcesBreakdownTotalSourcesProperties, IdentityEnhancedProperties, IdentityEnhancedPropertiesMatchedAddressesInner, IdentityEnhancedReport, IndiaPanReport, IndiaPanReportAllOfBreakdown, IndiaPanReportAllOfBreakdownDevice, IndiaPanReportAllOfBreakdownDeviceBreakdown, IndiaPanReportAllOfBreakdownDeviceBreakdownPanValid, IndiaPanReportAllOfProperties, IndiaPanReportAllOfPropertiesDevice, KnownFacesBreakdown, KnownFacesBreakdownImageIntegrity, KnownFacesBreakdownPreviouslySeenFaces, KnownFacesProperties, KnownFacesPropertiesMatchesInner, KnownFacesReport, LivePhoto, LivePhotoResponse, LivePhotosList, LiveVideo, LiveVideosList, Location, LocationBuilder, LocationShared, MotionCapture, MotionCapturesList, OnfidoInvalidSignatureError, PhotoAutoReasons, PhotoReasons, ProofOfAddressBreakdown, ProofOfAddressBreakdownDataComparison, ProofOfAddressBreakdownDataComparisonBreakdown, ProofOfAddressBreakdownDocumentClassification, ProofOfAddressBreakdownDocumentClassificationBreakdown, ProofOfAddressBreakdownImageIntegrity, ProofOfAddressBreakdownImageIntegrityBreakdown, ProofOfAddressProperties, ProofOfAddressReport, RepeatAttemptsList, RepeatAttemptsListRepeatAttemptsInner, ReportDocument, ReportName, ReportResult, ReportShared, ReportStatus, ReportSubResult, ReportsList, ResultsFeedback, SdkToken, SdkTokenBuilder, SdkTokenRequest, SdkTokenResponse, Task, TaskItem, TimelineFileReference, UsDrivingLicenceBreakdown, UsDrivingLicenceBreakdownAddress, UsDrivingLicenceBreakdownAddressBreakdown, UsDrivingLicenceBreakdownDocument, UsDrivingLicenceBreakdownDocumentBreakdown, UsDrivingLicenceBreakdownPersonal, UsDrivingLicenceBreakdownPersonalBreakdown, UsDrivingLicenceBuilder, UsDrivingLicenceReport, UsDrivingLicenceShared, VideoReasons, WatchlistAmlBreakdown, WatchlistAmlBreakdownAdverseMedia, WatchlistAmlBreakdownLegalAndRegulatoryWarnings, WatchlistAmlBreakdownPoliticallyExposedPerson, WatchlistAmlBreakdownSanction, WatchlistAmlProperties, WatchlistAmlReport, WatchlistEnhancedBreakdown, WatchlistEnhancedProperties, WatchlistEnhancedPropertiesRecordsInner, WatchlistEnhancedPropertiesRecordsInnerAddressInner, WatchlistEnhancedPropertiesRecordsInnerAliasInner, WatchlistEnhancedPropertiesRecordsInnerAssociateInner, WatchlistEnhancedPropertiesRecordsInnerAttributeInner, WatchlistEnhancedPropertiesRecordsInnerEventInner, WatchlistEnhancedPropertiesRecordsInnerEventInnerSource, WatchlistEnhancedPropertiesRecordsInnerSourceInner, WatchlistEnhancedReport, WatchlistMonitor, WatchlistMonitorBuilder, WatchlistMonitorMatch, WatchlistMonitorMatchesList, WatchlistMonitorMatchesUpdater, WatchlistMonitorResponse, WatchlistMonitorShared, WatchlistMonitorsList, WatchlistPepsOnlyReport, WatchlistSanctionsOnlyReport, WatchlistStandardBreakdown, WatchlistStandardProperties, WatchlistStandardReport, Webhook, WebhookBuilder, WebhookCreate, WebhookEvent, WebhookEventObjectStatus, WebhookEventPayload, WebhookEventPayloadObject, WebhookEventPayloadResource, WebhookEventResourceType, WebhookEventType, WebhookEventVerifier, WebhookResend, WebhookResponse, WebhookShared, WebhookUpdate, WebhookUpdater, WebhooksList, WebhooksResendItem, WorkflowRun, WorkflowRunBuilder, WorkflowRunError, WorkflowRunLink, WorkflowRunRequest, WorkflowRunResponse, WorkflowRunShared, WorkflowRunStatus

Constant Summary

VERSION =

'4.2.0'

Class Method Summary

• .configure ⇒ Object

  Customize default settings for the SDK using block.

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

Onfido.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.

# File 'lib/onfido.rb', line 322

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end