Skip to main content

Submit Heartbeat Event

Submit Hearbeat event to the service

Request Body REQUIRED
event object REQUIRED
timestamp int64 REQUIRED
eventType string REQUIRED

Possible values: [CREATE_LOAN_APPLICATION_REQUEST, CREATE_LOAN_APPLICATION_REQUEST_ACK, CREATE_LOAN_APPLICATIONS_RESPONSE, CREATE_LOAN_APPLICATIONS_RESPONSE_ACK, CONSENT_HANDLE_REQUEST, CONSENT_HANDLE_REQUEST_ACK, CONSENT_HANDLE_RESPONSE, CONSENT_HANDLE_RESPONSE_ACK, CONSENT_HANDLE_STATUS_REQUEST, CONSENT_HANDLE_STATUS_REQUEST_ACK, CONSENT_HANDLE_STATUS_RESPONSE, CONSENT_HANDLE_STATUS_RESPONSE_ACK, GENERATE_OFFERS_REQUEST, GENERATE_OFFERS_REQUEST_ACK, GENERATE_OFFERS_RESPONSE, GENERATE_OFFERS_RESPONSE_ACK, SEND_ADDITIONAL_DOCUMENTS_REQUEST, SEND_ADDITIONAL_DOCUMENTS_REQUEST_ACK, SEND_ADDITIONAL_DOCUMENTS_RESPONSE, SEND_ADDITIONAL_DOCUMENTS_RESPONSE_ACK, GET_ADDITIONAL_PLEDGED_DOCUMENTS_REQUEST, GET_ADDITIONAL_PLEDGED_DOCUMENTS_REQUEST_ACK, GET_ADDITIONAL_PLEDGED_DOCUMENTS_RESPONSE, GET_ADDITIONAL_PLEDGED_DOCUMENTS_RESPONSE_ACK, SET_OFFERS_REQUEST, SET_OFFERS_REQUEST_ACK, SET_OFFERS_RESPONSE, SET_OFFERS_RESPONSE_ACK, GET_KYC_METHODS_REQUEST, GET_KYC_METHODS_REQUEST_ACK, GET_KYC_METHODS_RESPONSE, GET_KYC_METHODS_RESPONSE_ACK, KYC_STATUS_REQUEST, KYC_STATUS_REQUEST_ACK, KYC_STATUS_RESPONSE, KYC_STATUS_RESPONSE_ACK, TRIGGER_KYC_REQUEST, TRIGGER_KYC_REQUEST_ACK, TRIGGER_KYC_RESPONSE, TRIGGER_KYC_RESPONSE_ACK, LOAN_AGREEMENT_REQUEST, LOAN_AGREEMENT_REQUEST_ACK, LOAN_AGREEMENT_RESPONSE, LOAN_AGREEMENT_RESPONSE_ACK, TRIGGER_LOAN_ACCEPTANCE_REQUEST, TRIGGER_LOAN_ACCEPTANCE_REQUEST_ACK, TRIGGER_LOAN_ACCEPTANCE_RESPONSE, TRIGGER_LOAN_ACCEPTANCE_RESPONSE_ACK, VERIFY_LOAN_ACCEPTANCE_REQUEST, VERIFY_LOAN_ACCEPTANCE_REQUEST_ACK, VERIFY_LOAN_ACCEPTANCE_RESPONSE, VERIFY_LOAN_ACCEPTANCE_RESPONSE_ACK, GRANT_LOAN_REQUEST, GRANT_LOAN_REQUEST_ACK, GRANT_LOAN_RESPONSE, GRANT_LOAN_RESPONSE_ACK, SET_REPAYMENT_PLAN_REQUEST, SET_REPAYMENT_PLAN_REQUEST_ACK, SET_REPAYMENT_PLAN_RESPONSE, SET_REPAYMENT_PLAN_RESPONSE_ACK, LOAN_REPAYMENT_RESP_ACK, SET_DISBURSEMENT_ACCOUNT_REQUEST, SET_DISBURSEMENT_ACCOUNT_REQUEST_ACK, SET_DISBURSEMENT_ACCOUNT_RESPONSE, SET_DISBURSEMENT_ACCOUNT_RESPONSE_ACK, TRIGGER_DISBURSEMENT_REQUEST, TRIGGER_DISBURSEMENT_REQUEST_ACK, TRIGGER_DISBURSEMENT_RESPONSE, TRIGGER_DISBURSEMENT_RESPONSE_ACK, TRIGGER_DISBURSEMENT_STATUS_REQUEST, TRIGGER_DISBURSEMENT_STATUS_REQUEST_ACK, TRIGGER_DISBURSEMENT_STATUS_RESPONSE, TRIGGER_DISBURSEMENT_STATUS_RESPONSE_ACK, TRIGGER_REPAYMENT_REQUEST, TRIGGER_REPAYMENT_REQUEST_ACK, TRIGGER_REPAYMENT_RESPONSE, TRIGGER_REPAYMENT_RESPONSE_ACK, CONFIRM_REPAYMENT_REQUEST, CONFIRM_REPAYMENT_REQUEST_ACK, REPAYMENT_CONDITION_CHANGE_REQUEST, REPAYMENT_CONDITION_CHANGE_REQUEST_ACK, REPAYMENT_CONDITION_CHANGE_RESPONSE, REPAYMENT_CONDITION_CHANGE_RESPONSE_ACK, GET_LOANS_REQUEST, GET_LOANS_REQUEST_ACK, GET_LOANS_RESPONSE, GET_LOANS_RESPONSE_ACK, LIST_LOANS_REQUEST, LIST_LOANS_REQUEST_ACK, LIST_LOANS_RESPONSE, LIST_LOANS_RESPONSE_ACK, LOAN_STATEMENT_REQUEST, LOAN_STATEMENT_REQUEST_ACK, LOAN_STATEMENT_RESPONSE, LOAN_STATEMENT_RESPONSE_ACK, LOAN_SUMMARY_REQUEST, LOAN_SUMMARY_REQUEST_ACK, LOAN_SUMMARY_RESPONSE, LOAN_SUMMARY_RESPONSE_ACK]

Heartbeat Event Types

requestId string REQUIRED
loanMetaData object REQUIRED

Information about the Loan

loanApplicationId string REQUIRED
loanId string REQUIRED
productData object REQUIRED
productId string REQUIRED
productNetworkId string REQUIRED
recipients object[] REQUIRED

Information to whom request was sent to and the response received with message

roleId string REQUIRED
responseCode int32 REQUIRED
responseMessage string REQUIRED
Responses
200

Success

Schema OPTIONAL
message string OPTIONAL
timestamp int64 OPTIONAL
errorCode string OPTIONAL
400

Bad Request

Schema OPTIONAL
message string OPTIONAL
timestamp int64 OPTIONAL
errorCode string OPTIONAL
401

Unauthenticated

Schema OPTIONAL
message string OPTIONAL
timestamp int64 OPTIONAL
errorCode string OPTIONAL
403

Unauthorised

Schema OPTIONAL
message string OPTIONAL
timestamp int64 OPTIONAL
errorCode string OPTIONAL
500

Internal Server Error

Schema OPTIONAL
message string OPTIONAL
timestamp int64 OPTIONAL
errorCode string OPTIONAL