Answers

Generate an Answer

POST
/core/aiservices/v4/{portalID}/answers

The Answers API allows enterprises to deliver fast, accurate, and contextual responses powered by their organizational knowledge. It supports two complementary approaches:

  • Certified Answers: Direct snippets retrieved from enterprise-authored content.
  • Generative Answers: Natural language responses synthesized by a large language model (LLM).

Every response includes supporting search results, references, and confidence scores—ensuring transparency, trust, and traceability. The API is built for secure, scalable integration across enterprise environments.

Authorization

accessToken
AuthorizationBearer <token>

JWT Bearer Token authentication for API access

In: header

Path Parameters

portalID*string

The ID of the portal being accessed.A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.

Match^[a-zA-Z0-9]{2,4}-\d{4,15}$
Length7 <= length <= 20

Query Parameters

q*string

The search query string.

Match^[\w\W]+$
Length2 <= length <= 1000
$filter[userProfileID]?string

The ID of the user profile.

Match^[a-zA-Z0-9]{2,4}-\d{4,15}$
Length7 <= length <= 20
$lang*string

The language that describes the details of a resource. Resources available in different languages may differ from each other.

Value in

  • "en-US"
  • "fr-FR"
  • "en-GB"
  • "es-ES"
  • "it-IT"
  • "nl-NL"
  • "da-DA"
  • "sv-SE"
  • "pt-PT"
  • "fi-FI"
  • "no-NB"
  • "no-NN"
  • "ja-JA"
  • "de-DE"
  • "pt-BR"
  • "zh-CN"
  • "zh-TW"
  • "ko-KO"
  • "ru-RU"
  • "el-EL"
  • "tr-TR"
  • "pl-PL"
  • "cs-CS"
  • "sk-SK"
  • "hu-HU"
  • "sr-SR"
  • "ar-SA"
  • "hr-HR"
  • "ro-RO"
  • "th-TH"
  • "xx-XX"
$filter[tags]?

An object where each key is a Category Tag ID (numeric string),
and each value is an array of Tag IDs for that category. Note:

  • The '$filter[tags]' query parameter JSON value should be url encoded.
  • Some developer tools for invoking APIs may not url encode the '$filter[tags]' query parameter JSON value by default. Ensure that only url encoded values are used.
  • Example of JSON value: {"BASE-40845":["BASE-40849","BASE-40853"]}
  • Example of URL encoded value: %7B%22BASE-40845%22%3A%5B%22BASE-40849%22%2C%22BASE-40853%22%5D%7D
Properties1 <= properties <= 20
$filter[topicIds]?array<>

An array of topic IDs. It is used to restrict search results to specific topics.

Items1 <= items <= 20

Request Body

application/json

channel?
eventId?string

Unique ID for this specific API call or event.

Match^[\w\W]*$
Lengthlength <= 255
clientSessionId?string

Session ID passed by the client for this specific API call or event.

Match^[\w\W]*$
Lengthlength <= 255
sessionId?string

eGain Session ID that ties multiple API calls to the same user session. Will be used as part of to tie events back to a session.

Match^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Lengthlength <= 255

Response Body

application/json

curl -X POST "https://example.com/core/aiservices/v4/PROD-1000/answers?q=What+is+a+loan%3F&%24lang=en-US&PROD-1234=PROD-2000%2CPROD-2003&PROD-2005=PROD-2007" \  -H "Content-Type: application/json" \  -d '{}'

Shows an generative answer to query in answer.answerValue.

{  "answer": {    "answerValue": "<p>A loan is a financial arrangement where a borrower receives money from a lender and agrees to repay it over time, usually with interest. For example, a mortgage loan is a type of loan used to purchase or refinance a home or real property, with payments typically spread over 10 to 30 years. The loan is secured by real estate, such as the borrower's primary residence.</p>",    "references": [      {        "id": "PROD-2575",        "name": "Glossary of Terms",        "docType": "HTML",        "source": "eGain Article"      }    ],    "answerType": "generative",    "relevanceScore": 0.9  },  "searchResults": [    {      "id": "PROD-2731",      "name": "What Does Loan Closing Mean?",      "docType": "HTML",      "source": "eGain Article",      "snippet": "Closing, generally, is when you sign your loan documents and become obligated on the mortgage loan, and, in a purchase transaction, when the seller signs documents to transfer you title to the property. The timing may depend on state laws and local practices.",      "snippetType": "chunks",      "normalizedScore": 0.8953199783507835,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1070",              "name": "Loans"            }          ]        }      ]    },    {      "id": "PROD-2680",      "name": "What Information Will I Need to Apply for a Loan?",      "docType": "HTML",      "source": "eGain Article",      "snippet": "Please have your personal information, annual income and any applicable collateral information available to apply.",      "snippetType": "chunks",      "normalizedScore": 0.8881018533023683,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1070",              "name": "Loans"            }          ]        }      ]    },    {      "id": "PROD-2679",      "name": "Can I have a Co-Signer?",      "docType": "HTML",      "source": "eGain Article",      "snippet": "Yes, A Co-Signer is someone who agrees to be responsible for someone else’s debt. If you cosign someone’s loan and that person doesn’t make payments on the loan or defaults, you’ll have to repay the loan.",      "snippetType": "chunks",      "normalizedScore": 0.8485992046672263,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1070",              "name": "Loans"            }          ]        }      ]    },    {      "id": "PROD-2679",      "name": "Can I have a Co-Signer?",      "docType": "HTML",      "source": "eGain Article",      "snippet": "Yes, A Co-Signer is someone who agrees to be responsible for someone else’s debt. If you cosign someone’s loan and that person doesn’t make payments on the loan or defaults, you’ll have to repay the loan.",      "snippetType": "chunks",      "normalizedScore": 0.8472550848151883,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1070",              "name": "Loans"            }          ]        }      ]    },    {      "id": "PROD-2679",      "name": "Can I have a Co-Signer?",      "docType": "HTML",      "source": "eGain Article",      "snippet": "Yes, A Co-Signer is someone who agrees to be responsible for someone else’s debt. If you cosign someone’s loan and that person doesn’t make payments on the loan or defaults, you’ll have to repay the loan.",      "snippetType": "chunks",      "normalizedScore": 0.8472550848151883,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1070",              "name": "Loans"            }          ]        }      ]    },    {      "id": "PROD-2681",      "name": "What is a Co-Signer? Requirements for a Co-Signer?",      "docType": "HTML",      "source": "eGain Article",      "snippet": "A co-signer is a person who is obligated to pay back the loan just as you, the borrower, are obligated to pay.",      "snippetType": "chunks",      "normalizedScore": 0.760438771174426,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1070",              "name": "Loans"            }          ]        }      ]    },    {      "id": "PROD-2732",      "name": "What is The Amortization Period?",      "docType": "HTML",      "source": "eGain Article",      "snippet": "This is the repayment period of a loan during which payments of both principal and interest are required to be made to pay down the balance on the loan according to the terms of the loan documents prior to its maturity date. The amortization period may vary by the loan product and whether the loan has an interest-only period. For example, a 30-year fixed rate mortgage loan, which requires principal and interest payments from the beginning, has a 30-year amortization period.",      "snippetType": "chunks",      "normalizedScore": 0.6721146426033902,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1070",              "name": "Loans"            }          ]        }      ]    },    {      "id": "PROD-2732",      "name": "What is The Amortization Period?",      "docType": "HTML",      "source": "eGain Article",      "snippet": "This is the repayment period of a loan during which payments of both principal and interest are required to be made to pay down the balance on the loan according to the terms of the loan documents prior to its maturity date. The amortization period may vary by the loan product and whether the loan has an interest-only period. For example, a 30-year fixed rate mortgage loan, which requires principal and interest payments from the beginning, has a 30-year amortization period.",      "snippetType": "chunks",      "normalizedScore": 0.6721146426033902,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1070",              "name": "Loans"            }          ]        }      ]    },    {      "id": "PROD-2575",      "name": "Glossary of Terms",      "docType": "HTML",      "source": "eGain Article",      "snippet": "# Glossary of Terms\n\nA | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z\n\n\n|  |  |\n| --- | --- |\n| A |  |\n| Account | A type of financial property or financial obligation that is held and owned under your name. When you open a financial account—whether it’s a checking account, savings account, CD or money market account—you have certain rights and responsibilities as an account holder. |\n| Account balance | The total amount of all funds in your account. |\n| ACH (Automated Clearing House) | ACH is a type of electronic funds transfer system that operates between banks, businesses and individual consumers in a nationwide network. Banks use ACH payments to move money between them. When you sign up for direct deposit of your paycheck at work, that money often moves into your bank account via ACH. |\n| Adjustable rate | A rate of interest that can vary during the term of the loan. Usually used when referring to mortgages. |\n| Annual percentage rate (APR) | The interest rate and fees or additional costs you’re charged per year for a loan or credit card. For you as a customer, a lower rate is always better. |\n| Annual percentage yield (APY) | The effective annual rate of return taking into account the compounding of interest on a savings, checking, CD or money market account. On this rate, the higher the better. |\n| APR (Annual Percentage Rate) | The total annualized cost of a loan. When you borrow money, whether it’s via a credit card, car loan or another loan, the lender is required to disclose the APR, so you understand the full cost of borrowing the money. |\n| APY (Annual Percentage Yield) | The annual yield earned on a deposit account, such as a savings, money market or CD account. Savers can use APY as one of several factors to help determine which savings options are the best. |\n| Assets | Any personal possessions of value. This also includes cash, real estate and investments. |\n| ATM (Automated Teller Machine) | A convenient location for basic banking transactions, such as withdrawing cash, depositing checks or making balance inquiries. Many banks offer access to a network of fee-free ATMs. |\n| ATM fees | Fees you’re charged for using an out-of-network ATM or exceeding a certain number of ATM transactions for your account, if limited. |\n| Auto loan | A loan for the purchase of a vehicle you pay off over time. This is more expensive than buying a car outright since you’re paying interest, but you also get to use the car while you’re paying for it. |\n| Automated clearing house (ACH) | The electronic network used to transfer money between accounts at different institutions. |\n| Automated Teller Machine (ATM) card | A card that gives you access to your account through an ATM. If it’s a debit card, it will also work at retailers. |\n",      "snippetType": "chunks",      "normalizedScore": 0.671025038404711,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1072",              "name": "Using Online Banking"            }          ]        }      ]    },    {      "id": "PROD-2575",      "name": "Glossary of Terms",      "docType": "HTML",      "source": "eGain Article",      "snippet": "# Glossary of Terms\n\nA | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z\n\n\n|  |  |\n| --- | --- |\n| A |  |\n| Account | A type of financial property or financial obligation that is held and owned under your name. When you open a financial account—whether it’s a checking account, savings account, CD or money market account—you have certain rights and responsibilities as an account holder. |\n| Account balance | The total amount of all funds in your account. |\n| ACH (Automated Clearing House) | ACH is a type of electronic funds transfer system that operates between banks, businesses and individual consumers in a nationwide network. Banks use ACH payments to move money between them. When you sign up for direct deposit of your paycheck at work, that money often moves into your bank account via ACH. |\n| Adjustable rate | A rate of interest that can vary during the term of the loan. Usually used when referring to mortgages. |\n| Annual percentage rate (APR) | The interest rate and fees or additional costs you’re charged per year for a loan or credit card. For you as a customer, a lower rate is always better. |\n| Annual percentage yield (APY) | The effective annual rate of return taking into account the compounding of interest on a savings, checking, CD or money market account. On this rate, the higher the better. |\n| APR (Annual Percentage Rate) | The total annualized cost of a loan. When you borrow money, whether it’s via a credit card, car loan or another loan, the lender is required to disclose the APR, so you understand the full cost of borrowing the money. |\n| APY (Annual Percentage Yield) | The annual yield earned on a deposit account, such as a savings, money market or CD account. Savers can use APY as one of several factors to help determine which savings options are the best. |\n| Assets | Any personal possessions of value. This also includes cash, real estate and investments. |\n| ATM (Automated Teller Machine) | A convenient location for basic banking transactions, such as withdrawing cash, depositing checks or making balance inquiries. Many banks offer access to a network of fee-free ATMs. |\n| ATM fees | Fees you’re charged for using an out-of-network ATM or exceeding a certain number of ATM transactions for your account, if limited. |\n| Auto loan | A loan for the purchase of a vehicle you pay off over time. This is more expensive than buying a car outright since you’re paying interest, but you also get to use the car while you’re paying for it. |\n| Automated clearing house (ACH) | The electronic network used to transfer money between accounts at different institutions. |\n| Automated Teller Machine (ATM) card | A card that gives you access to your account through an ATM. If it’s a debit card, it will also work at retailers. |\n",      "snippetType": "chunks",      "normalizedScore": 0.671025038404711,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1072",              "name": "Using Online Banking"            }          ]        }      ]    },    {      "id": "PROD-2575",      "name": "Glossary of Terms",      "docType": "HTML",      "source": "eGain Article",      "snippet": "# Glossary of Terms\n\nA | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z\n\n\n|  |  |\n| --- | --- |\n| A |  |\n| Account | A type of financial property or financial obligation that is held and owned under your name. When you open a financial account—whether it’s a checking account, savings account, CD or money market account—you have certain rights and responsibilities as an account holder. |\n| Account balance | The total amount of all funds in your account. |\n| ACH (Automated Clearing House) | ACH is a type of electronic funds transfer system that operates between banks, businesses and individual consumers in a nationwide network. Banks use ACH payments to move money between them. When you sign up for direct deposit of your paycheck at work, that money often moves into your bank account via ACH. |\n| Adjustable rate | A rate of interest that can vary during the term of the loan. Usually used when referring to mortgages. |\n| Annual percentage rate (APR) | The interest rate and fees or additional costs you’re charged per year for a loan or credit card. For you as a customer, a lower rate is always better. |\n| Annual percentage yield (APY) | The effective annual rate of return taking into account the compounding of interest on a savings, checking, CD or money market account. On this rate, the higher the better. |\n| APR (Annual Percentage Rate) | The total annualized cost of a loan. When you borrow money, whether it’s via a credit card, car loan or another loan, the lender is required to disclose the APR, so you understand the full cost of borrowing the money. |\n| APY (Annual Percentage Yield) | The annual yield earned on a deposit account, such as a savings, money market or CD account. Savers can use APY as one of several factors to help determine which savings options are the best. |\n| Assets | Any personal possessions of value. This also includes cash, real estate and investments. |\n| ATM (Automated Teller Machine) | A convenient location for basic banking transactions, such as withdrawing cash, depositing checks or making balance inquiries. Many banks offer access to a network of fee-free ATMs. |\n| ATM fees | Fees you’re charged for using an out-of-network ATM or exceeding a certain number of ATM transactions for your account, if limited. |\n| Auto loan | A loan for the purchase of a vehicle you pay off over time. This is more expensive than buying a car outright since you’re paying interest, but you also get to use the car while you’re paying for it. |\n| Automated clearing house (ACH) | The electronic network used to transfer money between accounts at different institutions. |\n| Automated Teller Machine (ATM) card | A card that gives you access to your account through an ATM. If it’s a debit card, it will also work at retailers. |\n",      "snippetType": "chunks",      "normalizedScore": 0.6703273067082975,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1072",              "name": "Using Online Banking"            }          ]        }      ]    },    {      "id": "PROD-2575",      "name": "Glossary of Terms",      "docType": "HTML",      "source": "eGain Article",      "snippet": "|  |  |\n| --- | --- |\n| Conditions | Also known as terms and conditions, this is the fine print of a bank account or loan agreement. Make sure you read and understand the implications of your financial accounts and obligations. |\n| Credit | An increase in a savings or checking account, such as a deposit made to the account. 2. A person or company’s ability to borrow money, with the expectation the money will be paid back in the future. |\n| Credit card | One of the most popular forms of credit, a card that allows you to spend up to a specific limit. Interest on the balance is assessed at the end of the monthly term, so to avoid paying any interest pay off your full balance each month. |\n| Credit limit | The maximum amount you’re allowed to charge on a credit card or HELOC. Once you’ve shown a habit of paying bills consistently on time, a lender may raise your credit limit—giving you more spending power. |\n| Credit rating | An evaluation of credit worthiness based on financial resources and credit history. Strictly speaking, ratings are usually applied to businesses or governments and expressed as a letter grade (A, B+, etc.) |\n| Credit score | In contrast to a credit rating, the credit score is a number (600, 700, etc.) indicating an individual's credit-worthiness. Credit bureaus look at factors such as your total debt, number of open accounts and whether you rent or own your home. A good credit score can result in a lower interest rate for loans. |\n| Credit/credit history/credit score | Credit generally refers to your ability to borrow—the willingness of banks and other lenders to extend a loan to you. If you have a strong credit history, that means you have a proven track record of paying bills on time and paying your debts. Your credit score is a measure of creditworthiness based, in part, on your credit history. Having a higher credit score can help you qualify for a lower interest on loans, better credit terms, larger loan amounts and higher credit limits. |\n| Current balance | The amount of funds in your account, including any pending activity. |\n| D |  |\n| Debit | A decrease in a savings or checking account, such as a withdrawal or a check written against the account. |\n| Debit card | An ATM card that allows you to pay for goods at stores or businesses, online, and at ATMs. A debit card draws the money from your checking account, in contrast to a credit card where you’re borrowing the money and have to pay it back later. |\n| Deposit | Funds added to your account. |\n| Direct deposit | An automatic deposit to your account made by your employer or an outside agency (such as a pension or government benefit payment). These are usually recurring and spare you the hassle of depositing a paper check. Online transfers are not considered direct deposits. |\n| E |  |\n| Early withdrawal penalty | A fee for withdrawing funds from an account—or closing it—before its maturity date. This applies to CDs and individual retirement accounts (IRAs). |\n| eBills | Electronic bills that are delivered directly to your online banking account for payment instead of being mailed to your home. |\n| Electronic check presentment (ECP) | An electronic image of a check that can be processed by banks and clearing houses instead of the actual paper check. |\n",      "snippetType": "chunks",      "normalizedScore": 0.5292205741674817,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1072",              "name": "Using Online Banking"            }          ]        }      ]    },    {      "id": "PROD-2575",      "name": "Glossary of Terms",      "docType": "HTML",      "source": "eGain Article",      "snippet": "|  |  |\n| --- | --- |\n| Home Equity Line of Credit (HELOC) | A line of credit based on the estimated value of your home, or on the amount of equity in your home. |\n| Home Equity Loan | A type of loan that uses the equity of your home as collateral. Typically, a home equity loan allows you to borrow a one-time lump-sum amount of money equal to or less than the equity you have in your home. |\n| I |  |\n| Indexed rate | The rate charged for an adjustable rate loan, such as a HELOC, mortgage or credit card. |\n| Insufficient funds | An account balance too low to cover a check presented for payment. Sometimes abbreviated as NSF for \"non-sufficient funds.\" |\n| Interest | The cost of borrowing money or the amount earned on a deposit account. To calculate simple interest, multiply the original amount (of your savings or your loan) by the interest rate. For compound interest, the interest is added to the total amount as it accumulates. |\n| Interest income | Your earnings on savings accounts, certificates of deposit and money markets. Banks or other organizations or individuals who pay interest usually report it on Form 1099-INT. |\n| Interest rate | The annual percentage paid on an interest-bearing savings account or CD, or the interest charged on loans. The interest paid on a deposit account is the \"annual percentage yield\" (APY) and the rate charged on a loan is the \"annual percentage rate\" (APR). |\n| Interest transfer | A process that allows interest earned on one account to be transferred to another account. For example, the interest earned on a CD can be transferred to a money market account. |\n| Investments | Investments are financial assets that are purchased and sold by investors, with the goal of earning a return on investment (ROI). Common types of investments include stocks, bonds, mutual funds, index funds, exchange traded funds and real estate. There are also various alternative investments like gold, commodities, fine art, wine and more. Unlike bank savings and checking accounts, investments are not FDIC insured and have a risk of loss. |\n| J |  |\n| Joint account | An account with two or more owners that own the account equally, with the same rights and obligations of using the account. For example, many married couples have a joint checking account that allows them both to write checks and make deposits into the same shared account. |\n| M |  |\n| Maturity date | This is the date of expiration for the contractual obligation of a financial instrument. For example, certificates of deposit have a maturity date that depends on the length of the CD term. When the CD matures, you have the option to withdraw the money. Some banks and credit unions also allow you to roll it into a new CD or enable the CD to renew automatically. |\n| Micro-deposits | Small deposits (usually a dollar or two) made to verify an account you’re trying to link. Once verified, you can use the account you’ve linked to your bank account for actions such as money transfers. Micro-deposits are usually reversed so there’s no permanent change in your balance. See also: EDV |\n| Minimum balance | The amount your average balance in a deposit account must stay above to avoid fees. |\n| Money market account | A high-yield savings account that’s FDIC-insured up to $250,000. In contrast to a CD, with a money market account, you can still have regular access to your funds. |\n",      "snippetType": "chunks",      "normalizedScore": 0.52916013291157,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1072",              "name": "Using Online Banking"            }          ]        }      ]    },    {      "id": "PROD-2575",      "name": "Glossary of Terms",      "docType": "HTML",      "source": "eGain Article",      "snippet": "|  |  |\n| --- | --- |\n| Home Equity Line of Credit (HELOC) | A line of credit based on the estimated value of your home, or on the amount of equity in your home. |\n| Home Equity Loan | A type of loan that uses the equity of your home as collateral. Typically, a home equity loan allows you to borrow a one-time lump-sum amount of money equal to or less than the equity you have in your home. |\n| I |  |\n| Indexed rate | The rate charged for an adjustable rate loan, such as a HELOC, mortgage or credit card. |\n| Insufficient funds | An account balance too low to cover a check presented for payment. Sometimes abbreviated as NSF for \"non-sufficient funds.\" |\n| Interest | The cost of borrowing money or the amount earned on a deposit account. To calculate simple interest, multiply the original amount (of your savings or your loan) by the interest rate. For compound interest, the interest is added to the total amount as it accumulates. |\n| Interest income | Your earnings on savings accounts, certificates of deposit and money markets. Banks or other organizations or individuals who pay interest usually report it on Form 1099-INT. |\n| Interest rate | The annual percentage paid on an interest-bearing savings account or CD, or the interest charged on loans. The interest paid on a deposit account is the \"annual percentage yield\" (APY) and the rate charged on a loan is the \"annual percentage rate\" (APR). |\n| Interest transfer | A process that allows interest earned on one account to be transferred to another account. For example, the interest earned on a CD can be transferred to a money market account. |\n| Investments | Investments are financial assets that are purchased and sold by investors, with the goal of earning a return on investment (ROI). Common types of investments include stocks, bonds, mutual funds, index funds, exchange traded funds and real estate. There are also various alternative investments like gold, commodities, fine art, wine and more. Unlike bank savings and checking accounts, investments are not FDIC insured and have a risk of loss. |\n| J |  |\n| Joint account | An account with two or more owners that own the account equally, with the same rights and obligations of using the account. For example, many married couples have a joint checking account that allows them both to write checks and make deposits into the same shared account. |\n| M |  |\n| Maturity date | This is the date of expiration for the contractual obligation of a financial instrument. For example, certificates of deposit have a maturity date that depends on the length of the CD term. When the CD matures, you have the option to withdraw the money. Some banks and credit unions also allow you to roll it into a new CD or enable the CD to renew automatically. |\n| Micro-deposits | Small deposits (usually a dollar or two) made to verify an account you’re trying to link. Once verified, you can use the account you’ve linked to your bank account for actions such as money transfers. Micro-deposits are usually reversed so there’s no permanent change in your balance. See also: EDV |\n| Minimum balance | The amount your average balance in a deposit account must stay above to avoid fees. |\n| Money market account | A high-yield savings account that’s FDIC-insured up to $250,000. In contrast to a CD, with a money market account, you can still have regular access to your funds. |\n",      "snippetType": "chunks",      "normalizedScore": 0.52916013291157,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1072",              "name": "Using Online Banking"            }          ]        }      ]    },    {      "id": "PROD-2575",      "name": "Glossary of Terms",      "docType": "HTML",      "source": "eGain Article",      "snippet": "|  |  |\n| --- | --- |\n| Home Equity Line of Credit (HELOC) | A line of credit based on the estimated value of your home, or on the amount of equity in your home. |\n| Home Equity Loan | A type of loan that uses the equity of your home as collateral. Typically, a home equity loan allows you to borrow a one-time lump-sum amount of money equal to or less than the equity you have in your home. |\n| I |  |\n| Indexed rate | The rate charged for an adjustable rate loan, such as a HELOC, mortgage or credit card. |\n| Insufficient funds | An account balance too low to cover a check presented for payment. Sometimes abbreviated as NSF for \"non-sufficient funds.\" |\n| Interest | The cost of borrowing money or the amount earned on a deposit account. To calculate simple interest, multiply the original amount (of your savings or your loan) by the interest rate. For compound interest, the interest is added to the total amount as it accumulates. |\n| Interest income | Your earnings on savings accounts, certificates of deposit and money markets. Banks or other organizations or individuals who pay interest usually report it on Form 1099-INT. |\n| Interest rate | The annual percentage paid on an interest-bearing savings account or CD, or the interest charged on loans. The interest paid on a deposit account is the \"annual percentage yield\" (APY) and the rate charged on a loan is the \"annual percentage rate\" (APR). |\n| Interest transfer | A process that allows interest earned on one account to be transferred to another account. For example, the interest earned on a CD can be transferred to a money market account. |\n| Investments | Investments are financial assets that are purchased and sold by investors, with the goal of earning a return on investment (ROI). Common types of investments include stocks, bonds, mutual funds, index funds, exchange traded funds and real estate. There are also various alternative investments like gold, commodities, fine art, wine and more. Unlike bank savings and checking accounts, investments are not FDIC insured and have a risk of loss. |\n| J |  |\n| Joint account | An account with two or more owners that own the account equally, with the same rights and obligations of using the account. For example, many married couples have a joint checking account that allows them both to write checks and make deposits into the same shared account. |\n| M |  |\n| Maturity date | This is the date of expiration for the contractual obligation of a financial instrument. For example, certificates of deposit have a maturity date that depends on the length of the CD term. When the CD matures, you have the option to withdraw the money. Some banks and credit unions also allow you to roll it into a new CD or enable the CD to renew automatically. |\n| Micro-deposits | Small deposits (usually a dollar or two) made to verify an account you’re trying to link. Once verified, you can use the account you’ve linked to your bank account for actions such as money transfers. Micro-deposits are usually reversed so there’s no permanent change in your balance. See also: EDV |\n| Minimum balance | The amount your average balance in a deposit account must stay above to avoid fees. |\n| Money market account | A high-yield savings account that’s FDIC-insured up to $250,000. In contrast to a CD, with a money market account, you can still have regular access to your funds. |\n",      "snippetType": "chunks",      "normalizedScore": 0.52916013291157,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1072",              "name": "Using Online Banking"            }          ]        }      ]    },    {      "id": "PROD-2575",      "name": "Glossary of Terms",      "docType": "HTML",      "source": "eGain Article",      "snippet": "|  |  |\n| --- | --- |\n| Conditions | Also known as terms and conditions, this is the fine print of a bank account or loan agreement. Make sure you read and understand the implications of your financial accounts and obligations. |\n| Credit | An increase in a savings or checking account, such as a deposit made to the account. 2. A person or company’s ability to borrow money, with the expectation the money will be paid back in the future. |\n| Credit card | One of the most popular forms of credit, a card that allows you to spend up to a specific limit. Interest on the balance is assessed at the end of the monthly term, so to avoid paying any interest pay off your full balance each month. |\n| Credit limit | The maximum amount you’re allowed to charge on a credit card or HELOC. Once you’ve shown a habit of paying bills consistently on time, a lender may raise your credit limit—giving you more spending power. |\n| Credit rating | An evaluation of credit worthiness based on financial resources and credit history. Strictly speaking, ratings are usually applied to businesses or governments and expressed as a letter grade (A, B+, etc.) |\n| Credit score | In contrast to a credit rating, the credit score is a number (600, 700, etc.) indicating an individual's credit-worthiness. Credit bureaus look at factors such as your total debt, number of open accounts and whether you rent or own your home. A good credit score can result in a lower interest rate for loans. |\n| Credit/credit history/credit score | Credit generally refers to your ability to borrow—the willingness of banks and other lenders to extend a loan to you. If you have a strong credit history, that means you have a proven track record of paying bills on time and paying your debts. Your credit score is a measure of creditworthiness based, in part, on your credit history. Having a higher credit score can help you qualify for a lower interest on loans, better credit terms, larger loan amounts and higher credit limits. |\n| Current balance | The amount of funds in your account, including any pending activity. |\n| D |  |\n| Debit | A decrease in a savings or checking account, such as a withdrawal or a check written against the account. |\n| Debit card | An ATM card that allows you to pay for goods at stores or businesses, online, and at ATMs. A debit card draws the money from your checking account, in contrast to a credit card where you’re borrowing the money and have to pay it back later. |\n| Deposit | Funds added to your account. |\n| Direct deposit | An automatic deposit to your account made by your employer or an outside agency (such as a pension or government benefit payment). These are usually recurring and spare you the hassle of depositing a paper check. Online transfers are not considered direct deposits. |\n| E |  |\n| Early withdrawal penalty | A fee for withdrawing funds from an account—or closing it—before its maturity date. This applies to CDs and individual retirement accounts (IRAs). |\n| eBills | Electronic bills that are delivered directly to your online banking account for payment instead of being mailed to your home. |\n| Electronic check presentment (ECP) | An electronic image of a check that can be processed by banks and clearing houses instead of the actual paper check. |\n",      "snippetType": "chunks",      "normalizedScore": 0.528856845715362,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1072",              "name": "Using Online Banking"            }          ]        }      ]    },    {      "id": "PROD-2575",      "name": "Glossary of Terms",      "docType": "HTML",      "source": "eGain Article",      "snippet": "|  |  |\n| --- | --- |\n| Conditions | Also known as terms and conditions, this is the fine print of a bank account or loan agreement. Make sure you read and understand the implications of your financial accounts and obligations. |\n| Credit | An increase in a savings or checking account, such as a deposit made to the account. 2. A person or company’s ability to borrow money, with the expectation the money will be paid back in the future. |\n| Credit card | One of the most popular forms of credit, a card that allows you to spend up to a specific limit. Interest on the balance is assessed at the end of the monthly term, so to avoid paying any interest pay off your full balance each month. |\n| Credit limit | The maximum amount you’re allowed to charge on a credit card or HELOC. Once you’ve shown a habit of paying bills consistently on time, a lender may raise your credit limit—giving you more spending power. |\n| Credit rating | An evaluation of credit worthiness based on financial resources and credit history. Strictly speaking, ratings are usually applied to businesses or governments and expressed as a letter grade (A, B+, etc.) |\n| Credit score | In contrast to a credit rating, the credit score is a number (600, 700, etc.) indicating an individual's credit-worthiness. Credit bureaus look at factors such as your total debt, number of open accounts and whether you rent or own your home. A good credit score can result in a lower interest rate for loans. |\n| Credit/credit history/credit score | Credit generally refers to your ability to borrow—the willingness of banks and other lenders to extend a loan to you. If you have a strong credit history, that means you have a proven track record of paying bills on time and paying your debts. Your credit score is a measure of creditworthiness based, in part, on your credit history. Having a higher credit score can help you qualify for a lower interest on loans, better credit terms, larger loan amounts and higher credit limits. |\n| Current balance | The amount of funds in your account, including any pending activity. |\n| D |  |\n| Debit | A decrease in a savings or checking account, such as a withdrawal or a check written against the account. |\n| Debit card | An ATM card that allows you to pay for goods at stores or businesses, online, and at ATMs. A debit card draws the money from your checking account, in contrast to a credit card where you’re borrowing the money and have to pay it back later. |\n| Deposit | Funds added to your account. |\n| Direct deposit | An automatic deposit to your account made by your employer or an outside agency (such as a pension or government benefit payment). These are usually recurring and spare you the hassle of depositing a paper check. Online transfers are not considered direct deposits. |\n| E |  |\n| Early withdrawal penalty | A fee for withdrawing funds from an account—or closing it—before its maturity date. This applies to CDs and individual retirement accounts (IRAs). |\n| eBills | Electronic bills that are delivered directly to your online banking account for payment instead of being mailed to your home. |\n| Electronic check presentment (ECP) | An electronic image of a check that can be processed by banks and clearing houses instead of the actual paper check. |\n",      "snippetType": "chunks",      "normalizedScore": 0.528856845715362,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1072",              "name": "Using Online Banking"            }          ]        }      ]    },    {      "id": "PROD-2575",      "name": "Glossary of Terms",      "docType": "HTML",      "source": "eGain Article",      "snippet": "|  |  |\n| --- | --- |\n| Minimum balance | The amount your average balance in a deposit account must stay above to avoid fees. |\n| Money market account | A high-yield savings account that’s FDIC-insured up to $250,000. In contrast to a CD, with a money market account, you can still have regular access to your funds. |\n| Mortgage loan | A loan used to purchase or refinance a home or real property, with payments usually spread over 10 to 30 years. It’s secured by real estate, such as the borrower's primary residence. |\n| Non-sufficient funds (NSF) | An account balance too low to cover a check presented for payment. |\n| Online bank | Online banks, also called digital or internet banks, operate primarily via the internet. You can manage your accounts at an online bank from a computer or mobile device from anywhere at any time. |\n| Overdraft | Something that occurs when you make a purchase with your debit card or write a check for an amount that exceeds your checking account’s available balance. Many bank accounts offer overdraft protection to help avoid overdraft fees. Some banks don’t charge overdraft fees at all. |\n| Overdraft protection | An arrangement made between you and your bank that allows you to withdraw more than the balance in your account without incurring any penalties. |\n| P |  |\n| Payee | A person or business to whom a check is written. |\n| Periodic rate | The interest rate over a specific period of time. A monthly periodic rate is the cost of credit per month. A daily periodic rate is the cost of credit per day, and so forth. |\n| Personal identification number (PIN) | A number issued with your debit or credit card so you can withdraw money from ATMs. To help prevent fraud, keep your PIN secret. A PIN should be memorized, never written down or disclosed to anyone else. |\n| Prime Rate | The interest rate that banks use to establish the indexed rate for certain loan products. The prime rate is published in The Wall Street Journal. |\n| Routing number | The first nine numbers that appear at the bottom of a check to identify the financial institution responsible for holding the account. Learn how to find a routing number on a check. |\n| S |  |\n| Savings account | An interest-bearing deposit account used for storing money, like an emergency fund. A savings account may have been your first experience with the banking industry. You have a number of options for where to stow your savings safely, both at banks and credit unions. |\n| Scheduled transfer | Moving money from one account to another on a regular recurring basis, often monthly. |\n| Secure Socket Layer (SSL) | A type of technology that protects your credit card and personal details when you shop or bank online. |\n| Service charge | A charge for a service or a penalty for not meeting certain requirements, such as insufficient funds in a checking account. |\n| Simple interest | Interest computed only on the principal balance, without compounding. |\n| Solvency | When banks have enough money to cover potential losses. Banks are expected to maintain a sufficient level of capital to remain solvent and avoid failure. The FDIC and other federal regulators work with banks to maintain standards for solvency. |\n",      "snippetType": "chunks",      "normalizedScore": 0.5201590697528378,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1072",              "name": "Using Online Banking"            }          ]        }      ]    },    {      "id": "PROD-2575",      "name": "Glossary of Terms",      "docType": "HTML",      "source": "eGain Article",      "snippet": "|  |  |\n| --- | --- |\n| Minimum balance | The amount your average balance in a deposit account must stay above to avoid fees. |\n| Money market account | A high-yield savings account that’s FDIC-insured up to $250,000. In contrast to a CD, with a money market account, you can still have regular access to your funds. |\n| Mortgage loan | A loan used to purchase or refinance a home or real property, with payments usually spread over 10 to 30 years. It’s secured by real estate, such as the borrower's primary residence. |\n| Non-sufficient funds (NSF) | An account balance too low to cover a check presented for payment. |\n| Online bank | Online banks, also called digital or internet banks, operate primarily via the internet. You can manage your accounts at an online bank from a computer or mobile device from anywhere at any time. |\n| Overdraft | Something that occurs when you make a purchase with your debit card or write a check for an amount that exceeds your checking account’s available balance. Many bank accounts offer overdraft protection to help avoid overdraft fees. Some banks don’t charge overdraft fees at all. |\n| Overdraft protection | An arrangement made between you and your bank that allows you to withdraw more than the balance in your account without incurring any penalties. |\n| P |  |\n| Payee | A person or business to whom a check is written. |\n| Periodic rate | The interest rate over a specific period of time. A monthly periodic rate is the cost of credit per month. A daily periodic rate is the cost of credit per day, and so forth. |\n| Personal identification number (PIN) | A number issued with your debit or credit card so you can withdraw money from ATMs. To help prevent fraud, keep your PIN secret. A PIN should be memorized, never written down or disclosed to anyone else. |\n| Prime Rate | The interest rate that banks use to establish the indexed rate for certain loan products. The prime rate is published in The Wall Street Journal. |\n| Routing number | The first nine numbers that appear at the bottom of a check to identify the financial institution responsible for holding the account. Learn how to find a routing number on a check. |\n| S |  |\n| Savings account | An interest-bearing deposit account used for storing money, like an emergency fund. A savings account may have been your first experience with the banking industry. You have a number of options for where to stow your savings safely, both at banks and credit unions. |\n| Scheduled transfer | Moving money from one account to another on a regular recurring basis, often monthly. |\n| Secure Socket Layer (SSL) | A type of technology that protects your credit card and personal details when you shop or bank online. |\n| Service charge | A charge for a service or a penalty for not meeting certain requirements, such as insufficient funds in a checking account. |\n| Simple interest | Interest computed only on the principal balance, without compounding. |\n| Solvency | When banks have enough money to cover potential losses. Banks are expected to maintain a sufficient level of capital to remain solvent and avoid failure. The FDIC and other federal regulators work with banks to maintain standards for solvency. |\n",      "snippetType": "chunks",      "normalizedScore": 0.5181809022102427,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1072",              "name": "Using Online Banking"            }          ]        }      ]    },    {      "id": "PROD-2575",      "name": "Glossary of Terms",      "docType": "HTML",      "source": "eGain Article",      "snippet": "|  |  |\n| --- | --- |\n| Minimum balance | The amount your average balance in a deposit account must stay above to avoid fees. |\n| Money market account | A high-yield savings account that’s FDIC-insured up to $250,000. In contrast to a CD, with a money market account, you can still have regular access to your funds. |\n| Mortgage loan | A loan used to purchase or refinance a home or real property, with payments usually spread over 10 to 30 years. It’s secured by real estate, such as the borrower's primary residence. |\n| Non-sufficient funds (NSF) | An account balance too low to cover a check presented for payment. |\n| Online bank | Online banks, also called digital or internet banks, operate primarily via the internet. You can manage your accounts at an online bank from a computer or mobile device from anywhere at any time. |\n| Overdraft | Something that occurs when you make a purchase with your debit card or write a check for an amount that exceeds your checking account’s available balance. Many bank accounts offer overdraft protection to help avoid overdraft fees. Some banks don’t charge overdraft fees at all. |\n| Overdraft protection | An arrangement made between you and your bank that allows you to withdraw more than the balance in your account without incurring any penalties. |\n| P |  |\n| Payee | A person or business to whom a check is written. |\n| Periodic rate | The interest rate over a specific period of time. A monthly periodic rate is the cost of credit per month. A daily periodic rate is the cost of credit per day, and so forth. |\n| Personal identification number (PIN) | A number issued with your debit or credit card so you can withdraw money from ATMs. To help prevent fraud, keep your PIN secret. A PIN should be memorized, never written down or disclosed to anyone else. |\n| Prime Rate | The interest rate that banks use to establish the indexed rate for certain loan products. The prime rate is published in The Wall Street Journal. |\n| Routing number | The first nine numbers that appear at the bottom of a check to identify the financial institution responsible for holding the account. Learn how to find a routing number on a check. |\n| S |  |\n| Savings account | An interest-bearing deposit account used for storing money, like an emergency fund. A savings account may have been your first experience with the banking industry. You have a number of options for where to stow your savings safely, both at banks and credit unions. |\n| Scheduled transfer | Moving money from one account to another on a regular recurring basis, often monthly. |\n| Secure Socket Layer (SSL) | A type of technology that protects your credit card and personal details when you shop or bank online. |\n| Service charge | A charge for a service or a penalty for not meeting certain requirements, such as insufficient funds in a checking account. |\n| Simple interest | Interest computed only on the principal balance, without compounding. |\n| Solvency | When banks have enough money to cover potential losses. Banks are expected to maintain a sufficient level of capital to remain solvent and avoid failure. The FDIC and other federal regulators work with banks to maintain standards for solvency. |\n",      "snippetType": "chunks",      "normalizedScore": 0.5181809022102427,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1072",              "name": "Using Online Banking"            }          ]        }      ]    },    {      "id": "PROD-2575",      "name": "Glossary of Terms",      "docType": "HTML",      "source": "eGain Article",      "snippet": "|  |  |\n| --- | --- |\n| Simple interest | Interest computed only on the principal balance, without compounding. |\n| Solvency | When banks have enough money to cover potential losses. Banks are expected to maintain a sufficient level of capital to remain solvent and avoid failure. The FDIC and other federal regulators work with banks to maintain standards for solvency. |\n| Surcharge | An amount charged by the owner of an ATM. This generally applies to out-of-network ATMs. |\n| T |  |\n| Term | The time to the maturity of a loan or deposit. For example, a CD can have a term from 3 to 60 months. |\n| Total value | The current worth of an account, including funds on hold or pending approval. |\n| V |  |\n| Variable rate | An interest rate that may fluctuate during the term of a loan, line of credit or deposit account. The new rate is sometimes determined by The Wall Street Journal prime rate. See also “adjustable rate” and “indexed rate.” |\n| W |  |\n| Wire transfer | An electronic payment service for transferring funds by wire. Wire transfers are guaranteed funds for the recipient, meaning the payment cannot be revoked by the sender after the transfer. A wire transfer typically involves paying a fee, depending on whether the transfer is incoming or outgoing and domestic or international. |\n",      "snippetType": "chunks",      "normalizedScore": 0.4720211674363051,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1072",              "name": "Using Online Banking"            }          ]        }      ]    },    {      "id": "PROD-2575",      "name": "Glossary of Terms",      "docType": "HTML",      "source": "eGain Article",      "snippet": "|  |  |\n| --- | --- |\n| Simple interest | Interest computed only on the principal balance, without compounding. |\n| Solvency | When banks have enough money to cover potential losses. Banks are expected to maintain a sufficient level of capital to remain solvent and avoid failure. The FDIC and other federal regulators work with banks to maintain standards for solvency. |\n| Surcharge | An amount charged by the owner of an ATM. This generally applies to out-of-network ATMs. |\n| T |  |\n| Term | The time to the maturity of a loan or deposit. For example, a CD can have a term from 3 to 60 months. |\n| Total value | The current worth of an account, including funds on hold or pending approval. |\n| V |  |\n| Variable rate | An interest rate that may fluctuate during the term of a loan, line of credit or deposit account. The new rate is sometimes determined by The Wall Street Journal prime rate. See also “adjustable rate” and “indexed rate.” |\n| W |  |\n| Wire transfer | An electronic payment service for transferring funds by wire. Wire transfers are guaranteed funds for the recipient, meaning the payment cannot be revoked by the sender after the transfer. A wire transfer typically involves paying a fee, depending on whether the transfer is incoming or outgoing and domestic or international. |\n",      "snippetType": "chunks",      "normalizedScore": 0.4720211674363051,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1072",              "name": "Using Online Banking"            }          ]        }      ]    },    {      "id": "PROD-2615",      "name": "Talk to a Banker - Home Loans",      "docType": "HTML",      "source": "eGain Article",      "snippet": "Whether you have questions about buying or refinancing a home, applying for or paying off a mortgage or home equity line of credit, or how the home lending process works in general, we've got answers.\n\nMake an appointment with a \\[Sample Company Name\\] Bank today by visiting \\[Sample Website Address\\] or by calling to talk to a Banker: \\[Sample Customer Service Phone Number\\] \\[Sample Text Based Phone Number\\]. Outside the U.S., call \\[Sample International Number\\].",      "snippetType": "chunks",      "normalizedScore": 0.45921719114211856,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1070",              "name": "Loans"            }          ]        }      ]    },    {      "id": "PROD-2997",      "name": "Discriminitatory Lending Practices",      "docType": "HTML",      "source": "eGain Article",      "snippet": "# What are some examples of discriminatory lending practices?\n\nA lender commits discriminatory lending practices when he or she acts in one or more of the following manners:\n\n- Refuses to make a mortgage loan on the basis of race, color, national origin, religion, sex, familial status, or disability; 7 8\n\n- Refuses to provide information regarding mortgage loans on the basis of race, color, national origin, religion, sex, familial status, or disability\n\n- Imposes different terms or conditions on a mortgage loan, such as different interest rates, points, or fees on the basis of race, color, national origin, religion, sex, familial status, or disability\n\n- Discriminates in appraising property on the basis of race, color, national origin, religion, sex, familial status, or disability\n\n- Steers an applicant toward a bad mortgage loan product on the basis of race, color, national origin, religion, sex, familial status, or disability\n\n- Provides inferior servicing of a mortgage loan on the basis of race, color, national origin, religion, sex, familial status, or disability\n\n# Can my bank officer commit lending discrimination?\n\nYes. Any lender, real estate and mortgage broker, appraiser, loan servicer, and title company can commit lending discrimination in any phase of the mortgage loan process. You should report any person, company, or entity attempting to violate your fair lending rights immediately to HUD or a state or local fair housing agency. (Refer to Red Tab, Reporting Lending Discrimination) \n\n# When does lending discrimination occur?\n\nWhether you are purchasing or refinancing a home, lending discrimination can occur at any stage of the lending process. For example, if a lender refuses to make a mortgage loan because of your race or ethnicity, or if a lender charges excessive fees to refinance your current mortgage loan based on your race or ethnicity, the lender is in violation of the federal Fair Housing Act. \n\n# What are some of the warning signs of lending discrimination?\n\nThe signs of lending discrimination may be blatant or subtle. They can occur in the marketing of mortgage loan products, mortgage loan transactions, terms and conditions of the loan, in the appraisal of a home, and in loan servicing.\n\nIn the marketing of mortgage loan products, be aware of:\n\n- Aggressive solicitations of adverse terms of credit to targeted minority neighborhoods, racial or ethnic groups, and communities\n\n- Racial steering to high cost lenders.\n\n- In the mortgage loan transaction, be aware of:\n\n- Requiring that women, but not men, provide a co-signer for a loan.\n\nIn the terms and conditions of the mortgage loan that are more often imposed upon borrowers of a certain race or nationality or upon women, be aware of: \n\n- Unnecessary closing costs\n\n- Inflated appraisal costs\n\n- Inflated broker or lender fees\n\n- Unnecessary recording fees\n\n- Excessive prepayment penalties\n\n- Changing mortgage loan terms at closing without the consent of the borrower.\n\nIn the appraisal of a home, be aware of properties that are undervalued because of the race or nationality of either the borrower or the other residents in the surrounding neighborhood.\n\nIn the servicing of the mortgage loan, be aware of:\n\n- Collection or foreclosure practices applied more harshly because of the race or nationality of either the borrower or the other residents in the surrounding neighborhood.",      "snippetType": "chunks",      "normalizedScore": 0.2830405804592237,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1080",              "name": "Banking Regulations"            }          ]        }      ]    },    {      "id": "PROD-2733",      "name": "What is the Difference Between Prequalification and Preapproval?",      "docType": "HTML",      "source": "eGain Article",      "snippet": "**Prequalification**\n\nThe Banker collects estimates of your income and liabilities to determine what mortgage products may be available to you and what you can afford to borrow. Our Mortgage Bankers can prequalify you by phone, in some cases. It normally takes 15 to 20 minutes and the applicant will receive a prequalification letter.\n\n**Preapproval**\n\nThis is a more thorough review of your creditworthiness. We verify not only your credit, but also your income, assets and liabilities. Further, you will need to submit documentation such as proof of income, assets and debt records. The process can take 20 minutes if you come prepared, or in some cases up to 2 business days.",      "snippetType": "chunks",      "normalizedScore": 0.18605361669534096,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1070",              "name": "Loans"            }          ]        }      ]    },    {      "id": "PROD-2583",      "name": "Using Zelle",      "docType": "HTML",      "source": "eGain Article",      "snippet": "# Using Zelle\n\nWith Zelle you can send money to friends, family and almost anyone you know and trust, no matter where they bank in the U.S.  \n\n# Why Use Zelle\n\nIt’s a fast and secure transfer where money is deposited directly into your recipient’s bank account typically within minutes. You can also request money from others using Zelle. \n\nYour recipient gets a request to send you money and you’ll receive the money within minutes after it’s sent.\n\n# Split Feature\n\nZelle comes with a handy Split feature that lets you easily divide expenses, making things like splitting dinner checks, settling up with roommates or paying your share of a group gift simple and easy.",      "snippetType": "chunks",      "normalizedScore": 0.18394147762849983,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1001",              "name": "Online Access"            },            {              "id": "PROD-1084",              "name": "Zelle"            }          ]        }      ]    },    {      "id": "PROD-2554",      "name": "Banking Regulations",      "docType": "HTML",      "source": "eGain Article",      "snippet": "U.S. banking regulation addresses privacy, disclosure, fraud prevention, anti-money laundering, anti-terrorism, anti-usury lending, and the promotion of lending to lower-income populations**.** Some individual cities also enact their own financial regulation laws (for example, defining what constitutes usurious lending).",      "snippetType": "chunks",      "normalizedScore": 0.16558712775547277,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1080",              "name": "Banking Regulations"            }          ]        }      ]    },    {      "id": "PROD-2577",      "name": "Short Description of Mobile Deposit",      "docType": "HTML",      "source": "eGain Article",      "snippet": "\\[Sample Company Name\\] deposit is secure and convenient. Deposit checks directly into your account using your mobile device.\n\n# How does mobile deposit work?\n\nMobile check deposit allows you to save time by depositing your checks remotely, no matter where you are or what time of day it is. Instead of making a run to the bank, you can simply snap a picture of the front and back of the check on your smartphone and deposit it using the bank's mobile app.",      "snippetType": "chunks",      "normalizedScore": 0.13648458089091964,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1066",              "name": "Checking and Savings Accounts"            }          ]        }      ]    },    {      "id": "PROD-2568",      "name": "Office of the Comptroller of the Currency (OCC) Banking Regulations",      "docType": "HTML",      "source": "eGain Article",      "snippet": "The OCC is the primary regulator of banks chartered under the National Bank Act (12 USC 1 et seq.) and federal savings associations chartered under the Home Owners' Loan Act of 1933 (12 USC 1461 et seq.). The OCC's regulations, derived from these acts, are in title 12 of the Code of Federal Regulations, \"Banks and Banking\" (12 CFR 1–199).\n\nThe OCC may take enforcement actions for violations of laws, rules or regulations, final orders or conditions imposed in writing; unsafe or unsound practices; and breach of fiduciary duty by institution-affiliated parties.\n\n- [OCC Bulletins](https://www.occ.treas.gov/news-issuances/bulletins/index.html)\n\n- [OCC Comptroller’s Handbook](https://www.occ.treas.gov/publications/publications-by-type/comptrollers-handbook/index-comptrollers-handbook.html)\n\n- [Part 2 - Sales of Credit Life Insurance](https://www.ecfr.gov/cgi-bin/text-idx?SID=224c14efa9422c576004740f04473ca0&tpl=/ecfrbrowse/Title12/12cfr2_main_02.tpl)\n\n- [Part 14 - Consumer Protection in Sales of Insurance](https://www.ecfr.gov/cgi-bin/text-idx?SID=224c14efa9422c576004740f04473ca0&tpl=/ecfrbrowse/Title12/12cfr14_main_02.tpl)\n\n- [Part 21 - Minimum Security Devices and Procedures, SAR & BSA Compliance Program](https://www.ecfr.gov/cgi-bin/text-idx?SID=224c14efa9422c576004740f04473ca0&tpl=/ecfrbrowse/Title12/12cfr21_main_02.tpl)\n\n- [Part 22 - Loans in Areas having Special Flood Hazards](https://www.ecfr.gov/cgi-bin/text-idx?SID=224c14efa9422c576004740f04473ca0&tpl=/ecfrbrowse/Title12/12cfr22_main_02.tpl)\n\n- [Part 25 - Community Reinvestment Act (CRA)](https://www.ecfr.gov/cgi-bin/text-idx?SID=224c14efa9422c576004740f04473ca0&tpl=/ecfrbrowse/Title12/12cfr25_main_02.tpl)\n\n- [Part 32 - Lending Limits](https://www.ecfr.gov/cgi-bin/text-idx?SID=224c14efa9422c576004740f04473ca0&tpl=/ecfrbrowse/Title12/12cfr32_main_02.tpl)\n\n- [Part 34 - Real Estate Lending and Appraisals](https://www.ecfr.gov/cgi-bin/text-idx?SID=224c14efa9422c576004740f04473ca0&tpl=/ecfrbrowse/Title12/12cfr34_main_02.tpl)",      "snippetType": "chunks",      "normalizedScore": 0.13457933361485352,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1080",              "name": "Banking Regulations"            }          ]        }      ]    },    {      "id": "PROD-2766",      "name": "How Do I Apply for a Credit Card?",      "docType": "HTML",      "source": "eGain Article",      "snippet": "You can apply online for our <c/cName#1> and <c/cName#2> by going to _**Compare Credit Cards**_ and clicking **\"Apply Now\"** next to the card you want. Alternatively, you can apply by calling \\[Sample Customer Service Phone Number\\] \\[Sample Credit Card Extension\\] /  \\[Sample Text Based Phone Number\\], Mon–Fri 7 am–5 pm PT.  To apply for the Secured Credit Card, visit your local branch.",      "snippetType": "chunks",      "normalizedScore": 0.1103068233378137,      "topicBreadcrumb": [        {          "topicSummary": [            {              "id": "PROD-1066",              "name": "Checking and Savings Accounts"            },            {              "id": "PROD-1068",              "name": "Credit Cards"            }          ]        }      ]    }  ],  "channel": {    "type": "custom",    "name": "Eight Bank Website"  },  "sessionId": "6154589f-b43f-4471-b2c7-92c6c888a791",  "eventId": "615458"}

Retrieve Chunks POST

The Retrieve API enables enterprises to directly access relevant content chunks from their organizational knowledge sources. It is designed for scenarios where developers want granular control over retrieved information, such as powering custom search, analytics, or retrieval-augmented generation (RAG) pipelines. The Retrieve API's response will either be a Certified Answer or a list of chunks. - **Certified Answers Response**: This response is observed when there's a matching certified answer to the user's query. - **Chunk List Response**: This response is observed, if there is no matched Certified Answer. Responses for both chunks and certified answers include relevance scores and metadata. By leveraging the Retrieve API, organizations can build tailored experiences while retaining confidence in the source material.

Create Import Job POST

# Import Content ## Overview This API initiates a bulk content import operation from Data Sources. It creates an asynchronous import job that processes content in the background, allowing you to import large volumes of content without blocking your application. ## Pre-requisties 1. Content in Data Source needs to be in this format: [Guide to Data Import Format](https://apidev.egain.com/developer-portal/guides/ingestion/data-import-format-guide/) ## How It Works 1. **Job Creation**: The API creates an import job and returns a unique job ID 2. **Content Processing**: Content is processed asynchronously in the background 3. **Status Monitoring**: Use the job ID to monitor progress via the Status API 4. **Completion**: Job completes when all content is processed or errors occur **Note:** After a successful import, please allow for a brief delay before the content is fully available for use. The system's search service synchronizes all new and updated content every 30 minutes. ## Supported Operations - **Import**: Add new content to the knowledge base - **Update**: Modify existing content ## Data Source Types - AWS S3 bucket - Shared file path ## Best Practices - **Scheduling**: Use scheduleTime for off-peak imports to minimize system impact. Please note that jobs can only be scheduled for a maximum of 7 days from the current date and time. - **Monitoring**: Regularly check job status and logs for any issues - **Error Handling**: Review failed items and retry with corrections ## Job Timing Controls - **scheduleTime.stopDate**: Defines a specific date time to cease operations regardless of progress (e.g., "Stop exactly at 5:00 PM").