Available to: Organization administrators
Environments: Production
Rate Limit: 250 requests per hour, 30-second back-off, counts all requests
Use this endpoint to submit a new subaccount request for a user in your organization.
errorText field in the response body to determine whether the request succeeded or failed.firstName and lastName fields exceeding a combined 60 characters are rejected, despite each field individually allowing up to 64 characters.US vs Non-US Requirements
taxIdentifier (Social Security Number, exactly 9 digits). The nationalId field is optional.nationalId (2-64 alphanumeric characters). The taxIdentifier field is optional.requestId for Uploading Documents
A successful request returns a unique requestId. Use this value:
subAccountRequestId when uploading the user’s required documents with submitpartnersubaccountdocumentsubAccountRequestId when tracking the progress of a subaccount request with getpartnersubaccountrequeststatusOptional: Attach Previously Uploaded Documents
If you have already uploaded the user’s required documents via the submitcustomerapplicationdocument endpoint, you can link them to the subaccount request by providing all three documentId fields (partial sets are rejected):
pOAFormDocIdgovernmentDocIdaddressDocIdIf you provide all three document IDs, the documents are linked directly and you do not need to call submitpartnersubaccountdocument afterward.
Optional: Specify an Auto-Liquidation Profile
Include autoLiqProfileId to assign a specific auto-liquidation profile to the new account. If you omit this field, the system uses your organization’s default auto-liquidation profile.
The system validates that the profile exists and belongs to your organization before accepting the request. If validation fails, the response includes an errorText:
"Auto-liq profile not found": the profile ID does not exist"Auto-liq profile does not belong to this organization": the profile belongs to a different organizationContact Evaluation Support for your organization’s available profile IDs.
Common Failure Scenarios
ctaUserIdctaUserId belongs to a different organizationnationalId for non-US citizenshiptransferAmountautoLiqProfileId references a non-existent profileautoLiqProfileId belongs to a different organizationNext Steps
submitpartnersubaccountdocument endpoint to upload them.getpartnersubaccountrequeststatus endpoint to check the status of the subaccount request.Bearer authentication of the form Bearer <token>, where token is your auth token.
Non-empty if the request failed