Direct Integration API icon

Direct Integration API

(0 reviews)

CompanyApplicant

Sample Request

{
    "Package": {
        "Content": {
            "Application": {
                "CompanyApplicant": [
                    {
                        "BeneficialOwner": [
                            {
                                "@x_BeneficialOwner": "uPersonApplicant0"
                            }
                        ],
                        "Director": [
                            {
                                "@x_Director": "uPersonApplicant0"
                            }
                        ],
                        "ResponsibleLending": {
                            "Mitigant": {
                                "@UniqueID": "e530408fca5c",
                                "@Factor": "Application Reflects Changes",
                                "@Description": "Description"
                            },
                            "SignificantChange": {
                                "@UniqueID": "ce27d4a3d04e",
                                "@Change": "Anticipated Large Expenditure",
                                "@Description": "Description",
                                "@StartDate": "2023-01-01",
                                "@EndDate": "2024-01-01"
                            },
                            "@AnticipatedChanges": "Yes"
                        },
                        "Business": {
                            "@Industry": "Coal Mining",
                            "@IndustryCode": "0600",
                            "@MainBusinessActivity": "MainBusinessActivity",
                            "@StartDate": "2001-06-10"
                        },
                        "Contact": {
                            "OfficePhone": {
                                "@CountryCode": "64",
                                "@NewZealandDialingCode": "01",
                                "@Number": "12"
                            },
                            "ContactPerson": {
                                "@x_ContactPerson": "uContactPerson0"
                            },
                            "@Email": "email@email.com",
                            "@PreferredContact": "Email",
                            "@x_PrincipalTradingAddress": "aa15be2d8a76",
                            "@x_RegisteredAddress": "aa15be2d8a76"
                        },
                        "ExistingCustomer": {
                            "@CustomerSince": "2024"
                        },
                        "Privacy": {
                            "@CreditAuthoritySigned": "No"
                        },
                        "@UniqueID": "dcc41a9ff085",
                        "@AllowDirectMarketing": "Yes",
                        "@AllowThirdPartyDisclosure": "Yes",
                        "@NumberOfDirectors": "1",
                        "@BusinessName": "BusinessName",
                        "@NZBN": "1234567890123",
                        "@CompanyName": "CompanyName",
                        "@CompanyNumber": "1234587",
                        "@RegisteredInCountry": "NZ",
                        "@TypeOfIncorporation": "Pty Ltd",
                        "@TradingMoreThanTwoYears": "Yes",
                        "@IsHoldingCompany": "No",
                        "@ApplicantType": "Borrower",
                        "@DateRegistered": "2000-02-01",
                        "@NZBNVerified": "No",
                        "@RegisteredForGST": "Yes",
                        "@GSTRegisteredDate": "2024-01-01",
                        "@IsExistingCustomer": "No",
                        "@PrimaryApplicant": "Yes",
                        "@BusinessNameSameAsCompanyName": "Yes"
                    }
                ]
            }
        }
    }
}

Detailed description of each field:
Field NameDescriptionTypePathRequiredEnumerationsNote
CompanyApplicantContains applicant details for business enterprises (including company, sole trader, partnership or government department) being either a borrower or a guarantor, and may be acting for a TrustarrayPackage.Content.Application.CompanyApplicant
BeneficialOwnerA beneficial owner of the company. All beneficial owners of the company should be captured (even persons captured elsewhere as directors, shareholders, beneficiaries etc.arrayPackage.Content.Application.CompanyApplicant.BeneficialOwner
@x_BeneficialOwnerA cross reference to the beneficial ownerstringPackage.Content.Application.CompanyApplicant.BeneficialOwner.x_BeneficialOwnerYes
DirectorContains a reference to an applicant or related party that is a director of the companyarrayPackage.Content.Application.CompanyApplicant.Director
@x_DirectorContains a reference to an applicant or related party that is a director of the companystringPackage.Content.Application.CompanyApplicant.Director.x_DirectorYes
ResponsibleLendingCaptures information about any significant changes in circumstances that will adversely affect the applicants' ability to make contracted loan repayments; the nature of the change, and how they will collectively continue to make repaymentsobjectPackage.Content.Application.CompanyApplicant.ResponsibleLending
MitigantIn relation to the significant changes, it must be possible to provide one or more mitigants for the significant changesobjectPackage.Content.Application.CompanyApplicant.ResponsibleLending.Mitigant
@UniqueIDUnique Identifier for this Mitigant ElementstringPackage.Content.Application.CompanyApplicant.ResponsibleLending.Mitigant.UniqueIDYes
@FactorIn relation to the significant changes, it must be possible to provide one or more mitigants for the significant changesstringPackage.Content.Application.CompanyApplicant.ResponsibleLending.Mitigant.FactorApplication Reflects Changes, Downsize of Principal Residence, Other, Reducing Expenditure, Sale of Assets, Securing Additional Income, Using Savings
@DescriptionCaptures a free text description of the mitigant factorstringPackage.Content.Application.CompanyApplicant.ResponsibleLending.Mitigant.DescriptionYes, If Anticipated Changes is Yes
SignificantChangeThe kind of change the applicant is expectingobjectPackage.Content.Application.CompanyApplicant.ResponsibleLending.SignificantChange
@UniqueIDUnique Identifier for this Significant Change ElementstringPackage.Content.Application.CompanyApplicant.ResponsibleLending.SignificantChange.UniqueIDYes
@ChangeThe kind of change the applicant is expectingstringPackage.Content.Application.CompanyApplicant.ResponsibleLending.SignificantChange.ChangeYesAnticipated Large Expenditure, Permanent Decrease in Income, Permanent Increase in Expense, Retirement, Temporary Decrease in Income, Temporary Increase in Expense
@DescriptionCaptures a free text description of the changestringPackage.Content.Application.CompanyApplicant.ResponsibleLending.SignificantChange.DescriptionYes
@StartDateThe anticipated start date of the change in circumstancesstringPackage.Content.Application.CompanyApplicant.ResponsibleLending.SignificantChange.StartDate
@EndDateThe anticipated end date of the change in circumstancesstringPackage.Content.Application.CompanyApplicant.ResponsibleLending.SignificantChange.EndDate
@AnticipatedChangesEach borrower to inform the lender if they are aware of any significant changes in circumstances that will adversely affect their ability to make contracted loan repaymentsstringPackage.Content.Application.CompanyApplicant.ResponsibleLending.AnticipatedChangesYesYes,No
BusinessContains information about the business of the companyobjectPackage.Content.Application.CompanyApplicant.Business
@IndustryCaptures a free text description of the Industry CodestringPackage.Content.Application.CompanyApplicant.Business.IndustryYes
@IndustryCodeThe four digit industry code, from the ANZSIC list of codes. If the nominal code is two or three digits, add '0's to the end to make the four digit codestringPackage.Content.Application.CompanyApplicant.Business.IndustryCodeYes
@MainBusinessActivityThe main activity of the businessstringPackage.Content.Application.CompanyApplicant.Business.MainBusinessActivityYes
@StartDateThe date that the company started operating the business describedstringPackage.Content.Application.CompanyApplicant.Business.StartDateYes
ContactContains contact details for the company applicantobjectPackage.Content.Application.CompanyApplicant.Contact
OfficePhoneOffice number for the companyobjectPackage.Content.Application.CompanyApplicant.Contact.OfficePhone
@CountryCodeCaptures the international dialing code for the country in which the fixed phone number is located, e.g. \"61\" for Australia. Maximum length is 3 digitsstringPackage.Content.Application.CompanyApplicant.Contact.OfficePhone.CountryCodeYes,if preferedcontact is office phone64
@NewZealandDialingCodeThe Area Code prefix for a New Zealand telephone numberstringPackage.Content.Application.CompanyApplicant.Contact.OfficePhone.NewZealandDialingCodeYes,if preferedcontact is office phone01, 011, 020, 021, 022, 023, 024, 025, 026, 027, 028, 029, 03, 04, 05, 050, 0508, 06, 07, 070, 08, 080, 0800, 09, 090, 1, 50
@NumberThe local-dial number. For local rate, free call, satellite or similar special non-overseas numbers where the area or dialing code is not otherwise available, the full phone number. Required, allowed once onlystringPackage.Content.Application.CompanyApplicant.Contact.OfficePhone.NumberYes,if preferedcontact is office phone
ContactPersonA contact person at the companyobjectPackage.Content.Application.CompanyApplicant.Contact.ContactPerson
@x_ContactPersonA contact person at the companystringPackage.Content.Application.CompanyApplicant.Contact.ContactPerson.x_ContactPerson
@EmailAn email address for the companystringPackage.Content.Application.CompanyApplicant.Contact.EmailYes, if PreferredContact is Email
@PreferredContactThe preferred method for contacting this applicantstringPackage.Content.Application.CompanyApplicant.Contact.PreferredContactYesWork Phone, Email
@x_PrincipalTradingAddressThe official address of the company applicant where business is carried outstringPackage.Content.Application.CompanyApplicant.Contact.x_PrincipalTradingAddressYes
@x_RegisteredAddressRegistered address of the companystringPackage.Content.Application.CompanyApplicant.Contact.x_RegisteredAddressYes
ExistingCustomerIndicates whether the applicant is an existing customer of the lender being applied tostringPackage.Content.Application.CompanyApplicant.ExistingCustomer
@CustomerSinceThe approximate year that the applicant became a customerstringPackage.Content.Application.CompanyApplicant.ExistingCustomer.CustomerSince
PrivacyThe applicant's privacy and consent detailsobjectPackage.Content.Application.CompanyApplicant.Privacy
@CreditAuthoritySignedThe applicant has signed a Credit Authority form to request a credit reportstringPackage.Content.Application.CompanyApplicant.Privacy.CreditAuthoritySignedYes,No
@UniqueIDSystem assigned unique identifierstringPackage.Content.Application.CompanyApplicant.UniqueIDYes
@AllowDirectMarketingIndicates whether this Party will allow their details to be used for direct marketing purposesstringPackage.Content.Application.CompanyApplicant.AllowDirectMarketingYesYes,No
@AllowThirdPartyDisclosureIndicates whether this Party will allow their details to be disclosed to third parties affiliated with this lenderstringPackage.Content.Application.CompanyApplicant.AllowThirdPartyDisclosureYesYes,No
@NumberOfDirectorsThe number of directors that company has on its Board of DirectorsstringPackage.Content.Application.CompanyApplicant.NumberOfDirectorsYes
@BusinessNameThe business name or trading name of the company should be capturedstringPackage.Content.Application.CompanyApplicant.BusinessNameYes
@NZBNCaptures the NZBN of the company applicantstringPackage.Content.Application.CompanyApplicant.NZBNYes
@CompanyNameThe legal name of the company should be capturedstringPackage.Content.Application.CompanyApplicant.CompanyNameYes
@CompanyNumberCaptures the registered Company Number of the company applicantstringPackage.Content.Application.CompanyApplicant.CompanyNumberYes
@RegisteredInCountryIndicates the country where the company is registeredstringPackage.Content.Application.CompanyApplicant.RegisteredInCountryYes
@TypeOfIncorporationThe company structure, in the form of the type of incorporationstringPackage.Content.Application.CompanyApplicant.TypeOfIncorporationYesInc, LTC, Ltd, NL, Pty Ltd
@TradingMoreThanTwoYearsIndicate if the business has been trading more than 2 yearssringPackage.Content.Application.CompanyApplicant.TradingMoreThanTwoYearsYes
@IsHoldingCompanyIndicate if the company is a holding companystringPackage.Content.Application.CompanyApplicant.IsHoldingCompanyYes
@ApplicantTypeWhether the loan party is a borrower or guarantorstringPackage.Content.Application.CompanyApplicant.ApplicantTypeYesBorrower, Borrower and Guarantor, Guarantor
@DateRegisteredIndicates the date when the company was registeredstringPackage.Content.Application.CompanyApplicant.DateRegisteredYes
@NZBNVerifiedFlag to indicate that the business number has been verified by a searchstringPackage.Content.Application.CompanyApplicant.NZBNVerifiedYesYes,No
@RegisteredForGSTFlag to indicate whether the company is registered for GSTtringPackage.Content.Application.RelatedCompany.RegisteredForGSTYes, No
@GSTRegisteredDateIf registered for GST, the date from which the company is registeredstringPackage.Content.Application.CompanyApplicant.GSTRegisteredDateYes, RegisteredForGST is Yes
@IsExistingCustomerIndicates whether the applicant is an existing customer of the lender being applied tostringPackage.Content.Application.CompanyApplicant.IsExistingCustomerYes,No
@PrimaryApplicantIndicates whether the lender should consider the party to be the primary applicant when processing the loan application. The significance of the primary applicant to the application varies from lender to lenderstringPackage.Content.Application.CompanyApplicant.PrimaryApplicant
@BusinessNameSameAsCompanyNameIndicates if the Business Name is the same as the Company NamestringPackage.Content.Application.CompanyApplicant.BusinessNameSameAsCompanyNameYes, No

Reviews