Onboarding Validation Errors
Service Task Validations
The service center APIs used for digital onboarding will return a list of validation errors in the errors
object in the API response when you POST
or PATCH
a service center task, if there is incomplete or missing data in the request. See below the list of validation errors that you can receive.
Please note that idx
in the field name represents the index of the sub task's list. For example, the second account
opening task is represented as accountOpeningTasks[1]
. Any validations not done here are done further upstream. All
validation errors are stored in the errors
field using ApiErrorResponse
structure.
Note
Please note that idx
in the field name represents the index of the CreateUserTask
in the createUserTasks
list.
Create User Task
Field Name | Description |
---|---|
createUserTasks[idx].firstName | First name is required |
createUserTasks[idx].lastName | Last name is required |
createUserTasks[idx].email | Email is required |
createUserTasks[idx].dayPhoneNumber | Daytime phone number is required, Daytime phone number is invalid |
createUserTasks[idx].eveningPhoneNumber | Evening phone number is required, Evening phone number is invalid |
createUserTasks[idx].primaryAddress.line1 | Address line 1 is required |
createUserTasks[idx].primaryAddress.city | Address city is required |
createUserTasks[idx].primaryAddress.state | Address state is required |
createUserTasks[idx].primaryAddress.zipcode | Address zipcode is required, Address zipcode should have only 5 digits |
createUserTasks[idx].mailingAddress.line1 | Address line 1 is required |
createUserTasks[idx].mailingAddress.city | Address city is required |
createUserTasks[idx].mailingAddress.state | Address state is required |
createUserTasks[idx].mailingAddress.zipcode | Address zipcode is required, Address zipcode should have only 5 digits |
createUserTasks[idx].dateOfBirth | Date of birth is required, Date of birth cannot be in the future, Date of birth cannot be before 1900, Client should be older than 18 |
createUserTasks[idx].tid | Tax ID is required |
createUserTasks[idx].countryOfCitizenship1 | Country of citizenship is required |
createUserTasks[idx].permanentUsResident | You can only create accounts for US citizens or US permanent residents. |
createUserTasks[idx].dependentCount | Invalid number of dependents |
createUserTasks[idx].directorOrTenPercentShareholder | Please answer if client is a director or 10% shareholder of a public company |
createUserTasks[idx].directorOrTenPercentShareholderCompany | Please select the companies the client is affiliated with |
createUserTasks[idx].finraAffiliated | Please answer if client is FINRA or securities industry affiliated |
createUserTasks[idx].politicallyExposed | Please answer if client is politically exposed |
createUserTasks[idx].anticipateDomesticWireTransfers | Please answer if client expects to use domestic wires |
createUserTasks[idx].domesticWireTransferPerMonth | Number of estimated wires required |
createUserTasks[idx].anticipateWritingChecksAgainstAccount | Please answer if client expects to use checks |
createUserTasks[idx].chequeTransferPerMonth | Number of estimated checks required |
createUserTasks[idx].sourceOfWealth | Source of wealth is missing, Client is %s but employment details under source of wealth is missing |
createUserTasks[idx].employments.annualIncome | Employer annual income is required |
createUserTasks[idx].employments.employerLineOfBusiness | Employer line of business is required |
createUserTasks[idx].loginId | Login ID is missing, Login ID must be > 8 characters long, Login ID must be < 32 characters long, Login ID must be in lowercase |
createUserTasks[idx].employmentStatus | Employment status is missing |
Account Opening Tasks
The more common and more generic validation categories are evaluated first. The more niche rules are evaluated later, this is so the more esoteric account types can override specific fields for the more general account types.
All Account Types
Field Name | Description |
---|---|
accountOpeningTasks[idx].accountName | Account Nickname is required, Account Nickname cannot be more than 16 characters |
accountOpeningTasks[idx].repCode | Rep Code is required |
accountOpeningTasks[idx].branchCode | Branch Code is required |
accountOpeningTasks[idx].accountTypeDescription | Account type is required |
accountOpeningTasks[idx].countryOfOrganization | Country of organization is required |
accountOpeningTasks[idx].relatedEntities.decedents | Decedent required |
accountOpeningTasks[idx].primaryAccountOwner | Missing legal entity owner for account |
accountOpeningTasks[idx].accountRegistrationInfo | Account registration info is required |
accountOpeningTasks[idx].placeOfBusiness.line1 | Place of business address line 1 is required |
accountOpeningTasks[idx].placeOfBusiness.city | Place of business address city is required |
accountOpeningTasks[idx].placeOfBusiness.state | Place of business address state is required |
accountOpeningTasks[idx].placeOfBusiness.zipcode | Place of business address zipcode is required |
accountOpeningTasks[idx].placeOfBusiness.country | Place of business address country is required |
accountOpeningTasks[idx].taxClassification | Tax classification is required |
accountOpeningTasks[idx].expectedActivity.domesticWireTransferPerMonth | Please provide a wire transfer estimate |
accountOpeningTasks[idx].expectedActivity.chequeTransferPerMonth | Please provide a check writing estimate |
accountOpeningTasks[idx].expectedActivity.internationalWireTransfersPerMonth | Please provide an international wire transfer estimate |
accountOpeningTasks[idx].jointOwners | Please choose a joint owner |
accountOpeningTasks[idx].minor.firstName | Minor first name required |
accountOpeningTasks[idx].minor.lastName | Minor last name required |
accountOpeningTasks[idx].minor.dateOfBirth | Minor date of birth required |
accountOpeningTasks[idx].minor.ssn | Minor social security number required |
accountOpeningTasks[idx].minor.state | Minor state required |
accountOpeningTasks[idx].minor.citizenship | Citizenship status is required for the Minor, Minor on the account needs to be a US Citizen or US Permanent Resident |
accountOpeningTasks[idx].relatedEntities.primaryExecutors | Primary executor required |
accountOpeningTasks[idx].relatedEntities.secondaryExecutors | Secondary executor required |
accountOpeningTasks[idx].primaryBeneficiaries | A primary beneficiary is required |
accountOpeningTasks[idx].primaryBeneficiaries[idx].firstName | Beneficiary first name required |
accountOpeningTasks[idx].primaryBeneficiaries[idx].lastName | Beneficiary last name required |
accountOpeningTasks[idx].primaryBeneficiaries[idx].ssn | Beneficiary social security number require 9 digits |
accountOpeningTasks[idx].primaryBeneficiaries[idx].relationship | Beneficiary relationship required |
accountOpeningTasks[idx].primaryBeneficiaries[idx].relationship | Cannot specify multiple spouses as primary beneficiary |
accountOpeningTasks[idx].contingentBeneficiaries[idx].relationship | Cannot specify multiple spouses as contingent beneficiary |
accountOpeningTasks[idx].primaryBeneficiaries[idx].sharePct | Primary beneficiary percent share must sum to 100 |
accountOpeningTasks[idx].contingentBeneficiaries[idx].sharePct | Contingent beneficiary percent share must sum to 100 |
accountOpeningTasks[idx].trustedContacts | Trusted contact required |
Natural Person Accounts
Field Name | Description |
---|---|
accountOpeningTasks[idx].primaryAccountOwner | Please choose a primary owner |
accountOpeningTasks[idx].primaryBeneficiaries | Please choose a primary beneficiary |
accountOpeningTasks[idx].contingentBeneficiaries | A primary beneficiary is required |
accountOpeningTasks[idx].trustedContacts | Please provide a valid email for the trusted contact |
Entity Accounts
Field Name | Description |
---|---|
accountOpeningTasks[idx].primaryAccountOwner | Missing legal entity owner for account. Provide the sub task id from opening account task or the firm id of the firm that owns the new account (same value as firmId ) |
createFirmTasks[idx].firmName | Firm name is required |
createFirmTasks[idx].firmRep | Firm representative is required |
createFirmTasks[idx].firmEmail1 | Firm email is required |
createFirmTasks[idx].firmTelephone1 | Primary phone is required |
createFirmTasks[idx].firmTelephone1 | Primary phone is invalid |
createFirmTasks[idx].firmTelephone2 | Secondary phone is required |
createFirmTasks[idx].firmTelephone2 | Secondary phone is invalid |
createFirmTasks[idx].firmTaxIdType | Tax ID type is required |
createFirmTasks[idx].firmTaxId | Tax ID is required |
createFirmTasks[idx].primaryAddress.line1 | Address line 1 is required |
createFirmTasks[idx].primaryAddress.city | City is required |
createFirmTasks[idx].primaryAddress.state | State is required |
createFirmTasks[idx].primaryAddress.zipcode | Zipcode is required |
accountOpeningTasks[idx].accountRegistrationInfo | Full legal entity name is required |
accountOpeningTasks[idx].placeOfBusiness.line1 | Place of business line1 required |
accountOpeningTasks[idx].placeOfBusiness.city | Place of business city required |
accountOpeningTasks[idx].placeOfBusiness.state | Place of business state required |
accountOpeningTasks[idx].placeOfBusiness.zipcode | Place of business zipcode required |
accountOpeningTasks[idx].placeOfBusiness.country | Place of business country required |
accountOpeningTasks[idx].taxClassification | Tax classification is required |
accountOpeningTasks[idx].expectedActivity.domesticWireTransferPerMonth | Please provide a wire transfer estimate |
accountOpeningTasks[idx].expectedActivity.chequeTransferPerMonth | Please provide a check writing estimate |
accountOpeningTasks[idx].expectedActivity.internationalWireTransfersPerMonth | Please provide an international wire transfer estimate |
Inherited Accounts
Field Name | Description |
---|---|
accountOpeningTasks[idx].relatedEntities.decedents | Decedent required |
accountOpeningTasks[idx].relatedEntities.decedents[idx].firstName | Decedent first name required |
accountOpeningTasks[idx].relatedEntities.decedents[idx].lastName | Decedent last name required |
accountOpeningTasks[idx].relatedEntities.decedents[idx].dateOfBirth | Decedent date of birth required |
accountOpeningTasks[idx].relatedEntities.decedents[idx].dateOfBirth | Decedent date of birth must be before today |
accountOpeningTasks[idx].relatedEntities.decedents[idx].relationship | Decedent relationship required |
accountOpeningTasks[idx].relatedEntities.decedents[idx].ssn | Decedent SSN required |
accountOpeningTasks[idx].relatedEntities.decedents[idx].dateOfDeath | Decedent date of death required |
accountOpeningTasks[idx].relatedEntities.decedents[idx].dateOfDeath | Decedent date of death must be before today |
accountOpeningTasks[idx].inheritedAcctDetail.inheritanceTypeDescription | Inheritance type required |
accountOpeningTasks[idx].inheritedAcctDetail.payoutElectionDescription | Pay out election required |
accountOpeningTasks[idx].minor.firstName | Minor first name required (if a beneficiary with type MINOR_AS_BENE is provided) |
accountOpeningTasks[idx].minor.lastName | Minor last name required |
accountOpeningTasks[idx].minor.dateOfBirth | Minor date of birth required |
accountOpeningTasks[idx].minor.ssn | Minor SSN required |
accountOpeningTasks[idx].minor.state | Minor state required |
accountOpeningTasks[idx].minor.citizenship | Citizenship status is required for the Minor |
accountOpeningTasks[idx].minor.citizenship | Minor on the account needs to be a US Citizen or US Permanent Resident |
accountOpeningTasks[idx].minor.dateOfBirth | [State] does not allow Custodial accounts for individuals over the age of [maxAge] |
Estate Accounts
role
is either primaryExecutors
or secondaryExecutors
Field Name | Description |
---|---|
accountOpeningTasks[idx].countryOfOrganization | Country of organization is required |
accountOpeningTasks[idx].relatedEntities.primaryExecutors | Missing primary executors on trust account |
accountOpeningTasks[idx].relatedEntities.[role][idx].firstName | Executor first name required |
accountOpeningTasks[idx].relatedEntities.[role][idx].lastName | Executor last name required |
accountOpeningTasks[idx].relatedEntities.[role][idx].executorCapacity | Executor capacity required |
accountOpeningTasks[idx].relatedEntities.[role][idx].primaryAddress.line1 | Executor address line1 required |
accountOpeningTasks[idx].relatedEntities.[role][idx].primaryAddress.city | Executor address city required |
accountOpeningTasks[idx].relatedEntities.[role][idx].primaryAddress.state | Executor address state required |
accountOpeningTasks[idx].relatedEntities.[role][idx].primaryAddress.zipcode | Executor address zipcode required |
Trust Accounts - Business Trust or Revocable Trust
Field Name | Description |
---|---|
accountOpeningTasks[idx].trustIndividuals | Please choose if all trust parties are individuals |
accountOpeningTasks[idx].accountRegistrationInfo | Trust full legal name is required |
accountOpeningTasks[idx].statutoryTrust | Please choose if this is a statutory trust |
accountOpeningTasks[idx].countryOfOrganization | Country of organization is required |
accountOpeningTasks[idx].stateOfOrganization | State of organization is required |
accountOpeningTasks[idx].dateOfFormation | Date of formation is required |
accountOpeningTasks[idx].placeOfBusiness.line1 | Place of business line1 required |
accountOpeningTasks[idx].placeOfBusiness.city | Place of business city required |
accountOpeningTasks[idx].placeOfBusiness.state | Place of business state required |
accountOpeningTasks[idx].placeOfBusiness.zipcode | Place of business zipcode required |
accountOpeningTasks[idx].placeOfBusiness.country | Place of business country required |
accountOpeningTasks[idx].expectedActivity.domesticWireTransferPerMonth | Please provide a wire transfer estimate |
accountOpeningTasks[idx].expectedActivity.chequeTransferPerMonth | Please provide a check writing estimate |
accountOpeningTasks[idx].relatedEntities.grantors | Missing grantors on trust account |
accountOpeningTasks[idx].relatedEntities.beneficiaries | Missing beneficiaries on trust account |
accountOpeningTasks[idx].relatedEntities.trusteeMembers | Missing trustees on trust account |
Custodial Accounts
Field Name | Description |
---|---|
accountOpeningTasks[idx].minor.firstName | Minor first name required |
accountOpeningTasks[idx].minor.lastName | Minor last name required |
accountOpeningTasks[idx].minor.dateOfBirth | Minor date of birth required |
accountOpeningTasks[idx].minor.ssn | Minor SSN required |
accountOpeningTasks[idx].minor.state | Minor state required |
accountOpeningTasks[idx].minor.citizenship | Citizenship status is required for the Minor |
accountOpeningTasks[idx].minor.citizenship | Minor on the account needs to be a US Citizen or US Permanent Resident |
accountOpeningTasks[idx].minor.dateOfBirth | [State] does not allow Custodial accounts for individuals over the age of [maxAge] |
Asset Transfer Task
Field Name | Description |
---|---|
assetTransferTasks[idx].accountNumber | Account number is required |
assetTransferTasks[idx].contraAccountNumber | Contra account number is required |
assetTransferTasks[idx].contraFirmName | Contra firm name is required |
assetTransferTasks[idx].contraAccountType | Contra account type is required |
assetTransferTasks[idx].transferType | Transfer type is required |
assetTransferTasks[idx].cashAmount | Cash amount is required (if transfer type is partial and not all cash) |
assetTransferTasks[idx].stocks | Stocks is required (if transfer type is partial) |
assetTransferTasks[idx].doNotSubmitUntil | Submission date should be in the future |
assetTransferTasks[idx].doNotSubmitUntil | Submission date should not be more than 60 days in the future |
Create Bank Link Task
Any validations not done here are done further upstream.
Field Name | Description |
---|---|
createBankLinkTasks[idx].bankLinkType | Bank link type is required |
createBankLinkTasks[idx].bankAccountType | Bank account type is required |
createBankLinkTasks[idx].alias | Bank link alias must not exceed 16 characters |
createBankLinkTasks[idx].routingNumber | Routing number is required |
createBankLinkTasks[idx].routingNumber | For international wires, routing number must be 8-11 digits, otherwise 9 digiits. |
createBankLinkTasks[idx].bankAccountNumber | Bank account number is required |
createBankLinkTasks[idx].bankAccountNumber | Bank account number must not exceed 35 characters |
Third Party Bank Links
Field Name | Description |
---|---|
createBankLinkTasks[idx].thirdPartyBeneficiaryName | Beneficiary name is required |
createBankLinkTasks[idx].thirdPartyBeneficiaryAddress1 | Beneficiary street address is required |
createBankLinkTasks[idx].thirdPartyBeneficiaryCity | Beneficiary city is required |
createBankLinkTasks[idx].thirdPartyBeneficiaryState | Beneficiary state is required |
createBankLinkTasks[idx].thirdPartyBeneficiaryZipCode | Beneficiary zipcode is required |
createBankLinkTasks[idx].thirdPartyBeneficiaryZipCode | Beneficiary zipcode must be 5 digits |
createBankLinkTasks[idx].intermediaryRoutingNumber | Intermediary routing number must be 9 digits |
createBankLinkTasks[idx].intermediaryRoutingNumber | Intermediary bank account number must not exceed 35 characters |
Was this page useful?
Give feedback to help us improve developer.gs.com and serve you better.