Create and update a loan (new format)

post /loan and put /loan/{id} use these calls to create and update a loan request in arix request url https // post/loan request url https // put/loan/{id} when you update a loan with put/loan , use a loanupdate object the attributes for a loanupdate object are the same as those used in the loan object, when you call post/loan the api block below is the reference information for the api attributes you can use when you create a loan they are the same attributes that show when you receive a response the same attributes are used for the update a loan request put /loan/{id} post /loan use this call to create a loan request in arix name endpoint loan method post url https arixapisandbox crbnj net loan description allows you to create a new loan by making an http post request to the specified url the request should include various details such as loan number borrower information loan amount net funding interest rate and other relevant loan parameters additionally the request can include information about different payment fields for rails tab examples examples languages id uo5lpxxaa6xbk3bcvebmm language curl code n loan n loannumber loannumber n issuingbankid crb n platform string n loantype 1 n notedate 2019 12 31 n borrowerlastname waters n borrowerfirstname therese n borrowerdob 1986 12 31 n borrowerssn borrowerssn n borroweraddress borroweraddress n borrowercity davisshire n borrowerstate borrowerstate n borrowerzip borrowerzip n loanamount 1500 n netfunding 1300 n rate 0 2 n apr 10 n batchid string n borrowerphone 959 390 4893 n borroweremail mara howell hotmail com n amortization 0 n term 36 n ratetype 0 n priorloanflag string n fico 10 n ficodate 2017 12 31 n creditgrade string n assetclass 0 n loanpurpose string n investor string n servicer string n applicationdate applicationdate n regbdecisiondate regbdecisiondate n purchasedate purchasedate n paymentduedate paymentduedate n approvedloanamount 0 n periodicpayment 0 n originationfee 100 n homeownerflag string n opencreditlines 0 n annualincome 0 n creditinquiries12months 0 n dqpast24months 0 n publicrecordsonfile 0 n employmentlength 0 n debtutilization 0 n totalrevolvingdebt 0 n accountsopenedpast24months 0 n collectionsexcludingmedical 0 n monthssincelastrecord 0 n employer string n dti 0 n mlaflag string n mapr string n receivername string n samedayflag 0 n addendarecord string n coborrowerfirstname string n coborrowerlastname string n coborrowerdob 1986 12 31 n coborrowerssn string n coborroweraddress string n coborrowercity string n coborrowerstate string n coborrowerzip string n coborrowerphone string n coborroweremail string n coborrowerfico 0 n merchantname string n merchantfee 0 n refundamount 0 n adjustedloanamount 0 n adjustednetfunding 0 n adjustedoriginationfee 0 n adjustedcurrentmonthlypayment 0 n refunddate 2017 12 31 n adjustedmerchantfee 0 n finalpaymentdate finalpaymentdate n finalpayment 0 n financecharge 0 n totalpayments 0 n ppy 0 n paymentfrequency 0 n standardentrytypecode string n interestaccrualmethoddays 0 n subpoolid moe83 n program dtm n field1 string n field2 string n field3 string n field4 string n field5 string n field6 string n field7 string n field8 string n field9 string n field10 string n field11 string n field12 string n field13 string n field14 string n field15 string n field16 string n field17 string n field18 string n field19 string n field20 string n t rails n n achfields n standardentryclasscode ppd n transactiontype push n toroutingnumber 021214891 n toaccounttype checking n toaccountname anita loan n toaccountnumber 9999999999 n description loanfunds n n railtype cosach n priority 1 n amount 100 n n n n customlabel selectedlanguageid uo5lpxxaa6xbk3bcvebmm results languages id g8caxfjudx1ebndjof8qn language 200 customlabel code n id bd054ec9 8598 497e ac2d ac5400bbbf3e n mplid tst n date date 1602674613963 0400 n loannumber mz 1afc220c66ed4ad n issuingbankid crb n platform string n loantype hfs n notedate date 1577768400000 0500 n borrowerlastname emard n borrowerfirstname darrion n borrowerdob date 536389200000 0500 n borrowerssn 640517072 n borroweraddress 8652 vonrueden walks n borrowercity east n borrowerstate lv n borrowerzip 30878 n loanamount 500 n netfunding 1300 n rate 0 05 n apr 10 n batchid string n borrowerphone 323 514 0396 n borroweremail helga hoeger14 gmail com n amortization 0 n term 36 n ratetype 0 n priorloanflag string n fico 10 n ficodate date 1514696400000 0500 n creditgrade string n assetclass 0 n loanpurpose string n investor string n servicer string n applicationdate date 1602674613934 0400 n regbdecisiondate date 1602674613934 0400 n purchasedate date 1602907200000 0400 n paymentduedate date 1607922000000 0500 n approvedloanamount 0 n periodicpayment 0 n originationfee 100 n homeownerflag string n opencreditlines 0 n annualincome 0 n creditinquiries12months 0 n dqpast24months 0 n publicrecordsonfile 0 n employmentlength 0 n debtutilization 0 n totalrevolvingdebt 0 n accountsopenedpast24months 0 n collectionsexcludingmedical 0 n monthssincelastrecord 0 n employer string n dti 0 n mlaflag string n mapr string n receivername string n samedayflag 0 n addendarecord string n coborrowerfirstname string n coborrowerlastname string n coborrowerdob date 536389200000 0500 n coborrowerssn string n coborroweraddress string n coborrowercity string n coborrowerstate string n coborrowerzip string n coborrowerphone string n coborroweremail string n coborrowerfico 0 n merchantname string n merchantfee 0 n refundamount 0 n adjustedloanamount 0 n adjustednetfunding 0 n adjustedoriginationfee 0 n adjustedcurrentmonthlypayment 0 n refunddate date 1514696400000 0500 n adjustedmerchantfee 0 n finalpaymentdate date 1618372800000 0400 n finalpayment 0 n financecharge 0 n totalpayments 0 n ppy 0 n paymentfrequency 0 n standardentrytypecode string n interestaccrualmethoddays 0 n subpoolid moe83 n program dtm n field1 string n field2 string n field3 string n field4 string n field5 string n field6 string n field7 string n field8 string n field9 string n field10 string n field11 string n field12 string n field13 string n field14 string n field15 string n field16 string n field17 string n field18 string n field19 string n field20 string n rails n n achfields n standardentryclasscode ppd n transactiontype push n toroutingnumber 021214891 n toaccounttype gl n toaccountname test n toaccountnumber 9999999999 n description test n n id c208ac03 803a 4b94 96c2 ac5400bbbf3e n railtype cosach n priority 1 n amount 300 n loanid bd054ec9 8598 497e ac2d ac5400bbbf3e n mplid tst n issuingbankid crb n isfailed false n loantype undefined n n n selectedlanguageid g8caxfjudx1ebndjof8qn request pathparameters queryparameters headerparameters bodydataparameters name loannumber kind required type string description a customer generated loan number up to 100 characters a customer generated loan number up to 100 characters name issuingbankid kind required type string description the id of the issuing bank crb nhb or brb required name platform kind required type string description the entity that is the intermediary between the customer and cross river 100 characters platform name loantype kind required type string description select from n1 hfs hold for sale n2 lthfs long term hold for sale n4 crbretained retained n required name notedate kind required type string description date the borrower becomes obligated to pay the loan date can be the signing date or the funding date dependent on the loan documents nthe format must be yyyy mm dd date the borrower becomes obligated to pay the loan date can be the signing date or the funding date dependent on the loan documents nthe format must be yyyy mm dd name borrowerlastname kind required type string description borrower s last name 80 characters borrower s last name 80 characters name borrowerfirstname kind required type string description borrower s first name 80 characters borrower s first name 80 characters name borrowerdob kind required type string description borrower s date of birth nthe format must be yyyy mm dd borrower s date of birth nthe format must be yyyy mm dd name borrowerssn kind required type string description borrower s social security number borrower s social security number name borroweraddress kind required type string description borrower s address 160 characters borrower s address 160 characters name borrowercity kind required type string description borrower s city of residence 80 characters borrower s city of residence 80 characters name borrowerstate kind required type string description borrower s state of residence 40 characters letter code required name borrowerzip kind required type string description borrower s zip code 20 digits borrower s zip code 20 digits name loanamount kind required type number description gross dollar amount requested nthis amount represents the sum of the origination fee plus net funding amount number name netfunding kind required type number description net dollar amount to be funded number name rate kind required type number description interest rate as a percent number name apr kind required type number description annual percentage interest rate as a percent number name servicingbankid kind optional type string description id of the servicing bank servicingbankid name borrowerphone kind optional type string description borrower s phone number borrower s phone number name borroweremail kind optional type string description borrower s email address 100 characters borrower s email address 100 characters name amortization kind optional type integer description number of payments at loan origination to pay off the loan integer name term kind optional type integer description number of months from loan origination to pay off the loan integer name ratetype kind optional type integer description 1 fixed n2 floating noptional 1 fixed n2 floating noptional name priorloanflag kind optional type string description whether the borrower took a loan with the platform in the past 20 characters ny yes nn no whether the borrower took a loan with the platform in the past 20 characters ny yes nn no name fico kind optional type integer description borrower s 3 digit fico score used for risk assessment integer name ficodate kind optional type string description date fico score was obtained nthe format must be yyyy mm dd date fico score was obtained nthe format must be yyyy mm dd name creditgrade kind optional type string description internal grade for loan or from credit policy 20 characters internal grade for loan or from credit policy 20 characters name assetclass kind optional type integer description reason for loan n1 student n2 solar n3 debt consolidation n4 home improvement n5 pos point of service n6 medical n7 auto n99 other noptional reason for loan n1 student n2 solar n3 debt consolidation n4 home improvement n5 pos point of service n6 medical n7 auto n99 other noptional name loanpurpose kind optional type string description borrower s stated purpose for the loan 500 characters borrower s stated purpose for the loan 500 characters name investor kind optional type string description name of investor who will be purchasing the loan nleave blank for loans retained by cross river n300 characters name of investor who will be purchasing the loan nleave blank for loans retained by cross river n300 characters name servicer kind optional type string description the entity that handles the servicing of your account such as billing statements notices 100 characters the entity that handles the servicing of your account such as billing statements notices 100 characters name applicationdate kind optional type string description date the borrower applied for the loan nthe format must be yyyy mm dd date the borrower applied for the loan nthe format must be yyyy mm dd name regbdecisiondate kind optional type string description date the loan was approved nthe format must be yyyy mm dd n date the loan was approved nthe format must be yyyy mm dd n name purchasedate kind optional type string description date the lender or investor will purchase the loan from cr nthe format must be yyyy mm dd date the lender or investor will purchase the loan from cr nthe format must be yyyy mm dd name paymentduedate kind optional type string description date the first payment is due nthe format must be yyyy mm dd date the first payment is due nthe format must be yyyy mm dd name approvedloanamount kind optional type number description dollar amount the borrower was approved to borrow at the time of application the amount can change before the final loan amount for reasons related to the borrower or lender number name periodicpayment kind optional type number description dollar amount of monthly payments dollar amount of monthly payments name originationfee kind optional type number description charge to the borrower for the loan charge to the borrower for the loan name homeownerflag kind optional type string description confirm if the borrower is a homeowner 20 characters nyes or no confirm if the borrower is a homeowner 20 characters nyes or no name opencreditlines kind optional type integer description number of open credit lines number of open credit lines name annualincome kind optional type integer description borrower s annual income integer name creditinquiries12months kind optional type integer description number of credit inquiries made on the borrower in the last 12 months number of credit inquiries made on the borrower in the last 12 months name dqpast24months kind optional type integer description number of times the borrower has paid their loan late in the last 24 months on all accounts integer name publicrecordsonfile kind optional type integer description number of open public records such as bankruptcy tax liens or judgments integer name employmentlength kind optional type integer description number of years the borrower has been employed at their current job integer name debtutilization kind optional type number description percent of available credit used by borrower number name totalrevolvingdebt kind optional type number description dollar amount of all revolving debt on the credit report dollar amount of all revolving debt on the credit report name accountsopenedpast24months kind optional type integer description number of accounts the borrower opened in the last 24 months number of accounts the borrower opened in the last 24 months name collectionsexcludingmedical kind optional type integer description number of open collection accounts not including collections for medical procedures integer name monthssincelastrecord kind optional type integer description this field indicates the number of months since the last active public record was on their credit report na public record may indicate that a borrower stopped paying bills integer name employer kind optional type string description name of empower 500 characters employer name dti kind optional type number description debt to income ratio nratio of total monthly payment obligations divided by the monthly income as a decimal not as a percent it is calculated differently for each credit policy nit must be submitted as a decimal the decimal value should be between 0 300 n number name mlaflag kind optional type string description if the loan is being made to a covered borrower 20 characters nyes or no if the loan is being made to a covered borrower 20 characters nyes or no name mapr kind optional type string description 20 characters na standard calculation used by lenders for loans covered by the department of defense s military lending act regulation z nmapr is required if mlaflag yes nfor more information see https www fdic gov regulations compliance manual 5 v 13 1 pdf 20 characters na standard calculation used by lenders for loans covered by the department of defense s military lending act regulation z nmapr is required if mlaflag yes nfor more information see https www fdic gov regulations compliance manual 5 v 13 1 pdf name receivername kind optional type string description name of party receiving funds via ach 200 characters name of party receiving funds via ach 200 characters name samedayflag kind optional type integer description if the loan being funded via ach or same day ach same day ach requires set up by cross river if the loan being funded via ach or same day ach same day ach requires set up by cross river name addendarecord kind optional type string description additional record used for information purposes 80 characters additional record used for information purposes 80 characters name coborrowerfirstname kind optional type string description coborrower s first name 80 characters coborrower s first name 80 characters name coborrowerlastname kind optional type string description coborrower s last name 80 characters coborrowerlastname name coborrowerdob kind optional type string description coborrower s date of birth nthe format must be yyyy mm dd coborrowerdob name coborrowerssn kind optional type string description coborrower s social security number coborrower s social security number name coborroweraddress kind optional type string description coborrower s address 160 characters coborrower s address 160 characters name coborrowercity kind optional type string description coborrower s city of residence 80 characters coborrowercity name coborrowerstate kind optional type string description coborrower s state of residence 40 characters coborrowerstate name coborrowerzip kind optional type string description coborrower s zip code 20 digits coborrowerzip name coborrowerphone kind optional type string description coborrower s phone number 20 digits coborrowerphone name coborroweremail kind optional type string description coborrower s email address 100 characters coborroweremail name coborrowerfico kind optional type string description coborrower s fico score coborrowerfico name merchantname kind optional type string description merchant s name 200 characters merchantname name merchantfee kind optional type number description dollar amount paid to merchant dollar amount paid to merchant name refundamount kind optional type string description refund amount refund amount name refunddate kind optional type string description refund date nthe format must be yyyy mm dd refunddate name finalpaymentdate kind optional type string description date due for final loan payment nthe format must be yyyy mm dd finalpaymentdate name finalpayment kind optional type number description dollar amount of final payment dollar amount of final payment name financecharge kind optional type number description finance charge paid by the borrower finance charge paid by the borrower name totalpayments kind optional type number description total paid by the borrower after all the payments were made total paid by the borrower after all the payments were made name ppy kind optional type number description number of payments per year number of payments per year name paymentfrequency kind optional type integer description frequency of payments n1 weekly n2 semi monthly n3 monthly n4 bi monthly n5 other n6 bi weekly paymentfrequency name standardentrytypecode kind optional type string description ppd consumer accounts nccd corporate accounts n20 characters standardentrytypecode name interestaccrualmethoddays kind optional type integer description 365 days 365 days name subpoolid kind optional type string description id of the subpool that the loan belongs to 100 characters id of the subpool that the loan belongs to 100 characters name program kind optional type string description mpl defined program that the loan belongs to 100 characters program name field1 kind required type string description reserved for submitter s ip address nup to 5000 characters n reserved for submitter s ip address nup to 5000 characters n name field2 kind required type string description reserved for json up to 5000 characters n n ofac decision true false n ofac decision source n n required name field3 kind required type string description reserved for up to 5000 characters nsee standard json format below reserved for up to 5000 characters nsee standard json format below name field4 kind required type string description reserved for loan agreement version nup to 5 000 characters n required name field5 kind optional type string description reserved for credit decisioning parameters nup to 5 000 characters nrequired for any credit information requested by cross river nsee standard json format below n reserved for credit decisioning parameters nup to 5 000 characters nrequired for any credit information requested by cross river nsee standard json format below n name field6 kind optional type string description required for business information nup to 5 000 characters nsee standard json format below n required for business information nup to 5 000 characters nsee standard json format below n name field7 kind optional type string description required for business owner information ncollect information on controlling person and business owners who own 25 or more nfor sba loans the threshold is 20 nup to 5 000 characters nsee standard json format below required for business owner information ncollect information on controlling person and business owners who own 25 or more nfor sba loans the threshold is 20 nup to 5 000 characters nsee standard json format below name field8 kind optional type string description open field for text nup to 5 000 characters open field for text nup to 5 000 characters name field9 kind optional type string description reserved for fraud vendor raw response nup to 5 000 characters field9 name field10 kind optional type string description open field for text nup to 5 000 characters field10 name field11 kind optional type string description open field for text nup to 5 000 characters field11 name field12 kind optional type string description open field for text nup to 5 000 characters open field for text nup to 5 000 characters name field13 kind optional type string description open field for text nup to 5 000 characters field13 name field14 kind optional type string description open field for text nup to 5 000 characters open field for text nup to 5 000 characters name field15 kind optional type string description open field for text nup to 5 000 characters open field for text nup to 5 000 characters name field16 kind optional type string description reserved for second look investors raw response nup to 5 000 characters reserved for second look investors raw response nup to 5 000 characters name field17 kind optional type string description open field for text nup to 5 000 characters open field for text nup to 5 000 characters name field18 kind optional type string description open field for text nup to 5 000 characters open field for text nup to 5 000 characters name field19 kind optional type string description open field for text nup to 5 000 characters open field for text nup to 5 000 characters name field20 kind optional type string description open field for text nup to 5 000 characters open field for text nup to 5 000 characters name field21 kind optional type array description optional addition of loan information nbyte array in base 64 byte up to 8 000 characters n optional addition of loan information nbyte array in base 64 byte up to 8 000 characters n name rails kind required type array description list railtransaction nfor more details about rails https docs crossriver com apis lending loan funding payment rails list railtransaction nfor more details about rails https docs crossriver com apis lending loan funding payment rails formdataparameters currentnewparameter label body parameter value bodydataparameters hastryitout false response name status kind optional type string description the status of a loan nfor more details about rails https docs crossriver com apis lending enums name timestamp kind optional type string description timestamp of the update children name id kind optional type number description unique identifier for the loan guid children name mplid kind optional type string description id of the mpl children name date kind optional type string description date of the transaction children field 3 cip "{ { "cip decision" "nondocumentary, documentary,other", "cip vendors used" { "cip kyc vendor" "socure", "cip bank account vendor" "plaid" }, "cip documents used" { "cip document" "driving license", "cip seconday document" "utility bill" }, "cip verification used" { "ocr" "mitek", "fraud" "experian fraud", "phone number" "white pages" } }, "cipcollectionmethod" { "name" "fromcustomerviaapplication|fromcustomervialeadgenerator|fromexternalsource", "address" "fromcustomerviaapplication|fromcustomervialeadgenerator|fromexternalsource", "dob" "fromcustomerviaapplication|fromcustomervialeadgenerator|fromexternalsource", "ssn" "fromcustomerviaapplication|fromcustomervialeadgenerator|fromexternalsource", "cipcollectionmethodexternalsource" "creditreport this field is required if the method of collection is from an external source; creditreport is an example" }, "taxnumber" "ssn|itin" }" field 5 credit decisioning { "revolvinglinefirstappearance" "yes/no", "revolvinglineguid" "id from origination/first appearance", "revolvinglinebalanceasofwhencallingcrb" "", "floridastamptaxcollectedfromcustomer" "y/n", "floridastamptaxamount" "0 00", "floridastamptaxrateused" "0 0035", "dmvfeeamount" "0 00", "discountedloan" "y|n", "purchase discount" "n%", "purchasediscountamount" "0 00", "premiumfee" "0 00", "creditbureau" "tu|experian|equifax|innovis|other", "creditpolicyversion" "v1 0", "creditmodelversion" "v1 0", "creditmodelversion 2ndmodel" "v1 0", "creditmodelversion 3rdmodel" "v1 0", "creditunderwritingrulesversion" "v1 0", "pricingpolicyversion" "v1 0", "bypassrulechecking" "true|false" } field 6 standard format (business) { "name" "business name", "tin" "ein/ssn", "incdate" "2008 01 01", "stateincorp" "az", "countrydomicile" "us", "phone" "4805477526", "email" "business email", "address" "business address", "city" "business city", "state" "business state", "zipcode" "business zip", "physicaladdress" "the complete physical address of the business if different to the business address cannot be po box or tbd", "payroll" "average monthly payroll", "businesstype" "business entity type sole proprietor,partnership, c corp, s corp, llc, independent contractor, eligible self employed individual,501(c)(3) nonprofit, 501(c)(19) veterans organization, tribal business (sec 31(b)(2)(c) of small business act), other", "businesspurpose" "business purpose / description", "industry" "xxx", "naicscode" "xxx", "franchise" "yes/no", "registeredtradingnames" "", "productservicesoffered" "", "insurancetype" "", "authorisedsignatory" "", "authorisedsignatoryverificationmethod" "", "businesslicenseinformation" "", "businesswebsiteverification" "yes|no", "businessannualturnover" "gross annual revenue, cannot be null", "businesspricingdetails" { "pricingtier2" "", "pricingtier3" "" }, "businesscreditlimit" { "consumercreditlimit" "", "dailycreditlimit" "", "businessapprovalexception" "y|n" } } field 7 standard format (business owners/principals) \[ { "name" "owner name", "ownershipper" 24, "tin" "ssn|ein|tin", "address" "owner address", "city" "owner city", "state" "ownerstate", "zipcode" "owner zip", "dob" "yyyy mm dd", "phone" "owner phone", "ownerfico" 700, "cip decision" "nondocumentary, documentary,other", "cip vendors used" { "cip kyc vendor" "eg socure", "cip bank account vendor" "eg plaid" }, "cip documents used" { "cip document" "eg for a person a driving license", "cip secondary document" "eg for a person utility bill" }, "ofac decision" "true|false", "ofac decision source" "", "cip verification used" { "ocr" "eg mitek", "fraud" "eg experian fraud", "phone number" "eg white pages", "type" "owner | control person", "citizenship" "us", "residencytype" "permanent resident alien | non immigrant alien | illegal alien" } }, {} ] any vendors noted above are provided for illustration only important when you add a date field in a request, the format must be yyyy mm dd these fields include borrowerdob and ficodate and must be in this format 1970 12 05