Debt Settlement Letters

A debt settlement letter is a formal written communication between a debtor (the person or entity that owes money) and a creditor (the person or entity to whom money is owed) in which the debtor proposes a negotiated settlement to resolve an outstanding debt for less than the full amount owed.

API Upload

The type parameter is ndr for the upload endpoint.


Field Descriptions:

The model automatically detects data such as:

Session NameField NameData TypeDescription
Basic InformationCustomer NameStringName of the customer.
Basic InformationCurrent BalanceNumberCurrent balance of the account.
Basic InformationSettlement AmountNumberSettlement amount for the account.
Account NumberOriginal Account NumberStringOriginal account number.
Account NumberReference NumberStringReference number associated with the account.
Account NumberDS ID NumberStringDS ID number for the account.
CreditorOriginal Creditor NameStringOriginal creditor's name.
CreditorCurrent CreditorStringCurrent creditor's name.
CreditorCollection AgencyStringName of the collection agency.
CreditorPhone NumberStringPhone number of the creditor or collection agency.
CreditorOnline Payment URLStringURL for online payments to the creditor.
Creditor Payment AddressAddressStringPayment address of the creditor or collection agency.
Creditor Payment AddressAddress_Line_1StringAddress line 1 of the payment address.
Creditor Payment AddressAddress_Line_2StringAddress line 2 of the payment address.
Creditor Payment AddressCityStringCity of the payment address.
Creditor Payment AddressStateStringState of the payment address.
Creditor Payment AddressZipCodeStringZip code of the payment address.
Payment DetailFirst Payment Due DateDateDue date for the first payment.
Payment DetailFinal Payment Due DateDateDue date for the final payment.
Payment DetailTotal Payments TermNumberTotal number of payment terms.
ErrorError MessageStringError message, if any.
Payment TableLine ItemTableTable of payment line items
DateDateDate of the payment.
AmountNumberAmount of the payment.
No of TermsNumberNumber of terms for the payment.
From DateDateStarting date for the payment term.
To DateDateEnding date for the payment term.

Version

  • 2.0.0

Sample

Sample JSON Output

{
    "data": {
            "Basic Information": {
                "Customer Name": {
                    "value": "",
                    "position": [],
                    "confidence": 1.0,
                    "review_required": false
                },
                "Current Balance": {
                    "value": "",
                    "position": [],
                    "confidence": 0,
                    "review_required": true
                },
                "Settlement Amount": {
                    "value": "",
                    "position": [],
                    "confidence": 0,
                    "review_required": true
                }
            },
            "Account Number": {
                "Original Account Number": {
                    "value": "",
                    "position": [],
                    "confidence": 0,
                    "review_required": true
                },
                "Reference Number": {
                    "value": "",
                    "position": [],
                    "confidence": 0,
                    "review_required": true
                },
                "DS ID Number": {
                    "value": "",
                    "position": [],
                    "confidence": 0,
                    "review_required": true
                }
            },
            "Creditor": {
                "Original Creditor Name": {
                    "value": "",
                    "position": [],
                    "confidence": 0,
                    "review_required": true
                },
                "Current Creditor": {
                    "value": "",
                    "position": [],
                    "confidence": 0,
                    "review_required": true
                },
                "Collection Agency": {
                    "value": "",
                    "position": [],
                    "confidence": 0,
                    "review_required": true
                },
                "Phone Number": {
                    "value": "",
                    "position": [],
                    "confidence": 0,
                    "review_required": true
                },
                "Online Payment URL": {
                    "value": "",
                    "position": [],
                    "confidence": 0,
                    "review_required": true
                }
            },
            "Creditor Payment Address": {
                "Address": {
                    "value": "",
                    "position": [],
                    "confidence": 0,
                    "review_required": true
                },
                "Address_Line_1": {
                    "value": "",
                    "position": [],
                    "confidence": 0,
                    "review_required": true
                },
                "Address_Line_2": {
                    "value": "",
                    "position": [],
                    "confidence": 0,
                    "review_required": true
                },
                "City": {
                    "value": "",
                    "position": [],
                    "confidence": 0,
                    "review_required": true
                },
                "State": {
                    "value": "",
                    "position": [],
                    "confidence": 0,
                    "review_required": true
                },
                "ZipCode": {
                    "value": "",
                    "position": [],
                    "confidence": 0,
                    "review_required": true
                }
            },
            "Payment Detail": {
                "First Payment Due Date": {
                    "value": "",
                    "position": [],
                    "confidence": 0,
                    "review_required": true
                },
                "Final Payment Due Date": {
                    "value": "",
                    "position": [],
                    "confidence": 0,
                    "review_required": true
                },
                "Total Payments Term": {
                    "value": "",
                    "position": [],
                    "confidence": 0,
                    "review_required": true
                }
            },
            "Error": {
                "Error Message": {
                    "value": "",
                    "position": [],
                    "confidence": 1.0,
                    "review_required": false
                }
            },
            "Payment Table": {
                "Line Item": [
                    {
                        "Date": {
                            "value": "",
                            "position": [],
                            "confidence": 0,
                            "review_required": true
                        },
                        "Amount": {
                            "value": "",
                            "position": [],
                            "confidence": 0,
                            "review_required": true
                        },
                        "No of Terms": {
                            "value": "",
                            "position": [],
                            "confidence": 0,
                            "review_required": true
                        },
                        "From Date": {
                            "value": "",
                            "position": [],
                            "confidence": 0,
                            "review_required": true
                        },
                        "To Date": {
                            "value": "",
                            "position": [],
                            "confidence": 0,
                            "review_required": true
                        }
                    }
                ]
            }
        }
    }