Submission API Error Responses and Workarounds
U4
E-Signature related error
- Error Response
- Collected Data Schema validation error,#/signatures/amendedFirmSignatoryRepresentations : ['Signature Date of Appropriate Signatory' is a required field.|Firm Signature of Appropriate Signatory' is required.]
- Reason
- This error occurs when the e-signature is turned on for the firm and the submission is being made via API
- Workaround
- Set "esignApplicable": false in metadata for the submission.
- Error Response
Unaffiliated firm error
- Error Response
- Collected Data Schema validation error, "#/dualRegistration : [The Registration With Unaffiliated Firms section must be provided for the selected filing type.]
- Reason
- Error occurs when unaffiliated firm data is missing from initial U4 submission and U4 amendment is submitted
- Workaround
- Add following code under operation
{ "op": "add", "path": "/dualRegistration", "value": { "unaffiliatedRegistration": { "bdAffiliatedFlag": false, "iaAffiliatedFlag": false } } }
- Add following code under operation
- Error Response
- Updating multiple values at once for a particular array object
- Error Response
- "Invalid Id values {nonIndustryEmploymentsInstanceNumber=8662036, id=null} at path $.individualNonIndustryEmployments[*]"
- Reason
- Error occurs when UUID field "id" is available for the object but is not provided in the value section. Even if the instanceNumber is provided in the path, id must be provided in value when available. "id" is not needed when only a single field is being updated for an arrary object.
- Workaround
- Add UUID "id" within value section as example below
"op": "replace", "path": "/individualNonIndustryEmployments/[nonIndustryEmploymentsInstanceNumber:9992036]", "value": { "address": { "cityName": "Rockville", "stateCode": "MD", "countryCode": "USA" }, "employerFirmName": "ABC Technology", "employmentEndDate": "2019-04", "employmentStartDate": "2018-04", "positionDescription": "MANAGER", "investmentRelatedIndicator": true, "nonIndustryEmploymentsInstanceNumber": 9992036, "id": "98877631-0d4f-4774-b3fb-f32cefbcb999" }
- Add UUID "id" within value section as example below
- Error Response