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.

  1. To see an example request, go to the Unified Add Customer API page.

  2. 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
  1. To make a sample request, go to the Getting started page.

Enum values


The estimatedMonthlyFunding enum values are as follows:

MF001< 1000
MF0021000 – 5000
MF0035000 – 10000
MF00410000 – 20000
MF005> 20000


The intendedUseOfAccount enum values are as follows:

IU100Receiving from/Transfers to accounts I own
IU101Receiving from/Transfers to friends or family
IU102Property, goods or services payments
IU103Education-related payment
IU105Receive or send donations
IU106Day-to-day spending
IU107Receiving a salary
IU108Travel related spending


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

OC0001Legislators and senior management
OC1001Administrative services managers
OC1002Managers in financial and business services
OC1003Managers in communication (except broadcasting)
OC1110Auditors, accountants and investment professionals
OC1120Human resources and business service professionals
OC1201Administrative and financial supervisors
OC1210Administrative and regulatory occupations
OC1211Court reporters, transcriptionists, records management technicians and statistical officers
OC1220Accounting, insurance and related business administrative occupations
OC1310Administrative, property and payroll officers
OC1311Office administrative assistants - general, legal and medical
OC1320Transportation and production logistics coordinators and customs and related broker occupations
OC1410Office support and court services occupations
OC1411Survey, statistical and data entry occupations
OC1420Financial, insurance and related administrative support workers
OC1430Library, correspondence and other clerks
OC1440Supply chain logistics, tracking and scheduling coordination occupations
OC2001Managers in engineering, architecture, science and information systems
OC2110Physical science professionals
OC2111Life science professionals
OC2112Public and environmental health and safety professionals
OC2120Architects, urban planners and land surveyors
OC2121Mathematicians, statisticians, actuaries and data scientists
OC2122Computer and information systems professionals
OC2123Computer, software and Web designers and developers
OC2130Civil and mechanical engineers
OC2131Electrical, electronics and computer engineers
OC2132Manufacturing and processing engineers
OC2133Natural resources engineers
OC2139Other engineers
OC2210Technical occupations in physical sciences
OC2211Technical occupations in life sciences
OC2221Technical occupations in architecture, drafting, surveying, geomatics and meteorology
OC2222Technical occupations in computer and information systems
OC2223Technical inspectors and regulatory officers
OC2230Technical occupations in civil, mechanical and industrial engineering
OC2231Technical occupations in electronics and electrical engineering
OC3001Managers in health care
OC3110Physicians and veterinarians
OC3111Dentists, optometrists and audiologists
OC3112Pharmacists and dietitians
OC3120Therapy and assessment professionals
OC3130Nursing and allied health professionals
OC3210Technical occupations in therapy and assessment
OC3211Technical occupations in dental health care
OC3212Medical technologists and technicians
OC3220Practitioners of natural healing
OC3310Assisting occupations in support of health services
OC4001Managers in public administration
OC4002Managers in education
OC4003Managers in social, community and correctional services
OC4004Managers in public protection services
OC4110Judges, lawyers and Quebec notaries
OC4120University professors and post-secondary assistants
OC4121College and other vocational instructors
OC4122Secondary, elementary and kindergarten school teachers
OC4130Social and community service professionals
OC4131Police investigators and probation officers
OC4132Educational and employment counsellors
OC4140Policy and program researchers, consultants and officers
OC4210Occupations in front-line public protection services
OC4220Paraprofessional occupations in legal, social, community and education services
OC4310Assisting occupations in education
OC4320Assisting occupations in legal and public protection
OC4410Home care provider occupations
OC4420Primary combat members of the Canadian Armed Forces
OC4510Student monitors, crossing guards and related occupations
OC5001Managers in art, culture, recreation and sport
OC5110Librarians, archivists, conservators and curators
OC5111Writing, translating and related communications professionals
OC5112Creative and performing artists
OC5210Technical occupations in libraries and public archives
OC5211Technical occupations in motion pictures, broadcasting and the performing arts
OC5212Graphic and interior designers
OC5310Occupations related to museums and art galleries
OC5311Photographers and support occupations in arts and culture
OC5312Occupations in creative and performing art
OC5320Athletes, coaches, referees and related occupations
OC5410Program leaders and instructors in recreation, sport and fitness
OC5510Support occupations in art and culture
OC6001Corporate sales managers
OC6002Retail and wholesale trade managers
OC6003Managers in food service and accommodation
OC6004Managers in customer and personal services
OC6201Retail sales supervisors
OC6202Service supervisors
OC6210Technical sales specialists in wholesale trade and retail and wholesale buyers
OC6220Specialized occupations in services
OC6310Insurance, real estate and financial sales occupations
OC6320Cooks, butchers and bakers
OC6321Hairstylists and estheticians
OC6322Shoe repairers, shoemakers and upholsterers
OC6410Retail salespersons and non-technical wholesale trade sales and account representatives
OC6420Occupations in personal service
OC6430Occupations in food and beverage service
OC6431Occupations in travel and accommodation
OC6432Tourism and amusement services occupations
OC6440Customer and information services representatives
OC6441Security guards and related security service occupations
OC6510Cashiers and other sales support occupations
OC6520Food support occupations
OC6521Support occupations in accommodation, travel, tourism and amusement services
OC6522Support occupations in personal services
OC6532Service support and related occupations
OC7001Managers in construction and facility operation and maintenance
OC7002Managers in transportation and postal and courier services
OC7201Contractors and supervisors, technical industrial, electrical and construction trades and related workers
OC7202Contractors and supervisors, technical maintenance trades and heavy equipment and transport operators
OC7210Machining, metal forming, shaping and erecting trades
OC7220Technical electrical trades and electrical power line and telecommunications workers
OC7230Plumbers, pipefitters and gas fitters
OC7231Carpenters and cabinetmakers
OC7232Bricklayers and Insulators
OC7240Machinery and transportation equipment mechanics (except motor vehicles)
OC7241Automotive service technicians
OC7242Small engine and equipment mechanics and related repairers (including electrical components)
OC7250Crane operators and water well drillers
OC7260Transportation officers and controllers
OC7299Others technical trades
OC7310Concrete finishers, tilesetters and plasterers
OC7311Roofers, glaziers, painters, decorators and floor covering installers
OC7320Building maintenance installers, servicers and repairers
OC7330Transport truck and transit drivers
OC7331Train crew operating occupations
OC7340Operators, drillers and blasters
OC7410Mail and message distribution occupations
OC7420Transport equipment operators, utility maintenance and related maintenance workers
OC7510Longshore workers and material handlers
OC7511Trades helpers and labourers
OC7520Taxi and personal service and delivery service drivers
OC7521Water and rail transport operators and labourers and related occupations
OC8001Managers in natural resources production and fishing
OC8002Managers in agriculture, horticulture and aquaculture
OC8201Supervisors, logging and forestry
OC8202Contractors and supervisors, mining, oil and gas
OC8203Contractors and supervisors, agriculture, horticulture and related operations and services
OC8310Underground miners, oil and gas drillers and related occupations
OC8311Logging machinery operators
OC8312Fishing vessel masters and fishermen/women
OC8410Mine service workers and operators in oil and gas drilling
OC8411Logging and forestry workers
OC8412Workers in agriculture and fishing occupations
OC8510Agriculture, horticulture and harvesting labourers and related occupations
OC8511Mine and oil and gas drilling, services and related labourers
OC8512Logging, forestry, landscaping and other related labourers
OC9001Managers in manufacturing and utilities
OC9201Supervisors, processing and manufacturing occupations
OC9202Supervisors, assembly and fabrication
OC9210Utilities equipment operators and controllers
OC9310Central control and process operators in processing and manufacturing
OC9320Aircraft assemblers and aircraft assembly inspectors
OC9410Machine operators and related workers in mineral and metal products processing and manufacturing
OC9411Machine operators and related workers in chemical, plastic and rubber processing
OC9412Machine operators and related workers in pulp and paper production and wood processing and manufacturing
OC9413Machine operators and related workers in textile, fabric, fur and leather products processing and manufacturing
OC9414Machine operators and related workers in food, beverage and associated products processing
OC9415Printing equipment operators and related occupations
OC9420Mechanical, electrical and electronics assemblers and inspectors
OC9421Furniture, wood, plastic and other products assemblers, finishers and inspectors
OC9510Labourers in processing, manufacturing and utilities