Direct Integration API
home
API Type
- Experience API
Overview
Direct Integration Mule API enables API consumers from Australia (AU) and New Zealand (NZ) enabling them to submit mortgage lodgment applications directly to Pepper.
Endpoint Quick Reference
/v1/directintegration/nz/lodgement
- POST - Submit Mortgage Lodgement Application
Supported Protocols
- HTTPS
Accepts
- application/json
Responds With
- application/json
Authentication
- Basic Authentication
Individual sections with detailed description :
- Address
- Business channel
- CompanyApplicant
- SalesChannel
- OtherIncome
- ContributionFunds
- LoanDetails
- Household Dependant
- Other Assets
- Liabilities
- Party
- Party Person
- Party Employment
- Party Proof of Identity
- Party Household
- RealEstateAssets
- RelatedCompany
- RelatedPerson
- TrustApplicant
Sample Request
{
"Package": {
"Content": {
"Application": {
"Address": [
{
"Standard": {
"@StreetName": "Ruatahuna",
"@StreetNumber": "5467",
"@StreetType": "Road"
},
"@City": "Ruatahuna",
"@Country": "NZ",
"@NewZealandPostCode": "3079",
"@SequenceNumber": "8",
"@Type": "Standard",
"@UniqueID": "aed1a4e5472e"
},
{
"Standard": {
"@StreetName": "Ormiston",
"@StreetNumber": "123",
"@StreetType": "Road"
},
"@City": "Auckland",
"@Country": "NZ",
"@NewZealandPostCode": "2019",
"@SequenceNumber": "13",
"@Suburb": "Flat Bush",
"@Type": "Standard",
"@UniqueID": "bb97ea2bdbc9"
},
{
"Standard": {
"@StreetName": "Peter",
"@StreetNumber": "22",
"@StreetType": "Terrace"
},
"@City": "Auckland",
"@Country": "NZ",
"@NewZealandPostCode": "0620",
"@SequenceNumber": "9",
"@Suburb": "Castor Bay",
"@Type": "Standard",
"@UniqueID": "c5b3d9956b64"
},
{
"Standard": {
"@StreetName": "Chapel",
"@StreetNumber": "345",
"@StreetType": "Road"
},
"@City": "Auckland",
"@Country": "NZ",
"@NewZealandPostCode": "2016",
"@SequenceNumber": "6",
"@Suburb": "Flat Bush",
"@Type": "Standard",
"@UniqueID": "d177811716f4"
},
{
"NonStandard": {
"@Line1": "Greenlane, PO Box 17506"
},
"@City": "Auckland",
"@Country": "NZ",
"@NewZealandPostCode": "1546",
"@SequenceNumber": "2",
"@Type": "Non Standard",
"@UniqueID": "d66ff9a1e37f"
},
{
"NonStandard": {
"@Line1": "Greenlane, PO Box 17506"
},
"@City": "Auckland",
"@Country": "NZ",
"@NewZealandPostCode": "1546",
"@SequenceNumber": "0",
"@Type": "Non Standard",
"@UniqueID": "ddad34a49d9b"
}
],
"BusinessChannel": {
"Contact": {
"OfficePhone": {
"@CountryCode": "64",
"@NewZealandDialingCode": "0800",
"@Number": "945658"
},
"@WebAddress": "www.peppermoney.co.nz",
"@x_Address": "ddad34a49d9b"
},
"@CompanyName": "PEPPER DIRECT NEW ZEALAND",
"@NZBN": "9429031065153",
"@OtherIdentifier": "CJF1QZ",
"@Type": "Bank",
"@UniqueID": "ec2c07b1ddb1"
},
"DetailedComment": {
"@SequenceNumber": "1",
"@UniqueID": "cae76f730e82"
},
"Household": {
"ExpenseDetails": {
"LivingExpense": [
{
"@Category": "Childcare",
"@Amount": "100",
"@Frequency": "Monthly"
},
{
"@Category": "Clothing and personal care",
"@Amount": "100",
"@Frequency": "Monthly"
},
{
"@Category": "General Basic Insurances",
"@Amount": "100",
"@Frequency": "Monthly"
},
{
"@Category": "Groceries",
"@Amount": "100",
"@Frequency": "Monthly"
},
{
"@Category": "Investment Property Running Costs",
"@Amount": "100",
"@Frequency": "Monthly"
},
{
"@Category": "Medical and health",
"@Amount": "100",
"@Frequency": "Monthly"
},
{
"@Category": "Other",
"@Amount": "100",
"@Frequency": "Monthly"
},
{
"@Category": "Primary Residence Running Costs",
"@Amount": "100",
"@Frequency": "Monthly"
},
{
"@Category": "Public or Government Primary and Secondary Education",
"@Amount": "100",
"@Frequency": "Monthly"
},
{
"@Category": "Recreation and entertainment",
"@Amount": "100",
"@Frequency": "Monthly"
},
{
"@Category": "Telephone, internet, pay TV and media streaming subscriptions",
"@Amount": "100",
"@Frequency": "Monthly"
},
{
"@Category": "Transport",
"@Amount": "100",
"@Frequency": "Monthly"
}
],
"OtherCommitment": [
{
"@Category": "Child and Spousal Maintenance",
"@Amount": "100",
"@Frequency": "Monthly"
},
{
"@Category": "Other",
"@Amount": "100",
"@Frequency": "Monthly"
},
{
"@Category": "Rent",
"@Amount": "100",
"@Frequency": "Monthly"
}
]
},
"@Name": "Abbott Household",
"@NumberOfAdults": "1",
"@NumberOfDependants": "0",
"@SequenceNumber": "0",
"@UniqueID": "b975f81c2c2f"
},
"LoanDetails": {
"FeaturesSelected": {
"@Redraw": "No"
},
"LendingPurpose": {
"@PurposeAmount": "185000",
"@PurposeOfFunds": "Fix Natural Disaster Affected Home",
"@UniqueID": "d8ef1c368f98",
"@ABSLendingPurposeCode": "12345"
},
"LoanPurpose": {
"@PrimaryPurpose": "Investment Residential"
},
"Term": {
"InterestOnlyReason": {
"@Reason": "Variable income",
"@UniqueID": "a55a4e644b73"
},
"@InterestType": "Fixed Rate",
"@InterestTypeDuration": "2",
"@InterestTypeUnits": "Years",
"@PaymentType": "Interest Only",
"@PaymentTypeDuration": "2",
"@PaymentTypeUnits": "Years",
"@TotalTermDuration": "30",
"@TotalTermType": "Total Term",
"@TotalTermUnits": "Years"
},
"@AmountRequested": "185000",
"@EstimatedSettlementDate": "2023-11-16",
"@LoanType": "Mortgage Loan",
"@MainProduct": "Yes",
"@OriginatorReferenceID": "PDEADIFI-LD-INO",
"@ProductCode": "1090",
"@ProductName": "Pepper Direct Easy Alt Doc INV Fixed IO",
"@SequenceNumber": "0",
"@UniqueID": "efd4795eb61a"
},
"Overview": {
"@ApplicationType": "Loan",
"@BrokerApplicationReferenceNumber": "APP-F1N0VF",
"@DocType": "Lo Doc",
"@LenderApplicationReferenceNumber": "MO-303780",
"@LodgementReferenceNumber": "APP-F1N0VF",
"@LodgementSequenceNumber": "1"
},
"PersonApplicant": [{
"Contact": {
"CurrentAddress": {
"@HousingStatus": "Renting",
"@StartDate": "2020-02-05",
"@x_MailingAddress": "c5b3d9956b64",
"@x_ResidentialAddress": "c5b3d9956b64"
},
"EmailAddress": {
"@UniqueID": "a4b34e68e2d1",
"@Email": "test@test.au"
},
"HomePhone": {
"@CountryCode": "64",
"@NewZealandDialingCode": "01",
"@Number": "34"
},
"PostSettlementAddress": {
"@HousingStatus": "Own Home",
"@x_MailingAddress": "c5b3d9956b64",
"@x_ResidentialAddress": "c5b3d9956b64"
},
"WorkPhone": {
"@CountryCode": "64",
"@NewZealandDialingCode": "021",
"@Number": "65467897"
},
"@PreferredContact": "Work Phone"
},
"CreditHistory": {
"@UniqueID": "c6cef8f477b5"
},
"Employment": [{
"PAYE": {
"Income": {
"@GrossSalaryAmount": "120000",
"@GrossSalaryFrequency": "Yearly"
},
"@ANZSCOOccupationCode": "111111",
"@Basis": "Full Time",
"@Occupation": "Chief Executive or Managing Director",
"@OnProbation": "No",
"@SequenceNumber": "0",
"@StartDate": "2010-02-10",
"@Status": "Primary",
"@UniqueID": "ed634fa41a55",
"@x_Employer": "a4b8e2d5a81b"
}
}],
"PersonName": {
"@FirstName": "Ian",
"@NameTitle": "Mr",
"@Surname": "Abbott"
},
"Privacy": {
"@AllowCreditCheck": "Yes",
"@AllowDirectMarketing": "No",
"@AllowTelemarketing": "No",
"@AllowThirdPartyDisclosure": "Yes",
"@CreditAuthoritySigned": "No",
"@DateSigned": "2023-09-29",
"@PrivacyActConsentSigned": "Yes"
},
"ProofOfIdentity": [{
"@ExpiryDate": "2024-10-15",
"@DOBVerified": "No",
"@DateOfIssue": "1959-10-14",
"@DocumentCategory": "Non Photographic",
"@DocumentNumber": "123456789975",
"@DocumentType": "New Zealand Birth Certificate",
"@NameOnDocument": "ian",
"@NameVerified": "No",
"@Original": "No",
"@PlaceOfIssue": "test place of issue",
"@SequenceNumber": "0",
"@UniqueID": "a90352a30fa6"
}],
"ResponsibleLending": {
"Mitigant": {
"@UniqueID": "a5c946d922b7"
},
"SignificantChange": {
"@UniqueID": "e4bc4900ab04"
},
"@AnticipatedChanges": "No"
},
"@ApplicantType": "Borrower",
"@Citizenship": "NZ",
"@DateOfBirth": "1957-09-20",
"@FirstHomeBuyer": "No",
"@Gender": "Male",
"@HasPreviousName": "No",
"@IsExistingCustomer": "No",
"@JointNomination": "No",
"@MaritalStatus": "Single",
"@POAGranted": "No",
"@PrimaryApplicant": "Yes",
"@ResidencyStatus": "Permanently in New Zealand",
"@SequenceNumber": "0",
"@UniqueID": "a0030d9d2870",
"@x_Household": "b975f81c2c2f",
"@x_Solicitor": "c03dd3c4f2c2"
}],
"RealEstateAsset": [{
"EstimatedValue": {
"@EstimateBasis": "Applicant Estimate",
"@Value": "375000"
},
"PercentOwned": {
"Owner": [{
"@Percent": "100",
"@x_Party": "a0030d9d2870"
}],
"@Proportions": "Equal"
},
"PropertyExpense": {
"@Amount": "275000",
"@Frequency": "Yearly"
},
"Residential": {
"@Type": "Duplex"
},
"@Construction": "No",
"@Holding": "Sole",
"@PrimaryPurpose": "Owner Occupied",
"@PrimarySecurity": "Yes",
"@PrimaryUsage": "Residential",
"@PropertyID": "ChIJf4pYU5JMDW0RSgvHj01Wctk",
"@SequenceNumber": "0",
"@Status": "Established",
"@ToBeUsedAsSecurity": "Yes",
"@Transaction": "Owns",
"@UniqueID": "f857ae9f5f78",
"@x_Address": "d177811716f4"
}],
"RelatedCompany": [
{
"Contact": {
"@x_Address": "bb97ea2bdbc9"
},
"@BusinessName": "test paye",
"@CompanyName": "test paye",
"@NZBNVerified": "No",
"@SequenceNumber": "4",
"@UniqueID": "a4b8e2d5a81b"
},
{
"Contact": {
"OfficePhone": {
"@CountryCode": "02",
"@Number": "1234",
"@OverseasDialingCode": "12"
},
"@x_Address": "aed1a4e5472e"
},
"@BusinessName": "test soli",
"@CompanyName": "test soli",
"@NZBNVerified": "No",
"@SequenceNumber": "2",
"@UniqueID": "c03dd3c4f2c2"
}
],
"SalesChannel": {
"Company": {
"Contact": {
"OfficePhone": {
"@CountryCode": "64",
"@NewZealandDialingCode": "0800",
"@Number": "945658"
},
"@WebAddress": "www.peppermoney.co.nz",
"@x_Address": "d66ff9a1e37f"
},
"@CompanyName": "PEPPER DIRECT NEW ZEALAND",
"@NZBN": "9429031065153",
"@OtherIdentifier": "CJF1QZ"
},
"LoanWriter": {
"Contact": {
"Mobile": {
"@CountryCode": "64",
"@NewZealandDialingCode": "020",
"@Number": "123456"
},
"@Email": "bkumar_nzdirect@pepper.com.au"
},
"@AccreditationNumber": "051248012",
"@FirstName": "Balaji",
"@NameTitle": "Mr",
"@OtherIdentifier": "UQDA87",
"@Surname": "Kumar",
"@UniqueID": "c2080badb441"
},
"Aggregator": {
"@AccreditationNumber": "49541"
}
},
"@UniqueID": "APP-F1N0VF"
}
},
"Instructions": {
"ApplicationInstructions": {
"Submit": {
"@AssessmentType": "Full",
"@IsAccountVariation": "No",
"@IsResubmission": "No"
}
}
},
"Publisher": {
"PhoneNumber": {
"@CountryCode": "61",
"@Number": "746765",
"@OverseasDialingCode": "1300"
},
"Software": {
"@Description": "The Most Advanced Electronic Lodgement tool. Loanapp is the dynamically configurable loan application tool that connects brokers and lenders in real-time.",
"@LIXICode": "SPLMO1",
"@Name": "LOANAPP",
"@TechnicalEmail": "itoperations@simpology.com.au",
"@Version": "1.0.0"
},
"@CompanyName": "Simpology Pty Limited",
"@ContactName": "Kate Gubbins",
"@Email": "support@simpology.com.au",
"@LIXICode": "SPLMO1"
},
"Recipient": {
"@Description": "PEPPER DIRECT NEW ZEALAND",
"@LIXICode": "MPKDCW2"
},
"SchemaVersion": {
"@GuidebookCode": "EGBT-37E39",
"@GuidebookVersion": "1.0.22",
"@GuidebookName": "Standard Residential Mortgages DEV",
"@LIXIVersion": "2.0.25",
"@LIXITransactionType": "CNZ"
},
"@UniqueID": "PACK-F1N0VF"
}
}Status Response Codes
- 200: OK
- 401: Unauthorized - Check whether your credentials are correct
- 404: Resource Not Found - Check if you have correct resource URI
- 405: Method Not Allowed - Check if you have valid methods for the resource
- 408: Request Timeout - The API could be still processing your request, try to adjust connection timeout
- 500: Unexpected Server Error - If this issue persists, contact support for troubleshooting
- 503: Service Unavailable - Server is handling too many request at this moment. try again later or reach out to support if issue persists
- 504: Gateway Timeout - There might be a problem with the load-balancer, reach out to support if issue persists
Contact
| Contact | Description |
|---|---|
| Pepper IT support email | dl-digitalalchemy@pepper.com.au |