Webhooks
Lending
Webhook events
1min
these are sample notification events you receive after you've registered to receive those event types payload delivery wrapper when an event is sent in the form of a webhook, there will always be a wrapper around the content the actual event will be in the json's content section example loanstatusupdated event inside wrapper { "mplid" "tst", "ignore" false, "content" { "id" 0, "loanid" "c1ee19e4 791c 4f38 b581 ae6d007692a6", "status" 5, "timestamp" "2022 04 04t07 13 08 5754408+00 00", "dateinserted" "0001 01 01t00 00 00+00 00" } } attribute description mplid string a 3 letter id for the partner ignore boolean true or false content json this is the actual content of the event being sent events loanstatusupdated this event is reported every time the status of a loan is changed { "id" 0, "loanid" "18c8704f 2fd2 4474 9378 aeb5009e6dfd", "status" 3, "timestamp" "2022 06 15t09 36 52 8913255+00 00", "dateinserted" "0001 01 01t00 00 00+00 00" } attribute description loanid string unique identifier for the loan status integer enums of the loan timestamp datetime timestamp when the webhook was added dateinserted datetime internal cr information this can be ignored complianceloanfailed this event is reported every time the loan fails to pass all compliance checks { "mplid" "xxx", "loanid" " guid ", "createdate" "date", "failedrulesreasons" \[ { "rulename" "rule name", "rule" "some string", "data" "some string", "result" true, "failedcomplianceid" 67 } ] } attribute description eventdata object array mplid string 3 digit id for the mpl loanid string unique identifier for the loan createdate datetime date and time the compliance failed failedrulesreasons array rule name string name of the rule that failed rule string the psuedo code of the rule data string the actual data found in the loan tape/ attachments result boolean true or false true if the compliance rule passed, otherwise false failedcomplianceid integer id of failed rule railupdated this event is reported when there is a status update to a rail that was requested { "id" 0, "railid" "…id of the rail that is received when rail created…", "loanid" "fd331267 6ac2 4818 9d0f ab2f00747b61", "railtype" 8, "amountfunded" 8500, "railtransactionid" "…railid from funding provider…", "fundresult" int(this is enum railresulttype), "message" "description of rail created if no error returned", "processedat" "2022 07 25t03 25 50 7233333 04 00", "transactiongroupid" "00000000 0000 0000 0000 000000000000", "datecreated" "2022 07 25t07 25 47 283+00 00", "railamount" 8500 } attribute description id string 0 ignore railid string unique identifier of the rail loanid string unique identifier for the loan railtype integer enums docid\ dz0px cw5pyj2bqy9dftj representing the rail used railtransactionid string unique identifier of the transaction, received from the rail provider that arix is using for this rail type fundresult integer enums docid\ dz0px cw5pyj2bqy9dftj railresulttype representing the result of the funding message string update message processedat datetime timestamp of when the rail was processed on the payment processor, and received this fundresult status transactiongroupid string unique identifier for the transaction group internal cr information datecreated datetime timestamp of when the rail request was processed railamount integer rail amount requested from the payment processor loannoteadded this event is reported when a bank operator wants to send you a message about a specific loan this is a message from a human user { "subject" "your loan sellingtest 11112652056066 has additional comments", "message" "this is a note sent from the manual review ui", "createdby" "apollack, crb", "createdon" "2024 09 29t10 16 00 2828498", "loanid" "e9ad35a8 a9fa 4334 995d b1e800eb3e17", "loannumber" "sellingtest 11112652056066", "mpldetails" "tst testing mpl", "uri" "https //lendingappsandbox crbcos com/loans/underwrite?query=eyjsb2fucyi6eyjmawx0zxiiont9lcjzzwfyy2gionsic2vhcmnoijoiztlhzdm1ytgtytlmys00mzm0ltk5nwqtyjflodawzwizzte3in19lcj2awv3vhlwzsi6ikxvyw5zin0=", "rulename" null, "data" null } attribute description subject string the title of the note being added message string message sent from a human user createdby string the username that sent the message, along with the company they work for createdon datetime when the note was created loanid string unique crb identifier for the loan loannumber string unique identifier for the loan, as sent by the partner mpldetails string mplid and name of the partner uri s tring uri that links to the loan that was commented on, in the cos lending manual review ui this can only be opened in a whitelisted workstation rulename string internal cr information data s tring internal cr information loansalestatusupdated this event is reported when a loan sale status has changed the { "subject" "in process of being updated/this is not the final content", "message" "this is a note sent from the manual review ui", "createdby" "gagee, crb", "createdon" "2024 09 29t10 16 00 2828498", "loanid" "e9ad35a8 a9fa 4334 995d b1e800eb3e17", "loannumber" "sellingtest 11112652056066", "mpldetails" "tst testing mpl", "uri" "https //lendingappsandbox crbcos com/loans/underwrite?query=eyjsb2fucyi6eyjmawx0zxiiont9lcjzzwfyy2gionsic2vhcmnoijoiztlhzdm1ytgtytlmys00mzm0ltk5nwqtyjflodawzwizzte3in19lcj2awv3vhlwzsi6ikxvyw5zin0=", "rulename" null, "data" null } batchpurchasecompleted this message is sent when a batch purchase is completed in selling { "subject" "in process of being updated/this is not the final content", "message" "this is a note sent from the manual review ui", "createdby" "gagee, crb", "createdon" "2024 09 29t10 16 00 2828498", "loanid" "e9ad35a8 a9fa 4334 995d b1e800eb3e17", "loannumber" "sellingtest 11112652056066", "mpldetails" "tst testing mpl", "uri" "https //lendingappsandbox crbcos com/loans/underwrite?query=eyjsb2fucyi6eyjmawx0zxiiont9lcjzzwfyy2gionsic2vhcmnoijoiztlhzdm1ytgtytlmys00mzm0ltk5nwqtyjflodawzwizzte3in19lcj2awv3vhlwzsi6ikxvyw5zin0=", "rulename" null, "data" null }