Get SMS Variables

Get sms summary within N Months

GET https://ezloan.genify.ai/borrowers/horizons_summary/

Path Parameters

Name	Type	Description
borrower_uuid*	string	requested borrower UUID

Headers

Name	Type	Description
username*	string	registered username.
authorization*	string	api_key of the registered user.
months	integer	count of months. Default: 12

200: OK 12M/Default response

{
    "avg_monthly_spending": {
        "BDC": 16.67,
        "BM": 291.67,
        "HSBC": 166.67,
        "WELANDLINE": 45.0
    },
    "avg_spending": {
        "BDC": 200.0,
        "BM": 1750.0,
        "HSBC": 1000.0,
        "WELANDLINE": 270.0
    },
    "bank_avg_amount": 475.01,
    "banks_count": 5,
    "ecommerce_avg_amount": "N/A",
    "ecommerce_count": 2,
    "frequency": {
        "monthly_count": {
            "AMAZON": {
                "1": 1,
                "3": 1
            },
            "BDC": {
                "7": 1
            },
            "BM": {
                "1": 1,
                "3": 1
            },
            "HSBC": {
                "1": 1,
                "3": 1
            },
            "WELANDLINE": {
                "1": 1,
                "3": 1
            }
        },
        "yearly_count": {
            "AMAZON": 2,
            "BDC": 1,
            "BM": 2,
            "HSBC": 2,
            "WELANDLINE": 2
        }
    },
    "incoming_payments": {
        "loan_disbursement": {
            "AMAN": 5000.0
        },
        "other_incoming_payments": {
            "CIB": 15000.0
        },
        "salary": {
            "MASHREQ": 14002.29
        }
    },
    "liability_repayment": {},
    "outgoing_payments": {
        "BDC": 200.0,
        "BM": 3500.0,
        "HSBC": 2000.0
    },
    "purchased products": [
        "Laptop - LENOVO ideapad 320",
        "Laptop - LENOVO ideapad 320"
    ],
    "services": [
        "AMAZON",
        "BDC",
        "BM",
        "HSBC",
        "WELANDLINE"
    ],
    "services_categories": {
        "AMAZON": "E-commerce",
        "BDC": "Bank",
        "BM": "Bank",
        "HSBC": "Bank",
        "WELANDLINE": "Telecom"
    },
    "sms_info": 12,
    "spending_amount": {
        "WELANDLINE": 540.0
    },
    "telcos_avg_amount": 45.0,
    "telecos_count": 2,
    "total_avg_monthly_spending": 520.01,
    "total_spending": {
        "BDC": 200.0,
        "BM": 3500.0,
        "HSBC": 2000.0,
        "WELANDLINE": 540.0
    }
}

400: Bad Request No SMSs found

{
    "error message": "no SMSs found for borrower with uuid ff28cba8-ebf7-11ec-860e on the cloud."
}

400: Bad Request months number validation err msg

{
    "error message": "Please enter a valid count for months."
}