gistfile1.txt

{ "swagger": "2.0",
  "info": {
    "title": "Loan Application API V2",
    "version": "v2"
  },"basePath":"/","tags":[{"name":"Loan Application API v2"},{"name":"Loan Application Document API v2"}],"paths":{"/loan/{loanUuid}/document":{"get":{"tags":["Loan Application Document API v2"],"summary":"Return documents associated with a loan.","description":"","operationId":"index","produces":["application/json"],"parameters":[{"name":"loanUuid","in":"path","required":true,"type":"string","x-example":"318120e7-9a8b-4f69-871e-ee06fed7419b"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Loan Documentation"}}},"security":[{"Mirador API Token.":[]}]}},"/loan/{loanUuid}/document/{documentUuid}/download":{"get":{"tags":["Loan Application Document API v2"],"summary":"Download a loan document.  Response is binary data, with an associated content-type.","description":"","operationId":"download","produces":["*/*"],"parameters":[{"name":"loanUuid","in":"path","required":true,"type":"string","x-example":"318120e7-9a8b-4f69-871e-ee06fed7419b"},{"name":"documentUuid","in":"path","required":true,"type":"string","x-example":"baf93443-970f-4f39-a4df-d5c53cb70c66"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string","format":"byte"}}},"security":[{"Mirador API Token.":[]}]}},"/loans/{lenderUuid}":{"get":{"tags":["Loan Application API v2"],"summary":"Return a list of Loans.","description":"Results are paginated.","operationId":"getLoanApplications","produces":["application/json"],"parameters":[{"name":"lenderUuid","in":"path","description":"Valid Lender UUID.","required":true,"type":"string","format":"uuid","x-example":"f845a2e0-6830-4712-8ad9-f6cf72c94ab8"},{"name":"loanCreatedDate","in":"query","description":"Loan Created Date to filter Loan listing results by.","required":false,"type":"string","format":"date-time","x-example":"2017-01-26T23:57:20.991Z"},{"name":"loanState","in":"query","description":"Loan State to filter Loan listing results by.","required":false,"type":"string","enum":["OPEN","SUBMITTED","APPROVED","DENIED","WITHDRAWN"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Loan Summary"}}},"security":[{"Mirador API Token.":[]}]}},"/loans/{lenderUuid}/{loanUuid}":{"get":{"tags":["Loan Application API v2"],"summary":"Return a Loan Application by Id.","description":"Returns a Loan Application","operationId":"getLoanApplication","produces":["application/json"],"parameters":[{"name":"lenderUuid","in":"path","description":"Valid Lender UUID.","required":true,"type":"string","format":"uuid","x-example":"f845a2e0-6830-4712-8ad9-f6cf72c94ab8"},{"name":"loanUuid","in":"path","description":"Valid Loan UUID.","required":true,"type":"string","format":"uuid","x-example":"f4eb57fa-f590-45c5-b40b-d6e3d479aabc"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Loan Application Rs"}}},"security":[{"Mirador API Token.":[]}]}}},"definitions":{"Loan Summary":{"type":"object","properties":{"loanApplicationUuid":{"type":"string","format":"uuid","example":"318120e7-9a8b-4f69-871e-ee06fed7419b"},"loanState":{"type":"string","enum":["SUBMITTED","APPROVED","REJECTED","WITHDRAWN","UNDECIDED","PREQUAL_UNQUALIFIED"]},"createdDate":{"type":"string","format":"date-time","example":"2017-01-26T23:42:49Z"}},"description":"Summary of a Loan Application."},"Owner":{"type":"object","properties":{"firstName":{"type":"string","example":"Tom"},"lastName":{"type":"string","example":"Jerry"},"email":{"type":"string","example":"test@test.com"},"dateOfBirth":{"type":"string","format":"date-time","example":"2017-01-26T23:42:49Z"},"ssn":{"type":"string","description":"000-00-0000"},"businessOwnershipPercentage":{"type":"number","description":"100"},"guarantor":{"type":"boolean","default":false},"acceptedTAC":{"type":"boolean","default":false},"ficoScore":{"type":"integer","format":"int32","example":"86"},"bureau":{"type":"string","example":"Experian"},"streetAddress":{"type":"string","example":"111 Main Street"},"streetAddressContinued":{"type":"string","example":"Suite 512"},"zipCode":{"type":"string","example":"97034"},"city":{"type":"string","example":"Seattle"},"state":{"type":"string","example":"Washington"},"country":{"type":"string","example":"USA"},"ownerQuestions":{"type":"array","items":{"$ref":"#/definitions/QuestionRs"}}},"description":"An owner of a business."},"QuestionRs":{"type":"object","properties":{"question":{"type":"string"},"answer":{"type":"string"}}},"Loan Document":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"318120e7-9a8b-4f69-871e-ee06fed7419b"},"contentType":{"type":"string","example":"application/pdf"},"name":{"type":"string","example":"PNL_DOCUMENT.pdf"},"createdAt":{"type":"string","format":"date-time","example":"2017-01-26T23:42:49Z"},"updatedAt":{"type":"string","format":"date-time","example":"2017-01-26T23:42:49Z"},"categorization":{"type":"string","enum":["BIZ_TAX","PERSONAL_TAX","REFJECTION_EMAIL"]},"downloadUri":{"type":"string","format":"uri","enum":["https://securedownload/file.pdf"]}},"description":"A Loan Document with associated metadata."},"Loan Documentation":{"type":"object","properties":{"businessBankStatements":{"type":"array","items":{"$ref":"#/definitions/Bank Statement"}},"businessAccountingDocuments":{"type":"array","items":{"$ref":"#/definitions/Loan Document"}},"creditReports":{"type":"array","example":"2017-01-26T23:42:49Z","items":{"$ref":"#/definitions/Credit Report"}},"signedDocuments":{"type":"array","example":"2017-01-26T23:42:49Z","items":{"$ref":"#/definitions/Loan Document"}},"customDocuments":{"type":"array","example":"2017-01-26T23:42:49Z","items":{"$ref":"#/definitions/Loan Document"}},"businessCreditReports":{"type":"array","example":"2017-01-26T23:42:49Z","items":{"$ref":"#/definitions/Loan Document"}},"ownerBankStatements":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/definitions/Bank Statement"}}},"ownerCustomDocuments":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/definitions/Loan Document"}}}},"description":"Externally-facing model for ALL Documents associated with a Loan"},"BusinessCreditRs":{"type":"object"},"Credit Report":{"type":"object","properties":{"ownerName":{"type":"string"},"document":{"example":"First_Last_creditreport.pdf ","$ref":"#/definitions/Loan Document"}},"description":"Representation of a Credit Memo"},"Loan Application Rs":{"type":"object","properties":{"loanUuid":{"type":"string","example":"318120e7-9a8b-4f69-871e-ee06fed7419b"},"updatedDate":{"type":"string","format":"date-time","example":"2017-01-26T23:42:49Z"},"createdDate":{"type":"string","format":"date-time","example":"2017-01-26T23:42:49Z"},"submittedDate":{"type":"string","format":"date-time","example":"2017-01-26T23:42:49Z"},"lenderState":{"type":"string","enum":["SUBMITTED","APPROVED","REJECTED","WITHDRAWN","UNDECIDED","PREQUAL_UNQUALIFIED"]},"loanAmount":{"type":"number","example":"10000"},"loanType":{"type":"string","example":"Accommodation and Food Services."},"useOfFundsCategory":{"type":"string","enum":["BUYING EQUIPMENT","HIRING EMPLOYEES","MARKETING","REMODEL/EXPANSION","WORKING CAPITAL","REFINANCING DEBT","PURCHASE INVENTORY","OPEN A NEW LOCATION","ACQUIRE COMMERCIAL REAL ESTATE","OTHER"]},"useOfFundsDescription":{"type":"string","example":"Need money to get this business going."},"businessName":{"type":"string","example":"Widgets, Inc."},"businessLegalName":{"type":"string","example":"Widgets, Inc."},"legalStructure":{"type":"string","enum":["C-CORP","S-CORP","B-CORP","LLC","PARTNERSHIP","SOLE PROPRIETORSHIP","COOPERATIVE"]},"businessType":{"type":"string","enum":["CHARITY","EDUCATION AND MEMBERSHIP","BEAUTY AND PERSONAL CARE","FOOD AND DRINK","HEALTH CARE & FITNESS","HOME AND REPAIR","CONSTRUCTION","LEISURE AND ENTERTAINMENT","PROFESSIONAL SERVICES","RETAIL","TRANSPORTATION","MANUFACTURING","FINANCE"]},"yearFounded":{"type":"integer","format":"int32","example":"2014"},"businessPhoneNumber":{"type":"string","example":"555-555-3531"},"numberOfEmployees":{"type":"integer","format":"int32","example":"10"},"employerIdentificationNumber":{"type":"string","example":"00-0000000"},"address":{"type":"string","example":"111 Main Street."},"city":{"type":"string","example":"Business City"},"state":{"type":"string","example":"Washington"},"zip":{"type":"string","example":"97034"},"estimatedIncomeLastYear":{"type":"number","example":"100000"},"owners":{"type":"array","description":"Question","items":{"$ref":"#/definitions/Owner"}},"businessQuestions":{"type":"array","description":"Question","items":{"$ref":"#/definitions/QuestionRs"}},"businessCredit":{"$ref":"#/definitions/BusinessCreditRs"},"approLoanApplicationRsvedDate":{"type":"string","format":"date-time"},"homeBusiness":{"type":"boolean","default":false}},"description":"Model representation of a Loan Application."},"Bank Statement":{"type":"object","properties":{"bankName":{"type":"string","example":"Global Bank"},"document":{"example":"Borrower Bank Statement - 1","$ref":"#/definitions/Loan Document"}}}}}