Direct Integration API

(0 reviews)

Party

Sample Request

{
    "Package": {
        "Content": {
            "Application": {
                "PersonApplicant": [
                    {
                        "@UniqueID": "uPersonApplicant0",
                        "@ApplicantType": "Borrower",
                        "@PrimaryApplicant": "No",
                        "@IsExistingCustomer": "No",
                        "@POAGranted": "No",
                        "@JointNomination": "No",
                        "@FirstHomeBuyer": "No",
                        "@EligibleForFHOG": "No",
                         "Privacy": {
                            "@AllowDirectMarketing": "No",
                            "@AllowCreditCheck": "Yes",
                            "@AllowTelemarketing": "No",
                            "@AllowThirdPartyDisclosure": "Yes",
                            "@CreditAuthoritySigned": "Yes",
                            "@PrivacyActConsentSigned": "Yes",
                            "@DateSigned": "2024-02-07"
                        },
                         "ResponsibleLending": {
                            "Mitigant": {
                                "@UniqueID": "d0a07d30e83d",
                                "@Factor": "Application Reflects Changes",
                                "Description": "Application reflects changes"
                            },
                            "SignificantChange": {
                                "@UniqueID": "c7dc1f42933b",
                                "@Change": "Anticipated Large Expenditure",
                                "@Description": "Anticipated Large Expenditure Change",
                                "@StartDate": "2024-01-01"",
                                "@EndDate": "2025-01-01"
                            },
                            "@AnticipatedChanges": "Yes"
                        }
                    }
                ]
            }
        }
    }
}

Detailed description of each field:

Field Name	Description	Type	Path	Required	Enumerations	Note
PersonApplicant	Contains applicant details where the applicant is a person, being either a borrower or a guarantor, and may be acting for a Trust	object	Package.Content.Application.PersonApplicant
@UniqueID	System assigned unique identifier	string	Package.Content.Application.PersonApplicant.UniqueID	Yes		If Party Exists
@ApplicantType	Whether the loan party is an borrower or guarantor	string	Package.Content.Application.PersonApplicant.ApplicantType	Yes	Borrower, Guarantor
@PrimaryApplicant	Indicates 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 lender	string	Package.Content.Application.PersonApplicant.PrimaryApplicant	Yes	Yes, No
@IsExistingCustomer	Indicates whether the applicant is an existing customer of the lender being applied to	string	Package.Content.Application.PersonApplicant.IsExistingCustomer		Yes, No
Privacy	Indicates whether the Party has agreed to allow disclosure and contains details of identity and credit checks	object	Package.Content.Application.PersonApplicant.Privacy
@AllowDirectMarketing	Indicates whether this Party will allow their personal details to be used for direct marketing purposes	string	Package.Content.Application.PersonApplicant.Privacy.AllowDirectMarketing	Yes	Yes, No	Mandatory if category is applicant
@AllowCreditCheck	Indicates whether this Party will allow a credit check using their personal details as a reference	string	Package.Content.Application.PersonApplicant.Privacy.AllowCreditCheck	Yes	Yes, No	Mandatory if category is applicant
@AllowTelemarketing	Each party may indicate if they are willing to be contacted for telemarketing	string	Package.Content.Application.PersonApplicant.Privacy.AllowTelemarketing		Yes, No
@AllowThirdPartyDisclosure	Indicates whether this Party will allow their personal details to be disclosed to third parties affiliated with this lender	string	Package.Content.Application.PersonApplicant.Privacy.AllowThirdPartyDisclosure	Yes	Yes, No	Mandatory if category is applicant
@CreditAuthoritySigned	Indicates if the applicant has signed a Credit Authority form to request a credit report	string	Package.Content.Application.PersonApplicant.Privacy.CreditAuthoritySigned		Yes, No
@PrivacyActConsentSigned	Indicates if the applicant has signed a Privacy Act consent form	string	Package.Content.Application.PersonApplicant.Privacy.PrivacyActConsentSigned	Yes	Yes, No	Mandatory if category is applicant
@DateSigned	The date on which the applicant signed the privacy consent/declaration that supports the responses provided to the privacy questions	date	Package.Content.Application.PersonApplicant.Privacy.DateSigned	Yes		Mandatory only if Privacy consent signed is available
@POAGranted	Flag to Indicate that the party has granted a power of attorney and that the agent will execute the loan documentation	string	Package.Content.Application.PersonApplicant.POAGranted		Yes, No
@JointNomination	Flag to indicate whether the borrower is nominating another borrower to receive notices jointly	string	Package.Content.Application.PersonApplicant.JointNomination		Yes, No
PowerOfAttorney	Container element for details of a power of attorney granted by the party	object	Package.Content.Application.PersonApplicant.PowerOfAttorney
@Type	Indicates the type of power granted to the POA Holder	string	Package.Content.Application.PersonApplicant.PowerOfAttorney.Type		Company, Enduring, General, Other
NominatedBorrower	Joint Borrowers who reside at the same address may choose to nominate one of them as the person who will receive notices and other documents relating to the loan, so that they do not have to each receive their own copy of any notices and other documents	object	Package.Content.Application.PersonApplicant.NominatedBorrower
@x_Nominee	Link to nominated borrower	string	Package.Content.Application.PersonApplicant.NominatedBorrower.x_Nominee
@EligibleForFHOG	The person should indicate whether they are eligible for a First Home Owners Grants as per the state governments requirements	string	Package.Content.Application.PersonApplicant.EligibleForFHOG		Yes, No
@FirstHomeBuyer	The person should indicate whether they are a first home buyer in accordance with the State Revenue Office's definition of a first home buyer	string	Package.Content.Application.PersonApplicant.FirstHomeBuyer		Yes, No
ResponsibleLending	Captures information about any significant changes in circumstances that will adversely affect the applicant's ability to make contracted loan repayments; the nature of the change, and how they will continue to make repayments	object	Package.Content.Application.PersonApplicant.ResponsibleLending
@AnticipatedChanges	Each 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 repayments	string	Package.Content.Application.PersonApplicant.ResponsibleLending.AnticipatedChanges	Yes	Yes, No	Mandatory if category is applicant
SignificantChange	The kind of change the applicant is expecting	object	Package.Content.Application.PersonApplicant.ResponsibleLending.SignificantChange
@UniqueID	Unique Identifier for this Significant Change Element	string	Package.Content.Application.PersonApplicant.ResponsibleLending.SignificantChange.UniqueID	Yes		Mandatory if category is Applicant and partyType is Person
@Change	The kind of change the applicant is expecting	string	Package.Content.Application.PersonApplicant.ResponsibleLending.SignificantChange.Change	Yes	Anticipated Large Expenditure, Permanent Decrease in Income, Permanent Increase in Expense, Retirement, Temporary Decrease in Income, Temporary Increase in Expense	Mandatory if anticipatedChanges = True
@Description	Captures a free text description of the change	string	Package.Content.Application.PersonApplicant.ResponsibleLending.SignificantChange.Description	Yes		Mandatory if anticipatedChanges = True
@StartDate	The anticipated start date of the change in circumstances	date	Package.Content.Application.PersonApplicant.ResponsibleLending.SignificantChange.StartDate	Yes		Mandatory if anticipatedChanges = True
@EndDate	The anticipated end date of the change in circumstances	date	Package.Content.Application.PersonApplicant.ResponsibleLending.SignificantChange.EndDate	Yes		Mandatory if anticipatedChanges = True
Mitigant	In relation to the significant changes, it must be possible to provide one or more mitigants for the significant changes	object	Package.Content.Application.PersonApplicant.ResponsibleLending.Mitigant
@UniqueID	Unique Identifier for this Mitigant Element	string	Package.Content.Application.PersonApplicant.ResponsibleLending.Mitgant.UniqueID	Yes		Mandatory if category is Applicant and partyType is Person
@Factor	In relation to the significant changes, it must be possible to provide one or more mitigants for the significant changes	string	Package.Content.Application.PersonApplicant.ResponsibleLending.Mitgant.Factor	Yes	Application Reflects Changes, Downsize of Principal in Residence, Other, Reducing Expenditure, Sale of Assets, Securing Additional Income, Using Savings	Mandatory if anticipatedChanges = True
@Description	Captures a free text description of the mitigant factor	string	Package.Content.Application.PersonApplicant.ResponsibleLending.Mitgant.Description	Yes		Mandatory if anticipatedChanges = True
ExistingCustomer	Indicates whether the applicant is an existing customer of the lender being applied to	object	Package.Content.Application.PersonApplicant.ExistingCustomer
@CustomerSince	The approximate year that the applicant became a customer	string	Package.Content.Application.PersonApplicant.ExistingCustomer.CustomerSince
AccountNumber	Account details for an account held that identifies the party as an existing customer	object	Package.Content.Application.PersonApplicant.ExistingCustomer.AccountNumber
@AccountNumber	The unique number assigned to this account. (typically by the financial institution)	string	Package.Content.Application.PersonApplicant.ExistingCustomer.AccountNumber.AccountNumber

Party

Sample Request

Detailed description of each field:

Reviews