Lending
Get loan details by ID
15min
get /loandetail/{id} use this call to retrieve specific collections for a specific loan (by id) you can retrieve all of the collections, or narrow down your request to retrieve only specific collections request url https // /loandetail/{id} the api response always returns the originalloaninfo (original details that were entered when the loan was created), and can also return other information therefore, if you made changes to a loan, it's easy to view and compare any of the changes you made to the loan to check the collections you've called, look at the fields in the path parameter that show after the equal (=) sign example in the response below, only results for fundingattempts and processedrails are returned, which in this case doesn't return any responses get /loandetail/{id}?fields=fundingattempts,processedrails loan collections a loan collection contains a specific set of results, in response to a query that you add to your call loan collections description loaninfoupdates array view all updates made to the loan to view a full list of the parameters returned, see loaninfoupdates below fundinginfoupdates array view all funding updates made to the loan to view a full list of the parameters returned, see fundinginfoupdates below failedloaninfoupdate array view information about a loan that failed to view a full list of the parameters returned, see failedloaninfoupdate below failedfundinginfoupdate array view information about the failed loan funding to view a full list of the parameters returned, see " failedfundinginfoupdate below processedrails array view the rails that were processed for a loan to view a full list of the parameters returned, go to funding your loan / payment rails fundingattempts array view the number of times funding was attempted to view a full list of the parameters returned, see fundingattempts below returnedrails array view the rails that were returned to view a full list of the parameters returned, go to funding your loan / payment rails statusupdates array view the status of the loan to view a full list of the parameters returned, go to status updates attachments array view the attachments that were submitted, or those that are missing to view a full list of the parameters returned, go to document reference requireddocs array view the documents that are required for the loan to view a full list of the parameters returned, go to document reference complianceloanresult array view the compliance status of the loan to view a full list of the parameters returned, go to compliance results adjustmentactions array view updates made to the loan after funding to view a full list of the parameters returned, go to adjustment action parameters requireddocs collection parameters this collection returns information about required documents and their received status for this loan attribute description documenttype one of the documents required for loan processing received confirms if a particular document was received receiveddate date the document was received status update parameters attribute description loanid string unique identifier for a loan status string loan status for more information, see enums timestamp string timestamp for the update dateinserted string timestamp when the status was entered (internal) complianceloanresult attributes this section displays the compliance results of a loan attribute description resultdate date of the result for the compliance check complianceruleresultlist list of compliance rules, specific to each mpl complianceruleresult parameters these are the fields of a compliance result of a loan for each specific rule if a rule failed, you can use these query parameters to check the data against the rule to see why it failed parameter description rulename string name of the compliance rule specific for every mpl rule string description of the compliance rule data string the actual data that was received for this loan in regards to this rule result string result of the compliance check true = passed false = failed you can run a loan through compliance a second time with one of these calls request a new payment rails (to update funding information) update a loan by id (to update loan information) add loan documents (to add attachments) fundingattempts this section displays the results of loan funding attribute description id string unique identifier for the loan funding information loanid string unique identifier for the loan time string time that the information was returned transactiongroupid string id for the transaction group fundingresult string indicates if the funding was successful amountfunded number indicates the amount funded loaninf oupdate collection parameters this collection returns information about any updates made to a loan attribute description loaninfoupdates unique identifier for the loan update updatedby string clerk who updated the loan updatedon datetime the date the loan was updated fundinginfoupdate collection parameters this collection returns information about any funding updates made to a loan attribute description loanid string unique identifier for the loan mplid string id of the mpl updatedby string clerk who updated the loan updatedon datetime the date the loan was updated rails list{railtransaction} click funding your loan / payment rails for a list of all rail types transactiongroupid string group id for the transaction fundingresult list of possible funding results success partialfailure fundingfailed see enums for more information amountfunded decimal dollar amount funded failedloaninfoupdate collection parameters this collection returns information about loan funding that failed attribute description failedloaninfoupdateid unique identifier of information about the failed loan updatedby string clerk who updated the loan updatedon datetime or null the date the loan was updated errormessages string error message failedfundinginfoupdate collection parameters this collection returns information about loan funding that failed attribute description errormessages string error message sample request in curl get /loandetail/{id} get loan details curl location request get 'https //arixapisandbox crbnj net/loandetail/f83f9c6f c187 4c53 a1c2 ac5800f1626d?fields=fundingattempts,processedrails,statusupdates,requireddocs,attachments,loaninfoupdates,compliance,returnedrails' \\ \ header 'accept application/json' \\ \ header 'authorization \<bearertoken>' \\ \ header 'cookie ss opt=temp; ss id=u1hu7zc2oofccyrj041c; ss pid=64srjkzopym2shfojzg7' \\ \ data raw '' sample response in json get /loandetail//{id} { "originalloaninfo" { "id" "f83f9c6f c187 4c53 a1c2 ac5800f1626d", "mplid" "tst", "date" "/date(1603031931240 0000)/", "loannumber" "dj 98dcf5dcb2c5407", "issuingbankid" "crb", "platform" "string", "loantype" "hfs", "notedate" "/date(1577768400000 0000)/", "borrowerlastname" "jacobi", "borrowerfirstname" "leonie", "borrowerdob" "/date(536389200000 0000)/", "borrowerssn" "841792974", "borroweraddress" "703 kacey court", "borrowercity" "new", "borrowerstate" "gu", "borrowerzip" "78383", "loanamount" 500 000000, "netfunding" 1300 000000, "rate" 0 050000, "apr" 10 000000, "batchid" "string", "borrowerphone" "919 959 8725", "borroweremail" "lilyan hackett\@gmail com", "amortization" 0, "term" 36, "ratetype" 0, "priorloanflag" "string", "fico" 10, "ficodate" "/date(1514696400000 0000)/", "creditgrade" "string", "assetclass" 0, "loanpurpose" "string", "investor" "string", "servicer" "string", "applicationdate" "/date(1603031931177 0000)/", "regbdecisiondate" "/date(1603031931177 0000)/", "purchasedate" "/date(1603252800000 0000)/", "paymentduedate" "/date(1608267600000 0000)/", "approvedloanamount" 0 000000, "periodicpayment" 0 000000, "originationfee" 100 000000, "homeownerflag" "string", "opencreditlines" 0, "annualincome" 0, "creditinquiries12months" 0, "dqpast24months" 0, "publicrecordsonfile" 0, "employmentlength" 0, "debtutilization" 0 000000, "totalrevolvingdebt" 0 000000, "accountsopenedpast24months" 0, "collectionsexcludingmedical" 0, "monthssincelastrecord" 0, "employer" "string", "dti" 0 000000, "mlaflag" "string", "mapr" "string", "receivername" "string", "samedayflag" 0, "addendarecord" "string", "coborrowerfirstname" "string", "coborrowerlastname" "string", "coborrowerdob" "/date(536389200000 0000)/", "coborrowerssn" "string", "coborroweraddress" "string", "coborrowercity" "string", "coborrowerstate" "string", "coborrowerzip" "string", "coborrowerphone" "string", "coborroweremail" "string", "coborrowerfico" 0, "merchantname" "string", "merchantfee" 0 000000, "refundamount" 0 000000, "adjustedloanamount" 0 000000, "adjustednetfunding" 0 000000, "adjustedoriginationfee" 0 000000, "adjustedcurrentmonthlypayment" 0 000000, "refunddate" "/date(1514696400000 0000)/", "adjustedmerchantfee" 0 000000, "finalpaymentdate" "/date(1618718400000 0000)/", "finalpayment" 0 000000, "financecharge" 0 000000, "totalpayments" 0 000000, "ppy" 0, "paymentfrequency" 0, "standardentrytypecode" "string", "interestaccrualmethoddays" 0, "subpoolid" "moe83", "program" "dtm", "field1" "string", "field2" "string", "field3" "string", "field4" "string", "field5" "string", "field6" "string", "field7" "string", "field8" "string", "field9" "string", "field10" "string", "field11" "string", "field12" "string", "field13" "string", "field14" "string", "field15" "string", "field16" "string", "field17" "string", "field18" "string", "field19" "string", "field20" "string", "rails" \[ { "achfields" { "standardentryclasscode" "ppd", "transactiontype" "push", "toroutingnumber" "021214891", "toaccounttype" "gl", "toaccountname" "test", "toaccountnumber" "9999999999", "description" "test" }, "id" "e6901e4f 75e3 4e86 a94f ac5800f1626d", "railtype" "cosach", "priority" 1, "amount" 300 0, "loanid" "f83f9c6f c187 4c53 a1c2 ac5800f1626d", "mplid" "tst", "issuingbankid" "crb", "isfailed" false, "loantype" "undefined" } ] }, "loaninfoupdates" \[], "processedrails" \[], "fundingattempts" \[], "returnedrails" \[], "statusupdates" \[ { "id" 1635439, "loanid" "f83f9c6f c187 4c53 a1c2 ac5800f1626d", "status" "received", "timestamp" "/date(1603031931243 0000)/", "dateinserted" "/date(1603031931327 0000)/" } ], "attachments" \[], "requireddocs" \[ { "documenttype" "loandocument", "received" false } ], "complianceloanresult" { "resultdate" "/date( 62135596800000 0000)/", "complianceruleresultlist" \[] } }