Create and Update a loan

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 table below is the reference information for the api attributes you can use when you create a loan or update a loan they are the same attributes that show when you receive a response request parameters attribute description loannumber string a customer generated loan number up to 100 characters required required issuingbankid string the id of the issuing bank crb, nhb or brb required required platform string (100 characters) the entity that is the intermediary between the customer and cr required required loantype string select from 1 hfs (hold for sale) 2 lthfs (long term hold for sale) 4 crbretained (retained) required required notedate string date the borrower becomes obligated to pay the loan date can be the signing date or the funding date (dependent on the loan documents) the format must be yyyy mm dd required required borrowerlastname string (80 characters) borrower's last name required required borrowerfirstname string (80 characters) borrower's first name required required borrowerdob string borrower's date of birth the format must be yyyy mm dd required required borrowerssn string borrower's social security number required required borroweraddress string (160 characters) borrower's address required required borrowercity string (80 characters) borrower's city of residence required required borrowerstate string (40 characters) letter code) borrower's state of residence required required borrowerzip string (20 digits) borrower's zip code required required loanamount number gross dollar amount requested this amount represents the sum of the origination fee plus (+) net funding amount required required netfunding number net dollar amount to be funded required required rate number interest rate, as a percent required required apr number annual percentage interest rate, as a percent required required servicingbankid string id of the servicing bank optional optional borrowerphone string (30 digits) borrower's phone number optional optional borroweremail string (100 characters) borrower's email address optional optional amortization integer or null number of payments at loan origination to pay off the loan optional optional term integer or null number of months from loan origination to pay off the loan optional optional ratetype integer or null 1 fixed 2 floating optional optional priorloanflag string (20 characters) whether the borrower took a loan with the platform in the past y yes n no optional optional fico integer or null borrower's 3 digit fico score used for risk assessment optional optional ficodate string date fico score was obtained the format must be yyyy mm dd optional optional creditgrade string (20 characters) internal grade for loan or from credit policy optional optional assetclass integer or null reason for loan 1 student 2 solar 3 debt consolidation 4 home improvement 5 pos (point of service) 6 medical 7 auto 99 other optional optional loanpurpose string (500 characters) borrower's stated purpose for the loan optional optional investor string (300 characters) name of investor who will be purchasing the loan leave blank for loans retained by cr optional optional servicer string (100 characters) the entity that handles the servicing of your account, such as billing statements, notices optional optional applicationdate string date the borrower applied for the loan the format must be yyyy mm dd optional optional regbdecisiondate string date the loan was approved the format must be yyyy mm dd optional optional purchasedate string date the lender or investor will purchase the loan from cr the format must be yyyy mm dd optional optional paymentduedate string date the first payment is due the format must be yyyy mm dd optional optional approvedloanamount number 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 optional optional periodicpayment number dollar amount of monthly payments optional optional originationfee number charge to the borrower for the loan optional optional homeownerflag string (20 characters) confirm if the borrower is a homeowner yes or no optional optional opencreditlines integer or null number of open credit lines optional optional annualincome integer or null borrower's annual income optional optional creditinquiries12months integer or null number of credit inquiries made on the borrower in the last 12 months optional optional dqpast24months integer or null number of times the borrower has paid their loan late in the last 24 months on all accounts optional optional publicrecordsonfile integer or null number of open public records, such as bankruptcy, tax liens or judgments optional optional employmentlength integer or null number of years the borrower has been employed at their current job optional optional debtutilization number percent of available credit used by borrower optional optional totalrevolvingdebt number dollar amount of all revolving debt on the credit report optional optional accountsopenedpast24months integer or null number of accounts the borrower opened in the last 24 months optional optional collectionsexcludingmedical integer or null number of open collection accounts, not including collections for medical procedures optional optional monthssincelastrecord integer or null this field indicates the number of months since the last active public record was on their credit report a public record may indicate that a borrower stopped paying bills optional optional employer string (500 characters) name of employer optional optional dti decimal debt to income ratio ratio 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 it must be submitted as a decimal the decimal value should be between 0 300 optional optional mlaflag string (20 characters) if the loan is being made to a covered borrower yes or no optional optional mapr string (20 characters) military apr a standard calculation used by lenders for loans covered by the department of defense's military lending act & regulation z mapr is required if mlaflag = yes for more information, see https //www fdic gov/regulations/compliance/manual/5/v 13 1 pdf optional optional receivername string (200 characters) name of party receiving funds via ach optional optional samedayflag integer or null if the loan being funded via ach or same day ach (same day ach requires set up by cr) optional optional addendarecord string (80 characters) additional record used for information purposes optional optional coborrowerfirstname string (80 characters) coborrower's first name optional optional coborrowerlastname string (80 characters) coborrower's last name optional optional coborrowerdob string coborrower's date of birth the format must be yyyy mm dd optional optional coborrowerssn string coborrower's social security number optional optional coborroweraddress string (160 characters) coborrower's address optional optional coborrowercity string (80 characters) coborrower's city of residence optional optional coborrowerstate string (40 characters) code) coborrower's state of residence optional optional coborrowerzip string (20 digits) coborrower's zip code optional optional coborrowerphone string (30 digits) coborrower's phone number optional optional coborroweremail string (100 characters) coborrower's email address optional optional coborrowerfico integer or null coborrower's fico score optional optional merchantname string (200 characters) merchant's name optional optional merchantfee number dollar amount paid to merchant optional optional refundamount number refund amount optional optional refunddate string refund date the format must be yyyy mm dd optional optional finalpaymentdate string date due for final loan payment the format must be yyyy mm dd optional optional finalpayment number dollar amount of final payment optional optional financecharge number finance charge paid by the borrower optional optional totalpayments number total paid by the borrower after all the payments were made optional optional ppy number number of payments per year optional optional paymentfrequency integer or null frequency of payments 1 weekly 2 semi monthly 3 monthly 4 bi monthly 5 other 6 bi weekly optional optional standardentrytypecode string (20 characters) ppd consumer accounts ccd corporate accounts optional optional interestaccrualmethoddays integer or null 365 (days) optional optional subpoolid string (20 characters) id of the subpool that the loan belongs to optional optional program string (100 characters) mpl defined program that the loan belongs to optional optional field1 string reserved for submitter's ip address up to 5,000 characters required required field2 string reserved for json "{ ""ofac decision"" ""true|false"", ""ofac decision source"" """" }" up to 5,000 characters required required field3 string reserved for json "{ { "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" }" up to 5,000 characters required required field4 string reserved for loan agreement version up to 5,000 characters required required field5 string reserved for credit decisioning parameters json { "revolvinglinefirstappearance" "yes/no", "revolvinglineguid" "id from origination/first appearance", "revolvinglinebalanceasofwhencallingcrb" "", "floridastamptaxcollectedfromcustomer" "y/n", "floridastamptaxamount" "0 00", "dmvfeeamount" "0 00", "floridastamptaxrateused" "0 0035", "discountedloan" "y|n", "purchase discount" "n%", "purchasediscountamount" "0 00", "creditpolicyversion" "v1 0", "creditmodelversion" "v1 0", "premiumfee" "0 00", "bypassrulechecking" "true|false" } up to 5,000 characters required for any credit information requested by cr field6 string required for business information up to 5,000 characters see standard json format below field7 string required for business owner information collect information on controlling person and business owners who own 25% or more for sba loans the threshold is 20% up to 5,000 characters see standard json format below field8 string open field for text up to 5,000 characters optional optional field9 string reserved for fraud vendor raw response up to 5,000 characters optional optional field10 string open field for text up to 5,000 characters optional optional field11 string open field for text up to 5,000 characters optional optional field12 string open field for text up to 5,000 characters optional optional field13 string open field for text up to 5,000 characters optional optional field14 string open field for text up to 5,000 characters optional optional field15 string open field for text up to 5,000 characters optional optional field16 string reserved for second look investors raw response up to 5,000 characters optional optional field17 string open field for text up to 5,000 characters optional optional field18 string open field for text up to 5,000 characters optional optional field19 string open field for text up to 5,000 characters optional optional field20 string open field for text up to 5,000 characters optional optional field21 byte \[ ] optional addition of loan information byte array in base 64 up to 8,000 characters optional optional rails list {railtransaction} click funding your loan / payment rails for information on rails required required 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 sample request in json post /loan { "loan" { "loannumber" {{loannumber}}, "issuingbankid" "crb", "platform" "string", "loantype" 1, "notedate" "2019 12 31", "borrowerlastname" {{$randomlastname}}, "borrowerfirstname" {{$randomfirstname}}, "borrowerdob" "1986 12 31", "borrowerssn" {{borrowerssn}}, "borroweraddress" {{borroweraddress}}, "borrowercity" {{$randomcity}}, "borrowerstate" {{borrowerstate}}, "borrowerzip" {{borrowerzip}}, "loanamount" 1500, "netfunding" 1300, "rate" 0 2, "apr" "10", "batchid" "string", "borrowerphone" {{$randomphonenumber}}, "borroweremail" {{$randomemail}}, "amortization" 0, "term" 36, "ratetype" 0, "priorloanflag" "string", "fico" 10, "ficodate" "2017 12 31", "creditgrade" "string", "assetclass" 0, "loanpurpose" "string", "investor" "string", "servicer" "string", "applicationdate" {{applicationdate}}, "regbdecisiondate" {{regbdecisiondate}}, "purchasedate" {{purchasedate}}, "paymentduedate" {{paymentduedate}}, "approvedloanamount" 0, "periodicpayment" 0, "originationfee" 100, "homeownerflag" "string", "opencreditlines" 0, "annualincome" 0, "creditinquiries12months" 0, "dqpast24months" 0, "publicrecordsonfile" 0, "employmentlength" 0, "debtutilization" 0, "totalrevolvingdebt" 0, "accountsopenedpast24months" 0, "collectionsexcludingmedical" 0, "monthssincelastrecord" 0, "employer" "string", "dti" 0, "mlaflag" "string", "mapr" "string", "receivername" "string", "samedayflag" 0, "addendarecord" "string", "coborrowerfirstname" "string", "coborrowerlastname" "string", "coborrowerdob" "1986 12 31", "coborrowerssn" "string", "coborroweraddress" "string", "coborrowercity" "string", "coborrowerstate" "string", "coborrowerzip" "string", "coborrowerphone" "string", "coborroweremail" "string", "coborrowerfico" 0, "merchantname" "string", "merchantfee" 0, "refundamount" 0, "adjustedloanamount" 0, "adjustednetfunding" 0, "adjustedoriginationfee" 0, "adjustedcurrentmonthlypayment" 0, "refunddate" "2017 12 31", "adjustedmerchantfee" 0, "finalpaymentdate" {{finalpaymentdate}}, "finalpayment" 0, "financecharge" 0, "totalpayments" 0, "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" }, "railtype" "cosach", "priority" 1, "amount" 300 } ] } } sample response in json post /loan response attributes attribute description status string the status of a loan see enums for response statuses timestamp string timestamp of the update id guid unique identifier for the loan mplid string id of the mpl date string date of the transaction loan created with id { "id" "bd054ec9 8598 497e ac2d ac5400bbbf3e", "mplid" "tst", "date" "/date(1602674613963 0400)/", "loannumber" "mz 1afc220c66ed4ad", "issuingbankid" "crb", "platform" "string", "loantype" "hfs", "notedate" "/date(1577768400000 0500)/", "borrowerlastname" "emard", "borrowerfirstname" "darrion", "borrowerdob" "/date(536389200000 0500)/", "borrowerssn" "640517072", "borroweraddress" "8652 vonrueden walks", "borrowercity" "east", "borrowerstate" "lv", "borrowerzip" "30878", "loanamount" 500, "netfunding" 1300, "rate" 0 05, "apr" 10, "batchid" "string", "borrowerphone" "323 514 0396", "borroweremail" "helga hoeger14\@gmail com", "amortization" 0, "term" 36, "ratetype" 0, "priorloanflag" "string", "fico" 10, "ficodate" "/date(1514696400000 0500)/", "creditgrade" "string", "assetclass" 0, "loanpurpose" "string", "investor" "string", "servicer" "string", "applicationdate" "/date(1602674613934 0400)/", "regbdecisiondate" "/date(1602674613934 0400)/", "purchasedate" "/date(1602907200000 0400)/", "paymentduedate" "/date(1607922000000 0500)/", "approvedloanamount" 0, "periodicpayment" 0, "originationfee" 100, "homeownerflag" "string", "opencreditlines" 0, "annualincome" 0, "creditinquiries12months" 0, "dqpast24months" 0, "publicrecordsonfile" 0, "employmentlength" 0, "debtutilization" 0, "totalrevolvingdebt" 0, "accountsopenedpast24months" 0, "collectionsexcludingmedical" 0, "monthssincelastrecord" 0, "employer" "string", "dti" 0, "mlaflag" "string", "mapr" "string", "receivername" "string", "samedayflag" 0, "addendarecord" "string", "coborrowerfirstname" "string", "coborrowerlastname" "string", "coborrowerdob" "/date(536389200000 0500)/", "coborrowerssn" "string", "coborroweraddress" "string", "coborrowercity" "string", "coborrowerstate" "string", "coborrowerzip" "string", "coborrowerphone" "string", "coborroweremail" "string", "coborrowerfico" 0, "merchantname" "string", "merchantfee" 0, "refundamount" 0, "adjustedloanamount" 0, "adjustednetfunding" 0, "adjustedoriginationfee" 0, "adjustedcurrentmonthlypayment" 0, "refunddate" "/date(1514696400000 0500)/", "adjustedmerchantfee" 0, "finalpaymentdate" "/date(1618372800000 0400)/", "finalpayment" 0, "financecharge" 0, "totalpayments" 0, "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" "c208ac03 803a 4b94 96c2 ac5400bbbf3e", "railtype" "cosach", "priority" 1, "amount" 300, "loanid" "bd054ec9 8598 497e ac2d ac5400bbbf3e", "mplid" "tst", "issuingbankid" "crb", "isfailed" false, "loantype" "undefined" } ] }