Applies to integrated customers using the RecoveryConnect APIDescription: This endpoint is used to create a new order (case) in the system. To make an order, you must provide mandatory details such as case type ID, client ID, lien holder ID, collateral details, borrower’s information, and borrower’s address.
URL: /api/v130/orders
Method: POST
Request Body Parameters:
| PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
| determination_flag | Defines case flow: 0 – Normal Flow, 1 – Switch Flow | No | 0 or 1 |
| case_type_id | Type of the case | Yes | 1 |
| client_id | Unique identifier for the client | Yes | 65690 |
| lienholder_id | Unique identifier for the lienholder | Yes | 65690 |
| client_account_number | Account number of the client | No | 2345324 |
| lienholder_account_number | Account number of the lienholder | No | 6468637 |
| assign_service_provider_id | Company ID to which the case is assigned (Forwarder/Agent) | No | 10004 |
| tier_level | Tier level of the case | No | 1 |
| placement_level | Placement level of the case | No | 1 |
| identification_number | Vehicle Identification Number (VIN) | Yes | 1FALP13P9VW12034926456 |
| vehicle_type_id | Type of collateral (vehicle) | No | 5 |
| Year | Manufacture year of the vehicle | No | 2015 |
| Make | Make of the Vehicle (brand) | No | Ford |
| Model | Model of the vehicle | No | Fusion |
| body_type | Body type of the vehicle | No | Sedan/Saloon |
| drive_train | Type of drive train of the vehicle | No | Front-Wheel Drive |
| Engine | Type of the engine | No | Cylinder |
| Trim | Trim type | No | LX |
| fuel_type | Fuel type of the vehicle | No | Gasoline |
| license_plate | License plate of the vehicle | No | 139507 |
| license_state | State of the license plate | No | OH |
| original_loan_amount | Loan amount taken by the borrower | No | 900 |
| payment_amount | Amount paid | No | 500 |
| past_due_amount | Amount overdue (not paid by due date) | No | 200 |
| unpaid_balance | Outstanding principal balance on the loan | No | 200 |
| contract_date | The date on which the loan agreement was officially created and recorded. | No | 2020-01-01 |
| delinquent_since | The date when the loan account first became past due or delinquent. | No | 2020-01-01 |
| chargeoff_date | The date when the lender officially declared the loan as a loss (charged off). | No | 2020-05-05 |
| collateral_value | Assessed the value of the collateral securing the loan | No | 700 |
| collateral_value_added | The date when the collateral value was last added or updated for the loan. | No | 2020-01-01 |
| color | Vehicle color | No | Light Blue |
| firstname | Borrower’s first name | Yes | John |
| middle_initial | Borrower’s Middle name | No | Samuel |
| lastname | Borrower’s Last name | No | Smith |
| date_of_birth | Borrower’s Date of Birth | No | 1984-01-01 |
| type | Indicates borrower or co-signer | Yes | borrower |
| ssn | Borrower’s Social Security Number | No | 123456789 |
| is_fraud | Boolean flag indicating fraud status (0 = No, 1 = Yes) | No | 0 |
| is_deceased | Boolean flag indicating if borrower is deceased (0 = No, 1 = Yes) | No | 0 |
| bankruptcy | Bankruptcy type and status | No | chapter_7_active |
| active_military | Boolean flag indicating if borrower is serving in the military (0/1) | No | 0 |
| address_name | Type of address (e.g., Home, Mailing, Additional) | Yes | Home Address |
| address_1 | Primary address line | Yes | 10851 Black Canyon |
| address_2 | Secondary address line | No | Highway Suite 500 |
| unit | The apartment, suite, or unit number within the borrower’s address | No | 3 |
| city | City name | No | Los Angeles |
| state | State of the borrower’s address | No | CA |
| zip_code | Zip/Postal code of the borrower’s address | Yes | 43015 |
| latitude | The geographic latitude coordinate | No | 42.795435 |
| longitude | The geographic longitude coordinate | No | -78.81862 |
| dwelling_id | Unique identifier for the dwelling/residence | No | 1 |
| category_id | Identifier for the loan’s category/classification | No | 1 |
| name | Type of address (e.g., Home, Mailing, Additional | No | additional_addresses |
| address_1 | Primary address line | Yes | 10851 Black Canyon |
| address_2 | Secondary address line | No | Highway Suite 500 |
| unit | The apartment, suite, or unit number within the borrower’s address | No | 3 |
| city | City name | No | Los Angeles |
| state | State of the borrower's address | No | CA |
| zip_code | Zip/Postal code of the borrower’s address | Yes | 85123 |
| latitude | The geographic latitude coordinate | No | 42.795435 |
| longitude | The geographic longitude coordinate | No | -78.81862 |
| dwelling_id | Unique identifier for the dwelling/residence | No | 1 |
| category_id | Identifier for the loan’s category/classification | No | 1 |
Success Code: 200 OK – Request Successful
Example:
URL: https://test-api.mbsisystems.com/api/v130/orders |
Request Body:
{ "case_type_id": 1, "client_id": 65690, "lienholder_id": 65690, "client_account_number": "2321", "lienholder_account_number": "3321", "assign_service_provider_id": 123, "tier_level": 1, "placement_level": 1, "collaterals": [ { "identification_number": "3C8FY58B82T387617", "vehicle_type_id": 1, "year": "2014", "make": "Ford", "model": "Fusion", "body_type": "Short Bed", "drive_train": "Front-Wheel Drive", "engine": "3.7-L V-6 DOHC 24V", "trim": "4dr 1500 LS", "fuel_type": "Diesel", "license_plate": "139507", "license_state": "OH", "loan_info": { "original_loan_amount": 900, "payment_amount": 500, "past_due_amount": 200, "unpaid_balance": 200, "contract_date": "2020-01-01", "delinquent_since": "2020-01-01", "chargeoff_date": "2020-01-01", "collateral_value": 700, "collateral_value_added": "2020-01-01" }, "color": "string" } ], "borrowers": [ { "firstname": "NEELIMA", "middle_initial": "M", "lastname": "TEST", "date_of_birth": "1984-01-01", "type": "borrower", "ssn": "123456789", "is_fraud": 1, "bankruptcy": "chapter_7_active", "active_military": 1, "is_deceased": 0, "phones": [ { "type": 6, "mobile_carrier_id": 1, "number": "123456", "extension": "22", "memo": "home", "valid": 1, "no_contact": 0 } ], "addresses": [ { "name": "Home Address", "address_1": "10851 Black Canyon", "address_2": "Highway Suite 500", "unit": "3", "city": "Los Angeles", "state": "CA", "zip_code": "43015", "latitude": 42.795435, "longitude": -78.81862, "dwelling_id": 1, "category_id": 1, "phones": [ { "type": 6, "mobile_carrier_id": 1, "number": "123456", "extension": "22", "memo": "home", "valid": 1, "no_contact": 0 } ] } ] } ], "additional_addresses": [ { "name": "Home Address", "address_1": "10851 Black Canyon", "address_2": "Highway Suite 500", "unit": "3", "city": "Los Angeles", "state": "CA", "zip_code": "43015", "latitude": 42.795435, "longitude": -78.81862, "dwelling_id": 1, "category_id": 1, "phones": [ { "type": 6, "mobile_carrier_id": 1, "number": "123456", "extension": "22", "memo": "home", "valid": 1, "no_contact": 0 } ] } ] } |
Response:
{ "data": { "id": 2594687, "client_id": 65690, "owner_id": 10001, "lienholder": 65690, "collector_id": null, "association_id": null, "assignment_manager": null, "status_date": "2020-07-15T23:48:12.000000Z", "note": null, "reason": null, "parent_id": null, "is_lender": "0", "order_type": 1, "prior_case_type_live_recovery": null, "client_accountno": "2321", "lien_accountno": "2321", "company_orderno": 2873, "debtor_skipped": null, "is_violent": 0, "expiration": null, "company_address": null, "accepted_date": "Jul 15, 2020", "other_refno": null, "company_address_id": null, "tier_level": null, "placement_level": null, "det_guid": null, "created_at": "Jul 15, 2020 4:48 pm", "updated_at": "Jul 15, 2020 4:50 pm", "deleted_at": null, "source": null, "company_origin": 10001, "source_file": null, "managed_by_company": null, "flagged_delete": 0, "from_transparency_set": 0, "trans_set_by_client_id": null, "trans_main_parent_id": null, "parent_case": 2594687, "reopen_num": 1, "is_latest_case": 1, "assignment_situation": null, "recovery_situation": null, "status": "Open", "status_id": 0 } } |