Available Endpoints

Please find the below endpoints:

Root /

The root of the API redirects to the swagger documentation page of the API, The swagger documentation of the API is a highlevel detailed documentation for developers.

GET /

Example request:

curl "https://customsubdomain.tausi.africa/"

/score

Endpoint to retrieve particular scoring data for a particular customer id

This requires a body to have a particular ID for the specific customer scored.The body is required to have id, unless agreed otherwise.

POST /score

Example request:

curl -X 'POST' \
  'https://customsubdomain.tausi.africa/score' \
  -H 'accept: application/json' \
  -H 'X-Auth-Token: XXXXXXXXXXXXXX' \
  -H 'Content-Type: application/json' \
  -d '{
                'loan_date': '2019-12-02',
                'birth_date': '24-08-1974',
                'mobile_money_reg_date': '2012-05-10',
                'network_reg_date': '2001-02-19',
                'network_number': 156,
                'mobile_money_deposit_highest': 1000000,
                'mobile_money_send_highest': 272000,
                'mobile_money_withdraw_acceptors': 25 ,
                'cip_grade': 'XX'
            }'

Example response:

{
  "id": "XXXXXXXXXXXXXXXXXXXXXX",
  "credit_limit": 250000,
}

/scores

Endpoint for retrieving all scores and details.

GET /scores

Example request:

curl -X 'GET' \
  'https://customsubdomain.tausi.africa/scores' \
  -H 'accept: application/json' \
  -H 'X-Auth-Token: XXXXXXXXXXXXXXXX'

Example response:

[
  {
  "id": "XXXXXXXXXXXXXXXXXXX",
  "credit_limit": 250000,
  },
// ... other scores details
]

All endpoint requires X-Auth-Token key header authorization to be accessed.