openapi: 3.0.2 info: version: 1.3.43 title: Lane History API contact: email: support@netsolapp.io, support@appexnow.com x-logo: url: ../lane/docs/64x64.png altText: Lane backgroundColor: '#FFFFFF' description: Lane offers a feature-rich, end-to-end order management system for asset leasing, loans and credit companies. Our platform covers all aspects, from conducting end-to-end sales to performing dealer and partner-related tasks and marketing-related activities. servers: - url: https://dms-api.netsolapp.io tags: - name: History description: Manage operations related to History paths: /dms/customer/customer-history: get: tags: - History summary: Get all customers records history description: Get all customers records history operationId: get_customer_history_dms_customer_customer_history_get parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query - description: 'Format: YYYY-MM-DD' required: false schema: title: From Date type: string description: 'Format: YYYY-MM-DD' format: date name: from_date in: query - description: 'Format: YYYY-MM-DD' required: false schema: title: To Date type: string description: 'Format: YYYY-MM-DD' format: date name: to_date in: query responses: '200': description: Successful Response content: application/json: schema: title: Response Get Customer History Dms Customer Customer History Get type: array items: $ref: '#/components/schemas/CustomerProfileModelResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/license-info-history: get: tags: - History summary: Get all customer license information history description: Get all customer license information history operationId: get_license_information_history_dms_customer_license_info_history_get parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query - required: true schema: title: Page Number type: integer name: page_number in: query - required: true schema: title: Page Size minimum: 1 type: integer name: page_size in: query - description: 'Format: YYYY-MM-DD' required: false schema: title: From Date type: string description: 'Format: YYYY-MM-DD' name: from_date in: query - description: 'Format: YYYY-MM-DD' required: false schema: title: To Date type: string description: 'Format: YYYY-MM-DD' name: to_date in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/LicenseInfoPaginationResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/third-party-response-history: get: tags: - History summary: Get third party response history description: Get third party response history operationId: get_third_part_response_history_dms_customer_third_party_response_history_get parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query - required: false schema: title: Identifier type: string name: identifier in: query - required: false schema: title: Include Images type: boolean default: false name: include_images in: query - required: false schema: title: Include Response type: boolean default: false name: include_response in: query - required: false schema: title: Type List type: array items: type: string name: type_list in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/address/history: get: tags: - History summary: Delete existing record of address description: Delete existing record of address operationId: address_history_dms_address_history_get parameters: - required: true schema: $ref: '#/components/schemas/AddressTypesEnum' name: address_type in: query - required: true schema: title: Reference Id type: string name: reference_id in: query responses: '200': description: Successful Response content: application/json: schema: title: Response Address History Dms Address History Get type: array items: $ref: '#/components/schemas/AddressResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/insurance-information-history: get: tags: - History summary: Get customer insurance information history description: Get customer insurance information history operationId: get_insurance_information_history_dms_customer_insurance_information_history_get parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query - required: true schema: title: Page Number type: integer name: page_number in: query - required: true schema: title: Page Size minimum: 1 type: integer name: page_size in: query - description: 'Format: YYYY-MM-DD' required: false schema: title: From Date type: string description: 'Format: YYYY-MM-DD' format: date name: from_date in: query - description: 'Format: YYYY-MM-DD' required: false schema: title: To Date type: string description: 'Format: YYYY-MM-DD' format: date name: to_date in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/InsuranceInfoPaginationResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' deprecated: true security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/insurance-information/document-history: get: tags: - History summary: Get customer insurance information document history description: Get customer insurance information document history operationId: get_insurance_documents_dms_customer_insurance_information_document_history_get parameters: - description: provide valid reference_id required: true schema: title: Reference Id minLength: 1 type: string description: provide valid reference_id name: reference_id in: query responses: '200': description: Successful Response content: application/json: schema: title: Response Get Insurance Documents Dms Customer Insurance Information Document History Get type: array items: $ref: '#/components/schemas/InsuranceDocumentsResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/order/order-checklist-update-history: get: tags: - History summary: Get Order Checklist Update History operationId: get_order_checklist_update_history_dms_order_order_checklist_update_history_get parameters: - required: true schema: title: Customer Reference Id type: string name: customer_reference_id in: query - required: true schema: title: Event type: string name: event in: query - required: true schema: title: Order Reference Id type: string name: order_reference_id in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/document-history: get: tags: - History summary: Get customer document history operationId: get_customer_document_history_dms_customer_document_history_get parameters: - required: true schema: title: Customer Reference Id type: string name: customer_reference_id in: query - required: true schema: title: Page Number type: integer name: page_number in: query - required: true schema: title: Page Size minimum: 1 type: integer name: page_size in: query - description: 'Format: YYYY-MM-DD' required: false schema: title: From Date type: string description: 'Format: YYYY-MM-DD' format: date name: from_date in: query - description: 'Format: YYYY-MM-DD' required: false schema: title: To Date type: string description: 'Format: YYYY-MM-DD' format: date name: to_date in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerStipulationPaginationResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/history: get: tags: - History summary: Get all customers records history description: Get all customers records history operationId: get_customer_all_history_dms_history_get parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query - required: true schema: title: Page Number type: integer name: page_number in: query - required: true schema: title: Page Size minimum: 1 type: integer name: page_size in: query - description: for stipulation, additional_document, insurance required: false schema: title: Order Reference Id type: string description: for stipulation, additional_document, insurance name: order_reference_id in: query - description: 'Format: YYYY-MM-DD' required: false schema: title: From Date type: string description: 'Format: YYYY-MM-DD' format: date name: from_date in: query - description: 'Format: YYYY-MM-DD' required: false schema: title: To Date type: string description: 'Format: YYYY-MM-DD' format: date name: to_date in: query - description: module required: false schema: type: array items: $ref: '#/components/schemas/ComparisonModule' description: module name: module_type in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/HistoryPaginationResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/history-details: get: tags: - History summary: Get history detail description: Get history detail operationId: history_detail_dms_history_details_get parameters: - required: true schema: $ref: '#/components/schemas/ComparisonModule' name: module_type in: query - required: true schema: title: Identifier type: string name: identifier in: query - required: false schema: title: Order Reference Id type: string name: order_reference_id in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] components: schemas: CustomerAddressWithoutAddressTypeModel: title: CustomerAddressWithoutAddressTypeModel type: object properties: address_line_1: title: Address Line 1 type: string description: Address line one address_line_2: title: Address Line 2 type: string description: Address line two state_name: title: State Name type: string description: Address state name zip_code: title: Zip Code type: string description: Zip code county: title: County type: string description: Address county city: title: City type: string description: Address city contact_number: title: Contact Number type: string description: Contact number verified: title: Verified type: boolean description: Is Address verified move_in_date: title: Move In Date type: string description: 'format: YYYY-MM-DD' format: date is_garaging: title: Is Garaging type: boolean description: Garaging flag default: false identifier: title: Identifier minLength: 1 type: string ValidationError: title: ValidationError required: - loc - msg - type type: object properties: loc: title: Location type: array items: anyOf: - type: string - type: integer msg: title: Message type: string type: title: Error Type type: string CustomerAddressPreResponseModel: title: CustomerAddressPreResponseModel required: - address_type type: object properties: address_line_1: title: Address Line 1 type: string description: Address line one address_line_2: title: Address Line 2 type: string description: Address line two state_name: title: State Name type: string description: Address state name zip_code: title: Zip Code type: string description: Zip code county: title: County type: string description: Address county city: title: City type: string description: Address city contact_number: title: Contact Number type: string description: Contact number verified: title: Verified type: boolean description: Is Address verified move_in_date: title: Move In Date type: string description: 'format: YYYY-MM-DD' format: date is_garaging: title: Is Garaging type: boolean description: Garaging flag default: false address_type: $ref: '#/components/schemas/AddressTypes' identifier: title: Identifier type: string created_at: title: Created At type: string format: date-time created_by: title: Created By type: string updated_at: title: Updated At type: string format: date-time updated_by: title: Updated By type: string deleted_at: title: Deleted At type: string format: date-time deleted_by: title: Deleted By type: string InsuranceDetailStatus: title: InsuranceDetailStatus enum: - Verified - Unverified - Expired type: string description: An enumeration. InsuranceInfoPaginationResponse: title: InsuranceInfoPaginationResponse type: object properties: result: title: Result type: array items: $ref: '#/components/schemas/InsuranceInformationResponseModel' page_number: title: Page Number type: integer page_size: title: Page Size type: integer total_pages: title: Total Pages type: integer total_results: title: Total Results type: integer AddressResponseModel: title: AddressResponseModel required: - address_type type: object properties: address_line_1: title: Address Line 1 type: string description: Address line one address_line_2: title: Address Line 2 type: string description: Address line two state_name: title: State Name type: string description: Address state name zip_code: title: Zip Code type: string description: Zip code county: title: County type: string description: Address county city: title: City type: string description: Address city contact_number: title: Contact Number type: string description: Contact number verified: title: Verified type: boolean description: Is Address verified move_in_date: title: Move In Date type: string description: 'format: YYYY-MM-DD' format: date is_garaging: title: Is Garaging type: boolean description: Garaging flag default: false address_type: $ref: '#/components/schemas/AddressTypes' identifier: title: Identifier type: string created_at: title: Created At type: string format: date-time created_by: title: Created By type: string updated_at: title: Updated At type: string format: date-time updated_by: title: Updated By type: string deleted_at: title: Deleted At type: string format: date-time deleted_by: title: Deleted By type: string reference_id: title: Reference Id type: string is_active: title: Is Active type: boolean AddressTypesEnum: title: AddressTypesEnum enum: - Mailing - Invoice - Office - Garaging - DealerAddress - DrivingLicense - Billing - InsuranceAddress - Residential - Previous - All type: string description: An enumeration. LicenseInfoPaginationResponse: title: LicenseInfoPaginationResponse type: object properties: result: title: Result type: array items: $ref: '#/components/schemas/LicenseInfoResponseModel' page_number: title: Page Number type: integer page_size: title: Page Size type: integer total_pages: title: Total Pages type: integer total_results: title: Total Results type: integer InsuranceDocumentsResponseModel: title: InsuranceDocumentsResponseModel type: object properties: document_uri: title: Document Uri type: string content_type: title: Content Type type: string name: title: Name type: string file_size: title: File Size type: string identifier: title: Identifier type: string is_active: title: Is Active type: boolean created_by: title: Created By type: string created_at: title: Created At type: string format: date deleted_at: title: Deleted At type: string format: date deleted_by: title: Deleted By type: string HistoryPaginationResponse: title: HistoryPaginationResponse type: object properties: results: title: Results type: array items: $ref: '#/components/schemas/HistoryResponseDetail' page_number: title: Page Number type: integer page_size: title: Page Size type: integer total_pages: title: Total Pages type: integer total_results: title: Total Results type: integer ComparisonModule: title: ComparisonModule enum: - CustomerProfile - InsuranceInformation - Stipulation - AdditionalDocument - StatusFlag - CustomerAdditionalDocument type: string description: An enumeration. LicenseInfoCustomerResponseModel: title: LicenseInfoCustomerResponseModel type: object properties: first_name: title: First Name type: string last_name: title: Last Name type: string status: title: Status type: string license_number: title: License Number type: string is_pdf_417: title: Is Pdf 417 type: boolean issue_date: title: Issue Date type: string description: 'format: YYYY-MM-DD' format: date expiry_date: title: Expiry Date type: string description: 'format: YYYY-MM-DD' format: date date_of_birth: title: Date Of Birth type: string description: 'format: YYYY-MM-DD' format: date is_selfie_verified: title: Is Selfie Verified type: boolean HistoryResponseDetail: title: HistoryResponseDetail type: object properties: identifier: title: Identifier type: string created_at: title: Created At type: string format: date-time created_by: title: Created By type: string updated_at: title: Updated At type: string format: date-time updated_by: title: Updated By type: string deleted_at: title: Deleted At type: string format: date-time deleted_by: title: Deleted By type: string action: title: Action type: string order_reference_id: title: Order Reference Id type: string module_type: title: Module Type type: string CustomerProfileModelResponse: title: CustomerProfileModelResponse type: object properties: prefix: title: Prefix type: string first_name: title: First Name type: string middle_name: title: Middle Name type: string last_name: title: Last Name type: string suffix: title: Suffix type: string ssn: title: Ssn type: string mobile_number: title: Mobile Number type: string mobile_number_verified_status: title: Mobile Number Verified Status type: boolean default: false home_number: title: Home Number type: string home_number_verified_status: title: Home Number Verified Status type: boolean default: false customer_type: title: Customer Type type: string date_of_birth: title: Date Of Birth type: string description: 'format: YYYY-MM-DD' format: date meta_data: title: Meta Data type: object stripe_customer_id: title: Stripe Customer Id type: string preferred_contact: title: Preferred Contact type: string reference_id: title: Reference Id type: string external_id: title: External Id type: string identifier: title: Identifier type: string email: title: Email type: string created_by: title: Created By type: string created_at: title: Created At type: string format: date-time updated_at: title: Updated At type: string format: date-time updated_by: title: Updated By type: string deleted_at: title: Deleted At type: string format: date-time deleted_by: title: Deleted By type: string customer_addresses: title: Customer Addresses type: array items: $ref: '#/components/schemas/CustomerAddressPreResponseModel' income_info: $ref: '#/components/schemas/CustomerEmploymentInfoPreResponseModel' payments_info: title: Payments Info type: array items: $ref: '#/components/schemas/CustomerPaymentInfoResponseModel' license_info: $ref: '#/components/schemas/LicenseInfoCustomerResponseModel' CustomerEmploymentInfoPreResponseModel: title: CustomerEmploymentInfoPreResponseModel type: object properties: employment_type: title: Employment Type type: string description: Employment type name: title: Name type: string description: Name phone: title: Phone type: string description: Phone employed_since: title: Employed Since type: string description: Employed since format: date occupation: title: Occupation type: string description: Occupation annual_employment_income: title: Annual Employment Income type: number description: Annual employment income annual_other_income: title: Annual Other Income type: number description: Annual other income source_of_other_income: title: Source Of Other Income type: string description: Annual other income created_at: title: Created At type: string format: date-time created_by: title: Created By type: string updated_at: title: Updated At type: string format: date-time updated_by: title: Updated By type: string deleted_at: title: Deleted At type: string format: date-time deleted_by: title: Deleted By type: string CallType: title: CallType enum: - manual - auto type: string description: An enumeration. AddressTypes: title: AddressTypes enum: - Mailing - Invoice - Office - Garaging - DealerAddress - DrivingLicense - Billing - InsuranceAddress - Residential - Employment type: string description: An enumeration. LicenseInfoResponseModel: title: LicenseInfoResponseModel type: object properties: first_name: title: First Name type: string description: First name last_name: title: Last Name type: string description: Last name date_of_birth: title: Date Of Birth type: string description: 'format: YYYY-MM-DD' format: date is_pdf_417: title: Is Pdf 417 type: boolean license_number: title: License Number type: string description: license number issue_date: title: Issue Date type: string description: 'format: YYYY-MM-DD' format: date expiry_date: title: Expiry Date type: string description: 'format: YYYY-MM-DD' format: date front_image: title: Front Image type: string description: license front image back_image: title: Back Image type: string description: license back image status: title: Status type: string call_type: $ref: '#/components/schemas/CallType' selfie_image: title: Selfie Image type: string cropped_front_image: title: Cropped Front Image type: string cropped_back_image: title: Cropped Back Image type: string cropped_selfie_image: title: Cropped Selfie Image type: string is_selfie_verified: title: Is Selfie Verified type: boolean created_by: title: Created By type: string reference_id: title: Reference Id type: string is_active: title: Is Active type: boolean identifier: title: Identifier type: string created_at: title: Created At type: string format: date-time updated_at: title: Updated At type: string format: date-time updated_by: title: Updated By type: string deleted_at: title: Deleted At type: string format: date-time deleted_by: title: Deleted By type: string address: $ref: '#/components/schemas/AddressBasicModel' HTTPValidationError: title: HTTPValidationError type: object properties: detail: title: Detail type: array items: $ref: '#/components/schemas/ValidationError' InsuranceInformationResponseModel: title: InsuranceInformationResponseModel type: object properties: order_reference_id: title: Order Reference Id type: string reference_id: title: Reference Id type: string insurer_name: title: Insurer Name type: string agent_phone: title: Agent Phone type: string subscription_id: title: Subscription Id type: string agent_name: title: Agent Name type: string policy_number: title: Policy Number type: string start_date: title: Start Date type: string description: 'format: YYYY-MM-DD' format: date expiration_date: title: Expiration Date type: string description: 'format: YYYY-MM-DD' format: date deductible_comprehensive: title: Deductible Comprehensive type: number deductible_collision: title: Deductible Collision type: number created_by: title: Created By type: string identifier: title: Identifier type: string is_verified: title: Is Verified type: boolean default: false insurance_documents: title: Insurance Documents type: array items: $ref: '#/components/schemas/InsuranceDocumentsResponseModel' insurer_address: $ref: '#/components/schemas/CustomerAddressWithoutAddressTypeModel' status: $ref: '#/components/schemas/InsuranceDetailStatus' is_active: title: Is Active type: boolean is_deleted: title: Is Deleted type: boolean created_at: title: Created At type: string format: date-time updated_at: title: Updated At type: string format: date-time updated_by: title: Updated By type: string deleted_at: title: Deleted At type: string format: date deleted_by: title: Deleted By type: string CustomerStipulationPaginationResponse: title: CustomerStipulationPaginationResponse type: object properties: result: title: Result type: array items: $ref: '#/components/schemas/CustomerDocumentWithReviewsResponseModel' page_number: title: Page Number type: integer page_size: title: Page Size type: integer total_pages: title: Total Pages type: integer total_results: title: Total Results type: integer CustomerDocumentWithReviewsResponseModel: title: CustomerDocumentWithReviewsResponseModel required: - document_reviews type: object properties: customer_reference_id: title: Customer Reference Id type: string external_reference_id: title: External Reference Id type: string document_type: title: Document Type type: string comment: title: Comment type: string category: title: Category type: string document_name: title: Document Name type: string document_size: title: Document Size type: string document_url: title: Document Url type: string reason_by_system: title: Reason By System type: string reason_for_customer: title: Reason For Customer type: string document_status: title: Document Status type: string document_upload_indicator: title: Document Upload Indicator type: boolean default: false expires_at: title: Expires At type: string description: 'format: YYYY-MM-DD hh:mm:ss' format: date-time created_at: title: Created At type: string description: 'format: YYYY-MM-DD hh:mm:ss' format: date-time updated_at: title: Updated At type: string description: 'format: YYYY-MM-DD hh:mm:ss' format: date-time deleted_at: title: Deleted At type: string description: 'format: YYYY-MM-DD hh:mm:ss' format: date-time updated_by: title: Updated By type: string created_by: title: Created By type: string deleted_by: title: Deleted By type: string uploaded_by: title: Uploaded By type: string uploaded_at: title: Uploaded At type: string format: date-time is_deleted: title: Is Deleted type: boolean default: false identifier: title: Identifier type: string stipulation_code: title: Stipulation Code type: string document_reviews: title: Document Reviews type: array items: $ref: '#/components/schemas/CustomerDocumentReviewPreResponseModel' CustomerDocumentReviewPreResponseModel: title: CustomerDocumentReviewPreResponseModel type: object properties: reviewed_by: title: Reviewed By type: string review_date_time: title: Review Date Time type: string description: 'format: YYYY-MM-DD hh:mm:ss' format: date-time review_status: title: Review Status type: string review_notes: title: Review Notes type: string reason: title: Reason type: array items: type: string other_reason: title: Other Reason type: string identifier: title: Identifier type: string CustomerPaymentInfoResponseModel: title: CustomerPaymentInfoResponseModel type: object properties: type: title: Type type: string stripe_payment_method_id: title: Stripe Payment Method Id type: string access_token: title: Access Token type: string account_id: title: Account Id type: string Bank_name: title: Bank Name type: string last4: title: Last4 type: integer default: title: Default type: boolean created_at: title: Created At type: string format: date-time created_by: title: Created By type: string updated_at: title: Updated At type: string format: date-time updated_by: title: Updated By type: string deleted_at: title: Deleted At type: string format: date-time deleted_by: title: Deleted By type: string AddressBasicModel: title: AddressBasicModel type: object properties: address_line_1: title: Address Line 1 type: string description: Address line one address_line_2: title: Address Line 2 type: string description: Address line two state_name: title: State Name type: string description: Address state name zip_code: title: Zip Code type: string description: Zip code county: title: County type: string description: Address county city: title: City type: string description: Address city contact_number: title: Contact Number type: string description: Contact number verified: title: Verified type: boolean description: Is Address verified move_in_date: title: Move In Date type: string description: 'format: YYYY-MM-DD' format: date is_garaging: title: Is Garaging type: boolean description: Garaging flag default: false securitySchemes: APIKeyHeader: type: apiKey in: header name: X-Api-Key OAuth2PasswordBearer: type: oauth2 flows: password: scopes: {} tokenUrl: /signup/verify-otp externalDocs: url: https://developer.appexnow.com/docs/lane/overview description: Product Documentation