Get Credit Score

Get Borrower's Total Score

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

This endpoint allows you to calculate a borrowers credit score. you have to send one of the following parameters with the request: phone_number, email, national_id, id

Query Parameters

Name	Type	Description
phone_number	string	phone number of applicant whose score you want to get.
email	string	Email of applicant whose score you want to get.
national_id	string	national ID of applicant whose score you want to get.
id	number	applicant's ID in the DB table.
evaluate_by*	string	type of formula used for calculations. options: rule or model
uuid*	string	borrower's UUID. (If not specified then you have to fill one of query parameters.)

Headers

Name	Type	Description
authorization*	string	partner's api key
user_name*	String	partner's name

Request Body

Name	Type	Description
acceptance_rules*	list<string>	list of acceptance rules that will be applied on that borrower.
rejection_rules	list<string>	list of rejection rules that will be applied on that borrower.

200: OK credit Score calculated successfully

{
    "DBR": "N/A",
    "ID_is_valid": "N/A",
    "age": "N/A",
    "area": "N/A",
    "certainty": "N/A",
    "credit_score": 569,
    "credit_score_classification": "N/A",
    "estimated_income": "N/A",
    "full_name": "01279955501 - first name 01279955501 - last name",
    "gender": "N/A",
    "list_of_credit_applications": "N/A",
    "monthly_debt": "N/A",
    "monthly_spending_capacity": "N/A",
    "national_id": "N/A",
    "number_of_credit_applications": "N/A",
    "pass_business_rules_state": true,
    "reports": "N/A",
    "uploaded docs": "N/A"
}

400: Bad Request Missing parameters.

"Please provide the user ID, phone number, national_id, or email for a user to get his records."

404: Not Found Borrower you queried for isn't found in database.

{
  "Borrower doesn’t exist"
}

500: Internal Server Error Error on our end, try again later.

{
  "Something went wrong, please try again"
}

400: Bad Request no access to model

"Partner does not have access to this model."

Get Borrowers Batch Total Score

GET https://ezloan.genify.ai/borrowers/get_total_score/batch/

Headers

Name	Type	Description
user_name*	string	partner's name
authorization	string	partner's api key

Request Body

Name	Type	Description
acceptance_rules*	list<string>	list of acceptance rules that will be applied on that borrower.
rejection_rules	list<string>	list of rejection rules that will be applied on that borrower.
target*	list<string>	list of UUIDs of the requested borrowers.

200: OK success

{
    "ec38e1ea-b984-11ec-81a5-0242ac180003": {
        "DBR": 4000,
        "ID_is_valid": true,
        "age": 24,
        "area": 1,
        "certainty": 0.8378378378378378,
        "credit_score": 150,
        "credit_score_classification": "Very Poor",
        "estimated_income": 0,
        "full_name": "ismail sharkawy",
        "gender": "Male",
        "list_of_credit_applications": [],
        "monthly_debt": 4000,
        "monthly_spending_capacity": -7669,
        "national_id": 29803020103973,
        "number_of_credit_applications": 0,
        "pass_business_rules_state": null,
        "reports": 0,
        "uploaded docs": null
    },
    "ec38e1ea-b984-11ec-81a5-0242ac180004": {
        "DBR": 4000,
        "ID_is_valid": true,
        "age": 24,
        "area": 1,
        "certainty": 0.8378378378378378,
        "credit_score": 638,
        "credit_score_classification": "Fair",
        "estimated_income": 0,
        "full_name": "ismail sharkawy",
        "gender": "Male",
        "list_of_credit_applications": [],
        "monthly_debt": 4000,
        "monthly_spending_capacity": -7669,
        "national_id": 29803020103974,
        "number_of_credit_applications": 0,
        "pass_business_rules_state": true,
        "reports": 0,
        "uploaded docs": null
    }
}