API Reference

Create Offers



Authentication: required

End to end service to provides initial offers and create prospect beneficiary based on the last 12 month sales

Authentication: required

This endpoint allows us to generate an offer based on the last twelve month sales data of a hashed customers

📘

At this stage customer information are hashed (unidentified) to avoid any confidentiality breaches with your customers

Leveraging on our powerful backend and alternative data we generate 3,000 simulations to predict the potential revenues scenarios of your customers and provide customized offers tailored made to the need of your clients.

Example of offer generated on your Platform

Example of an UI to be integrated into your customer journey

Example of an UI screen, you can design your own Screen!!!

Response body

Below is an example of the the body response (in JSON format) of this end point

Example of a Response body for this endpoint

{
  "BeneficiaryData": {
    "HashedID": "24b40ac30778469c969e5f2ed116bd7d",
    "Sector": "Restaurant",
    "monthlydata": [
      {"Period": "2023-01","Amount": 350000},
      {"Period": "2023-02","Amount": 360000},
      {"Period": "2023-03","Amount": 345000},
      {"Period": "2023-04","Amount": 370000},
      {"Period": "2023-05","Amount": 380000},
      {"Period": "2023-06","Amount": 365000},
      {"Period": "2023-07","Amount": 260000},
      {"Period": "2023-08","Amount": 275000},
      {"Period": "2023-09","Amount": 385000},
      {"Period": "2023-10","Amount": 390000},
      {"Period": "2023-11","Amount": 380000},
      {"Period": "2023-12","Amount": 400000}
    ]
  }
}

📘

Supported currencies

Alter-Mal only supports transactions in Saudi Riyals, other currencies will be available shortly

Example response of the API

{
   "result_1": "Beneficiary created with our reference unique ID",
   "Beneficiary_UID":" B-ebda9aae22094b15b9d1a41eb138a0e1",
  "OffersIO": "f07d445d0f3d4f6ba3c9a4756df7e412"
 
}

Offer Generations

If your customer is eligible for a loan , our engine will post on your callback webhook url the loan offers.

Noting that once information are updated in the Alter-Mal backend an automatic execution of a post process that generate webhook to inform you of the offers eligible for your customer

Example of webhook received:

🚧

Webhook setup

Please coordinate with Alter-Mal team to ensure that we receive the webhook based on your authentication requirements and please inform us of any updates on the URL when changed

Language
Credentials
Bearer
JWT
Click Try It! to start a request and see the response here!