Unified Add Customer API

Example request

The Unified Add Customer API creates a customer with the manual Know Your Customer (KYC) option where most of the parameters are applicable. For other KYC options, fewer parameters are applicable.

To see an example request, go to the Unified Add Customer API page.
Select an example by clicking anywhere on the word EXAMPLES to open the drop-down list of available examples:
- Sample for Manual KYC
- Sample for Screening only
- Sample for e-KYC

To make a sample request, go to the Getting started page.

Enum values

`estimatedMonthlyFunding`

The estimatedMonthlyFunding enum values are as follows:

Code	Description
`MF001`	< 1000
`MF002`	1000 – 5000
`MF003`	5000 – 10000
`MF004`	10000 – 20000
`MF005`	> 20000

`intendedUseOfAccount`

The intendedUseOfAccount enum values are as follows:

Code	Description
`IU100`	Receiving from/Transfers to accounts I own
`IU101`	Receiving from/Transfers to friends or family
`IU102`	Property, goods or services payments
`IU103`	Education-related payment
`IU104`	Investments
`IU105`	Receive or send donations
`IU106`	Day-to-day spending
`IU107`	Receiving a salary
`IU108`	Travel related spending
`IU109`	Saving

`occupation`

The occupationenum is only applicable for onboarding in Canada. The enum values are as follows:

Code	Description
`OC0001`	Legislators and senior management
`OC1001`	Administrative services managers
`OC1002`	Managers in financial and business services
`OC1003`	Managers in communication (except broadcasting)
`OC1110`	Auditors, accountants and investment professionals
`OC1120`	Human resources and business service professionals
`OC1201`	Administrative and financial supervisors
`OC1210`	Administrative and regulatory occupations
`OC1211`	Court reporters, transcriptionists, records management technicians and statistical officers
`OC1220`	Accounting, insurance and related business administrative occupations
`OC1310`	Administrative, property and payroll officers
`OC1311`	Office administrative assistants - general, legal and medical
`OC1320`	Transportation and production logistics coordinators and customs and related broker occupations
`OC1410`	Office support and court services occupations
`OC1411`	Survey, statistical and data entry occupations
`OC1420`	Financial, insurance and related administrative support workers
`OC1430`	Library, correspondence and other clerks
`OC1440`	Supply chain logistics, tracking and scheduling coordination occupations
`OC2001`	Managers in engineering, architecture, science and information systems
`OC2110`	Physical science professionals
`OC2111`	Life science professionals
`OC2112`	Public and environmental health and safety professionals
`OC2120`	Architects, urban planners and land surveyors
`OC2121`	Mathematicians, statisticians, actuaries and data scientists
`OC2122`	Computer and information systems professionals
`OC2123`	Computer, software and Web designers and developers
`OC2130`	Civil and mechanical engineers
`OC2131`	Electrical, electronics and computer engineers
`OC2132`	Manufacturing and processing engineers
`OC2133`	Natural resources engineers
`OC2139`	Other engineers
`OC2210`	Technical occupations in physical sciences
`OC2211`	Technical occupations in life sciences
`OC2221`	Technical occupations in architecture, drafting, surveying, geomatics and meteorology
`OC2222`	Technical occupations in computer and information systems
`OC2223`	Technical inspectors and regulatory officers
`OC2230`	Technical occupations in civil, mechanical and industrial engineering
`OC2231`	Technical occupations in electronics and electrical engineering
`OC3001`	Managers in health care
`OC3110`	Physicians and veterinarians
`OC3111`	Dentists, optometrists and audiologists
`OC3112`	Pharmacists and dietitians
`OC3120`	Therapy and assessment professionals
`OC3130`	Nursing and allied health professionals
`OC3210`	Technical occupations in therapy and assessment
`OC3211`	Technical occupations in dental health care
`OC3212`	Medical technologists and technicians
`OC3220`	Practitioners of natural healing
`OC3310`	Assisting occupations in support of health services
`OC4001`	Managers in public administration
`OC4002`	Managers in education
`OC4003`	Managers in social, community and correctional services
`OC4004`	Managers in public protection services
`OC4110`	Judges, lawyers and Quebec notaries
`OC4120`	University professors and post-secondary assistants
`OC4121`	College and other vocational instructors
`OC4122`	Secondary, elementary and kindergarten school teachers
`OC4130`	Social and community service professionals
`OC4131`	Police investigators and probation officers
`OC4132`	Educational and employment counsellors
`OC4140`	Policy and program researchers, consultants and officers
`OC4210`	Occupations in front-line public protection services
`OC4220`	Paraprofessional occupations in legal, social, community and education services
`OC4310`	Assisting occupations in education
`OC4320`	Assisting occupations in legal and public protection
`OC4410`	Home care provider occupations
`OC4420`	Primary combat members of the Canadian Armed Forces
`OC4510`	Student monitors, crossing guards and related occupations
`OC5001`	Managers in art, culture, recreation and sport
`OC5110`	Librarians, archivists, conservators and curators
`OC5111`	Writing, translating and related communications professionals
`OC5112`	Creative and performing artists
`OC5210`	Technical occupations in libraries and public archives
`OC5211`	Technical occupations in motion pictures, broadcasting and the performing arts
`OC5212`	Graphic and interior designers
`OC5310`	Occupations related to museums and art galleries
`OC5311`	Photographers and support occupations in arts and culture
`OC5312`	Occupations in creative and performing art
`OC5320`	Athletes, coaches, referees and related occupations
`OC5410`	Program leaders and instructors in recreation, sport and fitness
`OC5510`	Support occupations in art and culture
`OC6001`	Corporate sales managers
`OC6002`	Retail and wholesale trade managers
`OC6003`	Managers in food service and accommodation
`OC6004`	Managers in customer and personal services
`OC6201`	Retail sales supervisors
`OC6202`	Service supervisors
`OC6210`	Technical sales specialists in wholesale trade and retail and wholesale buyers
`OC6220`	Specialized occupations in services
`OC6310`	Insurance, real estate and financial sales occupations
`OC6320`	Cooks, butchers and bakers
`OC6321`	Hairstylists and estheticians
`OC6322`	Shoe repairers, shoemakers and upholsterers
`OC6410`	Retail salespersons and non-technical wholesale trade sales and account representatives
`OC6420`	Occupations in personal service
`OC6430`	Occupations in food and beverage service
`OC6431`	Occupations in travel and accommodation
`OC6432`	Tourism and amusement services occupations
`OC6440`	Customer and information services representatives
`OC6441`	Security guards and related security service occupations
`OC6510`	Cashiers and other sales support occupations
`OC6520`	Food support occupations
`OC6521`	Support occupations in accommodation, travel, tourism and amusement services
`OC6522`	Support occupations in personal services
`OC6531`	Cleaners
`OC6532`	Service support and related occupations
`OC7001`	Managers in construction and facility operation and maintenance
`OC7002`	Managers in transportation and postal and courier services
`OC7201`	Contractors and supervisors, technical industrial, electrical and construction trades and related workers
`OC7202`	Contractors and supervisors, technical maintenance trades and heavy equipment and transport operators
`OC7210`	Machining, metal forming, shaping and erecting trades
`OC7220`	Technical electrical trades and electrical power line and telecommunications workers
`OC7230`	Plumbers, pipefitters and gas fitters
`OC7231`	Carpenters and cabinetmakers
`OC7232`	Bricklayers and Insulators
`OC7240`	Machinery and transportation equipment mechanics (except motor vehicles)
`OC7241`	Automotive service technicians
`OC7242`	Small engine and equipment mechanics and related repairers (including electrical components)
`OC7250`	Crane operators and water well drillers
`OC7260`	Transportation officers and controllers
`OC7299`	Others technical trades
`OC7310`	Concrete finishers, tilesetters and plasterers
`OC7311`	Roofers, glaziers, painters, decorators and floor covering installers
`OC7320`	Building maintenance installers, servicers and repairers
`OC7330`	Transport truck and transit drivers
`OC7331`	Train crew operating occupations
`OC7340`	Operators, drillers and blasters
`OC7410`	Mail and message distribution occupations
`OC7420`	Transport equipment operators, utility maintenance and related maintenance workers
`OC7510`	Longshore workers and material handlers
`OC7511`	Trades helpers and labourers
`OC7520`	Taxi and personal service and delivery service drivers
`OC7521`	Water and rail transport operators and labourers and related occupations
`OC8001`	Managers in natural resources production and fishing
`OC8002`	Managers in agriculture, horticulture and aquaculture
`OC8201`	Supervisors, logging and forestry
`OC8202`	Contractors and supervisors, mining, oil and gas
`OC8203`	Contractors and supervisors, agriculture, horticulture and related operations and services
`OC8310`	Underground miners, oil and gas drillers and related occupations
`OC8311`	Logging machinery operators
`OC8312`	Fishing vessel masters and fishermen/women
`OC8410`	Mine service workers and operators in oil and gas drilling
`OC8411`	Logging and forestry workers
`OC8412`	Workers in agriculture and fishing occupations
`OC8510`	Agriculture, horticulture and harvesting labourers and related occupations
`OC8511`	Mine and oil and gas drilling, services and related labourers
`OC8512`	Logging, forestry, landscaping and other related labourers
`OC9001`	Managers in manufacturing and utilities
`OC9201`	Supervisors, processing and manufacturing occupations
`OC9202`	Supervisors, assembly and fabrication
`OC9210`	Utilities equipment operators and controllers
`OC9310`	Central control and process operators in processing and manufacturing
`OC9320`	Aircraft assemblers and aircraft assembly inspectors
`OC9410`	Machine operators and related workers in mineral and metal products processing and manufacturing
`OC9411`	Machine operators and related workers in chemical, plastic and rubber processing
`OC9412`	Machine operators and related workers in pulp and paper production and wood processing and manufacturing
`OC9413`	Machine operators and related workers in textile, fabric, fur and leather products processing and manufacturing
`OC9414`	Machine operators and related workers in food, beverage and associated products processing
`OC9415`	Printing equipment operators and related occupations
`OC9420`	Mechanical, electrical and electronics assemblers and inspectors
`OC9421`	Furniture, wood, plastic and other products assemblers, finishers and inspectors
`OC9510`	Labourers in processing, manufacturing and utilities