Overview

This documentation outlines the APIs required for AI voice agent integration.

Get Borrowers to Call API

Kastle can make this API Call every day to get a list of borrowers to call for welcome calls

Request

Endpoint: /get_borrowers

Method: POST

Headers:

• Content-Type: application/json

{
	"callType": "WELCOME",
	"fetchId": "string",
}

Response

// expected response
{
	"borrowers": [
		{
			"loanId": "string",
			"phoneNumber": "string",
			"loanAddedDate": "string",
			"prevServicer": "string",
			"nextPaymentAmount": "string",
			"paymentDueDate": "string",
			"propertyAddress": "string",
			"email": "string",
		},
		...
	]
}

Post Call Data Push API

Kastle can make this API call on a trigger (for eg: every hour) made to push data about the call to the servicer’s system

Request

Endpoint: /post_welcome_call

Method: POST

Headers: