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 deaccessioning happening in real time.

Note: The Developer Hub Sandbox is a test environment that allows you to make API calls that are the same in form and function to our production environments. It contains dummy test data so that you can prototype your application as if it were the real thing. When you’re finished testing, contact sales to request production access.

,

Note: Skip this step if you already created an app and have a pair of Client ID and Client Secret.

  1. Sign in to developer.citi.com
  2. Select My Applications tab.
  3. Click Register a New App
     

a. Fill out the required details

b. Upload an icon for your app (optional)

c. Click Submit

d. You will receive a pair of Client ID and Client Secret. Store this information securely. Use the Show button/checkbox to see your Client ID and Client Secret.

Note: Client secret is shown only once, so make sure you save this information. If in any case you lose your credential set, you can use the Regenerate button to get a new set of Client ID & Client Secret.

,

An access token is required to call all functional APIs. To retrieve your access token, visit your market’s Authorize guide.

,

GET /v1/apac/onboarding/products

Retrieves all products that are offered to prospects through your app

Parameters

Value

Authorization

Bearer <<Authorization Token>>

uuid

8120e2d6-0381-4e52-9d90-a5bf771ff243

Accept

application/json

Client_ID

e5245bed-daaf-4eac-867b-57a564604fda

nextStartIndex

 

,

POST /v1/apac/onboarding/products/unsecured/applications

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.

Parameters

Value

ApplicationAddRequest

{"product":{"creditCardProduct":{"productCode":"VC830","sourceCode":"WW5ARCE1","organization":"888","logo":"830","requestCreditShield":"false","embossName":"Matthew Hyden","billingAddress":"OFFICE_ADDRESS","cardDeliveryAddress":"OFFICE_ADDRESS","pinDeliveryAddress":"OFFICE_ADDRESS","giftCode":"gc123","creditLimitIncreaseIndicator":true}},"applicant":{"ocr":{"ocrReferenceNumber":"OCR456789434538922"},"motherMaidenName":"Lisa","name":{"salutation":"MR","givenName":"Matthew","middleName":"Du","surname":"Hayden","localEnglishGivenName":"Matthew","localEnglishSurname":"Hayden","aliasName":"Matt","saluteBy":"SURNAME"},"demographics":{"gender":"MALE","dateOfBirth":"1972-09-15","placeOfBirth":"Sydney","countryOfBirth":"AU","nationality":"AU","domicileCountryCode":"AU","permanentResidencyCountryCode":"AU","maritalStatus":"MARRIED","residencyStatus":"OWN_HOUSE","residenceType":"HOUSE","taxDomicileCountryCode":"AU","spokenLanguageCode":"ENGLISH","correspondenceLanguageCode":"ENGLISH"},"address":[{"addressType":"OFFICE_ADDRESS","addressLine1":"40A Orchard Road","addressLine2":"#99-99 Macdonald House","addressLine3":"Orchard Avenue 2","addressLine4":"Street 65","cityName":"Melbourne","state":"VICTORIA","postalCode":"345346","provinceCode":"Australia","countryCode":"AU","okToMail":true,"residenceDurationInYears":5,"residenceDurationInMonths":4,"countrySpecificAddress":{"unitNumber":"99","floorNumber":"18","blockNumber":"19","buildingName":"Estella","estateName":"Marine Parade","streetNumber":"52","streetName":"Marine Parade","streetType":"AVENUE","town":"AU"}}],"email":[{"emailAddress":"matt.hayden@gmail.com","okToEmail":true,"isPreferredEmailAddress":true}],"phone":[{"phoneType":"PRIMARY_MOBILE_NUMBER","phoneCountryCode":"61","areaCode":"02","phoneNumber":"6404232122","okToSms":true,"okToCall":true}],"contactPreference":{"sendSmsAdviceFlag":true,"sendEmailAdviceFlag":true,"preferredMailingAddress":"HOME_ADDRESS","eStatementEnrollmentFlag":true},"contactConsent":{"okToCall":true,"okToMail":true,"okToSms":true},"financialInformation":{"hasForeseeableFinancialChanges":true,"expenseDetails":[{"expenseType":"GENERAL_LIVING_EXPENSE","expenseAmount":590.25,"frequency":"MONTHLY"}],"incomeDetails":[{"incomeType":"DECLARED_GROSS_ANNUAL_INCOME","fixedAmount":7590.25,"variableAmount":1590.25,"frequency":"MONTHLY","otherIncomeDescription":"Rent"}],"existingLoanDetails":[{"loanType":"PERSONAL_LOAN","monthlyInstallmentAmount":250.25,"outstandingBalanceAmount":5000.25}]},"education":{"highestEducationLevel":"MASTER","yearOfGraduation":"2003","studentId":"STID234567","university":"NUS"},"employmentDetails":[{"employerName":"Citi Bank","jobTitle":"POLITICIAN","occupationCode":"BUSINESS_COMPUTER_ACCOUNTANT","industryCode":"TELEMARKETING","employmentDurationInYears":5,"employmentDurationInMonths":3,"employmentStatus":"EMPLOYED_FULL_TIME","monthsInPreviousEmployment":5,"yearsInPreviousEmployment":4,"accountantName":"Javier","accountantFirmName":"ACME","yearsInIndustry":5,"monthsInIndustry":6}],"identificationDocumentDetails":[{"idType":"PASSPORT_NUMBER","idNumber":"S42258011","idExpiryDate":"2027-04-11","idIssueDate":"2017-04-12","idIssuePlace":"AU","idIssueState":"QUEENSLAND","idIssueCountry":"AU","isPrimaryId":true}],"additionalData":{"numberOfDependents":"3","staffIndicator":true,"businessNature":"BANKING","emergencyContactName":"Pearline","emergencyContactPhoneNumber":"6164042321","overLimitConsentFlag":true,"countrySpecificGroup":{"bumiputraIndicator":true,"disabilityIndicator":true,"unionPayCardNumber":"5555666600008888","taxFileNumber":"656456737"},"referralGivenName":"Maxwell","referralSurname":"Gate"},"partnerCustomerDetails":{"partnerCustomerInternalId":"ZOW9IO793855","partnerCustomerId":"P011100000125","partnerCustomerSegment":"AD1"},"consentDetails":[{"consentType":"PDP_CONSENT","isConsentGiven":true},{"consentType":"PARTNER_CONSENT","isConsentGiven":true}],"selfDeclaration":{"totalActiveCreditCardLimitAmount":23000.25,"anticipatedIncomeDecreaseCode":"Yes","loanTakenIndicator":true,"monthlyRepaymentForAllExtLoans":5000.25},"kycInformation":{"selfPublicFigureDeclarationFlag":true,"publicFigureOfficeStatus":"Active","publicFigureOfficeDetails":"Department of education and training","publicFigureOfficeStartDate":"2017-04-12","publicFigureOfficeEndDate":"2020-04-11","isRelatedToSeniorPublicFigure":true,"relatedSeniorPublicFigureName":"Dan Lee","relatedSpfCountryOfGovernment":"AU","relatedSeniorPublicFigureDepartment":"Ministry","relationshipWithSeniorPublicFigure":"Father","relatedSeniorPublicFigureLastName":"Lee","usTaxStatus":"NFFE_EXCEPTED_DIRECT_REPORTING","usTaxId":"US234567"}}}

Content type

application/json

Authorization

Bearer <<Authorization Token>>

uuid

8120e2d6-0381-4e52-9d90-a5bf771ff243

Accept

application/json

Client_id

e5245bed-daaf-4eac-867b-57a564604fda

Content-type

application/json

Accept-Language

en-us

 

Screen unsecured credit application

POST /v1/apac/onboarding/products/unsecured/applications/{applicationId}/backgroundScreening

Submits the specified unsecured credit application for screening

Parameters

Value

applicationId

ZOW9IO793854

Authorization

Bearer <<Authorization Token>>

uuid

8120e2d6-0381-4e52-9d90-a5bf771ff243

Accept

application/json

Client_id

e5245bed-daaf-4eac-867b-57a564604fda

Content-Type

application/json

BackgroundScreeningRequest

{"controlFlowId":"bb56683b25f4df93b5269260f1d519fb107870035a98a3350011028f8ff3c06d"}

Content type

application/json

 

Update unsecured credit application

 

 

PUT /v1/apac/onboarding/products/unsecured/applications/{applicationId}

Updates a saved application to correct information that was previously blank

Parameters

Value

applicationId

ZOW9IO793854

Authorization

Bearer <<Authorization Token>>

uuid

8120e2d6-0381-4e52-9d90-a5bf771ff243

Accept

application/json

Client_id

e5245bed-daaf-4eac-867b-57a564604fda

Content-Type

application/json

ApplicationUpdateRequest

{"product":{"creditCardProduct":{"productCode":"VC830","sourceCode":"WW5ARCE1","organization":"888","logo":"830","requestCreditShield":"true","embossName":"Matthew Hyden","billingAddress":"HOME_ADDRESS","cardDeliveryAddress":"HOME_ADDRESS","pinDeliveryAddress":"HOME_ADDRESS","giftCode":"gc123","creditLimitIncreaseIndicator":"true","balanceTransferDetails":[{"amountToTransfer":5000.25,"issuingOrganizationName":"AMEX_AUSTRALIA","accountName":"Matt","accountReferenceNumber":"521212345121","billerCode":"11000125","campaignId":"C$11785241"}]}},"applicant":{"name":{"salutation":"MR","givenName":"Matthew","middleName":"Du","surname":"Hayden","localEnglishGivenName":"Matthew","localEnglishSurname":"Hayden","aliasName":"Matt","saluteBy":"SURNAME"},"phone":[{"phoneType":"PRIMARY_MOBILE_NUMBER","phoneCountryCode":"65","areaCode":"02","phoneNumber":"64043401","okToSms":"true","okToCall":"true"}],"email":[{"emailAddress":"matt.hayden@gmail.com","okToEmail":"true","isPreferredEmailAddress":"true"}],"ocr":{"ocrReferenceNumber":"OCR456789434538922"},"demographics":{"gender":"MALE","dateOfBirth":"string","placeOfBirth":"Sydney","countryOfBirth":"AU","nationality":"AU","domicileCountryCode":"AU","permanentResidencyCountryCode":"AU","maritalStatus":"MARRIED","residencyStatus":"RENTED_HOUSE","residenceType":"HOUSE","taxDomicileCountryCode":"AU","spokenLanguageCode":"ENGLISH","correspondenceLanguageCode":"ENGLISH"},"address":[{"addressType":"HOME_ADDRESS","addressLine1":"40A Orchard Road","addressLine2":"#99-99 Macdonald House","addressLine3":"Orchard Avenue 2","addressLine4":"Street 65","cityName":"Melbourne","state":"VICTORIA","postalCode":"238838","provinceCode":"Australia","countryCode":"AU","okToMail":"true","residenceDurationInYears":5,"residenceDurationInMonths":4,"countrySpecificAddress":{"unitNumber":"99","floorNumber":"18","blockNumber":"19","buildingName":"Estella","estateName":"Marine Parade","streetNumber":"52","streetName":"VC830","streetType":"Marine Crescent","town":"AU"}}],"contactPreference":{"sendSmsAdviceFlag":"true","sendEmailAdviceFlag":"true","preferredMailingAddress":"HOME_ADDRESS","eStatementEnrollmentFlag":"true"},"contactConsent":{"okToCall":"true","okToMail":"true","okToSms":"true"},"financialInformation":{"hasForeseeableFinancialChanges":true,"expenseDetails":[{"expenseType":"GENERAL_LIVING_EXPENSE","expenseAmount":"590.25","frequency":"MONTHLY"}],"incomeDetails":[{"incomeType":"DECLARED_GROSS_ANNUAL_INCOME","fixedAmount":"7590.25","variableAmount":"1590.25","frequency":"MONTHLY","otherIncomeDescription":"Rent"}],"existingLoanDetails":[{"loanType":"PERSONAL_LOAN","monthlyInstallmentAmount":250.25,"outstandingBalanceAmount":5000.25}]},"motherMaidenName":"Lisa","education":{"highestEducationLevel":"MASTER","yearOfGraduation":"2003","studentId":"STID234567","university":"NTU"},"employmentDetails":[{"employerName":"Citi Bank","jobTitle":"MANAGER","occupationCode":"BUSINESS_COMPUTER_ACCOUNTANT","industryCode":"TELEMARKETING","employmentDurationInYears":5,"employmentDurationInMonths":3,"employmentStatus":"EMPLOYED_FULL_TIME","monthsInPreviousEmployment":5,"yearsInPreviousEmployment":4,"accountantName":"Javier","accountantFirmName":"ACME","yearsInIndustry":5,"monthsInIndustry":6}],"identificationDocumentDetails":[{"idType":"PASSPORT_NUMBER","idNumber":"S42258011","idExpiryDate":"2027-04-11","idIssueDate":"2017-04-12","idIssuePlace":"AU","idIssueState":"QUEENSLAND","idIssueCountry":"AU","isPrimaryId":"true"}],"additionalData":{"numberOfDependents":"2","staffIndicator":"true","businessNature":"BANKING","emergencyContactName":"Pearline","emergencyContactPhoneNumber":"65012301","overLimitConsentFlag":"true","countrySpecificGroup":{"bumiputraIndicator":true,"disabilityIndicator":"true","unionPayCardNumber":"5555666600008888","taxFileNumber":"656456737"},"referralGivenName":"Maxwell","referralSurname":"Gate"},"partnerCustomerDetails":{"partnerCustomerInternalId":"ZOW9IO793855","partnerCustomerId":"P011100000125","partnerCustomerSegment":"AD1"},"consentDetails":[{"consentType":"PDP_CONSENT","isConsentGiven":"true"}],"selfDeclaration":{"totalActiveCreditCardLimitAmount":"23000.25","anticipatedIncomeDecreaseCode":"Yes","loanTakenIndicator":"true","monthlyRepaymentForAllExtLoans":5000.25},"kycInformation":{"selfPublicFigureDeclarationFlag":"true","publicFigureOfficeStatus":"Active","publicFigureOfficeDetails":"Department of education and training","publicFigureOfficeStartDate":"2017-04-12","publicFigureOfficeEndDate":"2017-04-12","isRelatedToSeniorPublicFigure":"true","relatedSeniorPublicFigureName":"Dan Lee","relatedSpfCountryOfGovernment":"AU","relatedSeniorPublicFigureDepartment":"Ministry","relationshipWithSeniorPublicFigure":"Father","relatedSeniorPublicFigureLastName":"Lee","usTaxStatus":"EXCEPTED_NFFE","usTaxId":"US234567"}},"controlFlowId":"bb56683b25f4df93b5269260f1d519fb107870035a98a3350011028f8ff3c06d"}

Content type

application/json

,

Request credit application decision

POST /v1/apac/onboarding/products/unsecured/applications/{applicationId}/inPrincipleApprovals

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

Parameters

Value

applicationId

ZOW9IO793854

Authorization

Bearer <<Authorization Token>>

uuid

8120e2d6-0381-4e52-9d90-a5bf771ff243

Accept

application/json

Client_id

e5245bed-daaf-4eac-867b-57a564604fda

Content-Type

application/json

InPrincipleApprovalRequest

{"controlFlowId":"bb56683b25f4df93b5269260f1d519fb107870035a98a3350011028f8ff3c06d"}

Content type

application/json

 

Accept cross sell products

POST /v1/apac/onboarding/products/unsecured/applications/{applicationId}/offerAcceptance

Accepts specified cross-sell product offers that were returned in the application decision

 

Parameters

Value

OfferAcceptanceRequest

{"counterProductAcceptedFlag":true,"counterProductConfirmation":[{"productCode":"VC830","sourceCode":"string","organization":"string","creditSpecificSelection":{"requestCreditShield":true,"embossName":"string","billingAddress":"HOME_ADDRESS","cardDeliveryAddress":"HOME_ADDRESS","pinDeliveryAddress":"HOME_ADDRESS","requestedCreditLimit":0,"atmRequiredFlag":0,"chequeBookRequiredFlag":0,"creditLimitIncreaseIndicator":true},"loanSpecificSelection":{"loanAmount":0,"tenor":"string","interestRate":0,"billingAddress":"HOME_ADDRESS"}}],"requestedProductConfirmation":[{"productCode":"VC830","sourceCode":"string","organization":"string","creditSpecificSelection":{"requestCreditShield":true,"embossName":"string","billingAddress":"HOME_ADDRESS","cardDeliveryAddress":"HOME_ADDRESS","pinDeliveryAddress":"HOME_ADDRESS","requestedCreditLimit":0,"atmRequiredFlag":0,"chequeBookRequiredFlag":0,"creditLimitIncreaseIndicator":true},"loanSpecificSelection":{"loanAmount":0,"tenor":"string","interestRate":0,"billingAddress":"HOME_ADDRESS"}}],"controlFlowId":"bb56683b25f4df93b5269260f1d519fb107870035a98a3350011028f8ff3c06d"}

Content type

application/json

applicationId

ZOW9IO793854

Authorization

Bearer <<Authorization Token>>

uuid

8120e2d6-0381-4e52-9d90-a5bf771ff243

Accept

application/json

Client_id

e5245bed-daaf-4eac-867b-57a564604fda

Content-Type

application/json

 

Upload application documents

POST /v1/apac/onboarding/applications/{applicationId}/documents

Uploads documents to the specified application.Required documents such as driver’s license and banking statements will be returned in the application decision

Parameters

Value

applicationId

ZOW9IO793854

Authorization

Bearer <<Authorization Token>>

uuid

8120e2d6-0381-4e52-9d90-a5bf771ff243

Accept

application/json

Client_id

e5245bed-daaf-4eac-867b-57a564604fda

Content-Type

application/json

InsertDocument

{"documentDetails":{"documentIdType":"PASSPORT_NUMBER","documentFormat":"PDF","proofType":"ADDRESS_PROOF","applicantType":"CO_APPLICANT_SUPPLEMENTARY","applicantId":"C$ZOW9IO793854","binaryData":"0101010001101000011010010111001100100000011001100110100101100101011011000110010000100000011000110110"},"controlFlowId":"bb56683b25f4df93b5269260f1d519fb107870035a98a3350011028f8ff3c06d"}

Content type

application/json

 

Submit application

POST /v1/apac/onboarding/products/unsecured/applications/{applicationId}/submission

Submits the created application to host systems for a particular application ID

 

Parameters

Value

applicationId

ZOW9IO793854

Authorization

Bearer <<Authorization Token>>

uuid

8120e2d6-0381-4e52-9d90-a5bf771ff243

Accept

application/json

Client_id

e5245bed-daaf-4eac-867b-57a564604fda

Content-Type

application/json

FinalSubmitRequest

{"controlFlowId":"bb56683b25f4df93b5269260f1d519fb107870035a98a3350011028f8ff3c06d"}

Content type

application/json

,

Check application status

GET /v1/apac/onboarding/products/unsecured/applications/{applicationId}/status

Returns the status of the specified application

Parameters

Value

applicationId

ZOW9IO793854

Authorization

Bearer <<Authorization Token>>

uuid

8120e2d6-0381-4e52-9d90-a5bf771ff243

Accept

application/json

Client_id

e5245bed-daaf-4eac-867b-57a564604fda

controlFlowId

bb56683b25f4df93b5269260f1d519fb107870035a98a3350011028f8ff3c06d

 

Submit prospect

POST /v1/apac/onboarding/prospects

Creates a new prospective customer.Returns a prospect ID that can be used for reach out and conversions to applications

Parameters

Value

Authorization

Bearer <<Authorization Token>>

uuid

8120e2d6-0381-4e52-9d90-a5bf771ff243

Accept

application/json

Client_id

e5245bed-daaf-4eac-867b-57a564604fda

Content-Type

application/json

ProspectAddRequest

{"interest":{"productGroup":"VC830","campaignId":"45645645","waveId":"23423"},"prospect":{"motherMaidenName":"Lisa","name":{"salutation":"MR","givenName":"Matthew","middleName":"DU","surname":"Hayden","localEnglishGivenName":"Matthew","localEnglishSurname":"Hyden","aliasName":"DU","suffix":"Junior","saluteBy":"SURNAME"},"demographics":{"gender":"MALE","dateOfBirth":"1972-09-15","placeOfBirth":"Sydney","countryOfBirth":"SG","nationality":"SG","religion":"Christian","domicileCountryCode":"SG","permanentResidencyCountryCode":"SG","maritalStatus":"MARRIED","residenceType":"BUNGALOW","residencyStatus":"OWN_HOUSE","taxDomicileCountryCode":"SG","spokenLanguageCode":"ENGLISH"},"address":[{"addressType":"OFFICE_ADDRESS","addressLine1":"40A Orchard Rodad","addressLine2":"#99-99 Macdonald House","addressLine3":"Orchard Avenue 2","addressLine4":"Street 65","cityName":"Singapore","state":"QUEENSLAND","postalCode":"345346","provinceCode":"SINGAPORE","countryCode":"SG","okToMail":"true"}],"email":[{"emailAddress":"matt.hayden@gmail.com","okToEmail":"true","isPrerferredEmailAddress":"true"}],"phone":[{"phoneType":"HOME_PHONE_NUMBER","phoneCountryCode":"61","areaCode":"02","phoneNumber":"64042408","okToSms":"true","okToCall":"true"}],"contactPreference":{"sendSmsAdviceFag":"true","preferredMailingAddress":"HOME_ADDRESS"},"financialInformation":{"incomeDetails":[{"incomeType":"DECLARED_FIXED","fixedAmount":23000.25,"variableAmount":23000.25,"frequency":"MONTHLY","otherIncomeDescription":"Rent"}]},"education":{"highestEducationLevel":"MASTER","yearOfGraduation":"2003","studentId":"STID234567","university":"NUS"},"employmentDetails":[{"employerName":"Citi Bank","jobTitle":"POLITICIAN","occupationCode":"ADMIN_SUPPORT_CLERICAL","industryCode":"ENVIRONMENTAL_CONTROLS","selfEmploymentCode":"EMPLOYED"}],"identificationDocumentDetails":[{"idType":"PASSPORT","idNumber":"S42258011","idExpiryDate":"2027-04-11","idIssueDate":"2017-04-12","idIssuePlace":"AU","idIssuingAuthority":"MINISTRY_OF_MANPOWER"}],"additionalData":{"numberOfChildren":3,"numberOfDependents":3,"staffIndicator":"true","countrySpecificGroup":{"bumiputraIndicator":"true","ethnicGroup":"English","disabilityIndicator":"true","unionPayCardNumber":"5555666600004444","taxFileNumber":"34534634734"}},"selfDeclaration":{"anticipatedIncomeDecreaseCode":"Yes","loanTakenIndicator":"true"},"kycInformation":{"usTaxStatus":"EXCEPTED_NFFE","usTaxId":"34534674363"}}}

Content type

application/json

 

Application Inquiry

GET /v1/apac/onboarding/products/unsecured/applications/{applicationId}

Returns the application details and status for a specific application ID after a successful Multi Factor Authentication

Parameters

Value

Authorization

Bearer <<Authorization Token>>

uuid

8120e2d6-0381-4e52-9d90-a5bf771ff243

Accept

application/json

Client_id

e5245bed-daaf-4eac-867b-57a564604fda

applicationId

ZOW9IO793854

controlFlowId

bb56683b25f4df93b5269260f1d519fb107870035a98a3350011028f8ff3c06d

 

Application Status

GET /partner/v1/apac/onboarding/products/unsecured/applications/{applicationId}/stage

Returns the current application status for a specific application ID

Parameters

Value

Authorization

Bearer <<Authorization Token>>

uuid

8120e2d6-0381-4e52-9d90-a5bf771ff243

Accept

application/json

Client_id

e5245bed-daaf-4eac-867b-57a564604fda

applicationId

ZOW9IO793854