{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:crowd-4-cash/authentication-get-token":{"post":{"operationId":"open_data_crowd_4_cash_authentication_get_token","summary":"Authenticate yourself and get an access token","description":"POST /Authenticate","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:crowd-4-cash/application-submit-loan-application":{"post":{"operationId":"open_data_crowd_4_cash_application_submit_loan_application","summary":"Apply for a regular loan - 100% online application","description":"POST /Loan","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:crowd-4-cash/application-submit-partner-loan-application":{"post":{"operationId":"open_data_crowd_4_cash_application_submit_partner_loan_application","summary":"Apply for a loan on behalf of your partners e.g. garages/shops/stores","description":"POST /IntermediaryLoan","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:crowd-4-cash/application-set-definitive-handover-date":{"post":{"operationId":"open_data_crowd_4_cash_application_set_definitive_handover_date","summary":"Set the definitive Handover Date (a date when the item is handed over to the customer)","description":"PUT /IntermediaryLoan","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:crowd-4-cash/application-submit-rental-loan-application":{"post":{"operationId":"open_data_crowd_4_cash_application_submit_rental_loan_application","summary":"Apply for a rental loan","description":"POST /RentalLoan","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:crowd-4-cash/opportunities-get-available-investments":{"get":{"operationId":"open_data_crowd_4_cash_opportunities_get_available_investments","summary":"Get available investment opportunities","description":"GET /Opportunities","tags":["open-data"],"parameters":[{"name":"Rating","in":"query","required":false,"description":"Evaluation of the credit risk based on a borrower's credit history, quality of the collateral, and the likelihood of repayment e.g. AA","schema":{"type":"string","enum":["AA","A","B","C","D"],"description":"Evaluation of the credit risk based on a borrower's credit history, quality of the collateral, and the likelihood of repayment e.g. AA"}},{"name":"LoanAmount","in":"query","required":false,"description":"Loan amount e.g. 25000","schema":{"type":"number","description":"Loan amount e.g. 25000"}},{"name":"LoanType","in":"query","required":false,"description":"Type of the loan e.g. Private, SME","schema":{"type":"string","description":"Type of the loan e.g. Private, SME"}},{"name":"AvailableAmount","in":"query","required":false,"description":"Available amount to be invested at the moment of our API consuming e.g. 2000","schema":{"type":"number","description":"Available amount to be invested at the moment of our API consuming e.g. 2000"}},{"name":"InterestRate","in":"query","required":false,"description":"Interest rate of the loan in % e.g. 5.6","schema":{"type":"number","description":"Interest rate of the loan in % e.g. 5.6"}},{"name":"Duration","in":"query","required":false,"description":"Duration in months e.g. 24","schema":{"type":"integer","description":"Duration in months e.g. 24"}},{"name":"Insurance","in":"query","required":false,"description":"Is loan issured? - Yes, No","schema":{"type":"string","enum":["No","Yes"],"description":"Is loan issured? - Yes, No"}},{"name":"Collateral","in":"query","required":false,"description":"Is loan collaterialized? - Yes, No","schema":{"type":"string","enum":["No","Yes"],"description":"Is loan collaterialized? - Yes, No"}},{"name":"BorrowerAge","in":"query","required":false,"description":"Age of the borrower e.g. 42","schema":{"type":"integer","description":"Age of the borrower e.g. 42"}},{"name":"BorrowerNationality","in":"query","required":false,"description":"Nationality of the borrower, e.g Switzerland, Liechtenstein ...","schema":{"type":"string","description":"Nationality of the borrower, e.g Switzerland, Liechtenstein ..."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:crowd-4-cash/bidding-place-bid":{"post":{"operationId":"open_data_crowd_4_cash_bidding_place_bid","summary":"Place a bid on certain loan","description":"POST /Bid","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:crowd-4-cash/bidding-submit-bids":{"post":{"operationId":"open_data_crowd_4_cash_bidding_submit_bids","summary":"Place bids on behalf of your connected investor(s)","description":"POST /Bids","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:crowd-4-cash/contracts-get-all":{"get":{"operationId":"open_data_crowd_4_cash_contracts_get_all","summary":"Get all your contracts","description":"GET /Contracts","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:crowd-4-cash/contracts-get-specific":{"get":{"operationId":"open_data_crowd_4_cash_contracts_get_specific","summary":"Get specific contract","description":"GET /Contracts/{loanId}","tags":["open-data"],"parameters":[{"name":"loanId","in":"query","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:crowd-4-cash/contracts-get-specific-intermediary-loan-contract":{"get":{"operationId":"open_data_crowd_4_cash_contracts_get_specific_intermediary_loan_contract","summary":"Get specific intermediary loan contract","description":"GET /Contracts/{partnerId}/{loanId}","tags":["open-data"],"parameters":[{"name":"partnerId","in":"query","required":true,"schema":{"type":"integer"}},{"name":"loanId","in":"query","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:crowd-4-cash/contracts-get-loan-contract":{"get":{"operationId":"open_data_crowd_4_cash_contracts_get_loan_contract","summary":"Get specific rental loan contract","description":"GET /Contracts/RentalLoan/{loanId}","tags":["open-data"],"parameters":[{"name":"loanId","in":"query","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:crowd-4-cash/portfolio-get-investments":{"get":{"operationId":"open_data_crowd_4_cash_portfolio_get_investments","summary":"Get your investment portfolio","description":"GET /Portfolio","tags":["open-data"],"parameters":[{"name":"from","in":"query","required":false,"schema":{"type":"string"}},{"name":"to","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:crowd-4-cash/portfolio-get-customized-portfolio":{"get":{"operationId":"open_data_crowd_4_cash_portfolio_get_customized_portfolio","summary":"Get your customized investment portfolio","description":"GET /CustomPortfolio","tags":["open-data"],"parameters":[{"name":"from","in":"query","required":false,"schema":{"type":"string"}},{"name":"to","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:crowd-4-cash/reports-get-connector-investments":{"get":{"operationId":"open_data_crowd_4_cash_reports_get_connector_investments","summary":"Get your connector account summary and investments of the connected investors","description":"GET /Connector","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:crowd-4-cash/reports-get-intermediary-data":{"get":{"operationId":"open_data_crowd_4_cash_reports_get_intermediary_data","summary":"Get your intermediary account summary and your partner loans data","description":"GET /Intermediary","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:crowd-4-cash/reports-rental-account-summary":{"get":{"operationId":"open_data_crowd_4_cash_reports_rental_account_summary","summary":"Get your rental account summary and your loans data","description":"GET /Rental","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:crowd-4-cash/loans-get-loan-data":{"get":{"operationId":"open_data_crowd_4_cash_loans_get_loan_data","summary":"Get a complete C4C loan data dataset for your credit analyses","description":"GET /Loans","tags":["open-data"],"parameters":[{"name":"PageNumber","in":"query","required":true,"description":"Page number you want to access","schema":{"type":"integer","description":"Page number you want to access"}},{"name":"PageSize","in":"query","required":true,"description":"Number of items per page. Max is 20","schema":{"type":"integer","description":"Number of items per page. Max is 20"}},{"name":"loanstatus","in":"query","required":true,"description":"Status values that need to be considered for filter","schema":{"type":"string","enum":["All","Funded","Active","Closed","Defaulted"],"description":"Status values that need to be considered for filter"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}