--- swagger: "2.0" info: description: The Onboarding API allows you to initiate the basic account opening process for new customers. The resources allow you to present eligible products, send applications for screening and submit a new application for one or more products. The resources also allow you to submit supporting documents. Application status can be checked at any point in the process, with decisioning happening in real time. title: Onboarding version: 1.0.0 x-ibm-name: onboarding_100 schemes: - https basePath: /api consumes: - application/json produces: - application/json x-ibm-configuration: enforced: true phase: realized testable: true tags: [] securityDefinitions: Client_id: type: apiKey name: X-IBM-Client-Id in: header description: "" security: - Client_id: [] definitions: Product: properties: productCode: description: A unique code that identifies the product. type: string example: VC380 productDescription: description: Detailed information about offered product type: string example: Citibank SMRT Visa Card sourceCode: description: A source code to identify the product. type: string example: WW5ARCE1 logo: description: Logo to identify the product. type: string example: "830" organisation: description: Card issuing organization name type: string example: "888" productType: description: Type of the product.This is a reference data field. Please use /v1/apac/utilities/referenceData/{productType} resource to get valid values of this field with descriptions. type: string example: CC minimumCreditLimitAmount: description: Minimum credit limit amount for the product type type: number format: double example: 5000.250000 maximumCreditLimitAmount: description: Maximum credit limit amount for the product type type: number format: double example: 10000.250000 annualFeeAmount: description: Annual fees for product type and source code type: number format: double example: 100.250000 currencyCode: description: The currency code in ISO 4217 format type: string example: SGD interestRate: description: Annual interest rate type: number format: double example: 28.250000 latePaymentFee: description: Late payment fee for the product type and source code type: number format: double example: 150.250000 importantInformations: description: Important informations to know about the product type type: string example: All Rewards are subject to the terms and conditions of the Citibank Rewards Program. termsAndConditions: description: Fees, charges and credit criteria apply. Terms and conditions apply and are available upon request. Cards are offered, issued and administered by Citigroup Pty Limited.Allow up to 15 working days to process your Application subject to verification. type: string example: Terms and conditions agreementStartDate: description: Product validity start date in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2016-10-10" agreementExpiryDate: description: Product validity expiry date in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2018-12-10" required: - productCode - sourceCode - productDescription - productType - maximumCreditLimitAmount - currencyCode - interestRate - latePaymentFee - importantInformations - termsAndConditions - agreementStartDate - agreementExpiryDate - minimumCreditLimitAmount ProductCatalogueResponse: properties: products: type: array items: $ref: '#/definitions/Product' nextStartIndex: description: The next start index of the next subset of products. type: string example: "11" required: - products ErrorResponse: properties: type: description: Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again enum: - error - warn - invalid - fatal type: string code: description: Error code which qualifies the error type: string details: description: Human readable explanation specific to the occurrence of the problem type: string location: description: The name of the field that resulted in the error type: string moreInfo: description: URI to human readable documentation of the error type: object required: - type - code ApplicationAddKycInformation: properties: selfPublicFigureDeclarationFlag: description: 'Flag for self declaration if applicant is public figure. Valid values: true and false' type: boolean example: true publicFigureOfficeStatus: description: Flag for status of public office if applicant is public figure type: string example: Active publicFigureOfficeDetails: description: Office details if applicant is public figure type: string example: Department of education and training publicFigureOfficeStartDate: description: Public figure office start date in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2017-04-12" publicFigureOfficeEndDate: description: Public figure office end date in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2020-04-11" isRelatedToSeniorPublicFigure: description: 'Self declaration if applicant has any relation with senior public figure. Valid values: true and false' type: boolean example: true relatedSeniorPublicFigureName: description: Senior Public Figure Name type: string example: Dan Lee relatedSpfCountryOfGovernment: description: Senior Public Figure Country of Government type: string example: SG relatedSeniorPublicFigureDepartment: description: Department Senior Public Figure belongs to type: string example: Ministry relationshipWithSeniorPublicFigure: description: Senior Public Figure relationship with applicant type: string example: Father relatedSeniorPublicFigureLastName: description: Senior Public Figure Last Name type: string example: Lee usTaxStatus: description: US Tax status. This is a reference data field. Please use /v1/apac/utilities/referenceData/{usTaxStatus} resource to get valid value of this field with description. You can use usTaxStatus field name as the referenceCode parameter to retrieve the values. type: string example: US_PERSON_REPORTABLE_DOCUMENTED usTaxId: description: US Tax ID type: string example: US234567 ApplicationAddAddress: properties: addressType: description: Type of address. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use addressType field name as the referenceCode parameter to retrieve the values. type: string example: HOME_ADDRESS addressLine1: description: Address line 1 type: string example: 40A Orchard Road addressLine2: description: Address line 2 type: string example: '#99-99 Macdonald House' addressLine3: description: Address line 3 type: string example: Orchard Avenue 2 addressLine4: description: Address line 4 type: string example: Street 65 cityName: description: City type: string example: Singapore state: description: State.This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressState} resource to get valid value of this field with description. You can use addressState field name as the referenceCode parameter to retrieve the values. type: string example: Singapore postalCode: description: Postal/ZIP code type: string example: "345346" provinceCode: description: Province code type: string example: Singapore countryCode: description: ISO country code. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use countryCode field name as the referenceCode parameter to retrieve the values. type: string example: SG okToMail: description: 'Applicant''s consent for receiving mail. Valid values: true and false' type: boolean example: true residenceDurationInYears: description: Applicant's residence duration in the current address in years. Applicable only for residential address. type: integer example: 5 residenceDurationInMonths: description: Applicant's residence duration in the current address in months. Applicable only for residential address. type: integer example: 4 countrySpecificAddress: $ref: '#/definitions/ApplicationAddCountrySpecificAddress' ApplicationAddContactPreference: properties: sendSmsAdviceFlag: description: 'Applicant''s subscription for receiving advices through SMS. Valid values: true and false' type: boolean example: true sendEmailAdviceFlag: description: 'Applicant''s subscription for receiving advices through email. Valid values: true and false' type: boolean example: true preferredMailingAddress: description: Preferred Mailing Address by applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use preferredMailingAddress field name as the referenceCode parameter to retrieve the values. type: string example: HOME_ADDRESS eStatementEnrollmentFlag: description: 'Applicant''s subscription for receiving statement over email. Valid values: true and false' type: boolean example: true ApplicationAddResponse: properties: applicationId: description: Unique identifier for the application type: string example: ZOW9IO793854 applicationStage: description: Current stage of an application.This is a reference data field. Please use /v1/apac/utilities/referenceData/{applicationStage} resource to get possible value of this field with description. You can use applicationStage field name as the referenceCode parameter to retrieve the values. type: string example: PRESCREENING controlFlowId: description: Control flow id is used to control the flow for subsequent requests in the session. type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId - applicationStage - applicationId ApplicationAddCountrySpecificGroup: properties: bumiputraIndicator: description: 'Indicator to specify the regional race and other indigenous peoples of Southeast Asia, and used particularly in Malaysia. Valid values: true and false.' type: boolean example: true disabilityIndicator: description: 'The instruments issued to applicants are provided with special needs like brailed characters on statements. Valid values: true and false.' type: boolean example: true unionPayCardNumber: description: Applicant's union pay card number to link the product. type: string example: "5555666600008888" taxFileNumber: description: Applicant's tax file number to link the product. type: string example: "656456737" ApplicationAddProduct: properties: creditCardProduct: $ref: '#/definitions/ApplicationAddCreditCardProduct' readyCreditProduct: $ref: '#/definitions/ApplicationAddReadyCreditProduct' unsecuredLoanProduct: $ref: '#/definitions/ApplicationAddUnsecuredLoanProduct' minimum: 1 ApplicationAddConsentDetails: properties: consentType: description: Applicant's consent types. This is a reference data field. Please use /v1/apac/utilities/referenceData/{consentType} resource to get valid value of this field with description. You can use consentType field name as the referenceCode parameter to retrieve the values. type: string example: BUREAU_PULL_CONSENT isConsentGiven: description: 'Consent flag. Valid values: true and false' type: boolean example: true ApplicationAddOcr: properties: ocrReferenceNumber: description: OCR (Optical Character Recognition) Reference number type: string example: OCR456789434538922 ApplicationAddFinancialInformation: properties: hasForeseeableFinancialChanges: description: Indicates whether any foreseeable changes in customer's financial circumstances. type: boolean example: true nonBankDebtObligationFlag: description: Indicates if the applicant has any loan with any non-banking financial organization. type: boolean example: true expenseDetails: type: array items: $ref: '#/definitions/ApplicationAddExpenseDetails' incomeDetails: type: array items: $ref: '#/definitions/ApplicationAddIncomeDetails' existingLoanDetails: type: array items: $ref: '#/definitions/ApplicationAddExistingLoanDetails' ApplicationAddEducation: properties: highestEducationLevel: description: Highest education level of the applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{highestEducationLevel} resource to get valid value of this field with description. You can use highestEducationLevel field name as the referenceCode parameter to retrieve the values. type: string example: MASTER yearOfGraduation: description: Year of completing graduation. This is required if applicant is a student type: string example: "2003" studentId: description: Unique ID of the student. This is required if applicant is a student type: string example: STID234567 university: description: University name. This is a reference data field. Please use /v1/apac/utilities/referenceData/{universityCode} resource to get valid value of this field with description. You can use university field name as the referenceCode parameter to retrieve the values. type: string example: NTU ApplicationAddIdentificationDocumentDetails: properties: idType: description: Type of Identification document. This is a reference data field. Please use /v1/apac/utilities/referenceData/{idType} resource to get valid values of this field with descriptions type: string example: PASSPORT idNumber: description: 'Unique identifier of identification document. Ex: Passport Number' type: string example: S42258011 idExpiryDate: description: Expiry date of identification document in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2027-04-11" idIssueDate: description: Issuance date of identification document in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2017-04-12" idIssuePlace: description: Identification document issuance place type: string example: AU idIssueState: description: State from which identification document was issued.This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressState} resource to get valid value of this field with description. You can use addressState field name as the referenceCode parameter to retrieve the values. type: string example: QUEENSLAND idIssueCountry: description: Country of issuance. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use idIssueCountry field name as the referenceCode parameter to retrieve the values. type: string example: AU isPrimaryId: description: 'Flag to mark primary identification document. Valid values: true and false' type: boolean example: true ApplicationAddCountrySpecificAddress: properties: unitNumber: description: Applicant's unit Number type: string example: "99" floorNumber: description: Applicant's floor Number type: string example: "18" blockNumber: description: Applicant's block Number type: string example: "19" buildingName: description: Applicant's building Name type: string example: Estella estateName: description: Applicant's estate Name type: string example: Marine Parade streetNumber: description: Applicant's street Number type: string example: "52" streetName: description: Applicant's street Name type: string example: Marine Parade streetType: description: Applicant's street Type.Please use /v1/apac/utilities/referenceData/{streetType} resource to get valid value of this field with description. You can use streetType field name as the referenceCode parameter to retrieve the values type: string example: ARCADE town: description: Applicant's town type: string example: SG ApplicationAddReadyCreditProduct: properties: productCode: description: A unique code that identifies the product type: string example: US251 sourceCode: description: A source code to identify the product type: string example: PGP144 organization: description: Card issuing organization name type: string example: "030" logo: description: Product logo to identify the product type: string example: PNC1 requestCreditShield: description: 'Insurance enrolment for outstanding balance on the card. Valid values: true and false' type: boolean example: false embossName: description: Name to be embossed on card type: string example: Matthew Hayden billingAddress: description: Billing address of applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use addressType field name as the referenceCode parameter to retrieve the values. type: string example: OFFICE_ADDRESS cardDeliveryAddress: description: Card delivery address of applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use addressType field name as the referenceCode parameter to retrieve the values. type: string example: OFFICE_ADDRESS pinDeliveryAddress: description: Delivery address for card pin of applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use addressType field name as the referenceCode parameter to retrieve the values. type: string example: OFFICE_ADDRESS giftCode: description: A unique code that identifies the gift offered along with the product type: string example: gc123 creditLimitIncreaseIndicator: description: 'Option for to review the credit limit in the future.Valid values: true and false' type: boolean example: true atmRequiredFlag: description: 'Option to get ATM card along with product. Valid values: true and false' type: boolean example: true chequeBookRequiredFlag: description: 'Option to get cheque book along with product. Valid values: true and false' type: boolean example: true required: - productCode - sourceCode - organization - logo ApplicationAddPartnerCustomerDetails: properties: partnerCustomerInternalId: description: Unique customer internal number associated with the partner. type: string example: ZOW9IO793855 partnerCustomerId: description: Unique customer Id associated with the partner type: string example: P011100000125 partnerCustomerSegment: description: Partner customer segment.This is a reference data field. Please use /v1/apac/utilities/referenceData/{partnerCustomerSegment} resource to get possible value of this field with description. You can use partnerCustomerSegment field name as the referenceCode parameter to retrieve the values. type: string example: AD1 ApplicationAddExpenseDetails: properties: expenseType: description: Expense type. This is a reference data field. Please use /v1/apac/utilities/referenceData/{expenseType} resource to get valid value of this field with description. You can use expenseType field name as the referenceCode parameter to retrieve the values. type: string example: COSTS_OF_LIVING expenseAmount: description: Expenditure amount for an applicant type: number format: double example: 590.250000 frequency: description: Expense Frequency. This is a reference data field. Please use /v1/apac/utilities/referenceData/{frequency} resource to get valid value of this field with description. You can use frequency field name as the referenceCode parameter to retrieve the values. type: string example: MONTHLY ApplicationAddIncomeDetails: properties: incomeType: description: Income type. This is a reference data field. Please use /v1/apac/utilities/referenceData/{incomeType} resource to get valid value of this field with description. You can use incomeType field name as the referenceCode parameter to retrieve the values. type: string example: DECLARED_FIXED fixedAmount: description: Fixed income amount of applicant type: number format: double example: 7590.250000 variableAmount: description: Variable income amount of applicant type: number format: double example: 1590.250000 frequency: description: Income Frequency. This is a reference data field. Please use /v1/apac/utilities/referenceData/{frequency} resource to get valid value of this field with description. You can use frequency field name as the referenceCode parameter to retrieve the values. type: string example: MONTHLY otherIncomeDescription: description: Description of income from other sources type: string example: Rent ApplicationAddAdditionalData: properties: numberOfDependents: description: Number of dependents type: number example: "3" staffIndicator: description: 'Flag to indicates if applicant is a Citi Staff. Valid values: true and false' type: boolean example: true businessNature: description: Business nature of the applicant This is a reference data field. Please use /v1/apac/utilities/referenceData/{businessNature} resource to get valid value of this field with description. You can use businessNature field name as the referenceCode parameter to retrieve the values. type: string example: BANKING_FINANCIAL_INSTITUTIONS emergencyContactName: description: Emergency contact Name type: string example: Pearline emergencyContactPhoneNumber: description: Emergency contact Number. type: string example: "6164042321" overLimitConsentFlag: description: 'Customer consent on spending more than the limit assigned to him. Valid values: true and false' type: boolean example: true countrySpecificGroup: $ref: '#/definitions/ApplicationAddCountrySpecificGroup' primaryBankDetails: $ref: '#/definitions/ApplicationAddPrimaryBankDetails' referralGivenName: description: Referral First Name. type: string example: Maxwell referralSurname: description: Referral Surname/Last Name. type: string example: Gate relatedToCitiEmployeeFlag: description: 'Self declaration if applicant has any relation with citi bank employee. Valid values: true and false' type: boolean example: true relatedCitiEmployeeName: description: Name of the citi employee if applicant has any relation with citi bank employee. type: string example: Anderson relatedCitiEmployeeDepartment: description: Department of citi employee if applicant has any relation with citi bank employee. type: string example: Finance creditCardUsagePurpose: description: Indicates applicants usage of credit card whether it is for personal or business.Please use /v1/apac/utilities/referenceData/{creditCardUsagePurpose} resource to get valid value of this field with description. type: string example: PERSONAL ApplicationAddSelfDeclaration: properties: totalActiveCreditCardLimitAmount: description: Total credit limit of all the credit cards the applicant is holding type: number format: double example: 23000.250000 anticipatedIncomeDecreaseCode: description: 'Anticipated income decrease code. Valid values: Yes and No' type: string example: "Yes" loanTakenIndicator: description: 'To indicate if any loan is outstanding.Valid values: true and false' type: boolean example: true monthlyRepaymentForAllExtLoans: description: Customer declaration for his/her total monthly repayment amount for all the external loans. type: number format: double example: 5000.250000 ApplicationAddDemographics: properties: gender: description: Gender/sex. This is a reference data field. Please use /v1/apac/utilities/referenceData/{gender} resource to get valid value of this field with description. You can use gender field name as the referenceCode parameter to retrieve the values. type: string example: MALE dateOfBirth: description: Applicant's date of birth in ISO 8601 date format YYYY-MM-DD type: string format: date example: "1972-09-15" placeOfBirth: description: Applicant's place of birth type: string example: Sydney countryOfBirth: description: Applicant's Country of birth. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use countryOfBirth field name as the referenceCode parameter to retrieve the values. type: string example: AU nationality: description: Applicant's nationality. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use nationality field name as the referenceCode parameter to retrieve the values. type: string example: AU domicileCountryCode: description: Domicile country code. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use the field name as the referenceCode parameter to retrieve the values. type: string example: SG permanentResidencyCountryCode: description: Permanent residency country code. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use domicileCountryCode field name as the referenceCode parameter to retrieve the values. type: string example: AU maritalStatus: description: Applicant's marital status. This is a reference data field. Please use /v1/apac/utilities/referenceData/{maritalStatus} resource to get valid value of this field with description. You can use maritalStatus field name as the referenceCode parameter to retrieve the values. type: string example: MARRIED residencyStatus: description: Indicate status of residence. This is a reference data field. Please use /v1/apac/utilities/referenceData/{residenceStatus} resource to get valid value of this field with description. You can use residenceStatus field name as the referenceCode parameter to retrieve the values. type: string example: RENTED_HOUSE residenceType: description: Type of Residence. This is a reference data field. Please use /v1/apac/utilities/referenceData/{residenceType} resource to get valid value of this field with description. You can use residenceType field name as the referenceCode parameter to retrieve the values. type: string example: CONDOMINIUM taxDomicileCountryCode: description: Tax domicile country code. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use taxDomicileCountryCode field name as the referenceCode parameter to retrieve the values. type: string example: SG spokenLanguageCode: description: Code for spoken language of applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{spokenLanguageCode} resource to get valid value of this field with description. You can use spokenLanguageCode field name as the referenceCode parameter to retrieve the values. type: string example: EN correspondenceLanguageCode: description: Code for correspondence language of applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{spokenLanguageCode} resource to get valid value of this field with description. You can use correspondenceLanguageCode field name as the referenceCode parameter to retrieve the values. type: string example: EN ApplicationAddPhone: properties: phoneType: description: The type of phone. Ex:OFFICE, HOME, MOBILE, PRIMARY_MOBILE, FAX. This is a reference data field. Please use /v1/apac/utilities/referenceData/{phoneType} resource to get valid value of this field with description. You can use phoneType field name as the referenceCode parameter to retrieve the values. type: string example: PRIMARY_MOBILE_NUMBER phoneCountryCode: description: Country code of phone number type: string example: "61" areaCode: description: The area code of phone number type: string example: "02" phoneNumber: description: Applicant's phone number type: string example: "64042321" extension: description: Extension of telephone number type: string example: "23" okToSms: description: 'Applicant''s consent for receiving sms. This is applicable only if phone type is MOBILE. Valid values: true and false' type: boolean example: true okToCall: description: 'Applicant''s consent for receiving phone calls. Valid values: true and false' type: boolean example: true required: - phoneType - phoneCountryCode - phoneNumber ApplicationAddPrimaryBankDetails: properties: bankName: description: Main bank name with Citi. This is a reference data field. Please use /v1/apac/utilities/referenceData/{bankName} resource to get valid value of this field with description. type: string example: CITIBANK_MALAYSIA accountType: description: Type of the account. This is a reference data field. Please use /v1/apac/utilities/referenceData/{accountType} resource to get valid value of this field with description. type: string example: FIXED_ACCOUNT ApplicationAddName: properties: salutation: description: Salutation. This is a reference data field. Please use /v1/apac/utilities/referenceData/{salutation} resource to get valid value of this field with description. You can use salutation field name as the referenceCode parameter to retrieve the values. type: string example: Mr givenName: description: Given/first name of the applicant type: string example: Matthew middleName: description: Middle name of the applicant type: string example: Du surname: description: Surname/last name of the applicant type: string example: Hayden localEnglishGivenName: description: Local given name in English type: string example: Matthew localEnglishSurname: description: Local surname in English type: string example: Hayden aliasName: description: Alias name of the applicant type: string example: Matt fullName: description: Full name of the applicant. type: string example: John Bill Smith saluteBy: description: Contains value with which applicant like to be addressed. This is a reference data field. Please use /v1/apac/utilities/referenceData/{saluteBy} resource to get valid value of this field with description. You can use saluteBy field name as the referenceCode parameter to retrieve the values. type: string example: SURNAME required: - givenName ApplicationAddRequest: properties: product: $ref: '#/definitions/ApplicationAddProduct' applicant: $ref: '#/definitions/ApplicationAddApplicant' required: - product - applicant ApplicationAddUnsecuredLoanProduct: properties: productCode: description: A unique code that identifies the product type: string example: VC001 sourceCode: description: A source code to identify the product type: string example: S1N7QYDC organization: description: Card issuing Organisation code type: string example: "111" logo: description: Product logo to identify the product type: string example: "001" requestCreditShield: description: 'Insurance enrolment for outstanding balance on the card. Valid values: true and false' type: boolean example: "false" billingAddress: description: Billing address of applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use addressType field name as the referenceCode parameter to retrieve the values. type: string example: LEGAL_OR_RESIDENTIAL_ADDRESS giftCode: description: A unique code that identifies the gift offered along with the product type: string example: gc123 requestedLoanAmount: description: Requested loan amount type: number format: double example: 5500.250000 tenor: description: Tenure of loan. This is a reference data field. Please use /v1/apac/utilities/referenceData/{tenor} resource to get valid value of this field with description. You can use tenor field name as the referenceCode parameter to retrieve the values. type: string example: 36_MONTHS required: - productCode - sourceCode - organization - logo ApplicationAddExistingLoanDetails: properties: loanType: description: Loan Type.This is a reference data field. Please use /v1/apac/utilities/referenceData/{loanType} resource to get valid value of this field with description. You can use loanType field name as the referenceCode parameter to retrieve the values. type: string example: STUDENT_LOAN otherDebtObligationType: description: Other debt obligation type. Free text if others is selected under loan type. Please use /v1/apac/utilities/referenceData/{otherDebtObligationType} resource to get valid value of this field with description. You can use loanType field name as the referenceCode parameter to retrieve the values. type: string example: Free text monthlyInstallmentAmount: description: Monthly repayment amount type: number format: double example: 250.250000 outstandingBalanceAmount: description: Balance Owing type: number format: double example: 5000.250000 debtOwnership: description: Nature debt ownership. Please use /v1/apac/utilities/referenceData/{debtOwnership} resource to get valid value of this field with description. type: string example: JOINT lenderName: description: Name of the lender/non-banking financial institution. type: string example: KINROS CORPORATION ApplicationAddContactConsent: properties: okToCall: description: 'Applicant''s consent for receiving phone calls. Valid values: true and false' type: boolean example: true okToMail: description: 'Applicant''s consent for receiving mails. Valid values: true and false' type: boolean example: true okToSms: description: 'Applicant''s consent for receiving sms. Valid values: true and false' type: boolean example: true ApplicationAddEmail: properties: emailAddress: description: Applicant's email address type: string example: matt.hayden@gmail.com okToEmail: description: 'Applicant''s consent for receiving email. Valid values: true and false' type: boolean example: true isPreferredEmailAddress: description: 'Flag to mark preferred email. Valid values: true and false' type: boolean example: true required: - emailAddress ApplicationAddMarketingConsent: properties: personalDataOptOutOthersFlag: description: Opt out from use of personal data to other person/organization in direct marketing type: boolean example: false ApplicationAddApplicant: properties: ocr: $ref: '#/definitions/ApplicationAddOcr' motherMaidenName: description: Mother's maiden name type: string example: Lisa name: $ref: '#/definitions/ApplicationAddName' demographics: $ref: '#/definitions/ApplicationAddDemographics' address: type: array items: $ref: '#/definitions/ApplicationAddAddress' email: type: array minimum: 1 items: $ref: '#/definitions/ApplicationAddEmail' phone: type: array minimum: 1 items: $ref: '#/definitions/ApplicationAddPhone' contactPreference: $ref: '#/definitions/ApplicationAddContactPreference' contactConsent: $ref: '#/definitions/ApplicationAddContactConsent' financialInformation: $ref: '#/definitions/ApplicationAddFinancialInformation' education: $ref: '#/definitions/ApplicationAddEducation' employmentDetails: type: array items: $ref: '#/definitions/ApplicationAddEmploymentDetails' identificationDocumentDetails: type: array items: $ref: '#/definitions/ApplicationAddIdentificationDocumentDetails' additionalData: $ref: '#/definitions/ApplicationAddAdditionalData' partnerCustomerDetails: $ref: '#/definitions/ApplicationAddPartnerCustomerDetails' consentDetails: type: array items: $ref: '#/definitions/ApplicationAddConsentDetails' marketingConsent: $ref: '#/definitions/ApplicationAddMarketingConsent' selfDeclaration: $ref: '#/definitions/ApplicationAddSelfDeclaration' kycInformation: $ref: '#/definitions/ApplicationAddKycInformation' required: - name - phone ApplicationAddCreditCardProduct: properties: productCode: description: A unique code that identifies the product. type: string example: VC830 sourceCode: description: A source code to identify the product type: string example: WW5ARCE1 organization: description: Card issuing organization name type: string example: "888" logo: description: Product logo to identify the product type: string example: "830" requestCreditShield: description: 'Insurance enrolment for outstanding balance on the card. Valid values: true and false' type: boolean example: "false" embossName: description: Name to be embossed on card.If blank, bank will assign automatically based on the market norms. type: string example: Matthew Hyden billingAddress: description: Billing address of the applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use addressType field as the referenceCode parameter to retrieve the values. type: string example: HOME_ADDRESS cardDeliveryAddress: description: Card delivery address of the applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use addressType field name as the referenceCode parameter to retrieve the values. type: string example: HOME_ADDRESS pinDeliveryAddress: description: Delivery address for card pin of the applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use addressType field name as the referenceCode parameter to retrieve the values. type: string example: HOME_ADDRESS giftCode: description: A unique code that identifies the gift offered along with the product type: string example: gc123 creditLimitIncreaseIndicator: description: 'Option to review the credit limit in the future.Valid values: true and false' type: boolean example: true required: - productCode - sourceCode - organization - logo ApplicationAddEmploymentDetails: properties: employerName: description: Name of the employer. type: string example: Citi Bank jobTitle: description: Job Title. This is a reference data field. Please use /v1/apac/utilities/referenceData/{jobTitle} resource to get valid value of this field with description. You can use jobTitle field name as the referenceCode parameter to retrieve the values. type: string example: ACCOUNTANT occupationCode: description: Occupation code. This is a reference data field. Please use /v1/apac/utilities/referenceData/{occupationCode} resource to get valid value of this field with description. You can use occupationCode field name as the referenceCode parameter to retrieve the values. type: string example: ACCOUNTANT industryCode: description: Code of the industry of employment. This is a reference data field. Please use /v1/apac/utilities/referenceData/{industryCode} resource to get valid value of this field with description. You can use industryCode field name as the referenceCode parameter to retrieve the values. type: string example: CITIBANK_SUB_NON_BANK employmentDurationInYears: description: Employment duration in years type: integer example: 5 employmentDurationInMonths: description: Employment duration in months type: integer example: 3 employmentStatus: description: Status of the employment.This is a reference data field. Please use /v1/apac/utilities/referenceData/{employmentStatus} resource to get valid value of this field with description. You can use the field name as the referenceCode parameter to retrieve the values. type: string example: EMPLOYED monthsInPreviousEmployment: description: Months spent in the previouse employment type: integer example: 5 yearsInPreviousEmployment: description: Years spent in the previouse employment type: integer example: 4 accountantName: description: Accountant or contact's name type: string example: Javier accountantFirmName: description: Accountant's firm or business name type: string example: ACME yearsInIndustry: description: Years spent in industry type: integer example: 5 monthsInIndustry: description: Months spent in industry type: integer example: 6 BackgroundScreeningRequest: properties: controlFlowId: description: Control Flow Id type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId BackgroundScreeningResponse: properties: applicationStage: description: Current stage of an application.This is a reference data field. Please use /v1/apac/utilities/referenceData/{applicationStage} resource to get possible value of this field with description. You can use applicationStage field name as the referenceCode parameter to retrieve the values. type: string example: PRESCREENING ApplicationUpdateIncomeDetails: properties: incomeType: description: Income type. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{incomeType} resource to get valid value of this field with description. You can use incomeType field name as the referenceCode parameter to retrieve the values. type: string example: DECLARED_FIXED fixedAmount: description: Fixed income amount of applicant type: number format: double example: "7590.25" variableAmount: description: Variable income amount of appliacnt type: number format: double example: "1590.25" frequency: description: Income Frequency. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{frequency} resource to get valid value of this field with description. You can use frequency field name as the referenceCode parameter to retrieve the values. type: string example: MONTHLY otherIncomeDescription: description: Description of income from other sources type: string example: Rent ApplicationUpdateExpenseDetails: properties: expenseType: description: Expense type. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{expenseType} resource to get valid value of this field with description. You can use expenseType field name as the referenceCode parameter to retrieve the values. type: string example: COSTS_OF_LIVING expenseAmount: description: Expenditure amount for an applicant type: number format: double example: "590.25" frequency: description: Expense Frequency. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{frequency} resource to get valid value of this field with description. You can use frequency field name as the referenceCode parameter to retrieve the values. type: string example: MONTHLY ApplicationUpdateOcr: properties: ocrReferenceNumber: description: OCR (Optical Character Recognition) Reference number type: string example: OCR456789434538922 ApplicationUpdateContactConsent: properties: okToCall: description: 'Applicant''s consent for receiving phone calls. Valid values: true and false' type: boolean example: "true" okToMail: description: 'Applicant''s consent for receiving mails. Valid values: true and false' type: boolean example: "true" okToSms: description: 'Applicant''s consent for receiving sms. Valid values: true and false' type: boolean example: "true" ApplicationUpdatePhone: properties: phoneType: description: The type of phone. Ex:OFFICE, HOME, MOBILE, PRIMARY_MOBILE, FAX. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{phoneType} resource to get valid value of this field with description. You can use phoneType field name as the referenceCode parameter to retrieve the values. type: string example: PRIMARY_MOBILE_NUMBER phoneCountryCode: description: Country code of telephone number type: string example: "65" areaCode: description: The area code of telephone number type: string example: "02" phoneNumber: description: The phone number of applicant type: string example: "64043401" extension: description: Extension of telephone number type: string example: "23" okToSms: description: 'Applicant''s consent for receiving sms. This is applicable only if phone type is MOBILE. Valid values: true and false' type: boolean example: "true" okToCall: description: 'Applicant''s consent for receiving phone calls. Valid values: true and false' type: boolean example: "true" required: - phoneType - phoneCountryCode - phoneNumber ApplicationUpdateEmploymentDetails: properties: employerName: description: Name of the employer. type: string example: Citi Bank jobTitle: description: Job Title. This is a reference data field. Please use /v1/apac/utilities/referenceData/{jobTitle} resource to get valid value of this field with description. You can use jobTitle field name as the referenceCode parameter to retrieve the values. type: string example: ACCOUNTANT occupationCode: description: Occupation code. This is a reference data field. Please use /v1/apac/utilities/referenceData/{occupationCode} resource to get valid value of this field with description. You can use occupationCode field name as the referenceCode parameter to retrieve the values. type: string example: ACCOUNTANT industryCode: description: Code of the industry of employment. This is a reference data field. Please use /v1/apac/utilities/referenceData/{industryCode} resource to get valid value of this field with description. You can use industryCode field name as the referenceCode parameter to retrieve the values. type: string example: CITIBANK_SUB_NON_BANK employmentDurationInYears: description: Employment duration in years type: integer example: 5 employmentDurationInMonths: description: Employment duration in months type: integer example: 3 employmentStatus: description: Status of the employment.This is a reference data field. Please use /v1/apac/utilities/referenceData/{employmentStatus} resource to get valid value of this field with description. You can use the field name as the referenceCode parameter to retrieve the values. type: string example: EMPLOYED monthsInPreviousEmployment: description: Months spent in the previouse employment type: integer example: 5 yearsInPreviousEmployment: description: Years spent in the previouse employment type: integer example: 4 accountantName: description: Accountant or contact's name type: string example: Javier accountantFirmName: description: Accountant's firm or business name type: string example: ACME yearsInIndustry: description: Years spent in industry type: integer example: 5 monthsInIndustry: description: Months spent in industry type: integer example: 6 ApplicationUpdateConsentDetails: properties: consentType: description: Applicant's consent types. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{consentType} resource to get valid value of this field with description. You can use consentType field name as the referenceCode parameter to retrieve the values. type: string example: PDP_CONSENT isConsentGiven: description: 'Consent flag. Valid values: true and false' type: boolean example: "true" ApplicationUpdateUnsecuredLoanProduct: properties: productCode: description: A unique code that identifies the product type: string example: VC001 sourceCode: description: A source code to identify the product type: string example: S1N7QYDC organization: description: Card issuing Organisation code type: string example: "111" logo: description: Product logo to identify the product type: string example: "001" requestCreditShield: description: 'Insurance enrolment for outstanding balance on the card. Valid values: true and false' type: boolean example: "false" billingAddress: description: Billing address of applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use addressType field name as the referenceCode parameter to retrieve the values. type: string example: LEGAL_OR_RESIDENTIAL_ADDRESS giftCode: description: A unique code that identifies the gift offered along with the product type: string example: gc123 requestedLoanAmount: description: Requested loan amount type: number format: double example: 5500.250000 tenor: description: Tenure of loan. This is a reference data field. Please use /v1/apac/utilities/referenceData/{tenor} resource to get valid value of this field with description. You can use tenor field name as the referenceCode parameter to retrieve the values. type: string example: 36_MONTHS ApplicationUpdateReadyCreditProduct: properties: productCode: description: A unique code that identifies the product type: string example: US251 sourceCode: description: A source code to identify the product type: string example: PGP144 organization: description: Card issuing organization name type: string example: "030" logo: description: Product logo to identify the product type: string example: PNC1 requestCreditShield: description: 'Insurance enrolment for outstanding balance on the card. Valid values: true and false' type: boolean example: "false" embossName: description: Name to be embossed on card type: string example: Matthew Hyden billingAddress: description: Billing address of applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use addressType field name as the referenceCode parameter to retrieve the values. type: string example: OFFICE_ADDRESS cardDeliveryAddress: description: Card delivery address of applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use addressType field name as the referenceCode parameter to retrieve the values. type: string example: OFFICE_ADDRESS pinDeliveryAddress: description: Delivery address for card pin of applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use addressType field name as the referenceCode parameter to retrieve the values. type: string example: OFFICE_ADDRESS giftCode: description: A unique code that identifies the gift offered along with the product type: string example: gc123 creditLimitIncreaseIndicator: description: 'Option for to review the credit limit in the future.Valid values: true and false' type: boolean example: "true" atmRequiredFlag: description: 'Option to get ATM card along with product. Valid values: true and false' type: boolean example: "true" chequeBookRequiredFlag: description: 'Option to get cheque book along with product. Valid values: true and false' type: boolean example: "true" balanceTransferDetails: type: array items: $ref: '#/definitions/ApplicationUpdateBalanceTransferDetails' ApplicationUpdateRequest: properties: product: $ref: '#/definitions/ApplicationUpdateProduct' applicant: $ref: '#/definitions/ApplicationUpdateApplicant' controlFlowId: description: Control flow id is used to control the flow for subsequent requests in the session. type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId ApplicationUpdateExistingLoanDetails: properties: loanType: description: Loan Type.This is a reference data field. Please use /v1/apac/utilities/referenceData/{loanType} resource to get valid value of this field with description. You can use loanType field name as the referenceCode parameter to retrieve the values. type: string example: STUDENT_LOAN otherDebtObligationType: description: Other debt obligation type. type: string example: Free text monthlyInstallmentAmount: description: Monthly repayment amount type: number format: double example: 250.250000 outstandingBalanceAmount: description: Balance Owing type: number format: double example: 5000.250000 debtOwnership: description: Nature debt ownership. Please use /v1/apac/utilities/referenceData/{debtOwnership} resource to get valid value of this field with description. type: string example: JOINT lenderName: description: Name of the lender/non-banking financial institution. type: string example: KINROS CORPORATION ApplicationUpdateBalanceTransferDetails: properties: amountToTransfer: description: Amount to Transfer type: number format: double example: 5000.250000 issuingOrganizationName: description: Name of the Organization to which the fund has to be transferred. This is a reference data field. Please use /v1/apac/utilities/referenceData/{cardIssuingOrganization} resource to get valid value of this field with description. You can use cardIssuingOrganization field name as the referenceCode parameter to retrieve the values. type: string example: VOYAGER accountName: description: Customer's account Name type: string example: Matt accountReferenceNumber: description: Customer's account reference number with biller. type: string example: "521212345121" billerCode: description: It is a unique code to identify a BPAY biller type: string example: "11000125" campaignId: description: Campaign code of the balance transfer. type: string example: C$11785241 required: - amountToTransfer - billerCode ApplicationUpdateCreditCardProduct: properties: productCode: description: A unique code that identifies the product. type: string example: VC830 sourceCode: description: A source code to identify the product type: string example: WW5ARCE1 organization: description: Card issuing organization name type: string example: "888" logo: description: Product logo to identify the product type: string example: "830" requestCreditShield: description: 'Insurance enrolment for outstanding balance on the card. Valid values: true and false' type: boolean example: "true" embossName: description: Name to be embossed on card.If blank, bank will assign automatically based on the market norms. type: string example: Matthew Hyden billingAddress: description: Billing address of applicant. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use addressType field name as the referenceCode parameter to retrieve the values. type: string example: HOME_ADDRESS cardDeliveryAddress: description: Card delivery address of applicant. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use addressType field name as the referenceCode parameter to retrieve the values. type: string example: HOME_ADDRESS pinDeliveryAddress: description: Delivery address for card pin of applicant. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use addressType field name as the referenceCode parameter to retrieve the values. type: string example: HOME_ADDRESS giftCode: description: A unique code that identifies the gift offered along with the product type: string example: gc123 creditLimitIncreaseIndicator: description: 'Option to review the credit limit in the future.Valid values: true and false' type: boolean example: "true" balanceTransferDetails: type: array items: $ref: '#/definitions/ApplicationUpdateBalanceTransferDetails' ApplicationUpdateDemographics: properties: gender: description: Gender/sex. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{gender} resource to get valid value of this field with description. You can use gender field name as the referenceCode parameter to retrieve the values. type: string example: MALE dateOfBirth: description: Applicant's date of birth in ISO 8601 date format YYYY-MM-DD type: string format: "1972-09-15" placeOfBirth: description: Applicant's place of birth type: string example: Sydney countryOfBirth: description: Applicant's Country of birth. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use countryOfBirth field name as the referenceCode parameter to retrieve the values. type: string example: AU nationality: description: Applicant's nationality. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use nationality field name as the referenceCode parameter to retrieve the values. type: string example: AU domicileCountryCode: description: Domicile country code. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use domicileCountryCode field name as the referenceCode parameter to retrieve the values. type: string example: AU permanentResidencyCountryCode: description: Permanent residency country code. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use permanentResidencyCountryCode field name as the referenceCode parameter to retrieve the values. type: string example: AU maritalStatus: description: Applicant's marital status. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{maritalStatus} resource to get valid value of this field with description. You can use maritalStatus field name as the referenceCode parameter to retrieve the values. type: string example: MARRIED residencyStatus: description: Indicate status of residence. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{residenceStatus} resource to get valid value of this field with description. You can use residencyStatus field name as the referenceCode parameter to retrieve the values. type: string example: RENTED_HOUSE residenceType: description: Type of Residence. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{residenceType} resource to get valid value of this field with description. You can use residenceType field name as the referenceCode parameter to retrieve the values. type: string example: CONDOMINIUM taxDomicileCountryCode: description: Tax domicile country code. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use taxDomicileCountryCode field name as the referenceCode parameter to retrieve the values. type: string example: SG spokenLanguageCode: description: Code for spoken language of applicant. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{spokenLanguageCode} resource to get valid value of this field with description. You can use the field name as the referenceCode parameter to retrieve the values. type: string example: EN correspondenceLanguageCode: description: Code for correspondence language of applicant. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{spokenLanguageCode} resource to get valid value of this field with description. You can use the field name as the referenceCode parameter to retrieve the values. type: string example: EN ApplicationUpdateSelfDeclaration: properties: totalActiveCreditCardLimitAmount: description: Total active credit card amount type: number format: double example: "23000.25" anticipatedIncomeDecreaseCode: description: 'Anticipated income decrease code. Valid values: Yes and No' type: string example: "Yes" loanTakenIndicator: description: 'To indicate if a loan has been taken previously. Valid values: true and false' type: boolean example: "true" monthlyRepaymentForAllExtLoans: description: Applicants declaration for his/her total monthly repayment amount for all the external loans. type: number format: double example: 5000.250000 ApplicationUpdateApplicant: properties: name: $ref: '#/definitions/ApplicationUpdateName' phone: type: array minimum: 1 items: $ref: '#/definitions/ApplicationUpdatePhone' email: type: array minimum: 1 items: $ref: '#/definitions/ApplicationUpdateEmail' ocr: $ref: '#/definitions/ApplicationUpdateOcr' demographics: $ref: '#/definitions/ApplicationUpdateDemographics' address: type: array items: $ref: '#/definitions/ApplicationUpdateAddress' contactPreference: $ref: '#/definitions/ApplicationUpdateContactPreference' contactConsent: $ref: '#/definitions/ApplicationUpdateContactConsent' financialInformation: $ref: '#/definitions/ApplicationUpdateFinancialInformation' motherMaidenName: description: Mother's maiden name type: string example: Lisa education: $ref: '#/definitions/ApplicationUpdateEducation' employmentDetails: type: array items: $ref: '#/definitions/ApplicationUpdateEmploymentDetails' identificationDocumentDetails: type: array items: $ref: '#/definitions/ApplicationUpdateIdentificationDocumentDetails' additionalData: $ref: '#/definitions/ApplicationUpdateAdditionalData' partnerCustomerDetails: $ref: '#/definitions/ApplicationUpdatePartnerCustomerDetails' consentDetails: type: array items: $ref: '#/definitions/ApplicationUpdateConsentDetails' marketingConsent: $ref: '#/definitions/ApplicationUpdateMarketingConsent' selfDeclaration: $ref: '#/definitions/ApplicationUpdateSelfDeclaration' kycInformation: $ref: '#/definitions/ApplicationUpdateKycInformation' ApplicationUpdateResponse: properties: applicationStage: description: Application stage of an Application type: string example: BACKGROUND_SCREENING required: - applicationStage ApplicationUpdateName: properties: salutation: description: Salutation. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{salutation} resource to get valid value of this field with description. You can use salutation field name as the referenceCode parameter to retrieve the values. type: string example: Mr givenName: description: Given/first name of the applicant type: string example: Matthew middleName: description: Middle name of the applicant type: string example: Du surname: description: Surname/last name of the applicant type: string example: Hayden localEnglishGivenName: description: Local Given Name in English type: string example: Matthew localEnglishSurname: description: Local surname in English type: string example: Hayden aliasName: description: Alias name of the applicant type: string example: Matt fullName: description: Full name of the applicant. type: string example: John Bill Smith saluteBy: description: Contains value with which applicant like to be addressed. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{saluteBy} resource to get valid value of this field with description. You can use saluteBy field name as the referenceCode parameter to retrieve the values. type: string example: SURNAME required: - givenName ApplicationUpdateFinancialInformation: properties: hasForeseeableFinancialChanges: description: Indicates whether any foreseeable changes in customer's financial circumstances. type: boolean example: true nonBankDebtObligationFlag: description: Indicates if the applicant has any loan with any non-banking financial organization. type: boolean example: true expenseDetails: type: array items: $ref: '#/definitions/ApplicationUpdateExpenseDetails' incomeDetails: type: array items: $ref: '#/definitions/ApplicationUpdateIncomeDetails' existingLoanDetails: type: array items: $ref: '#/definitions/ApplicationUpdateExistingLoanDetails' ApplicationUpdateCountrySpecificGroup: properties: bumiputraIndicator: description: 'Indicator to specify the regional race and other indigenous peoples of Southeast Asia, and used particularly in Malaysia. Valid values: true and false.' type: boolean example: true disabilityIndicator: description: 'The instruments issued to applicants are provided with special needs like brailed characters on statements. Valid values: true and false. Applicable to Singapore only' type: boolean example: "true" unionPayCardNumber: description: Applicant's union pay card number to link the product and applicable to China only type: string example: "5555666600008888" taxFileNumber: description: Applicant's tax file number to link the product and applicable to Australia only type: string example: "656456737" ApplicationUpdateAddress: properties: addressType: description: Type of address. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use the field name as the referenceCode parameter to retrieve the values. type: string example: HOME_ADDRESS addressLine1: description: Address line 1 type: string example: 40A Orchard Road addressLine2: description: Address line 2 type: string example: '#99-99 Macdonald House' addressLine3: description: Address line 3 type: string example: Orchard Avenue 2 addressLine4: description: Address line 4 type: string example: Street 65 cityName: description: City type: string example: Singapore state: description: State.This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressState} resource to get valid value of this field with description. You can use addressState field name as the referenceCode parameter to retrieve the values. type: string example: Singapore postalCode: description: Postal/ZIP code type: string example: "238838" provinceCode: description: Province code type: string example: Singapore countryCode: description: ISO country code. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use countryCode field name as the referenceCode parameter to retrieve the values. type: string example: SG okToMail: description: 'Applicant''s consent for receiving mail. Valid values: true and false' type: boolean example: "true" residenceDurationInYears: description: Applicant's residence duration in the current address in years. Applicable only for residential address. type: integer example: 5 residenceDurationInMonths: description: Applicant's residence duration in the current address in months. Applicable only for residential address. type: integer example: 4 countrySpecificAddress: $ref: '#/definitions/ApplicationUpdateCountrySpecificAddress' ApplicationUpdateEmail: properties: emailAddress: description: Email Id of applicant type: string example: matt.hayden@gmail.com okToEmail: description: 'Applicant''s consent for receiving email. Valid values: true and false' type: boolean example: "true" isPreferredEmailAddress: description: 'Flag to mark preferred email. Valid values: true and false' type: boolean example: "true" required: - emailAddress ApplicationUpdatePrimaryBankDetails: properties: bankName: description: Main bank name with Citi. This is a reference data field. Please use /v1/apac/utilities/referenceData/{bankName} resource to get valid value of this field with description. type: string example: CITIBANK_MALAYSIA accountType: description: Type of the account. This is a reference data field. Please use /v1/apac/utilities/referenceData/{accountType} resource to get valid value of this field with description. type: string example: FIXED_ACCOUNT ApplicationUpdateAdditionalData: properties: numberOfDependents: description: Number of dependants type: number example: "2" staffIndicator: description: 'Flag to indicates if applicant is a Citi Staff. Valid values: true and false' type: boolean example: "true" businessNature: description: Business nature of the applicant. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{businessNature} resource to get valid value of this field with description. You can use businessNature field name as the referenceCode parameter to retrieve the values. type: string example: BANKING_FINANCIAL_INSTITUTIONS emergencyContactName: description: Emergency Contact Name type: string example: Pearline emergencyContactPhoneNumber: description: Emergency Contact Number. type: string example: "65012301" overLimitConsentFlag: description: 'Customer Consent on spending more than the limit assigned to him. Valid values: true and false' type: boolean example: "true" countrySpecificGroup: $ref: '#/definitions/ApplicationUpdateCountrySpecificGroup' primaryBankDetails: $ref: '#/definitions/ApplicationUpdatePrimaryBankDetails' referralGivenName: description: Referral First Name. type: string example: Maxwell referralSurname: description: Referral Surname/Last Name. type: string example: Gate relatedToCitiEmployeeFlag: description: 'Self declaration if applicant has any relation with citi bank employee. Valid values: true and false' type: boolean example: true relatedCitiEmployeeName: description: Name of the citi employee if applicant has any relation with citi bank employee. type: string example: Anderson relatedCitiEmployeeDepartment: description: Department of citi employee if applicant has any relation with citi bank employee. type: string example: Finance creditCardUsagePurpose: description: Indicates applicants usage of credit card whether it is for personal or business.Please use /v1/apac/utilities/referenceData/{creditCardUsagePurpose} resource to get valid value of this field with description. type: string example: PERSONAL ApplicationUpdateCountrySpecificAddress: properties: unitNumber: description: Unit Number type: string example: "99" floorNumber: description: Floor Number type: string example: "18" blockNumber: description: Block Number type: string example: "19" buildingName: description: Building Name type: string example: Estella estateName: description: Estate Name type: string example: Marine Parade streetNumber: description: Street Number type: string example: "52" streetName: description: Street Name type: string example: Marine Parade streetType: description: Applicant's street Type.Please use /v1/apac/utilities/referenceData/{streetType} resource to get valid value of this field with description. You can use streetType field name as the referenceCode parameter to retrieve the values type: string example: ARCADE town: description: Town type: string example: SG ApplicationUpdatePartnerCustomerDetails: properties: partnerCustomerInternalId: description: Unique customer internal number associated with the partner. type: string example: ZOW9IO793855 partnerCustomerId: description: Unique customer Id associated with the partner type: string example: P011100000125 partnerCustomerSegment: description: Partner customer segment.Partner customer segment.This is a reference data field. Please use /v1/apac/utilities/referenceData/{partnerCustomerSegment} resource to get possible value of this field with description. You can use partnerCustomerSegment field name as the referenceCode parameter to retrieve the values. type: string example: AD1 ApplicationUpdateKycInformation: properties: selfPublicFigureDeclarationFlag: description: 'Flag for self declaration if applicant is public figure. Valid values: true and false' type: boolean example: "true" publicFigureOfficeStatus: description: Flag for status of public office if applicant is public figure type: string example: Active publicFigureOfficeDetails: description: Office details if applicant is public figure type: string example: Department of education and training publicFigureOfficeStartDate: description: Public figure office start date in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2017-04-12" publicFigureOfficeEndDate: description: Public figure office end date in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2017-04-12" isRelatedToSeniorPublicFigure: description: 'Self declaration if applicant has any relation with senior public figure. Valid values: true and false' type: boolean example: "true" relatedSeniorPublicFigureName: description: Senior Public Figure Name type: string example: Dan Lee relatedSpfCountryOfGovernment: description: Senior Public Figure Country of Government type: string example: SG relatedSeniorPublicFigureDepartment: description: Department Senior Public Figure belongs to type: string example: Ministry relationshipWithSeniorPublicFigure: description: Senior Public Figure relationship with applicant type: string example: Father relatedSeniorPublicFigureLastName: description: Senior Public Figure Last Name type: string example: Lee usTaxStatus: description: US Tax status. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{usTaxStatus} resource to get valid value of this field with description. You can use usTaxStatus field name as the referenceCode parameter to retrieve the values. type: string example: US_PERSON_REPORTABLE_DOCUMENTED usTaxId: description: US Tax ID type: string example: US234567 ApplicationUpdateContactPreference: properties: sendSmsAdviceFlag: description: 'Applicant''s subscription for receiving advices through SMS. Valid values: true and false' type: boolean example: "true" sendEmailAdviceFlag: description: 'Applicant''s subscription for receiving advices through email. Valid values: true and false' type: boolean example: "true" preferredMailingAddress: description: Preferred Mailing Address by applicant. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use the field name as the referenceCode parameter to retrieve the values. type: string example: HOME_ADDRESS eStatementEnrollmentFlag: description: 'Applicant''s subscription for receiving statement over email. Valid values: true and false' type: boolean example: "true" ApplicationUpdateMarketingConsent: properties: personalDataOptOutOthersFlag: description: Opt out from use of personal data to other person/organization in direct marketing type: boolean example: false ApplicationUpdateEducation: properties: highestEducationLevel: description: Highest education level of the applicant. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{highestEducationLevel} resource to get valid value of this field with description. You can use highestEducationLevel field name as the referenceCode parameter to retrieve the values. type: string example: D yearOfGraduation: description: Year of completing graduation. This is required if applicant is a student type: string example: "2003" studentId: description: Unique ID of the student. This is required if applicant is a student type: string example: STID234567 university: description: University name. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{universityCode} resource to get valid value of this field with description. You can use university field name as the referenceCode parameter to retrieve the values. type: string example: NTU ApplicationUpdateIdentificationDocumentDetails: properties: idType: description: Type of Identification document. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{idType} resource to get valid values of this field with descriptions type: string example: PASSPORT idNumber: description: 'Unique identifier of identification document. Ex: Passport Number' type: string example: S42258011 idExpiryDate: description: Expiry date of identification document in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2027-04-11" idIssueDate: description: Issuance date of identification document in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2017-04-12" idIssuePlace: description: Identification document issuance place type: string example: AU idIssueState: description: State from which identification document was issued. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressState} resource to get valid value of this field with description. You can use addressState field name as the referenceCode parameter to retrieve the values. type: string example: QUEENSLAND idIssueCountry: description: Country of issuance. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use idIssueCountry field name as the referenceCode parameter to retrieve the values. type: string example: AU isPrimaryId: description: 'Flag to mark primary identification document. Valid values: true and false' type: boolean example: "true" ApplicationUpdateProduct: properties: creditCardProduct: $ref: '#/definitions/ApplicationUpdateCreditCardProduct' readyCreditProduct: $ref: '#/definitions/ApplicationUpdateReadyCreditProduct' unsecuredLoanProduct: $ref: '#/definitions/ApplicationUpdateUnsecuredLoanProduct' minimum: 1 InPrincipleApprovalRequest: properties: controlFlowId: description: Control Flow Id type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId RepaymentSchedule: properties: tenorOccurence: description: Different tenor applicable for repayment type: string example: "10" paymentDueDate: description: Payment due date for each instalment in ISO 8601 date format YYYY-MM-DD type: string format: date example: "1972-09-15" monthlyInstallmentAmount: description: Monthly instalment amount for loan taken type: number format: double example: "500.25" principalAmount: description: Principal amount of instalment type: number format: double example: "500.25" interestAmount: description: Interest amount of instalment type: number format: double example: "500.25" remainingPrincipalAmount: description: Remaining Principal Amount after each instalment has been paid by customer type: number format: double example: "500.25" InPrincipleApprovalResponse: properties: applicationStage: description: Current stage of an application.This is a reference data field. Please use /v1/apac/utilities/referenceData/{applicationStage} resource to get possible value of this field with description. You can use applicationStage field name as the referenceCode parameter to retrieve the values. type: string example: PRESCREENING ipaExpiryDate: description: In principle approval expiration date in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2018-09-15" requestedProductDecision: type: array items: $ref: '#/definitions/RequestedProductDecision' counterOffers: type: array items: $ref: '#/definitions/CounterOffer' crossSellOffers: type: array items: $ref: '#/definitions/CrossSellOffer' required: - applicationStage LoanSpecificRecommendations: properties: loanAmount: description: Eligible Loan amount. type: number format: double example: "25000.25" tenor: description: Tenor for the loan repayment. This is a reference data field. Please use /v1/apac/utilities/referenceData/{tenor} resource to get valid value of this field with description. type: string example: "45" interestRate: description: The rate of interest applicable to product type: number format: double example: "5.25" handlingFee: description: Handling fee to be paid. type: number format: double example: "5.25" installmentAmount: description: Installment amount to be paid. type: number format: double example: "500.25" annualPercentageRate: description: Applicable Annual Percentage Rate type: number format: double example: "5.25" totalPrincipalAmount: description: Total principal to be paid by customer type: number format: double example: "5000.25" totalInterestAmount: description: Total interest to be paid by customer type: number format: double example: "500.25" totalInstallmentAmount: description: Total installment amount to be paid by customer type: number format: double example: "500.25" repaymentScheduleIssueDate: description: Repayment schedule start date in ISO 8601 date format YYYY-MM-DD type: string format: date example: "1972-09-15" repaymentSchedule: type: array items: $ref: '#/definitions/RepaymentSchedule' RequestedProductDecision: properties: productCode: description: A unique code that identifies the product type: string example: VC830 organisationName: description: Card issuing Organisation code type: string example: "888" sourceCode: description: A source code to identify the product type: string example: WW5ARCE1 logo: description: Product logo to identify the product type: string example: "830" creditDecision: description: Evaluated Applicant Credit Decision type: string example: IN_PRINCIPAL_APPROVED_FULL creditSpecificRecommendations: type: array items: $ref: '#/definitions/CreditSpecificRecommendations' loanSpecificRecommendations: type: array items: $ref: '#/definitions/LoanSpecificRecommendations' requiredDocuments: type: array items: $ref: '#/definitions/RequiredDocuments' required: - productCode - organisationName - sourceCode CreditSpecificRecommendations: properties: recommendedCreditLimit: description: Eligible Credit limit type: number format: double example: "25000.25" btMaximumLoanPercentage: description: Balance transfer maximum loan percentage. Applicable to Counter and Cross-sell offers type: number format: double example: "5.25" btMonthlyInterestRate: description: Balance transfer monthly interest rate. Applicable to Counter and Cross-sell offers type: number format: double example: "500.25" eppMaximumLoanPercentage: description: EPP(Equal Payment Plan) Max loan percentage. Applicable to counter and cross-sell offers. type: number format: double example: "5.25" eppMonthlyInterestRate: description: Equal payment plan monthly interest rate. Applicable to counter and cross-sell offers type: number format: double example: "5.25" btCampaignId: description: Balance transfer campaignId. Applicable to counter and cross-sell offers. type: string example: "34543634" eppPromoId: description: PromoId of equal payment plan. Applicable for ready credit, Counter and cross-sell offers type: string example: "34543634" RequiredDocuments: properties: documentIdType: description: Document ID for each proof. This is a reference data field. Please use /v1/apac/utilities/referenceData/{documentIdType} resource to get valid values of this field with descriptions.You can use the documentIdType as the referenceCode parameter to retrieve the values. type: string example: PAYSLIP documentStatus: description: Status of document ID proof. This is a reference data data field. Please use /v1/apac/utilities/referenceData/{documentStatus} resource to get valid values of this field with descriptions type: string example: SUBMITTED productCode: description: A unique code that identifies the product type: string example: VC830 proofType: description: Type of document. This is a reference data field. Please use /v1/apac/utilities/referenceData/{proofType} resource to get possible values of this field with descriptions.You can use the proofType as the referenceCode parameter to retrieve the values. type: string example: INCOME_PROOF linkedDocumentId: description: Linked document id is used to link different documents for the required documents/proof type. type: string example: "02" applicantType: description: Applicant relationship with the Bank. Currently supported value is primary.This is a reference data data field. Please use /v1/apac/utilities/referenceData/{applicantType} resource to get valid values of this field with descriptions type: string example: PRIMARY_APPLICANT_MAIN_APPLICANT CrossSellOffer: properties: creditSpecificRecommendations: type: array items: $ref: '#/definitions/CreditSpecificRecommendations' loanSpecificRecommendations: type: array items: $ref: '#/definitions/LoanSpecificRecommendations' offerProductCode: description: A unique code that identifies the product type: string example: VC830 offerProductOrganisation: description: Card issuing organization name type: string example: "888" offerSourceCode: description: A source code to identify the product type: string example: WW5ARCE1 requiredDocuments: type: array items: $ref: '#/definitions/RequiredDocuments' CounterOffer: properties: creditSpecificRecommendations: type: array items: $ref: '#/definitions/CreditSpecificRecommendations' loanSpecificRecommendations: type: array items: $ref: '#/definitions/LoanSpecificRecommendations' offerProductCode: description: A unique code that identifies the offered product to applicant type: string example: VC830 offerProductOrganisation: description: offered card issuing organization name type: string example: "888" offerSourceCode: description: A source code to identify the product type: string example: WW5ARCE1 requiredDocuments: type: array items: $ref: '#/definitions/RequiredDocuments' CreditSpecificSelection: properties: requestCreditShield: description: 'Insurance enrolment for outstanding balance on the card. Valid values: true and false' type: boolean example: "true" embossName: description: Name to be embossed on card type: string example: Matthew Hyden billingAddress: description: Billing address of applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use billingAddress field as the referenceCode parameter to retrieve the values. type: string example: HOME_ADDRESS cardDeliveryAddress: description: Card delivery address of applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use cardDeliveryAddress field name as the referenceCode parameter to retrieve the values. type: string example: HOME_ADDRESS pinDeliveryAddress: description: Delivery address for card pin of applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid values of this field with descriptions. You can use pinDeliveryAddress field name as the referenceCode parameter to retrieve the values. type: string example: HOME_ADDRESS requestedCreditLimit: description: Credit limit accepted by customer type: number format: double example: 25000 offeredCreditLimitAcceptedFlag: description: 'Consent to offered credit limit and If the customer has not accepted Bank’s approved credit limit then requestedCreditLimit is mandatory. Valid values: true and false' type: boolean example: "true" atmRequiredFlag: description: 'Option to get ATM card along with product. Valid values: true and false' type: boolean example: "true" chequeBookRequiredFlag: description: 'Option to get cheque book along with product. Valid values: true and false' type: boolean example: "true" creditLimitIncreaseIndicator: description: 'Option to increase credit limit. Valid values: true and false' type: boolean example: "true" ProductConfirmation: properties: productCode: description: A unique code that identifies the product type: string example: VC830 sourceCode: description: A source code to identify the product type: string example: WW5ARCE1 organization: description: Card issuing Organisation code type: string example: "888" creditSpecificSelection: $ref: '#/definitions/CreditSpecificSelection' loanSpecificSelection: $ref: '#/definitions/LoanSpecificSelection' required: - productCode LoanSpecificSelection: properties: loanAmount: description: Loan Amount accepted by customer type: number format: double example: 25000.250000 tenor: description: Tenure of loan. This is a reference data field. Please use /v1/apac/utilities/referenceData/{tenor} resource to get valid values of this field with descriptions. You can use tenor field name as the referenceCode parameter to retrieve the values. type: string example: 10_MONTHS interestRate: description: Interest rate applicable for the loan type: number format: double example: 10.250000 billingAddress: description: Billing address of applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use billingAddress field as the referenceCode parameter to retrieve the values. type: string example: HOME_ADDRESS required: - loanAmount - tenor - interestRate OfferAcceptanceRequest: properties: counterProductAcceptedFlag: description: 'Flag to indicate a counter offer selected by an applicant. Valid values: true and false' type: boolean example: "true" counterProductConfirmation: type: array items: $ref: '#/definitions/ProductConfirmation' requestedProductConfirmation: type: array items: $ref: '#/definitions/ProductConfirmation' controlFlowId: description: Control Flow Id type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId - requestedProductConfirmation InsertDocumentResponse: properties: binaryDataSize: description: Binary stream size of the document. type: string example: 450kb required: - binaryDataSize InsertDocumentRequest: properties: documentDetails: $ref: '#/definitions/DocumentDetails' controlFlowId: description: Control flow id is used to control the flow for subsequent requests in the session. type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId - documentDetails DocumentDetails: properties: documentIdType: description: Document ID for each proof.This is a reference data field. Please use /v1/apac/utilities/referenceData/{documentIdType} resource to get possible value of this field with description. You can use the documentIdType as the referenceCode parameter to retrieve the values. type: string example: PAYSLIP documentFormat: description: Format of the scanned document.This is a reference data field. Please use /v1/apac/utilities/referenceData/{documentFormat} resource to get possible value of this field with description. You can use the documentFormat as the referenceCode parameter to retrieve the values. type: string example: PDF proofType: description: Classification of the document. This is a reference data field. Please use /v1/apac/utilities/referenceData/{proofType} resource to get possible values of this field with descriptions.You can use the proofType as the referenceCode parameter to retrieve the values. type: string example: INCOME_PROOF applicantType: description: Type of an applicant.This is a reference data field.Please use /utilities/referenceData/{applicantType} resource to get valid values of this field with descriptions. You can use the applicantType as the referenceCode parameter to retrieve the values. type: string example: SUPPLEMENTARY applicantId: description: Unique identifier to be provided for a supplementary applicant. type: string example: C$ZOW9IO793854 binaryData: description: This field contains binary data of the uploaded document. type: string example: "0101010001101000011010010111001100100000011001100110100101100101011011000110010000100000011000110110" required: - documentIdType - binaryData - documentFormat - proofType FinalSubmitRequest: properties: controlFlowId: description: Control Flow Id type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId ApplicationStatusInqRequestedProductDecision: properties: productCode: description: A unique code that identifies the product type: string example: VC830 organisationName: description: Card issuing Organisation type: string example: "111" sourceCode: description: A source code to identify the product type: string example: WW5ARCE1 creditDecision: description: Evaluated Applicant Credit Decision. This is a reference data field. Please use /v1/apac/utilities/referenceData/{creditDecision} resource to get valid value of this field with description. type: string example: IN_PRINCIPAL_APPROVED_PARTIAL creditSpecificRecommendations: type: array items: $ref: '#/definitions/CreditSpecificRecommendations' loanSpecificRecommendations: type: array items: $ref: '#/definitions/LoanSpecificRecommendations' requiredDocuments: type: array items: $ref: '#/definitions/RequiredDocuments' ApplicationStatusResponse: properties: applicationStage: description: Current stage of an application.This is a reference data field. Please use /v1/apac/utilities/referenceData/{applicationStage} resource to get possible value of this field with description. You can use applicationStage field name as the referenceCode parameter to retrieve the values. type: string example: PRESCREENING ipaExpiryDate: description: In principle approval expiration date in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2016-09-15" requestedProductDecision: type: array items: $ref: '#/definitions/ApplicationStatusInqRequestedProductDecision' counterOffers: type: array items: $ref: '#/definitions/CounterOffer' crossSellOffers: type: array items: $ref: '#/definitions/CrossSellOffer' required: - applicationStage Address: properties: addressType: description: 'Type of address. Ex: Residential, commercial, etc. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get possible value of this field with description. You can use addressType field name as the referenceCode parameter to retrieve the values.' type: string example: "003" addressLine1: description: Address line 1 type: string example: 40A Orchard Rodad addressLine2: description: Address line 2 type: string example: '#99-99 Macdonald House' addressLine3: description: Address line 3 type: string example: Orchard Avenue 2 addressLine4: description: Address line 4 type: string example: Street 65 cityName: description: City type: string example: Singapore state: description: State type: string example: Singapore postalCode: description: Postal/ZIP code type: string example: "345346" provinceCode: description: Province code type: string example: SINGAPORE countryCode: description: ISO country code. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get possible value of this field with description. You can use countryCode field name as the referenceCode parameter to retrieve the values. type: string example: SG okToMail: description: 'To indicate whether the prospect is ok to be sent mails. Valid values: true and false' type: boolean example: "true" required: - addressType - addressLine1 AddressSearchUsingPostalCodeResponse: properties: addressSearchDetails: type: array items: $ref: '#/definitions/Address' required: - addressSearchDetails EmploymentDetails: properties: employerName: description: Name of the Employer. type: string example: Citi Bank jobTitle: description: Job Title. This is a reference data field. Please use /v1/apac/utilities/referenceData/{jobTitle} resource to get possible values of this field with descriptions. You can use jobTitle field name as the referenceCode parameter to retrieve the values. type: string example: ACCOUNTANT occupationCode: description: Occupation code. This is a reference data field. Please use /v1/apac/utilities/referenceData/{occupationCode} resource to get possible values of this field with descriptions. You can use occupationCode field name as the referenceCode parameter to retrieve the values. type: string example: ACCOUNTANT industryCode: description: Code of the industry of employment. This is a reference data field. Please use /v1/apac/utilities/referenceData/{industryCode} resource to get possible values of this field with descriptions. You can use the field name as the referenceCode parameter to retrieve the values. type: string example: CITIBANK_SUB_NON_BANK AdditionalData: properties: numberOfChildren: description: Number of children type: number example: 2 numberOfDependents: description: Number of dependants type: number example: 3 staffIndicator: description: 'Indicates whether prospect is a Citi Staff. Valid values: true and false' type: boolean example: "true" countrySpecificGroup: $ref: '#/definitions/CountrySpecificGroup' Email: properties: emailAddress: description: Email ID type: string example: matt.hayden@gmail.com okToEmail: description: 'Flag to indicate whether prospect wants to receive emails or not. Valid values: true and false' type: boolean example: "true" isPrerferredEmailAddress: description: 'Indicates whether this email id is preferred email for all communications. Valid values: true and false' type: boolean example: "true" required: - emailAddress FinancialInformation: properties: incomeDetails: type: array items: $ref: '#/definitions/IncomeDetails' IdentificationDocumentDetails: properties: idType: description: Type of Identification document. This is a reference data field. Please use /v1/apac/utilities/referenceData/{idType} resource to get valid values of this field with descriptions type: string example: PASSPORT idNumber: description: 'Unique identifier of identification document. Ex: Passport Number' type: string example: S42258011 idExpiryDate: description: 'Expiry date of identification document. Format: ISO 8601 date format YYYY-MM-DD' type: string format: date example: "2027-04-11" idIssueDate: description: 'Issuance date of identification document. Format: ISO 8601 date format YYYY-MM-DD' type: string format: date example: "2017-04-12" idIssuePlace: description: Place of issuance type: string example: SG idIssuingAuthority: description: Authority which issued the identification document type: string example: MINISTRY_OF_MANPOWER KycInformation: properties: usTaxStatus: description: US Tax status. This is a reference data field. Please use /v1/apac/utilities/referenceData/{usTaxStatus} resource to get possible values of this field with descriptions. You can use usTaxStatus field name as the referenceCode parameter to retrieve the values. type: string example: US_PERSON_REPORTABLE_DOCUMENTED usTaxId: description: US Tax ID type: string example: "34534674363" ProspectAddRequest: properties: interest: $ref: '#/definitions/Interest' prospect: $ref: '#/definitions/Prospect' required: - interest - prospect ProspectAddResponse: properties: prospectId: description: Unique identifier for the prospect type: string example: "2345326532632" Name: properties: salutation: description: Salutation. This is a reference data field. Please use /v1/apac/utilities/referenceData/{salutation} resource to get possible value of this field with description. You can use salutation field name as the referenceCode parameter to retrieve the values. type: string example: Mr givenName: description: Given/first name of the prospect type: string example: Matthew middleName: description: Middle name of the applicant type: string example: DU surname: description: Surname/last name of the prospect type: string example: Hayden localEnglishGivenName: description: Local Given Name in English type: string example: Matthew localEnglishSurname: description: Local surname in English type: string example: Hayden aliasName: description: Alias name of the prospect type: string example: DU suffix: description: Generational qualifier that follow a person given name. It is used to explicitly identify the named individual within the same family. type: string example: Junior saluteBy: description: Contains value with which prospect like to be addressed, is it by first name/last name. This is a reference data field. Please use /v1/apac/utilities/referenceData/{saluteBy} resource to get possible value of this field with description. You can use saluteBy field name as the referenceCode parameter to retrieve the values. type: string example: SURNAME required: - givenName - surname Interest: properties: productGroup: description: A unique code that identifies the product group. This is prospect selected product type: string example: VC830 campaignId: description: Campaign Id. The unique identifier for campaign. type: string example: "45645645" waveId: description: Wave Id corresponding to campaign. type: string example: "23423" required: - productGroup Demographics: properties: gender: description: Gender/sex. This is a reference data field. Please use /v1/apac/utilities/referenceData/{gender} resource to get possible value of this field with description. You can use gender field name as the referenceCode parameter to retrieve the values. type: string example: MALE dateOfBirth: description: 'Prospect''s date of birth. Format: ISO 8601 date format YYYY-MM-DD' type: string format: date example: "1972-09-15" placeOfBirth: description: Place of birth type: string example: Sydney countryOfBirth: description: Prospect's country of birth. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get possible values of this field with descriptions. You can use countryOfBirth field name as the referenceCode parameter to retrieve the values. type: string example: AU nationality: description: Prospect's nationality. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get possible value of this field with description. You can use nationality field name as the referenceCode parameter to retrieve the values. type: string example: AU domicileCountryCode: description: Domicile country code. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get possible value of this field with description. You can use domicileCountryCode field name as the referenceCode parameter to retrieve the values. type: string example: SG permanentResidencyCountryCode: description: Prospect's permanent residency country code. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get possible value of this field with description. You can use permanentResidencyCountryCode field name as the referenceCode parameter to retrieve the values. type: string example: AU maritalStatus: description: Prospect's marital status. This is a reference data field. Please use /v1/apac/utilities/referenceData/{maritalStatus} resource to get possible value of this field with description. You can use the maritalStatus as the referenceCode parameter to retrieve the values. type: string example: MARRIED residencyStatus: description: Indicate status of residence whether owned property/rented property etc. This is a reference data field. Please use /v1/apac/utilities/referenceData/{residenceStatus} resource to get possible value of this field with description. You can use maritalStatus field name as the referenceCode parameter to retrieve the values. type: string example: PARENTS_OR_RELATIVES_HOUSE residenceType: description: Type of Residence. Private Condo/government hdb etc. This is a reference data field. Please use /v1/apac/utilities/referenceData/{residenceType} resource to get possible value of this field with description. You can use residenceType field name as the referenceCode parameter to retrieve the values. type: string example: LEASED_APARTMENT taxDomicileCountryCode: description: Tax domicile country code. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get possible value of this field with description. You can use taxDomicileCountryCode field name as the referenceCode parameter to retrieve the values. type: string example: SG spokenLanguageCode: description: Prospect's spoken language. This is a reference data field. Please use /v1/apac/utilities/referenceData/{spokenLanguageCode} resource to get possible values of this field with descriptions. You can use spokenLanguageCode field name as the referenceCode parameter to retrieve the values. type: string example: EN correspondenceLanguageCode: description: Language for correspondence (Statement/Advices etc). type: string example: EN required: - gender - dateOfBirth - nationality Education: properties: highestEducationLevel: description: Highest education level of the applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{highestEducationLevel} resource to get possible values of this field with descriptions. You can use highestEducationLevel field name as the referenceCode parameter to retrieve the values. type: string example: MASTER yearOfGraduation: description: Year of completing graduation. This is required if prospect is a student type: string example: "2003" studentId: description: Unique ID of the student. This is required if prospect is a student type: string example: STID3245346 university: description: Student studying in university. This is a reference data field. Please use /v1/apac/utilities/referenceData/{universityCode} resource to get possible values of this field with descriptions. You can use university field name as the referenceCode parameter to retrieve the values. type: string example: NTU Phone: properties: phoneType: description: The type of phone. Ex:OFFICE, HOME, MOBILE, PRIMARY_MOBILE, FAX. This is a reference data field. Please use /v1/apac/utilities/referenceData/{phoneType} resource to get possible values of this field with descriptions. You can use phoneType field name as the referenceCode parameter to retrieve the values. type: string example: HOME_PHONE_NUMBER phoneCountryCode: description: Country code of telephone number type: string example: "65" areaCode: description: The area code of telephone number type: string example: "02" phoneNumber: description: The phone number of prospect type: string example: "64042408" extension: description: Extension of telephone number type: string example: "234" okToSms: description: 'Flag to indicate whether prospect wants to receive SMS or not. This is applicable only if phone type is MOBILE. Valid values: true and false' type: boolean example: "true" okToCall: description: 'Flag to indicate whether prospect wants to receive calls or not. Valid values: true and false' type: boolean example: "true" required: - phoneType - phoneNumber CountrySpecificGroup: properties: bumiputraIndicator: description: 'Bumiputra indicator (whether the person is from Malay ethnic group/son of soil). Valid values: true and false' type: boolean example: "true" ethnicGroup: description: Ethnic group. type: string example: English disabilityIndicator: description: 'Applicable for some countries. The instruments issued to applicants are provided with special needs like brailed characters on statements. Valid values: true and false' type: boolean example: "true" unionPayCardNumber: description: 'Country: CN Specific to get the UnionPayCardNumber to link the product' type: string example: "5555666600004444" taxFileNumber: description: 'Country: AU Specific TaxFileNumber' type: string example: "34534634734" ContactPreference: properties: sendSmsAdviceFag: description: 'Prospect is opting to receive advices via SMS. Valid values: true and false' type: boolean example: "true" preferredMailingAddress: description: Preferred Mailing Address by prospect. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid values of this field with descriptions. You can use the field name as preferredMailingAddress referenceCode parameter to retrieve the values. type: string example: HOME_ADDRESS Prospect: properties: motherMaidenName: description: Mother's maiden name type: string example: Lisa name: $ref: '#/definitions/Name' demographics: $ref: '#/definitions/Demographics' address: type: array items: $ref: '#/definitions/Address' email: type: array items: $ref: '#/definitions/Email' phone: type: array items: $ref: '#/definitions/Phone' contactPreference: $ref: '#/definitions/ContactPreference' financialInformation: $ref: '#/definitions/FinancialInformation' education: $ref: '#/definitions/Education' employmentDetails: type: array items: $ref: '#/definitions/EmploymentDetails' identificationDocumentDetails: type: array items: $ref: '#/definitions/IdentificationDocumentDetails' additionalData: $ref: '#/definitions/AdditionalData' selfDeclaration: $ref: '#/definitions/SelfDeclaration' kycInformation: $ref: '#/definitions/KycInformation' required: - name - address - email - phone - contactPreference SelfDeclaration: properties: anticipatedIncomeDecreaseCode: description: 'Anticipated income decrease code. Possible Values: Yes or No' type: string example: "Yes" loanTakenIndicator: description: 'To indicate if a loan has been taken previously. Valid values: true and false' type: boolean example: "true" IncomeDetails: properties: incomeType: description: Income type. This is a reference data field. Please use /v1/apac/utilities/referenceData/{incomeType} resource to get possible values of this field with descriptions. You can use incomeType field name as the referenceCode parameter to retrieve the values. type: string example: DECLARED_FIXED fixedAmount: description: Fixed income amount type: number format: double example: 23000.250000 variableAmount: description: Variable income amount type: number format: double example: 23000.250000 currencyCode: description: Currency Code in ISO 4217 format. type: string example: AUD frequency: description: Frequency. This is a reference data field. Please use /v1/apac/utilities/referenceData/{frequency} resource to get possible values of this field with descriptions. You can use frequency field name as the referenceCode parameter to retrieve the values. type: string example: MONTHLY otherIncomeDescription: description: Description of income from other sources type: string example: Rent ApplicantAddConsentDetails: properties: consentType: description: Applicant's consent types. This is a reference data field. Please use /v1/apac/utilities/referenceData/{consentType} resource to get valid value of this field with description. You can use consentType field name as the referenceCode parameter to retrieve the values. type: string example: PDP_CONSENT isConsentGiven: description: 'Consent flag. Valid values: true and false' type: boolean example: true ApplicantAddAdditionalData: properties: numberOfDependents: description: Number of dependents type: integer example: 3 ApplicantAddName: properties: salutation: description: Salutation. This is a reference data field. Please use /v1/apac/utilities/referenceData/{salutation} resource to get valid value of this field with description. You can use salutation field name as the referenceCode parameter to retrieve the values. type: string example: Mr. givenName: description: Given/first name of the applicant type: string example: John middleName: description: Middle name of the applicant type: string example: Bill surname: description: Surname/last name of the applicant type: string example: Smith aliasName: description: Alias name of the applicant type: string example: Matt required: - givenName ApplicantAddEmploymentDetails: properties: employmentDurationInYears: description: Employment duration in years type: integer example: 5 employmentDurationiInMonths: description: Employment duration in months type: integer example: 6 employerName: description: Name of the employer. type: string example: JP Morgan jobTitle: description: Job Title. This a reference data field. Please use /utilities/referenceData/{jobTitle} resource to get valid values of this field with descriptions. You can use the jobTitle as the referenceCode parameter to retrieve the values. type: string example: CONSULTANT occupationCode: description: Occupation code. This is a reference data field. Please use /utilities/referenceData/{occupationCode} resource to get valid values of this field with descriptions. You can use the occupationCode as the referenceCode parameter to retrieve the values. type: string example: CONSULTANT employmentStatus: description: Status of the employment.This is a reference data field. Please use /v1/apac/utilities/referenceData/{employmentStatus} resource to get valid value of this field with description. You can use the field name as the referenceCode parameter to retrieve the values. type: string example: EMPLOYED ApplicantAddAddress: properties: addressType: description: Type of the address. This is a reference data field. Please use /utilities/referenceData/{addressType} resource to get valid values of this field with descriptions. You can use addressType as the referenceCode parameter to retrieve the values. type: string example: HOME_ADDRESS addressLine1: description: Address line 1 type: string example: Post Box 56 addressLine2: description: Address line 2 type: string example: 99 George Street addressLine3: description: Address line 3 type: string example: Broadway Avenue addressLine4: description: Address line 4 type: string example: Wandaloo ESP cityName: description: City type: string example: Tharwa state: description: State.This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressState} resource to get valid value of this field with description. You can use addressState field name as the referenceCode parameter to retrieve the values. type: string example: Canberra postalCode: description: Postal/ZIP code type: string example: WA 6125 countryCode: description: ISO country code. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use countryCode field name as the referenceCode parameter to retrieve the values. type: string example: AU residenceDurationInYears: description: Applicant's residence duration in the current address in years type: integer format: int32 example: 2 residenceDurationInMonths: description: Applicant's residence duration in the current address in months type: integer format: int32 example: 5 countrySpecificAddress: $ref: '#/definitions/ApplicantAddCountrySpecificAddress' ApplicantAddContactConsent: properties: okToCall: description: 'Applicant''s consent for receiving phone calls. Valid values: true and false' type: boolean example: true okToMail: description: 'Applicant''s consent for receiving mails. Valid values: true and false' type: boolean example: true okToSms: description: 'Applicant''s consent for receiving sms. Valid values: true and false' type: boolean example: true ApplicantAddDemographics: properties: gender: description: Gender/sex. This is a reference data field. Please use /v1/apac/utilities/referenceData/{gender} resource to get valid value of this field with description. You can use gender field name as the referenceCode parameter to retrieve the values. type: string example: MALE dateOfBirth: description: Applicant's date of birth in ISO 8601 date format YYYY-MM-DD type: string format: date example: "1980-01-02" placeOfBirth: description: Applicant's place of birth type: string example: Canberra' countryOfBirth: description: Applicant's Country of birth. This is a reference data field. Please use /utilities/referenceData/{country} resource to get valid values of this field with descriptions. You can use the countryOfBirth as the referenceCode parameter to retrieve the values. type: string example: AU nationality: description: Applicant's nationality. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use nationality field name as the referenceCode parameter to retrieve the values. type: string example: AU maritalStatus: description: Applicant's marital status. This is a reference data field. Please use /v1/apac/utilities/referenceData/{maritalStatus} resource to get valid value of this field with description. You can use maritalStatus field name as the referenceCode parameter to retrieve the values. type: string example: MARRIED residentialStatus: description: Indicate status of residence. This is a reference data field. Please use /v1/apac/utilities/referenceData/{residenceStatus} resource to get valid value of this field with description. You can use residenceStatus field name as the referenceCode parameter to retrieve the values. type: string example: RENTED_HOUSE ApplicantAddPhone: properties: phoneType: description: The type of phone.This is a reference data field. Please use /v1/apac/utilities/referenceData/{phoneType} resource to get valid value of this field with description. You can use phoneType field name as the referenceCode parameter to retrieve the values. type: string example: PRIMARY_MOBILE_NUMBER phoneCountryCode: description: Country code of phone number type: string example: "61" areaCode: description: The area code of phone number type: string example: "02" phoneNumber: description: Applicant's phone number type: string example: "491570157" extension: description: Extension of phone number type: string example: "7123" okToSms: description: 'Applicant''s consent for receiving sms. This is applicable only if phone type is MOBILE. Valid values: true and false' type: boolean example: true okToCall: description: 'Applicant''s consent for receiving phone calls. Valid values: true and false' type: boolean example: false required: - phoneType - phoneCountryCode - phoneNumber ApplicantAddKycInformation: properties: selfPublicFigureDeclarationFlag: description: 'Flag for self declaration if applicant is public figure. Valid values: true and false' type: boolean example: true ApplicantAddPartnerCustomerDetails: properties: partnerCustomerInternalId: description: Unique customer internal number associated with the partner. type: string example: ZOW9IO793855 partnerCustomerId: description: Unique customer Id associated with the partner type: string example: P011100000125 partnerCustomerSegment: description: Partner customer segment.Partner customer segment.This is a reference data field. Please use /v1/apac/utilities/referenceData/{partnerCustomerSegment} resource to get possible value of this field with description. You can use partnerCustomerSegment field name as the referenceCode parameter to retrieve the values. type: string example: AD1 ApplicantAddCountrySpecificAddress: properties: unitNumber: description: Applicant's unit number type: string example: "265" floorNumber: description: Applicant's floor number type: string example: "12" blockNumber: description: Applicant's block number type: string example: "141" buildingName: description: Applicant's building name type: string example: Cardiff estateName: description: Applicant's estate name type: string example: Orchard Estate streetNumber: description: Applicant's street number type: string example: "99" streetName: description: Applicant's street name type: string example: George Street streetType: description: Applicant's street type. This is a reference data field.Please use /v1/apac/utilities/referenceData/{streetType} resource to get valid value of this field with description. You can use streetType field name as the referenceCode parameter to retrieve the values type: string example: ARCADE ApplicantAddResponse: properties: applicantId: description: Unique identifier for an applicant type: string example: C$ZOW9IO793854 required: - applicantId ApplicantAddIdentificationDocumentDetails: properties: idType: description: Type of Identification document. This is a reference data field. Please use /v1/apac/utilities/referenceData/{idType} resource to get valid values of this field with descriptions type: string example: PASSPORT idNumber: description: Unique identifier of identification document. type: string example: M0992136 idExpiryDate: description: Expiry date of identification document in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2024-02-29" idIssueDate: description: Issuance date of identification document in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2014-03-01" idIssuePlace: description: Identification document issuance place type: string example: Canberra idIssueState: description: State from which identification document was issued type: string example: Canberra idIssueCountry: description: Country of issuance. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use idIssueCountry field name as the referenceCode parameter to retrieve the values. type: string example: AUSTRALIA isPrimaryId: description: 'Flag to mark primary identification document. Valid values: true and false' type: boolean example: true ApplicantAddEmail: properties: emailAddress: description: Applicant's email address type: string example: john.smith@yahoo.com okToEmail: description: 'Applicant''s consent for receiving email. Valid values: true and false' type: boolean example: true isPreferredEmailAddress: description: 'Flag to mark preferred email. Valid values: true and false' type: boolean example: false required: - emailAddress ApplicantAddFinancialInformation: properties: incomeDetails: type: array items: $ref: '#/definitions/ApplicantAddIncomeDetails' ApplicantAddCreditCardProduct: properties: embossName: description: Name to be embossed on card. type: string example: Matthew Hayden requestedCreditLimit: description: Credit limit accepted by applicant type: number format: double example: 25000.250000 overseasCardActivationFlag: description: 'Flag to activate the card for overseas usage.Valid values: true and false' type: boolean example: true ApplicantAddIncomeDetails: properties: incomeType: description: Applciants income type. This is a reference data field. Please use /utilities/referenceData/{incomeType} resource to get valid values of this field with descriptions. You can use the fieldname as the referenceCode parameter to retrieve the values. type: string example: DECLARED_FIXED fixedAmount: description: Fixed income amount of applicant type: number format: double example: 5000.250000 variableAmount: description: Variable income amount of applicant type: number format: double example: 3500.250000 frequency: description: Income Frequency. This a reference data field. Please use /utilities/referenceData/{frequency} resource to get valid values of this field with descriptions. You can use the fieldname as the referenceCode parameter to retrieve the values. type: string example: MONTHLY ApplicantAddRequest: properties: controlFlowId: description: Control flow id is used to control the flow for subsequent requests in the session. type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d applicant: $ref: '#/definitions/ApplicantAddApplicant' creditCardProduct: $ref: '#/definitions/ApplicantAddCreditCardProduct' required: - controlFlowId - applicant ApplicantAddApplicant: properties: applicantType: description: Type of an applicant.This is a reference data field.Please use /utilities/referenceData/{applicantType} resource to get valid values of this field with descriptions. You can use the fieldname as the referenceCode parameter to retrieve the values. type: string example: SUPPLEMENTARY motherMaidenName: description: Mothers maiden name type: string example: Monica name: $ref: '#/definitions/ApplicantAddName' demographics: $ref: '#/definitions/ApplicantAddDemographics' address: type: array items: $ref: '#/definitions/ApplicantAddAddress' email: type: array items: $ref: '#/definitions/ApplicantAddEmail' phone: type: array items: $ref: '#/definitions/ApplicantAddPhone' financialInformation: $ref: '#/definitions/ApplicantAddFinancialInformation' employmentDetails: type: array items: $ref: '#/definitions/ApplicantAddEmploymentDetails' identificationDocumentDetails: type: array items: $ref: '#/definitions/ApplicantAddIdentificationDocumentDetails' additionalData: $ref: '#/definitions/ApplicantAddAdditionalData' partnerCustomerDetails: $ref: '#/definitions/ApplicantAddPartnerCustomerDetails' consentDetails: type: array items: $ref: '#/definitions/ApplicantAddConsentDetails' kycInformation: $ref: '#/definitions/ApplicantAddKycInformation' contactConsent: $ref: '#/definitions/ApplicantAddContactConsent' required: - applicantType - name ApplicantUpdateIdentificationDocumentDetails: properties: idType: description: Type of Identification document. This is a reference data field. Please use /v1/apac/utilities/referenceData/{idType} resource to get valid values of this field with descriptions type: string example: PASSPORT idNumber: description: Unique identifier of identification document. type: string example: M0992136 idExpiryDate: description: Expiry date of identification document in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2024-02-29" idIssueDate: description: Issuance date of identification document in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2014-03-01" idIssuePlace: description: Identification document issuance place type: string example: Canberra idIssueState: description: State from which identification document was issued type: string example: Canberra idIssueCountry: description: Country of issuance. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use idIssueCountry field name as the referenceCode parameter to retrieve the values. type: string example: AUSTRALIA isPrimaryId: description: 'Flag to mark primary identification document. Valid values: true and false' type: boolean example: true ApplicantUpdateKycInformation: properties: selfPublicFigureDeclarationFlag: description: 'Flag for self declaration if applicant is public figure. Valid values: true and false' type: boolean example: true ApplicantUpdateRequest: properties: controlFlowId: description: It is used to control the flow for subsequent requests in the session. type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d applicant: $ref: '#/definitions/ApplicantUpdateApplicant' creditCardProduct: $ref: '#/definitions/ApplicantUpdateCreditCardProduct' required: - controlFlowId - applicant ApplicantUpdateAddress: properties: addressType: description: Type of the address. This is a reference data field. Please use /utilities/referenceData/{addressType} resource to get valid values of this field with descriptions. You can use addressType as the referenceCode parameter to retrieve the values. type: string example: HOME_ADDRESS addressLine1: description: Address line 1 type: string example: Post Box 56 addressLine2: description: Address line 2 type: string example: 99 George Street addressLine3: description: Address line 3 type: string example: Broadway Avenue addressLine4: description: Address line 4 type: string example: Wandaloo ESP cityName: description: City type: string example: Tharwa state: description: State.This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressState} resource to get valid value of this field with description. You can use addressState field name as the referenceCode parameter to retrieve the values. type: string example: Canberra postalCode: description: Postal/ZIP code type: string example: WA 6125 countryCode: description: ISO country code. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use countryCode field name as the referenceCode parameter to retrieve the values. type: string example: AU residenceDurationInYears: description: Applicant's residence duration in the current address in years type: integer format: int32 example: 2 residenceDurationInMonths: description: Applicant's residence duration in the current address in months type: integer format: int32 example: 5 countrySpecificAddress: $ref: '#/definitions/ApplicantUpdateCountrySpecificAddress' ApplicantUpdateAdditionalData: properties: numberOfDependents: description: Number of dependents type: integer example: 3 ApplicantUpdatePhone: properties: phoneType: description: The type of phone.This is a reference data field. Please use /v1/apac/utilities/referenceData/{phoneType} resource to get valid value of this field with description. You can use phoneType field name as the referenceCode parameter to retrieve the values. type: string example: PRIMARY_MOBILE_NUMBER phoneCountryCode: description: Country code of phone number type: string example: "61" areaCode: description: The area code of phone number type: string example: "02" phoneNumber: description: Applicant's phone number type: string example: "491570157" extension: description: Extension of phone number type: string example: "7123" okToSms: description: 'Applicant''s consent for receiving sms. This is applicable only if phone type is MOBILE. Valid values: true and false' type: boolean example: true okToCall: description: 'Applicant''s consent for receiving phone calls. Valid values: true and false' type: boolean example: false required: - phoneType - phoneCountryCode - phoneNumber ApplicantUpdateFinancialInformation: properties: incomeDetails: type: array items: $ref: '#/definitions/ApplicantUpdateIncomeDetails' ApplicantUpdateApplicant: properties: applicantType: description: Type of an applicant.This is a reference data field.Please use /utilities/referenceData/{applicantType} resource to get valid values of this field with descriptions. You can use the fieldname as the referenceCode parameter to retrieve the values. type: string example: SUPPLEMENTARY motherMaidenName: description: Mothers maiden name type: string example: Monica name: $ref: '#/definitions/ApplicantUpdateName' demographics: $ref: '#/definitions/ApplicantUpdateDemographics' address: type: array items: $ref: '#/definitions/ApplicantUpdateAddress' email: type: array items: $ref: '#/definitions/ApplicantUpdateEmail' phone: type: array items: $ref: '#/definitions/ApplicantUpdatePhone' financialInformation: $ref: '#/definitions/ApplicantUpdateFinancialInformation' employmentDetails: type: array items: $ref: '#/definitions/ApplicantUpdateEmploymentDetails' identificationDocumentDetails: type: array items: $ref: '#/definitions/ApplicantUpdateIdentificationDocumentDetails' additionalData: $ref: '#/definitions/ApplicantUpdateAdditionalData' partnerCustomerDetails: $ref: '#/definitions/ApplicantUpdatePartnerCustomerDetails' consentDetails: type: array items: $ref: '#/definitions/ApplicantUpdateConsentDetails' kycInformation: $ref: '#/definitions/ApplicantUpdateKycInformation' contactConsent: $ref: '#/definitions/ApplicantUpdateContactConsent' required: - applicantType - name ApplicantUpdatePartnerCustomerDetails: properties: partnerCustomerInternalId: description: Unique customer internal number associated with the partner. type: string example: ZOW9IO793855 partnerCustomerId: description: Unique customer Id associated with the partner type: string example: P011100000125 partnerCustomerSegment: description: Partner customer segment.Partner customer segment.This is a reference data field. Please use /v1/apac/utilities/referenceData/{partnerCustomerSegment} resource to get possible value of this field with description. You can use partnerCustomerSegment field name as the referenceCode parameter to retrieve the values. type: string example: AD1 ApplicantUpdateCountrySpecificAddress: properties: unitNumber: description: Applicant's unit number type: string example: "265" floorNumber: description: Applicant's floor number type: string example: "12" blockNumber: description: Applicant's block number type: string example: "141" buildingName: description: Applicant's building name type: string example: Cardiff estateName: description: Applicant's estate name type: string example: Orchard Estate streetNumber: description: Applicant's street number type: string example: "99" streetName: description: Applicant's street name type: string example: George Street streetType: description: Applicant's street type.Please use /v1/apac/utilities/referenceData/{streetType} resource to get valid value of this field with description. You can use streetType field name as the referenceCode parameter to retrieve the values type: string example: ARCADE ApplicantUpdateName: properties: salutation: description: Salutation. This is a reference data field. Please use /v1/apac/utilities/referenceData/{salutation} resource to get valid value of this field with description. You can use salutation field name as the referenceCode parameter to retrieve the values. type: string example: Mr. givenName: description: Given/first name of the applicant type: string example: John middleName: description: Middle name of the applicant type: string example: Bill surname: description: Surname/last name of the applicant type: string example: Smith aliasName: description: Alias name of the applicant type: string example: Matt required: - givenName ApplicantUpdateIncomeDetails: properties: incomeType: description: Applciants income type. This is a reference data field. Please use /utilities/referenceData/{incomeType} resource to get valid values of this field with descriptions. You can use the fieldname as the referenceCode parameter to retrieve the values. type: string example: DECLARED_FIXED fixedAmount: description: Fixed income amount of applicant type: number format: double example: 5000.250000 variableAmount: description: Variable income amount of applicant type: number format: double example: 3500.250000 frequency: description: Income Frequency. This a reference data field. Please use /utilities/referenceData/{frequency} resource to get valid values of this field with descriptions. You can use the fieldname as the referenceCode parameter to retrieve the values. type: string example: MONTHLY ApplicantUpdateEmploymentDetails: properties: employmentDurationInYears: description: Employment duration in years type: integer format: int32 example: 5 employmentDurationiInMonths: description: Employment duration in months type: integer format: int32 example: 6 employerName: description: Name of the employer. type: string example: JP Morgan jobTitle: description: Job Title. This a reference data field. Please use /utilities/referenceData/{jobTitle} resource to get valid values of this field with descriptions. You can use the jobTitle as the referenceCode parameter to retrieve the values. type: string example: CONSULTANT occupationCode: description: Occupation code. This is a reference data field. Please use /utilities/referenceData/{occupationCode} resource to get valid values of this field with descriptions. You can use the occupationCode as the referenceCode parameter to retrieve the values. type: string example: CONSULTANT employmentStatus: description: Status of the employment.This is a reference data field. Please use /v1/apac/utilities/referenceData/{employmentStatus} resource to get valid value of this field with description. You can use the field name as the referenceCode parameter to retrieve the values. type: string example: EMPLOYED ApplicantUpdateEmail: properties: emailAddress: description: Applicant's email address type: string example: john.smith@yahoo.com okToEmail: description: 'Applicant''s consent for receiving email. Valid values: true and false' type: boolean example: true isPreferredEmailAddress: description: 'Flag to mark preferred email. Valid values: true and false' type: boolean example: false required: - emailAddress ApplicantUpdateDemographics: properties: gender: description: Gender/sex. This is a reference data field. Please use /v1/apac/utilities/referenceData/{gender} resource to get valid value of this field with description. You can use gender field name as the referenceCode parameter to retrieve the values. type: string example: MALE dateOfBirth: description: Applicant's date of birth in ISO 8601 date format YYYY-MM-DD type: string format: date example: "1980-01-02" placeOfBirth: description: Applicant's place of birth type: string example: Canberra' countryOfBirth: description: Applicant's Country of birth. This is a reference data field. Please use /utilities/referenceData/{country} resource to get valid values of this field with descriptions. You can use the countryOfBirth as the referenceCode parameter to retrieve the values. type: string example: AU nationality: description: Applicant's nationality. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use nationality field name as the referenceCode parameter to retrieve the values. type: string example: AU maritalStatus: description: Applicant's marital status. This is a reference data field. Please use /v1/apac/utilities/referenceData/{maritalStatus} resource to get valid value of this field with description. You can use maritalStatus field name as the referenceCode parameter to retrieve the values. type: string example: MARRIED residentialStatus: description: Indicate status of residence. This is a reference data field. Please use /v1/apac/utilities/referenceData/{residenceStatus} resource to get valid value of this field with description. You can use residenceStatus field name as the referenceCode parameter to retrieve the values. type: string example: RENTED_HOUSE ApplicantUpdateCreditCardProduct: properties: embossName: description: Name to be embossed on card. type: string example: Matthew Hayden requestedCreditLimit: description: Credit limit accepted by applicant type: number format: double example: 25000.250000 overseasCardActivationFlag: description: 'Flag to activate the card for overseas usage.Valid values: true and false' type: boolean example: true ApplicantUpdateConsentDetails: properties: consentType: description: Applicant's consent types. This is a reference data field. Please use /v1/apac/utilities/referenceData/{consentType} resource to get valid value of this field with description. You can use consentType field name as the referenceCode parameter to retrieve the values. type: string example: PDP_CONSENT isConsentGiven: description: 'Consent flag. Valid values: true and false' type: boolean example: true ApplicantUpdateContactConsent: properties: okToCall: description: 'Applicant''s consent for receiving phone calls. Valid values: true and false' type: boolean example: true okToMail: description: 'Applicant''s consent for receiving mails. Valid values: true and false' type: boolean example: true okToSms: description: 'Applicant''s consent for receiving sms. Valid values: true and false' type: boolean example: true applicantDeleteRequest: properties: controlFlowId: description: It is used to control the flow for subsequent requests in the session. type: string example: 6e3774334f724a2b7947663653712f52456f524c41797038516a59347a437549564a77755676376e616a733d required: - controlFlowId ApplicantInquiryKycInformation: properties: selfPublicFigureDeclarationFlag: description: 'Flag for self declaration if applicant is public figure. Valid values: true and false' type: boolean example: true ApplicantInquiryPartnerCustomerDetails: properties: partnerCustomerInternalId: description: Unique customer internal number associated with the partner. type: string example: ZOW9IO793855 partnerCustomerId: description: Unique customer Id associated with the partner type: string example: P011100000125 partnerCustomerSegment: description: Partner customer segment.Partner customer segment.This is a reference data field. Please use /v1/apac/utilities/referenceData/{partnerCustomerSegment} resource to get possible value of this field with description. You can use partnerCustomerSegment field name as the referenceCode parameter to retrieve the values. type: string example: AD1 ApplicantInquiryAdditionalData: properties: numberOfDependents: description: Number of dependents type: integer example: 3 ApplicantInquiryConsentDetails: properties: consentType: description: Applicant's consent types. This is a reference data field. Please use /v1/apac/utilities/referenceData/{consentType} resource to get valid value of this field with description. You can use consentType field name as the referenceCode parameter to retrieve the values. type: string example: PDP_CONSENT isConsentGiven: description: 'Consent flag. Valid values: true and false' type: boolean example: true ApplicantInquiryContactConsent: properties: okToCall: description: 'Applicant''s consent for receiving phone calls. Valid values: true and false' type: boolean example: true okToMail: description: 'Applicant''s consent for receiving mails. Valid values: true and false' type: boolean example: true okToSms: description: 'Applicant''s consent for receiving sms. Valid values: true and false' type: boolean example: true ApplicantInquiryCreditCardProduct: properties: embossName: description: Name to be embossed on card. type: string example: Matthew Hayden requestedCreditLimit: description: Credit limit accepted by applicant type: number format: double example: 25000.250000 overseasCardActivationFlag: description: 'Flag to activate the card for overseas usage.Valid values: true and false' type: boolean example: true ApplicantInquiryAddress: properties: addressType: description: Type of the address. This is a reference data field. Please use /utilities/referenceData/{addressType} resource to get valid values of this field with descriptions. You can use addressType as the referenceCode parameter to retrieve the values. type: string example: HOME_ADDRESS addressLine1: description: Address line 1 type: string example: Post Box 56 addressLine2: description: Address line 2 type: string example: 99 George Street addressLine3: description: Address line 3 type: string example: Broadway Avenue addressLine4: description: Address line 4 type: string example: Wandaloo ESP cityName: description: City type: string example: Tharwa state: description: State.This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressState} resource to get valid value of this field with description. You can use addressState field name as the referenceCode parameter to retrieve the values. type: string example: Canberra postalCode: description: Postal/ZIP code type: string example: WA 6125 countryCode: description: ISO country code. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use countryCode field name as the referenceCode parameter to retrieve the values. type: string example: AU residenceDurationInYears: description: Applicant's residence duration in the current address in years type: integer format: int32 example: 2 residenceDurationInMonths: description: Applicant's residence duration in the current address in months type: integer format: int32 example: 5 countrySpecificAddress: $ref: '#/definitions/ApplicantInquiryCountrySpecificAddress' ApplicantInquiryEmail: properties: emailAddress: description: Applicant's email address type: string example: john.smith@yahoo.com okToEmail: description: 'Applicant''s consent for receiving email. Valid values: true and false' type: boolean example: true isPreferredEmailAddress: description: 'Flag to mark preferred email. Valid values: true and false' type: boolean example: false required: - emailAddress ApplicantInquiryIncomeDetails: properties: incomeType: description: Applciants income type. This is a reference data field. Please use /utilities/referenceData/{incomeType} resource to get valid values of this field with descriptions. You can use the fieldname as the referenceCode parameter to retrieve the values. type: string example: DECLARED_FIXED fixedAmount: description: Fixed income amount of applicant type: number format: double example: 5000.250000 variableAmount: description: Variable income amount of applicant type: number format: double example: 3500.250000 frequency: description: Income Frequency. This a reference data field. Please use /utilities/referenceData/{frequency} resource to get valid values of this field with descriptions. You can use the fieldname as the referenceCode parameter to retrieve the values. type: string example: MONTHLY ApplicantInquiryDemographics: properties: gender: description: Gender/sex. This is a reference data field. Please use /v1/apac/utilities/referenceData/{gender} resource to get valid value of this field with description. You can use gender field name as the referenceCode parameter to retrieve the values. type: string example: MALE dateOfBirth: description: Applicant's date of birth in ISO 8601 date format YYYY-MM-DD type: string format: date example: "1980-01-02" placeOfBirth: description: Applicant's place of birth type: string example: Canberra' countryOfBirth: description: Applicant's Country of birth. This is a reference data field. Please use /utilities/referenceData/{country} resource to get valid values of this field with descriptions. You can use the countryOfBirth as the referenceCode parameter to retrieve the values. type: string example: AU nationality: description: Applicant's nationality. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use nationality field name as the referenceCode parameter to retrieve the values. type: string example: AU maritalStatus: description: Applicant's marital status. This is a reference data field. Please use /v1/apac/utilities/referenceData/{maritalStatus} resource to get valid value of this field with description. You can use maritalStatus field name as the referenceCode parameter to retrieve the values. type: string example: MARRIED residentialStatus: description: Indicate status of residence. This is a reference data field. Please use /v1/apac/utilities/referenceData/{residenceStatus} resource to get valid value of this field with description. You can use residenceStatus field name as the referenceCode parameter to retrieve the values. type: string example: RENTED_HOUSE ApplicantInquiryResponse: properties: applicants: type: array items: $ref: '#/definitions/ApplicantDetail' required: - applicants ApplicantInquiryEmploymentDetails: properties: employmentDurationInYears: description: Employment duration in years type: integer format: int32 example: 5 employmentDurationiInMonths: description: Employment duration in months type: integer format: int32 example: 6 employerName: description: Name of the employer. type: string example: JP Morgan jobTitle: description: Job Title. This a reference data field. Please use /utilities/referenceData/{jobTitle} resource to get valid values of this field with descriptions. You can use the jobTitle as the referenceCode parameter to retrieve the values. type: string example: CONSULTANT occupationCode: description: Occupation code. This is a reference data field. Please use /utilities/referenceData/{occupationCode} resource to get valid values of this field with descriptions. You can use the occupationCode as the referenceCode parameter to retrieve the values. type: string example: CONSULTANT employmentStatus: description: Status of the employment.This is a reference data field. Please use /v1/apac/utilities/referenceData/{employmentStatus} resource to get valid value of this field with description. You can use the field name as the referenceCode parameter to retrieve the values. type: string example: EMPLOYED ApplicantInquiryApplicant: properties: applicantType: description: Type of an applicant.This is a reference data field.Please use /utilities/referenceData/{applicantType} resource to get valid values of this field with descriptions. You can use the fieldname as the referenceCode parameter to retrieve the values. type: string example: SUPPLEMENTARY applicantId: description: Unique ID created for an Applicant. This is retuned back in ApplicantAdd response and the same should be passed here. type: string example: Z012378545 motherMaidenName: description: Mothers maiden name type: string example: Monica name: $ref: '#/definitions/ApplicantInquiryName' demographics: $ref: '#/definitions/ApplicantInquiryDemographics' address: type: array items: $ref: '#/definitions/ApplicantInquiryAddress' email: type: array items: $ref: '#/definitions/ApplicantInquiryEmail' phone: type: array items: $ref: '#/definitions/ApplicantInquiryPhone' financialInformation: $ref: '#/definitions/ApplicantInquiryFinancialInformation' employmentDetails: type: array items: $ref: '#/definitions/ApplicantInquiryEmploymentDetails' identificationDocumentDetails: type: array items: $ref: '#/definitions/ApplicantInquiryIdentificationDocumentDetails' additionalData: $ref: '#/definitions/ApplicantInquiryAdditionalData' partnerCustomerDetails: $ref: '#/definitions/ApplicantInquiryPartnerCustomerDetails' consentDetails: type: array items: $ref: '#/definitions/ApplicantInquiryConsentDetails' requiredDocuments: type: array items: $ref: '#/definitions/ApplicantInquiryRequiredDocuments' kycInformation: $ref: '#/definitions/ApplicantInquiryKycInformation' contactConsent: $ref: '#/definitions/ApplicantInquiryContactConsent' required: - applicantType - name ApplicantInquiryPhone: properties: phoneType: description: The type of phone.This is a reference data field. Please use /v1/apac/utilities/referenceData/{phoneType} resource to get valid value of this field with description. You can use phoneType field name as the referenceCode parameter to retrieve the values. type: string example: PRIMARY_MOBILE_NUMBER phoneCountryCode: description: Country code of phone number type: string example: "61" areaCode: description: The area code of phone number type: string example: "02" phoneNumber: description: Applicant's phone number type: string example: "491570157" extension: description: Extension of phone number type: string example: "7123" okToSms: description: 'Applicant''s consent for receiving sms. This is applicable only if phone type is MOBILE. Valid values: true and false' type: boolean example: true okToCall: description: 'Applicant''s consent for receiving phone calls. Valid values: true and false' type: boolean example: false required: - phoneType - phoneCountryCode - phoneNumber ApplicantInquiryFinancialInformation: properties: incomeDetails: type: array items: $ref: '#/definitions/ApplicantInquiryIncomeDetails' ApplicantInquiryName: properties: salutation: description: Salutation. This is a reference data field. Please use /v1/apac/utilities/referenceData/{salutation} resource to get valid value of this field with description. You can use salutation field name as the referenceCode parameter to retrieve the values. type: string example: Mr. givenName: description: Given/first name of the applicant type: string example: John middleName: description: Middle name of the applicant type: string example: Bill surname: description: Surname/last name of the applicant type: string example: Smith aliasName: description: Alias name of the applicant type: string example: Matt required: - givenName ApplicantInquiryRequiredDocuments: properties: documentIdType: description: Document ID for each proof. This is a reference data field. Please use /v1/apac/utilities/referenceData/{documentIdType} resource to get valid values of this field with descriptions.You can use the documentIdType as the referenceCode parameter to retrieve the values. type: string example: PAYSLIP documentStatus: description: Status of document proof.This is a reference data field. Please use /v1/apac/utilities/referenceData/{documentStatus} resource to get possible values of this field with descriptions.You can use the documentStatus as the referenceCode parameter to retrieve the values. type: string example: PENDING productCode: description: A unique code that identifies the product type: string example: VC830 proofType: description: Type of document. This is a reference data field. Please use /v1/apac/utilities/referenceData/{proofType} resource to get possible values of this field with descriptions.You can use the proofType as the referenceCode parameter to retrieve the values. type: string example: INCOME_PROOF linkedDocumentId: description: Linked document id specifies that the same document can be used for different proof types type: string example: "02" applicantType: description: Applicant's relationship with the Bank. Currently supported is Primary - P.This is a reference data field. Please use /v1/apac/utilities/referenceData/{applicantType} resource to get valid value of this field with description.You can use the documentType as the referenceCode parameter to retrieve the values. type: string example: SUPPLEMENTARY_APPLICANT ApplicantDetail: properties: applicant: $ref: '#/definitions/ApplicantInquiryApplicant' creditCardProduct: $ref: '#/definitions/ApplicantInquiryCreditCardProduct' required: - applicant ApplicantInquiryCountrySpecificAddress: properties: unitNumber: description: Applicant's unit number type: string example: "265" floorNumber: description: Applicant's floor number type: string example: "12" blockNumber: description: Applicant's block number type: string example: "141" buildingName: description: Applicant's building name type: string example: Cardiff estateName: description: Applicant's estate name type: string example: Orchard Estate streetNumber: description: Applicant's street number type: string example: "99" streetName: description: Applicant's street name type: string example: George Street streetType: description: Applicant's street type.Please use /v1/apac/utilities/referenceData/{streetType} resource to get valid value of this field with description. You can use streetType field name as the referenceCode parameter to retrieve the values type: string example: ARCADE ApplicantInquiryIdentificationDocumentDetails: properties: idType: description: Type of Identification document. This is a reference data field. Please use /v1/apac/utilities/referenceData/{idType} resource to get valid values of this field with descriptions type: string example: PASSPORT idNumber: description: Unique identifier of identification document. type: string example: M0992136 idExpiryDate: description: Expiry date of identification document in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2024-02-29" idIssueDate: description: Issuance date of identification document in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2014-03-01" idIssuePlace: description: Identification document issuance place type: string example: Canberra idIssueState: description: State from which identification document was issued type: string example: Canberra idIssueCountry: description: Country of issuance. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use idIssueCountry field name as the referenceCode parameter to retrieve the values. type: string example: AUSTRALIA isPrimaryId: description: 'Flag to mark primary identification document. Valid values: true and false' type: boolean example: true ApplicationInquiryDemographics: properties: gender: description: Gender/sex. This is a reference data field. Please use /v1/apac/utilities/referenceData/{gender} resource to get valid value of this field with description. You can use gender field name as the referenceCode parameter to retrieve the values. type: string example: MALE dateOfBirth: description: Applicant's date of birth in ISO 8601 date format YYYY-MM-DD type: string format: date example: "1972-09-15" placeOfBirth: description: Applicant's place of birth type: string example: Sydney countryOfBirth: description: Applicant's Country of birth. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use countryOfBirth field name as the referenceCode parameter to retrieve the values. type: string example: AU nationality: description: Applicant's nationality. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use nationality field name as the referenceCode parameter to retrieve the values. type: string example: AU domicileCountryCode: description: Domicile country code. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use the field name as the referenceCode parameter to retrieve the values. type: string example: AU permanentResidencyCountryCode: description: Permanent residency country code. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use domicileCountryCode field name as the referenceCode parameter to retrieve the values. type: string example: AU maritalStatus: description: Applicant's marital status. This is a reference data field. Please use /v1/apac/utilities/referenceData/{maritalStatus} resource to get valid value of this field with description. You can use maritalStatus field name as the referenceCode parameter to retrieve the values. type: string example: MARRIED residencyStatus: description: Indicate status of residence. This is a reference data field. Please use /v1/apac/utilities/referenceData/{residenceStatus} resource to get valid value of this field with description. You can use residenceStatus field name as the referenceCode parameter to retrieve the values. type: string example: RENTED_HOUSE residenceType: description: Type of Residence. This is a reference data field. Please use /v1/apac/utilities/referenceData/{residenceType} resource to get valid value of this field with description. You can use residenceType field name as the referenceCode parameter to retrieve the values. type: string example: CONDOMINIUM taxDomicileCountryCode: description: Tax domicile country code. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use taxDomicileCountryCode field name as the referenceCode parameter to retrieve the values. type: string example: SG spokenLanguageCode: description: Code for spoken language of applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{spokenLanguageCode} resource to get valid value of this field with description. You can use spokenLanguageCode field name as the referenceCode parameter to retrieve the values. type: string example: EN correspondenceLanguageCode: description: Code for correspondence language of applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{spokenLanguageCode} resource to get valid value of this field with description. You can use correspondenceLanguageCode field name as the referenceCode parameter to retrieve the values. type: string example: EN ApplicationInquiryContactConsent: properties: okToCall: description: 'Applicant''s consent for receiving phone calls. Valid values: true and false' type: boolean example: true okToMail: description: 'Applicant''s consent for receiving mails. Valid values: true and false' type: boolean example: true okToSms: description: 'Applicant''s consent for receiving sms. Valid values: true and false' type: boolean example: true ApplicationInquiryCreditCardProduct: properties: productCode: description: A unique code that identifies the product. type: string example: VC830 sourceCode: description: A source code to identify the product type: string example: WW5ARCE1 organization: description: Card issuing organization name type: string example: "888" logo: description: Product logo to identify the product type: string example: "830" requestCreditShield: description: 'Insurance enrolment for outstanding balance on the card. Valid values: true and false' type: boolean example: "false" embossName: description: Name to be embossed on card. type: string example: Matthew Hayden billingAddress: description: Billing address of applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use addressType field as the referenceCode parameter to retrieve the values. type: string example: HOME_ADDRESS cardDeliveryAddress: description: Card delivery address of applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use addressType field name as the referenceCode parameter to retrieve the values. type: string example: HOME_ADDRESS pinDeliveryAddress: description: Delivery address for card pin of applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use addressType field name as the referenceCode parameter to retrieve the values. type: string example: HOME_ADDRESS giftCode: description: A unique code that identifies the gift offered along with the product type: string example: gc123 creditLimitIncreaseIndicator: description: 'Option to review the credit limit in the future.Valid values: true and false' type: boolean example: true requestedCreditLimit: description: Credit limit accepted by applicant type: number format: double example: 25000.250000 balanceTransferDetails: type: array items: $ref: '#/definitions/ApplicationInquiryBalanceTransferDetails' required: - productCode - sourceCode - organization - logo ApplicationInquiryFinancialInformation: properties: hasForeseeableFinancialChanges: description: Indicates whether any foreseeable changes in customer's financial circumstances. type: boolean example: true expenseDetails: type: array items: $ref: '#/definitions/ApplicationInquiryExpenseDetails' incomeDetails: type: array items: $ref: '#/definitions/ApplicationInquiryIncomeDetails' existingLoanDetails: type: array items: $ref: '#/definitions/ApplicationInquiryExistingLoanDetails' ApplicationInquiryIncomeDetails: properties: incomeType: description: Income type. This is a reference data field. Please use /v1/apac/utilities/referenceData/{incomeType} resource to get valid value of this field with description. You can use incomeType field name as the referenceCode parameter to retrieve the values. type: string example: DECLARED_FIXED fixedAmount: description: Fixed income amount of applicant type: number format: double example: 7590.250000 variableAmount: description: Variable income amount of applicant type: number format: double example: 1590.250000 frequency: description: Income Frequency. This is a reference data field. Please use /v1/apac/utilities/referenceData/{frequency} resource to get valid value of this field with description. You can use frequency field name as the referenceCode parameter to retrieve the values. type: string example: MONTHLY otherIncomeDescription: description: Description of income from other sources type: string example: Rent ApplicationInquiryRequiredDocuments: properties: documentIdType: description: Document ID for each proof. This is a reference data field. Please use /v1/apac/utilities/referenceData/{documentIdType} resource to get valid values of this field with descriptions.You can use the documentIdType as the referenceCode parameter to retrieve the values. type: string example: PAYSLIP documentStatus: description: Status of document proof.This is a reference data field. Please use /v1/apac/utilities/referenceData/{documentStatus} resource to get possible values of this field with descriptions.You can use the documentStatus as the referenceCode parameter to retrieve the values. type: string example: PENDING productCode: description: A unique code that identifies the product type: string example: VC830 proofType: description: Type of document. This is a reference data field. Please use /v1/apac/utilities/referenceData/{proofType} resource to get possible values of this field with descriptions.You can use the proofType as the referenceCode parameter to retrieve the values. type: string example: INCOME_PROOF linkedDocumentId: description: Linked document id specifies that the same document can be used for different proof types type: string example: "02" applicantType: description: Applicant's relationship with the Bank. Currently supported is Primary - P.This is a reference data field. Please use /v1/apac/utilities/referenceData/{applicantType} resource to get valid value of this field with description.You can use the documentType as the referenceCode parameter to retrieve the values. type: string example: PRIMARY_APPLICANT_MAIN_APPLICANT ApplicationInquiryApplicant: properties: motherMaidenName: description: Mother's maiden name type: string example: Lisa name: $ref: '#/definitions/ApplicationInquiryName' demographics: $ref: '#/definitions/ApplicationInquiryDemographics' address: type: array items: $ref: '#/definitions/ApplicationInquiryAddress' email: type: array minimum: 1 items: $ref: '#/definitions/ApplicationInquiryEmail' phone: type: array minimum: 1 items: $ref: '#/definitions/ApplicationInquiryPhone' contactPreference: $ref: '#/definitions/ApplicationInquiryContactPreference' contactConsent: $ref: '#/definitions/ApplicationInquiryContactConsent' financialInformation: $ref: '#/definitions/ApplicationInquiryFinancialInformation' education: $ref: '#/definitions/ApplicationInquiryEducation' employmentDetails: type: array items: $ref: '#/definitions/ApplicationInquiryEmploymentDetails' identificationDocumentDetails: type: array items: $ref: '#/definitions/ApplicationInquiryIdentificationDocumentDetails' additionalData: $ref: '#/definitions/ApplicationInquiryAdditionalData' partnerCustomerDetails: $ref: '#/definitions/ApplicationInquiryPartnerCustomerDetails' consentDetails: type: array items: $ref: '#/definitions/ApplicationInquiryConsentDetails' marketingConsent: $ref: '#/definitions/ApplicationInquiryMarketingConsent' selfDeclaration: $ref: '#/definitions/ApplicationInquirySelfDeclaration' kycInformation: $ref: '#/definitions/ApplicationInquiryKycInformation' required: - name - phone ApplicationInquiryConsentDetails: properties: consentType: description: Applicant's consent types. This is a reference data field. Please use /v1/apac/utilities/referenceData/{consentType} resource to get valid value of this field with description. You can use consentType field name as the referenceCode parameter to retrieve the values. type: string example: COUNTER_OFFER_CONSENT isConsentGiven: description: 'Consent flag. Valid values: true and false' type: boolean example: true ApplicationInquiryRepaymentSchedule: properties: tenorOccurence: description: Installment month type: string example: "1" paymentDueDate: description: Payment due date for each instalment in ISO 8601 date format YYYY-MM-DD type: string format: date example: "1972-09-15" monthlyInstallmentAmount: description: Monthly installment amount. type: number format: double example: 500.250000 principalAmount: description: Principal amount of installment type: number format: double example: 500.250000 interestAmount: description: Interest amount of installment type: number format: double example: 500.250000 remainingPrincipalAmount: description: Remaining Principal Amount after each installment has been paid by customer type: number format: double example: 500.250000 ApplicationInquiryCountrySpecificGroup: properties: bumiputraIndicator: description: 'Indicator to specify the regional race and other indigenous peoples of Southeast Asia, and used particularly in Malaysia. Valid values: true and false.' type: boolean example: true disabilityIndicator: description: 'The instruments issued to applicants are provided with special needs like brailed characters on statements. Valid values: true and false.' type: boolean example: true unionPayCardNumber: description: Applicant's union pay card number to link the product. type: string example: "5555666600008888" taxFileNumber: description: Applicant's tax file number to link the product. type: string example: "656456737" ApplicationInquiryEmail: properties: emailAddress: description: Applicant's email address type: string example: matt.hayden@gmail.com okToEmail: description: 'Applicant''s consent for receiving email. Valid values: true and false' type: boolean example: true isPreferredEmailAddress: description: 'Flag to mark preferred email. Valid values: true and false' type: boolean example: true ApplicationInquiryExpenseDetails: properties: expenseType: description: Expense type. This is a reference data field. Please use /v1/apac/utilities/referenceData/{expenseType} resource to get valid value of this field with description. You can use expenseType field name as the referenceCode parameter to retrieve the values. type: string example: COSTS_OF_LIVING expenseAmount: description: Expenditure amount for an applicant type: number format: double example: 590.250000 frequency: description: Expense Frequency. This is a reference data field. Please use /v1/apac/utilities/referenceData/{frequency} resource to get valid value of this field with description. You can use frequency field name as the referenceCode parameter to retrieve the values. type: string example: MONTHLY ApplicationInquiryAdditionalData: properties: numberOfDependents: description: Number of dependents type: number example: "3" staffIndicator: description: 'Flag to indicates if applicant is a Citi Staff. Valid values: true and false' type: boolean example: true businessNature: description: Business nature of the applicant This is a reference data field. Please use /v1/apac/utilities/referenceData/{businessNature} resource to get valid value of this field with description. You can use businessNature field name as the referenceCode parameter to retrieve the values. type: string example: BANKING_FINANCIAL_INSTITUTIONS emergencyContactName: description: Emergency contact Name type: string example: Pearline emergencyContactPhoneNumber: description: Emergency contact Number. type: string example: "64042321" overLimitConsentFlag: description: 'Customer consent on spending more than the limit assigned to him. Valid values: true and false' type: boolean example: true countrySpecificGroup: $ref: '#/definitions/ApplicationInquiryCountrySpecificGroup' referralGivenName: description: Referral First Name. type: string example: Maxwell referralSurname: description: Referral Surname/Last Name. type: string example: Gate relatedToCitiEmployeeFlag: description: 'Self declaration if applicant has any relation with citi bank employee. Valid values: true and false' type: boolean example: true relatedCitiEmployeeName: description: Name of the citi employee if applicant has any relation with citi bank employee. type: string example: Anderson relatedCitiEmployeeDepartment: description: Department of citi employee if applicant has any relation with citi bank employee. type: string example: Finance ApplicationInquiryIdentificationDocumentDetails: properties: idType: description: Type of Identification document. This is a reference data field. Please use /v1/apac/utilities/referenceData/{idType} resource to get valid values of this field with descriptions type: string example: PASSPORT idNumber: description: 'Unique identifier of identification document. Ex: Passport Number' type: string example: S42258011 idExpiryDate: description: Expiry date of identification document in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2027-04-11" idIssueDate: description: Issuance date of identification document in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2017-04-12" idIssuePlace: description: Identification document issuance place type: string example: AU idIssueState: description: State from which identification document was issued. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressState} resource to get valid value of this field with description. You can use addressState field name as the referenceCode parameter to retrieve the values. type: string example: QUEENSLAND idIssueCountry: description: Country of issuance. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use idIssueCountry field name as the referenceCode parameter to retrieve the values. type: string example: AU isPrimaryId: description: 'Flag to mark primary identification document. Valid values: true and false' type: boolean example: true required: - idType - idNumber ApplicationInquiryPartnerCustomerDetails: properties: partnerCustomerInternalId: description: Unique customer internal number associated with the partner. type: string example: ZOW9IO793855 partnerCustomerId: description: Unique customer Id associated with the partner type: string example: P011100000125 partnerCustomerSegment: description: Partner customer segment.Partner customer segment.This is a reference data field. Please use /v1/apac/utilities/referenceData/{partnerCustomerSegment} resource to get possible value of this field with description. You can use partnerCustomerSegment field name as the referenceCode parameter to retrieve the values. type: string example: AD1 ApplicationInquiryCountrySpecificAddress: properties: unitNumber: description: Applicant's unit Number type: string example: "99" floorNumber: description: Applicant's floor Number type: string example: "18" blockNumber: description: Applicant's block Number type: string example: "19" buildingName: description: Applicant's building Name type: string example: Estella estateName: description: Applicant's estate Name type: string example: Marine Parade streetNumber: description: Applicant's street Number type: string example: "52" streetName: description: Applicant's street Name type: string example: Marine Parade streetType: description: Applicant's street Type.Please use /v1/apac/utilities/referenceData/{streetType} resource to get valid value of this field with description. You can use streetType field name as the referenceCode parameter to retrieve the values type: string example: ARCADE town: description: Applicant's town type: string example: SG ApplicationInquiryEmploymentDetails: properties: employerName: description: Name of the employer. type: string example: Citi Bank jobTitle: description: Job Title. This is a reference data field. Please use /v1/apac/utilities/referenceData/{jobTitle} resource to get valid value of this field with description. You can use jobTitle field name as the referenceCode parameter to retrieve the values. type: string example: ACCOUNTANT occupationCode: description: Occupation code. This is a reference data field. Please use /v1/apac/utilities/referenceData/{occupationCode} resource to get valid value of this field with description. You can use occupationCode field name as the referenceCode parameter to retrieve the values. type: string example: ACCOUNTANT industryCode: description: Code of the industry of employment. This is a reference data field. Please use /v1/apac/utilities/referenceData/{industryCode} resource to get valid value of this field with description. You can use industryCode field name as the referenceCode parameter to retrieve the values. type: string example: CITIBANK_SUB_NON_BANK employmentDurationInYears: description: Employment duration in years type: integer example: 5 employmentDurationInMonths: description: Employment duration in months type: integer example: 3 employmentStatus: description: Status of the employment.This is a reference data field. Please use /v1/apac/utilities/referenceData/{employmentStatus} resource to get valid value of this field with description. You can use the field name as the referenceCode parameter to retrieve the values. type: string example: EMPLOYED monthsInPreviousEmployment: description: Months spent in the previouse employment type: integer example: 5 yearsInPreviousEmployment: description: Years spent in the previouse employment type: integer example: 4 accountantName: description: Accountant or contact's name type: string example: Javier accountantFirmName: description: Accountant's firm or business name type: string example: ACME yearsInIndustry: description: Years spent in industry type: integer example: 5 monthsInIndustry: description: Months spent in industry type: integer example: 6 ApplicationInquiryMarketingConsent: properties: personalDataOptOutFlag: description: Opt out from use of personal data in direct marketing type: boolean example: true personalDataOptOutOthersFlag: description: Opt out from use of personal data to other person in direct marketing type: boolean example: false ApplicationInquiryPhone: properties: phoneType: description: The type of phone. Ex:OFFICE, HOME, MOBILE, PRIMARY_MOBILE, FAX. This is a reference data field. Please use /v1/apac/utilities/referenceData/{phoneType} resource to get valid value of this field with description. You can use phoneType field name as the referenceCode parameter to retrieve the values. type: string example: PRIMARY_MOBILE_NUMBER phoneCountryCode: description: Country code of phone number type: string example: "65" areaCode: description: The area code of phone number type: string example: "02" phoneNumber: description: Applicant's phone number type: string example: "63492610" extension: description: Extension of telephone number type: string example: "23" okToSms: description: 'Applicant''s consent for receiving sms. This is applicable only if phone type is MOBILE. Valid values: true and false' type: boolean example: true okToCall: description: 'Applicant''s consent for receiving phone calls. Valid values: true and false' type: boolean example: true required: - phoneType - phoneCountryCode - phoneNumber ApplicationInquiryReadyCreditProduct: properties: productCode: description: A unique code that identifies the product type: string example: US251 sourceCode: description: A source code to identify the product type: string example: PGP144 organization: description: Card issuing organization name type: string example: "030" logo: description: Product logo to identify the product type: string example: PNC1 requestCreditShield: description: 'Insurance enrolment for outstanding balance on the card. Valid values: true and false' type: boolean example: "false" embossName: description: Name to be embossed on card type: string example: Matthew Hayden billingAddress: description: Billing address of applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use addressType field name as the referenceCode parameter to retrieve the values. type: string example: OFFICE_ADDRESS cardDeliveryAddress: description: Card delivery address of applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use addressType field name as the referenceCode parameter to retrieve the values. type: string example: OFFICE_ADDRESS pinDeliveryAddress: description: Delivery address for card pin of applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use addressType field name as the referenceCode parameter to retrieve the values. type: string example: OFFICE_ADDRESS giftCode: description: A unique code that identifies the gift offered along with the product type: string example: gc123 creditLimitIncreaseIndicator: description: 'Option for to review the credit limit in the future.Valid values: true and false' type: boolean example: true atmRequiredFlag: description: 'Option to get ATM card along with product. Valid values: true and false' type: boolean example: true chequeBookRequiredFlag: description: 'Option to get cheque book along with product. Valid values: true and false' type: boolean example: true balanceTransferDetails: type: array items: $ref: '#/definitions/ApplicationInquiryBalanceTransferDetails' required: - productCode - sourceCode - organization - logo ApplicationInquirySelfDeclaration: properties: totalActiveCreditCardLimitAmount: description: Total credit limit of all the credit cards the applicant is holding type: number format: double example: 23000.250000 anticipatedIncomeDecreaseCode: description: 'Anticipated income decrease code. Valid values: Yes and No' type: string example: "Yes" loanTakenIndicator: description: 'To indicate if any loan is outstanding.Valid values: true and false' type: boolean example: true monthlyRepaymentForAllExtLoans: description: Applicants declaration for his/her total monthly repayment amount for all the external loans. type: number format: double example: 5000.250000 ApplicationInquiryCounterOffer: properties: offerProductCode: description: A unique code that identifies the offered product to applicant type: string example: VC830 offerProductOrganisation: description: Offered card issuing organization name type: string example: "888" offerSourceCode: description: A source code to identify the product type: string example: WW5ARCE1 creditSpecificRecommendations: type: array items: $ref: '#/definitions/ApplicationInquiryCreditSpecificRecommendations' loanSpecificRecommendations: type: array items: $ref: '#/definitions/ApplicationInquiryLoanSpecificRecommendations' requiredDocuments: type: array items: $ref: '#/definitions/ApplicationInquiryRequiredDocuments' ApplicationInquiryCrossSellOffer: properties: offerProductCode: description: A unique code that identifies the offered product to applicant type: string example: VC311 offerProductOrganisation: description: Offered card issuing organization name type: string example: "888" offerSourceCode: description: A source code to identify the product type: string example: WW5ARDE1 creditSpecificRecommendations: type: array items: $ref: '#/definitions/ApplicationInquiryCreditSpecificRecommendations' loanSpecificRecommendations: type: array items: $ref: '#/definitions/ApplicationInquiryLoanSpecificRecommendations' requiredDocuments: type: array items: $ref: '#/definitions/ApplicationInquiryRequiredDocuments' ApplicationInquiryBalanceTransferDetails: properties: amountToTransfer: description: Amount to Transfer type: number format: double example: 5000.250000 issuingOrganizationName: description: Name of the Organization to which the fund has to be transferred. This is a reference data field. Please use /v1/apac/utilities/referenceData/{cardIssuingOrganization} resource to get valid value of this field with description. You can use cardIssuingOrganization field name as the referenceCode parameter to retrieve the values. type: string example: VOYAGER accountName: description: Customer's account Name type: string example: Matt accountReferenceNumber: description: Customer's account reference number with biller. type: string example: "521212345121" billerCode: description: It is a unique code to identify a BPAY biller type: string example: "11000125" campaignId: description: Campaign code of the balance transfer. type: string example: C$11785241 required: - amountToTransfer - billerCode ApplicationInquiryContactPreference: properties: sendSmsAdviceFlag: description: 'Applicant''s subscription for receiving advices through SMS. Valid values: true and false' type: boolean example: true sendEmailAdviceFlag: description: 'Applicant''s subscription for receiving advices through email. Valid values: true and false' type: boolean example: true preferredMailingAddress: description: Preferred Mailing Address by applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use preferredMailingAddress field name as the referenceCode parameter to retrieve the values. type: string example: HOME_ADDRESS eStatementEnrollmentFlag: description: 'Applicant''s subscription for receiving statement over email. Valid values: true and false' type: boolean example: true ApplicationInquiryAddress: properties: addressType: description: Type of address. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use addressType field name as the referenceCode parameter to retrieve the values. type: string example: HOME_ADDRESS addressLine1: description: Address line 1 type: string example: 40A Orchard Road addressLine2: description: Address line 2 type: string example: '#99-99 Macdonald House' addressLine3: description: Address line 3 type: string example: Orchard Avenue 2 addressLine4: description: Address line 4 type: string example: Street 65 cityName: description: City type: string example: Singapore state: description: State.This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressState} resource to get valid value of this field with description. You can use addressState field name as the referenceCode parameter to retrieve the values. type: string example: Singapore postalCode: description: Postal/ZIP code type: string example: "345346" provinceCode: description: Province code type: string example: Singapore countryCode: description: ISO country code. This is a reference data field. Please use /v1/apac/utilities/referenceData/{country} resource to get valid value of this field with description. You can use countryCode field name as the referenceCode parameter to retrieve the values. type: string example: SG okToMail: description: 'Applicant''s consent for receiving mail. Valid values: true and false' type: boolean example: true residenceDurationInYears: description: Applicant's residence duration in the current address in years. Applicable only for residential address. type: integer example: 5 residenceDurationInMonths: description: Applicant's residence duration in the current address in months. Applicable only for residential address. type: integer example: 4 countrySpecificAddress: $ref: '#/definitions/ApplicationInquiryCountrySpecificAddress' ApplicationInquiryEducation: properties: highestEducationLevel: description: Highest education level of the applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{highestEducationLevel} resource to get valid value of this field with description. You can use highestEducationLevel field name as the referenceCode parameter to retrieve the values. type: string example: MASTER yearOfGraduation: description: Year of completing graduation. This is required if applicant is a student type: string example: "2003" studentId: description: Unique ID of the student. This is required if applicant is a student type: string example: STID234567 university: description: University name. This is a reference data field. Please use /v1/apac/utilities/referenceData/{universityCode} resource to get valid value of this field with description. You can use university field name as the referenceCode parameter to retrieve the values. type: string example: NTU ApplicationInquiryCreditSpecificRecommendations: properties: recommendedCreditLimit: description: Recommended credit limit type: number format: double example: 25000.250000 btMaximumLoanPercentage: description: Balance transfer maximum loan percentage. Applicable to Counter and Cross-sell offers type: number format: double example: 95.250000 btMonthlyInterestRate: description: Balance transfer monthly interest rate. Applicable to Counter and Cross-sell offers type: number format: double example: 95.250000 eppMaximumLoanPercentage: description: Equal payment plan max loan percentage. Applicable to Counter and Cross-sell offers type: number format: double example: 5.250000 eppMonthlyInterestRate: description: Equal payment plan monthly interest rate. Applicable to Counter and Cross-sell offers type: number format: double example: 5.250000 btCampaignId: description: Balance transfer CampaignId. Applicable to Counter and Cross-sell offers. type: string example: "34543634" eppPromoId: description: PromoId of equal payment plan. Applicable for ready credit, Counter and Cross-sell offers type: string example: "34543634" ApplicationInquiryName: properties: salutation: description: Salutation. This is a reference data field. Please use /v1/apac/utilities/referenceData/{salutation} resource to get valid value of this field with description. You can use salutation field name as the referenceCode parameter to retrieve the values. type: string example: Mr givenName: description: Given/first name of the applicant type: string example: Matthew middleName: description: Middle name of the applicant type: string example: Du surname: description: Surname/last name of the applicant type: string example: Hayden localEnglishGivenName: description: Local Given Name in English type: string example: Matthew localEnglishSurname: description: Local surname in English type: string example: Hayden aliasName: description: Alias name of the applicant type: string example: Matt saluteBy: description: Contains value with which applicant like to be addressed. This is a reference data field. Please use /v1/apac/utilities/referenceData/{saluteBy} resource to get valid value of this field with description. You can use saluteBy field name as the referenceCode parameter to retrieve the values. type: string example: SURNAME required: - givenName ApplicationInquiryKycInformation: properties: selfPublicFigureDeclarationFlag: description: 'Flag for self declaration if applicant is public figure. Valid values: true and false' type: boolean example: true publicFigureOfficeStatus: description: Flag for status of public office if applicant is public figure type: string example: Active publicFigureOfficeDetails: description: Office details if applicant is public figure type: string example: Department of education and training publicFigureOfficeStartDate: description: Public figure office start date in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2017-04-12" publicFigureOfficeEndDate: description: Public figure office end date in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2020-04-11" isRelatedToSeniorPublicFigure: description: 'Self declaration if applicant has any relation with senior public figure. Valid values: true and false' type: boolean example: true relatedSeniorPublicFigureName: description: Senior Public Figure Name type: string example: Dan Lee relatedSeniorPublicFigureDesignation: description: Public figure designation. type: string example: Member of Parliament relatedSpfCountryOfGovernment: description: Senior Public Figure Country of Government type: string example: SG relatedSeniorPublicFigureDepartment: description: Department Senior Public Figure belongs to type: string example: Ministry relationshipWithSeniorPublicFigure: description: Senior Public Figure relationship with applicant type: string example: Father relatedSeniorPublicFigureLastName: description: Senior Public Figure Last Name type: string example: Lee usTaxStatus: description: US Tax status. This is a reference data field. Please use /v1/apac/utilities/referenceData/{usTaxStatus} resource to get valid value of this field with description. You can use usTaxStatus field name as the referenceCode parameter to retrieve the values. type: string example: US_PERSON_REPORTABLE_DOCUMENTED usTaxId: description: US Tax ID type: string example: US234567 ApplicationInquiryResponse: properties: applicationStage: description: Current stage of an application.This is a reference data field. Please use /v1/apac/utilities/referenceData/{applicationStage} resource to get possible value of this field with description. You can use applicationStage field name as the referenceCode parameter to retrieve the values. type: string example: PRESCREENING hasAnySupplementaryFlag: description: Flag indicating whether the primary applicant has any supplementary. type: boolean example: true ipaExpiryDate: description: In principle approval expiration date in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2018-09-15" product: $ref: '#/definitions/ApplicationInquiryProduct' applicant: $ref: '#/definitions/ApplicationInquiryApplicant' requestedProductDecision: type: array items: $ref: '#/definitions/ApplicationInquiryRequestedProductDecision' counterOffers: type: array items: $ref: '#/definitions/ApplicationInquiryCounterOffer' crossSellOffers: type: array items: $ref: '#/definitions/ApplicationInquiryCrossSellOffer' required: - product - applicant - applicationStage ApplicationInquiryLoanSpecificRecommendations: properties: loanAmount: description: Recommended loan amount. type: number format: double example: 25000.250000 tenor: description: Tenor for the loan repayment.This is a reference data field. Please use /v1/apac/utilities/referenceData/{tenor} resource to get valid values of this field with descriptions. type: string example: "10" interestRate: description: The rate of interest applicable for the product type: number format: double example: 5.250000 handlingFee: description: One-time processing fee. type: number format: double example: 5.250000 installmentAmount: description: Instalment amount to be paid. type: number format: double example: 500.250000 annualPercentageRate: description: Applicable Annual Percentage Rate type: number format: double example: 5.250000 totalPrincipalAmount: description: Total principal to be paid by customer type: number format: double example: 5000.250000 totalInterestAmount: description: Total interest amount to be paid by applicant. type: number format: double example: 500.250000 totalInstallmentAmount: description: Total instalment amount to be paid by customer type: number format: double example: 500.250000 repaymentScheduleIssueDate: description: Repayment schedule start date in ISO 8601 date format YYYY-MM-DD type: string format: date example: "1972-09-15" repaymentSchedule: type: array items: $ref: '#/definitions/ApplicationInquiryRepaymentSchedule' ApplicationInquiryExistingLoanDetails: properties: loanType: description: Loan Type.This is a reference data field. Please use /v1/apac/utilities/referenceData/{loanType} resource to get valid value of this field with description. You can use loanType field name as the referenceCode parameter to retrieve the values. type: string example: STUDENT_LOAN monthlyInstallmentAmount: description: Monthly repayment amount type: number format: double example: 250.250000 outstandingBalanceAmount: description: Balance Owing type: number format: double example: 5000.250000 ApplicationInquiryUnsecuredLoanProduct: properties: productCode: description: A unique code that identifies the product type: string example: VC001 sourceCode: description: A source code to identify the product type: string example: S1N7QYDC organization: description: Card issuing Organisation code type: string example: "111" logo: description: Product logo to identify the product type: string example: "001" requestCreditShield: description: 'Insurance enrolment for outstanding balance on the card. Valid values: true and false' type: boolean example: "false" billingAddress: description: Billing address of applicant. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use addressType field name as the referenceCode parameter to retrieve the values. type: string example: LEGAL_OR_RESIDENTIAL_ADDRESS giftCode: description: A unique code that identifies the gift offered along with the product type: string example: gc123 requestedLoanAmount: description: Requested loan amount type: number format: double example: 5500.250000 tenor: description: Tenure of loan. This is a reference data field. Please use /v1/apac/utilities/referenceData/{tenor} resource to get valid value of this field with description. You can use tenor field name as the referenceCode parameter to retrieve the values. type: string example: 36_MONTHS required: - productCode - sourceCode - organization - logo ApplicationInquiryProduct: properties: creditCardProduct: $ref: '#/definitions/ApplicationInquiryCreditCardProduct' readyCreditProduct: $ref: '#/definitions/ApplicationInquiryReadyCreditProduct' unsecuredLoanProduct: $ref: '#/definitions/ApplicationInquiryUnsecuredLoanProduct' minimum: 1 ApplicationInquiryRequestedProductDecision: properties: productCode: description: A unique code that identifies the product type: string example: VC830 organisationName: description: Card issuing Organisation code type: string example: "888" sourceCode: description: A source code to identify the product type: string example: WW5ARCE1 logo: description: Product logo to identify the product type: string example: "830" creditDecision: description: Evaluated Applicant Credit Decision type: string example: IN_PRINCIPAL_PARTIAL_APPROVED creditSpecificRecommendations: type: array items: $ref: '#/definitions/ApplicationInquiryCreditSpecificRecommendations' loanSpecificRecommendations: type: array items: $ref: '#/definitions/ApplicationInquiryLoanSpecificRecommendations' requiredDocuments: type: array items: $ref: '#/definitions/ApplicationInquiryRequiredDocuments' required: - productCode - organisationName - sourceCode ApplicationStageResponse: properties: applicationStage: description: Current stage of an application.This is a reference data field. Please use /v1/apac/utilities/referenceData/{applicationStage} resource to get possible value of this field with description. You can use applicationStage field name as the referenceCode parameter to retrieve the values. type: string example: ACCOUNT_OPENED ipaExpiryDate: description: In principle approval expiration date in ISO 8601 date format YYYY-MM-DD type: string format: date example: "2017-06-16" required: - applicationStage paths: /v1/apac/onboarding/products: get: summary: Retrieve product catalogue description: Retrieves all products that are offered to prospects through your app. tags: [] parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: nextStartIndex in: header description: The start index of the next subset of products. type: string responses: 200: description: Successful operation. schema: $ref: '#/definitions/ProductCatalogueResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 404: description:
errorresourceNotFoundEmpty resource/resource not found
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/apac/onboarding/products/unsecured/applications: post: summary: Create unsecured credit application description: Pre-populates an application for card and banking products with the applicant's details. The API will then return an application ID that can be used to perform actions on the application and check status. tags: [] parameters: - name: ApplicationAddRequest required: true in: body description: Input Data to submit the application. schema: $ref: '#/definitions/ApplicationAddRequest' - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: Accept-Language in: header description: List of acceptable human languages for response type: string required: false responses: 200: description: Successful operation. schema: $ref: '#/definitions/ApplicationAddResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorsingleProductAllowedOnly 1 product allowed in the request
errorproductAgreementExpiredAgreement duration of this product is expired
invalidinvalidProductMissing or Invalid product
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/apac/onboarding/products/unsecured/applications/{applicationId}/backgroundScreening: post: summary: Screen unsecured credit application description: Submits the specified unsecured credit application for screening. tags: [] parameters: - name: applicationId in: path description: The unique identifier of the application type: string required: true - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: BackgroundScreeningRequest required: true in: body schema: $ref: '#/definitions/BackgroundScreeningRequest' responses: 200: description: The request has succeeded schema: $ref: '#/definitions/BackgroundScreeningResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorapplicationRejectedApplication Rejected.Cannot process further
errorbackgroundScreeningAlreadyInitiatedBackground Screening already initiated
errorinvalidControlFlowIdControl flow Id is invalid
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error/server unavailability
schema: $ref: '#/definitions/ErrorResponse' /v1/apac/onboarding/products/unsecured/applications/{applicationId}: put: summary: Update unsecured credit application description: Updates a saved application to correct information that was previously blank. tags: [] parameters: - name: applicationId in: path description: Unique ID created for an Application. This is retuned back in ApplicationAdd response and the same should be passed here. type: string required: true - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: ApplicationUpdateRequest required: true in: body description: Input Data to submit the application. schema: $ref: '#/definitions/ApplicationUpdateRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/ApplicationUpdateResponse' 400: description:
TypeCodeDetails
invalidInvalidRequestMissing or invalid parameters
errorfieldUpdateNotAllowedAtThisAppStageThis data cannot be updated at this application stage.
errorinvalidControlFlowIdControl flow Id is invalid
erroramountToTransferBelowMinimumLimitAmount to transfer less than the minimum limit allowed
errorexceedsAllowedBalanceTransferLimitTotal Balance transfer amount requested is above the maximum limit allowed
errorexceededNumberOfBalanceTransfersNumber of balance transfers exceeded
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' get: summary: Application Inquiry description: Returns the application details and status for a specific application ID after a successful Multi Factor Authentication. tags: [] parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: applicationId in: path description: Unique identifier for the application. type: string required: true - name: controlFlowId in: query description: Control flow id is used to control the flow for subsequent requests in the session. type: string responses: 200: description: Successful operation. schema: $ref: '#/definitions/ApplicationInquiryResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidControlFlowIdControl flow ID is invalid
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
errormfaRequiredMulti factor authorization is required/td>
schema: $ref: '#/definitions/ErrorResponse' 404: description:
errorresourceNotFoundEmpty resource/resource not found
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/apac/onboarding/products/unsecured/applications/{applicationId}/inPrincipleApprovals: post: summary: Request credit application decision description: Returns the results of a decision inquiry for an application, including credit limit, counter-product offers and cross-sell offers along with the list of required documents. tags: [] parameters: - name: applicationId in: path description: the ID of the application type: string required: true - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: InPrincipleApprovalRequest in: body required: true schema: $ref: '#/definitions/InPrincipleApprovalRequest' responses: 200: description: The request has succeeded schema: $ref: '#/definitions/InPrincipleApprovalResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorapplicationRejectedApplication Rejected.Cannot process further
errorapplicationNeedsManualReviewApplication needs manual review. IPA not applicable. Please fill all details and do final submission
errorawaitingBackgroundScreeningResultPlease trigger after sometime. Awaiting background screening response
errorperformBackgroundScreeningFirstPlease perform background screening first
errorinPrincipalApprovalAlreadyGivenInPrincipalApproval already given
errorinvalidControlFlowIdControl flow Id is invalid
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/apac/onboarding/products/unsecured/applications/{applicationId}/offerAcceptance: post: summary: Accept cross sell products description: Accepts specified cross-sell product offers that were returned in the application decision. tags: [] parameters: - name: OfferAcceptanceRequest required: true in: body description: Input Data to accept the product offered in the application. schema: $ref: '#/definitions/OfferAcceptanceRequest' - name: applicationId in: path description: the ID of the application type: string required: true - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string responses: 200: description: Successful operation. 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidProductCodeinvalid ProductCode
errorapplicationRejectedapplicationRejected
errorincorrectProductSelectedincorrect Product Selected
errorexceededApprovedCreditLimitRequested credit limit is more than the maximum limit allowed.
errorinvalidControlFlowIdControl flow Id is invalid
errorrequestedCreditLimitBelowMinimumRequested credit limit is less than the below minimum limit allowed
errorinvalidMultipleRequestCreditLimitRequested credit limit amount is not an expected multiple
schema: $ref: '#/definitions/ErrorResponse' 401: description:
TypeCodeDetails
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/apac/onboarding/applications/{applicationId}/documents: post: summary: Upload application documents description: Uploads documents to the specified application. Required documents such as drivers license and banking statements will be returned in the application decision. tags: [] parameters: - name: applicationId in: path description: The unique identifier of the application. type: string required: true - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: InsertDocument required: true in: body description: Insert the documents in documentum. schema: $ref: '#/definitions/InsertDocumentRequest' responses: 200: description: The request has succeeded schema: $ref: '#/definitions/InsertDocumentResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorunSupportedDocumentTypeDocument Type is not supported
errorfileCorruptedFile is corrupted
errorinvalidControlFlowIdControl flow Id is invalid
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error/server unavailability
schema: $ref: '#/definitions/ErrorResponse' /v1/apac/onboarding/products/unsecured/applications/{applicationId}/submission: post: summary: Submit application description: Submits the created application to host systems for a particular application ID. tags: [] parameters: - name: applicationId in: path description: The unique identifier of the application. type: string required: true - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: FinalSubmitRequest required: true in: body schema: $ref: '#/definitions/FinalSubmitRequest' responses: 200: description: The request has succeeded 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorapplicationRejectedApplication not successful
errorinvalidControlFlowIdControl flow Id is invalid
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/apac/onboarding/products/unsecured/applications/{applicationId}/status: get: summary: Check application status description: Returns the status of the specified application. tags: [] parameters: - name: applicationId in: path description: the ID of the application type: string required: true - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: controlFlowId in: query description: Control Flow Id required: true type: string responses: 200: description: The request has succeeded schema: $ref: '#/definitions/ApplicationStatusResponse' 400: description:
invalidinvalidRequestMissing or invalid parameters
errorinvalidControlFlowIdControl flow Id is invalid
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/apac/utilities/addresses/{postalCode}: get: summary: Retrieve address description: Returns address parameters for the specified postal code. It can be used to either validate addresses or populate address fields. tags: [] parameters: - name: postalCode in: path description: Postal Code type: string required: true - name: Authorization in: header description: Access token to authenticate your request. type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string responses: 200: description: The request has succeeded schema: $ref: '#/definitions/AddressSearchUsingPostalCodeResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
errorinvalidPostalCodeMissing or invalid PostalCode
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
invalidaccessNotConfiguredThe request operation is not configured to access this resource.Channel/Country/Business provided in the request is not supported currently
schema: $ref: '#/definitions/ErrorResponse' 404: description:
errorresourceNotFoundEmpty resource/resource not found
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error/server unavailability
schema: $ref: '#/definitions/ErrorResponse' /v1/apac/onboarding/prospects: post: summary: Submit prospect description: Creates a new prospective customer. Returns a prospect ID that can be used for reach out and conversions to applications. tags: [] parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: ProspectAddRequest required: true in: body description: Prospect Add Request schema: $ref: '#/definitions/ProspectAddRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/ProspectAddResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid parameters
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/apac/onboarding/products/unsecured/applications/{applicationId}/applicants: post: summary: Supp Applicant Add description: Create a new supplementary card application along with Primary card application. tags: [] parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Types that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: applicationId in: path description: Unique ID created for an Application. This is retuned back in ApplicationAdd response and the same should be passed here. type: string required: true - name: ApplicantAddRequest required: true in: body description: Add applicant details to the application schema: $ref: '#/definitions/ApplicantAddRequest' responses: 200: description: Successful operation. schema: $ref: '#/definitions/ApplicantAddResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid Parameters
errorinvalidControlFlowIdControl flow ID is invalid
errorrequestedCreditLimitBelowMinimumRequested credit limit is less than the below minimum limit allowed
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' get: summary: Supp Applicant Inquiry description: Returns supplementary application details for the specific supplementary application ID. tags: [] parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Types that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: applicationId in: path description: Unique ID created for an Application. This is retuned back in ApplicationAdd response and the same should be passed here. type: string required: true - name: applicantId in: query description: Unique ID created for an Applicant. This is retuned back in ApplicantAdd response and the same should be passed here. type: string - name: controlFlowId in: query description: It is used to control the flow for subsequent requests in the session. type: string required: true responses: 200: description: Successful operation. schema: $ref: '#/definitions/ApplicantInquiryResponse' 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid Parameters
errorinvalidControlFlowIdControl flow ID is invalid
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 404: description:
errorresourceNotFoundEmpty resource/resource not found
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/apac/onboarding/products/unsecured/applications/{applicationId}/applicants/{applicantId}: put: summary: Supp Applicant Update description: Allows primary card holder to edit or update the supplementary card application details. tags: [] parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Types that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: applicationId in: path description: Unique ID created for an Application. This is retuned back in ApplicationAdd response and the same should be passed here. type: string required: true - name: applicantId in: path description: Unique ID created for an Applicant. This is retuned back in ApplicantAdd response and the same should be passed here. type: string required: true - name: ApplicantUpdateRequest required: true in: body description: Add applicant details to the application schema: $ref: '#/definitions/ApplicantUpdateRequest' responses: 200: description: Successful operation. 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid Parameters
errorinvalidControlFlowIdControl flow ID is invalid
errorrequestedCreditLimitBelowMinimumRequested credit limit is less than the below minimum limit allowed
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /v1/apac/onboarding/products/unsecured/applications/{applicationId}/applicants/{applicantId}/delete: put: summary: Supp Applicant Delete description: Allows primary card holder to delete the supplementary card application. tags: [] parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Types that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: Content-Type in: header description: application/json required: true type: string - name: applicationId in: path description: Unique ID created for an Application. This is retuned back in ApplicationAdd response and the same should be passed here. type: string required: true - name: applicantId in: path description: Unique ID created for an Applicant.. type: string required: true - name: applicantDeleteRequest required: true in: body description: Add applicant details to the application schema: $ref: '#/definitions/applicantDeleteRequest' responses: 200: description: Successful operation. 400: description:
TypeCodeDetails
invalidinvalidRequestMissing or invalid Parameters
errorinvalidControlFlowIdControl flow ID is invalid
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credential is missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 404: description:
errorresourceNotFoundEmpty resource/resource not found
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' /partner/v1/apac/onboarding/products/unsecured/applications/{applicationId}/stage: get: summary: Application Status description: Returns the current application status for a specific application ID. tags: [] parameters: - name: Authorization in: header description: 'The most recent Authorization token. This will have the format Bearer + {space} + {accessToken}. Example: Bearer KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==.' type: string required: true - name: uuid in: header description: 128 bit random UUID generated uniquely for every request. type: string required: true - name: Accept in: header description: Content-Type that are acceptable for the response. type: string required: true - name: client_id in: header description: Client ID generated during application registration. required: true type: string - name: applicationId in: path description: Unique ID created for an Application. This is returned back in ApplicationAdd response and the same should be passed here. type: string required: true responses: 200: description: Successful operation. schema: $ref: '#/definitions/ApplicationStageResponse' 400: description:
invalidinvalidRequestMissing or invalid parameters
errorinvalidControlFlowIdControl flow Id is invalid
schema: $ref: '#/definitions/ErrorResponse' 401: description:
errorunAuthorizedAuthorization credentials are missing or invalid
schema: $ref: '#/definitions/ErrorResponse' 403: description:
erroraccessNotConfiguredAccess is not configured for this resource
schema: $ref: '#/definitions/ErrorResponse' 404: description:
errorresourceNotFoundEmpty resource/resource not found
schema: $ref: '#/definitions/ErrorResponse' 500: description:
fatalserverUnavailableThe request failed due to an internal error
schema: $ref: '#/definitions/ErrorResponse' x-ibm-endpoints: - endpointUrl: https://sandbox.apihub.citi.com/gcb description: Custom Gateway API Endpoint type: - production - development ...