HomeAPI ReferenceUser DocumentationStatus PageUAT Portal LoginProd Portal Login
API Reference

Submit Lead

post
https://bizcore-api.bizcorebeta.com.au/api/v1/leads/submit-lead

Creates and stores the lead as an application record of type EXTERNAL LEAD provided that it passes validation

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

A NewLead instance populated with all the required information to create a new Lead Application (of type ExternalLead) record.

string | null
string | null
string | null
string | null
date-time
int32
enum
Show Details
0Australia
1NewZealand
2Afghanistan
3AlandIslands
4Albania
5Algeria
6AmericanSamoa
7Andorra
8Angola
9Anguilla
10Antarctica
11AntiguaBarbuda
12Argentina
13Armenia
14Aruba
15Austria
16Azerbaijan
17Bahamas
18Bahrain
19Bangladesh
20Barbados
21Belarus
22Belgium
23Belize
24Benin
25Bermuda
26Bhutan
27Bolivia
28BonaireSintEustatiusSaba
29BosniaHerzegovina
30Botswana
31BouvetIsland
32Brazil
33BritishIndianOceanTerritory
34Brunei
35Bulgaria
36BurkinaFaso
37Burundi
38Cambodia
39Cameroon
40Canada
41CapeVerde
42CaymanIslands
43CentralAfricanRepublic
44Chad
45Chile
46China
47ChristmasIsland
48CocosKeelingIslands
49Colombia
50Comoros
51Congo
52CookIslands
53CostaRica
54IvoryCoast
55Croatia
56Cuba
57Curacao
58Cyprus
59CzechRepublic
60DemocraticRepublicCongo
61Denmark
62Djibouti
63Dominica
64DominicanRepublic
65Ecuador
66Egypt
67ElSalvador
68EquatorialGuinea
69Eritrea
70Estonia
71Ethiopia
72FalklandIslandsMalvinas
73FaroeIslands
74Fiji
75Finland
76France
77FrenchGuiana
78FrenchPolynesia
79FrenchSouthernTerritories
80Gabon
81Gambia
82Georgia
83Germany
84Ghana
85Gibraltar
86Greece
87Greenland
88Grenada
89Guadeloupe
90Guam
91Guatemala
92Guernsey
93Guinea
94GuineaBissau
95Guyana
96Haiti
97HeardIslandMcDonaldIslands
98Honduras
99HongKong
100Hungary
101Iceland
102India
103Indonesia
104Iran
105Iraq
106Ireland
107IsleMan
108Israel
109Italy
110Jamaica
111Japan
112Jersey
113Jordan
114Kazakhstan
115Kenya
116Kiribati
117Kuwait
118Kyrgyzstan
119Laos
120Latvia
121Lebanon
122Lesotho
123Liberia
124Libya
125Liechtenstein
126Lithuania
127Luxembourg
128Macao
129Macedonia
130Madagascar
131Malawi
132Malaysia
133Maldives
134Mali
135Malta
136MarshallIslands
137Martinique
138Mauritania
139Mauritius
140Mayotte
141Mexico
142Micronesia
143Moldova
144Monaco
145Mongolia
146Montenegro
147Montserrat
148Morocco
149Mozambique
150Myanmar
151Namibia
152Nauru
153Nepal
154Netherlands
155NewCaledonia
156Nicaragua
157Niger
158Nigeria
159Niue
160NorfolkIsland
161NorthKorea
162NorthernMarianaIslands
163Norway
164Oman
165Pakistan
166Palau
167Palestine
168Panama
169PapuaNewGuinea
170Paraguay
171Peru
172Philippines
173Pitcairn
174Poland
175Portugal
176PuertoRico
177Qatar
178Reunion
179Romania
180Russia
181Rwanda
182SaintBarthelemy
183SaintHelenaAscensionTristanDaCunha
184SaintKittsNevis
185SaintLucia
186SaintMartin
187SaintPierreMiquelon
188SaintVincentGrenadines
189Samoa
190SanMarino
191SaoTomePrincipe
192SaudiArabia
193Senegal
194Serbia
195Seychelles
196SierraLeone
197Singapore
198SintMaarten
199Slovakia
200Slovenia
201SolomonIslands
202Somalia
203SouthAfrica
204SouthGeorgiaSouthSandwichIslands
205SouthKorea
206SouthSudan
207Spain
208SriLanka
209Sudan
210Suriname
211SvalbardJanMayen
212Swaziland
213Sweden
214Switzerland
215Syria
216Taiwan
217Tajikistan
218Tanzania
219Thailand
220TimorLeste
221Togo
222Tokelau
223Tonga
224TrinidadTobago
225Tunisia
226Turkey
227Turkmenistan
228TurksCaicosIslands
229Tuvalu
230Uganda
231Ukraine
232UnitedArabEmirates
233UnitedKingdom
234UnitedStates
235UnitedStatesMinorOutlyingIslands
236Uruguay
237Uzbekistan
238Vanuatu
239VaticanCity
240Venezuela
241Vietnam
242BritishVirginIslands
243USVirginIslands
244WallisFutuna
245WesternSahara
246Yemen
247Zambia
248Zimbabwe
int32
enum
Show Details
0Other
1Female
2Male
Allowed:
int32
enum
Show Details
0Other
1Single
2Married
3Divorced
4Widowed
5DeFacto
6Separated
Allowed:
uuid | null
uuid | null
date-time | null
int32 | null
string | null
date-time | null
string | null
string | null
string | null
date-time | null
string | null
string | null
date-time | null
string | null
string | null
string | null
date-time | null
string | null
uuid | null
int32
enum
Show Details
0Casual
1Contract
2PartTime
3FullTime
4Benefits
5SelfEmployed
Allowed:
string | null
string | null
string | null
string | null
string | null
string | null
double | null
int32
enum
Show Details
0Daily
1Weekly
2Fortnightly
3Monthly
4Quarterly
5HalfYearly
6Yearly
7OnceOff
double | null
int32
enum
Show Details
0Daily
1Weekly
2Fortnightly
3Monthly
4Quarterly
5HalfYearly
6Yearly
7OnceOff
double | null
int32
enum
Show Details
0Daily
1Weekly
2Fortnightly
3Monthly
4Quarterly
5HalfYearly
6Yearly
7OnceOff
double | null
int32
enum
Show Details
0Daily
1Weekly
2Fortnightly
3Monthly
4Quarterly
5HalfYearly
6Yearly
7OnceOff
string | null
double | null
int32 | null
double | null
int32
enum
Show Details
0Daily
1Weekly
2Fortnightly
3Monthly
4Quarterly
5HalfYearly
6Yearly
7OnceOff
string | null
int32
enum
Show Details
0Car
1Motorcycle
2Trailer
3Boat
4Van
5RV
6Truck
7Plane
8JetSki
9Yacht
string | null
string | null
int32 | null
string | null
string | null
string | null
uuid | null
string | null
string | null
string | null
date-time | null
boolean | null
string | null
string | null
string | null
string | null
int32
enum
Show Details
0Illion
1CreditSense
Allowed:
string | null

CustomerId provided by Illion. Required if "bankStatementProviderId" = 0.

string | null

EncryptionKey provided by Illion. Required if "bankStatementProviderId" = 0.

boolean
string | null
uuid | null
uuid
string | null
string | null
string | null
string | null
identifiers
object | null

Key-Value Pairs used to identify this Lead. Must contain a valid value for key "CS_App_ID" if "bankStatementProviderId" = 1.

uuid | null
string | null
double
int32
enum
Show Details
0Daily
1Weekly
2Fortnightly
3Monthly
4Quarterly
5HalfYearly
6Yearly
7OnceOff
int32 | null
int32
enum
Show Details
0Other
1HouseholdGoodsAndFurniture
2MedicalDentalSpecialistExpenses
3RentalBond
4UtilityBills
5TravelHoliday
6EventCosts
7ProfessionalServices
8EducationFees
9Gifts
10CarServiceRepairs
11BasicLivingExpenses
12WorkExpenses
13CarRegistration
14RelocationCosts
15EntertainmentLeisure
16HomeRepairsImprovements
17Insurance
18DebtConsolidation
string | null
string | null
emailContacts
array of objects | null
emailContacts
phoneContacts
array of objects | null
phoneContacts
addressContacts
array of objects | null
addressContacts
boolean
boolean
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

401

Unauthorized

Updated 15 days ago

Language
Credentials
LoadingLoading…
Response
Choose an example:
text/plain
application/json
text/json

Updated 15 days ago