{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"adb04b75-6435-4c69-b505-5014e85d4b33","name":"Referrer Loan Application API","description":"**Welcome to Max Funding API!**\nThe Max Funding API is a RESTFUL API with predictable, resource-oriented URLs, using semantic HTTP response codes to indicate API errors. JSON is returned by all APIs. All API requests must be made over HTTPS.\n\n# Data Schema\nThere are 2 types of application API, **full application** and **partial application**. The payload requirement is different. Either case, it should contain a JSON object with the following:\n\n| Elements  | Data Type | Required | Description |\n| ------------- |:-------------:|:-------------:|:-------------:|\n| Partner ID      | String  | Yes | Unique identifer of partners.\n| Applicant      | Array     |  Yes |An array of applicant objects. Refer to applicant schema. Note: Only 1 applicant is currently supported.\n| Vehicles     | Array     |  Optional |An array of vehicle objects. Refer to vehicle schema. Note: Up to 6 vehicles are supported if more than 6 vehicles provided, only the first 6 would be considered.\n| Properties     | Array     |  Optional |An array of properties objects. Refer to properties schema. Note: Up to 6 properties are supported if more than 6 properties provided, only the first 6 would be considered.\n| Business     | Object     |   Full - Yes <br />  Part - Optional |Refer to business schema.\n| General     | Object     | Full - Yes <br />  Part - Optional |Refer to business schema.\n\n#### Applicant Object\n\n| Fields  | Data Type | Full - Required |Part - Required| Description |\n| ------------- |:-------------:|:-------------:|:-------------:|:-------------:|\n| FirstName      | String   | Yes    |Yes    |  First name of applicant; as shown on driver licence.\n| SurName      | String  | Yes    |Yes    |  Surname of applicant; as shown on driver licence.\n| Mobile     | String  | Yes    |Yes    |  Mobile must have 10 digits\n| Email     | String   | Yes   | Yes    | Email must have valid syntax\n| DateBirth     | String  | Yes    |Optional|  Date of birth in format DD/MM/YYYY\n| Title     | String  | Yes    | Optional| Data restricted to Select Field Options\n| Citizenship     | String  | Yes    | Optional| Data restricted to Select Field Options\n| StreetNum     | String | Yes     |Optional|  Street number\n| Street     | String  | Yes    |Optional|  Street name\n| Suburb     | String   | Yes   |Optional|  Suburb name\n| PostCode     | String   | Yes   |Optional|  Postcode\n| State     | String   | Yes   | Optional| Data restricted to Select Field Options\n| credit_history     | String | Yes     | Optional| Credit history of applicant. Data restricted to Select Field Options\n\n\n###### Example:\n\n```\n  {\n      \"FirstName\": \"David\",\n      \"SurName\": \"Smith\",\n      \"DateBirth\": \"01/03/1970\",\n      \"Title\": \"Mr\",\n      \"Mobile\": \"0468655055\",\n      \"Email\": \"david123@gmail.com\",\n      \"Citizenship\": \"Australian\",\n      \"StreetNum\": \"31\",\n      \"Street\": \"Bright Ave.\",\n      \"Suburb\": \"Sydney\",\n      \"PostCode\": \"2000\",\n      \"State\": \"NSW\",\n      \"credit_history\": \"Clean (no default)\"\n    }\n```\n\n\n#### Vehicles Object\nVehicle is optional.\n\n| Fields  | Data Type | Full - Required |Part - Required| Description |\n| ------------- |:-------------:|:-------------:|:-------------:|:-------------:|\n| VehicleValue      | Integer   | Yes   | Optional| Estimate vehicle trade-in value\n| Brand      | String  | Yes    |  Optional | Brand and make of the vehicle\n| VehicleYear     | Integer  | Yes    |Optional| Year vehicle was manufactured.\n| Finance     | String  | Yes    | Optional|Vehicle is under financed. String must be \"Yes\" or \"No\".\n| Owner     | String   | Yes   | Optional|Refer to Select Fields Options.\n| Insurance     | String  | Yes    |Optional| Vehicle is under financed. String must be \"Yes\" or \"No\".\n\n###### Example:\n\n```\n   \n    {\n      \"VehicleValue\": 25000,\n      \"Brand\": \"Toyota Camry\",\n      \"VehicleYear\": 2018,\n      \"Finance\": \"Yes\",\n      \"Owner\": \"Fully Own By 1st Applicant\",\n      \"Insurance\": \"Yes\"\n    },\n```\n\n#### Property Object\nProperty is optional.\n\n| Fields  | Data Type | Full - Required |Part - Required| Description |\n| ------------- |:-------------:|:-------------:|:-------------:|:-------------:|\n| Address      | String   | Yes    | Optional | Full address of the property. E.g. 12/90 Greenland Ave., Belfield NSW 2012\n| Owner      | String  | Yes    | Optional | Data restricted to Select Field Options\n| PropertyValue     | Integer  | Yes    | Optional | Estimate property value\n| MortgageOwing     | Integer  | Yes    | Optional | Total mortgage owing against the property\n| MortgageLender     | String   | Yes   | Optional | The name of the mortgageee. If more than one, the main mortgagee.\n| PropertyType     | String  | Yes    | Optional | Data restricted to Select Field Options\n| Bedroom     | Integer  | Yes    | Optional | Number of bedrooms, whole number only.\n| Bathroom     | Integer  | Yes    | Optional | Number of bathroom, whole number only.\n| LandSize     | Integer  | Yes    | Optional | Land size in m2.\n\n###### Example:\n\n```\n{\n      \"Address\": \"12/90 Greenland Ave., Belfield NSW 2012\",\n      \"Owner\": \"Fully Own By 1st Applicant\",\n      \"PropertyValue\": 500000,\n      \"MortgageOwing\": 300000,\n      \"MortgageLender\": \"St George\",\n      \"PropertyType\": \"Residential\",\n      \"Bedroom\": 4,\n      \"Bathroom\": 2,\n      \"LandSize\": 400\n    }\n```\n\n\n#### Business Object\nThis object is required.\n\n| Fields  | Data Type | Full - Required |Part - Required| Description |\n| ------------- |:-------------:|:-------------:|:-------------:|:-------------:|\n| BusinessStage      | Integer   | Yes    | Optional | Data restricted to Select Field Options \n| Nature      | String  | Yes    |Optional | Data restricted to Select Field Options\n| ABN     | Integer  | Yes    |Optional | Restricted to 10 digits\n| tradingname     | String| Yes    |Optional | Trading name of the business\n| Address     | String   | Yes   | Optional |Full address of the business premises. e.g. 12/90 Greenland Ave., Belfield NSW 2012\n| Website     | String  | Optional | Optional |Full website address\n| SalesMonthly    | Integer  | Yes    |Optional | Average monthly sales for the last 3 months\n| RepayLoanBy     | String | Yes    | Optional |Method to repay the loan by. Data restricted to Select Field Options\n| MaxRepayMonthly    | Integer  | Yes    | Optional |Maximum comfortable monthly repayment available for this loan.\n\n\n###### Example:\n\n```\n{\n    \"BusinessStage\": 1,\n    \"Nature\": \"Construction & Trades\",\n    \"ABN\": 2122222222,\n    \"tradingname\": \"David's Handyman\",\n    \"Address\": \"12/90 Greenland Ave., Belfield NSW 2012\",\n    \"Website\": \"www.davidhandyman.com.au\",\n    \"SalesMonthly\": 150000,\n    \"RepayLoanBy\": \"Business Income\",\n    \"MaxRepayMonthly\": 30000\n  }\n\n```\n#### General Object\nThis object is required.\n\n| Fields  | Data Type | Full - Required |Part - Required| Description |\n| ------------- |:-------------:|:-------------:|:-------------:|:-------------:|\n| DesiredAmount      | Integer   | Yes    |Optional | Desired loan amount\n| loanpurposereason      | String  | Yes    |Optional | Data restricted to Select Field Options\n\n\n# Authentication\nParter ID is required to use this API. Please contact our BDM if you are unsure about your ID.\n\n# Error Handling\nService validation errors response include:\n\n###### Invalid Partner ID:\n```\n{\n    \"TrackID\": \"81916438659\",\n    \"Error\": \"{\\\"Message\\\":\\\"Wrong Partner ID provided\\\",\\\"Error\\\":\\\"Please try again with a correct ID.\\\"}\",\n    \"err\": {\n        \"Message\": \"Wrong Partner ID provided\",\n        \"Error\": \"Please try again with a correct ID.\"\n    }\n}\n```\n###### Data mismatch with schema:\nIn the event that payload mismatches with the data schema, ``200 OK`` response will be returned, along with the error a message indicating the invalid fields. Example as shown below.\n```\n{\n    \"TrackID\": \"7424063527\",\n    \"Error\": \"[{\\\"name\\\":\\\"ValidationError\\\",\\\"value\\\":{\\\"FirstName\\\":\\\"Michael\\\",\\\"SurName\\\":\\\"Pence\\\",\\\"DateBirth\\\":\\\"01/03/190\\\",\\\"Title\\\":\\\"Mr\\\",\\\"Mobile\\\":\\\"0468655055\\\",\\\"Email\\\":\\\"michael123@gmail.com\\\",\\\"Citizenship\\\":\\\"Australian\\\",\\\"StreetNum\\\":\\\"31\\\",\\\"Street\\\":\\\"Bright Ave.\\\",\\\"Suburb\\\":\\\"Sydney\\\",\\\"PostCode\\\":\\\"2000\\\",\\\"State\\\":\\\"NSW\\\",\\\"credit_history\\\":\\\"Clean (no default)\\\"},\\\"errors\\\":[\\\"Format: DD/MM/YYYY. Eg. 01/01/1960\\\"],\\\"inner\\\":[{\\\"name\\\":\\\"ValidationError\\\",\\\"value\\\":\\\"01/03/190\\\",\\\"path\\\":\\\"DateBirth\\\",\\\"type\\\":\\\"matches\\\",\\\"errors\\\":[\\\"Format: DD/MM/YYYY. Eg. 01/01/1960\\\"],\\\"inner\\\":[],\\\"message\\\":\\\"Format: DD/MM/YYYY. Eg. 01/01/1960\\\",\\\"params\\\":{\\\"path\\\":\\\"DateBirth\\\",\\\"value\\\":\\\"01/03/190\\\",\\\"originalValue\\\":\\\"01/03/190\\\",\\\"regex\\\":{}}}],\\\"message\\\":\\\"Format: DD/MM/YYYY. Eg. 01/01/1960\\\"}]\",\n    \"err\": [\n        {\n            \"name\": \"ValidationError\",\n            \"value\": {\n                \"FirstName\": \"Michael\",\n                \"SurName\": \"Pence\",\n                \"DateBirth\": \"01/03/190\",\n                \"Title\": \"Mr\",\n                \"Mobile\": \"0468655055\",\n                \"Email\": \"michael123@gmail.com\",\n                \"Citizenship\": \"Australian\",\n                \"StreetNum\": \"31\",\n                \"Street\": \"Bright Ave.\",\n                \"Suburb\": \"Sydney\",\n                \"PostCode\": \"2000\",\n                \"State\": \"NSW\",\n                \"credit_history\": \"Clean (no default)\"\n            },\n            \"errors\": [\n                \"Format: DD/MM/YYYY. Eg. 01/01/1960\"\n            ],\n            \"inner\": [\n                {\n                    \"name\": \"ValidationError\",\n                    \"value\": \"01/03/190\",\n                    \"path\": \"DateBirth\",\n                    \"type\": \"matches\",\n                    \"errors\": [\n                        \"Format: DD/MM/YYYY. Eg. 01/01/1960\"\n                    ],\n                    \"inner\": [],\n                    \"message\": \"Format: DD/MM/YYYY. Eg. 01/01/1960\",\n                    \"params\": {\n                        \"path\": \"DateBirth\",\n                        \"value\": \"01/03/190\",\n                        \"originalValue\": \"01/03/190\",\n                        \"regex\": {}\n                    }\n                }\n            ],\n            \"message\": \"Format: DD/MM/YYYY. Eg. 01/01/1960\"\n        }\n    ]\n}\n```\n\n\n# Rate limit\nMaximum 1 post per second.\n\n# Feedback\nReferrer API was set up to make it easier for our partners to refer us to loan applications. If you would like more features or have found a bug, please feel email partner@maxfunding.com.au.\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"13255462","team":1351238,"collectionId":"adb04b75-6435-4c69-b505-5014e85d4b33","publishedId":"TVYGcdnf","public":true,"publicUrl":"https://api.maxfunding.finbotic.com.au","privateUrl":"https://go.postman.co/documentation/13255462-adb04b75-6435-4c69-b505-5014e85d4b33","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"1E75BC"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2020-12-02T03:34:53.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/b88ed8007ff7c6d8a90f90448b14e9adda9cc3e28bd87e42b8df204a83361670","favicon":"https://finbotic.com.au/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api.maxfunding.finbotic.com.au/view/metadata/TVYGcdnf"}