ZEscrow Docs

Create Subaccount

Mutation Variables

{
"addSubaccount": {
"organizationIdentifier": "xyz789",
"bankAccountIdentifier": "abc123",
"subaccount": {
"subaccountFolderIdentifier": 4,
"nickname": "abc123",
"hasCompletedSignatureCard": false,
"initialBalance": Decimal,
"initialAccruedInterest": Decimal,
"authorizerIdentifier": "4",
"subaccountType": "STANDARD",
"openedDate": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"closeDate": "2007-12-03T10:15:30Z",
"beneficiary": {
"beneficiaryType": "INDIVIDUAL",
"residentType": "US_RESIDENT",
"citizenship": "abc123",
"firstName": "xyz789",
"lastName": "xyz789",
"ssn": "abc123",
"itin": "abc123",
"ssnOrItinNotRequired": false,
"dateOfBirth": "2007-12-03T10:15:30Z",
"businessName": "xyz789",
"ein": "xyz789",
"phoneNumber": "xyz789",
"emailAddress": "xyz789",
"hasCompletedW9": true,
"hasCompletedW8": false,
"hasCompletedBenOwnerForm": false,
"beneficialOwnerInfoRequired": false,
"address": {
"lineOne": "xyz789",
"lineTwo": "xyz789",
"city": "abc123",
"stateCode": "abc123",
"zipCode": "xyz789",
"addressType": "MAILING",
"isInternational": false,
"countryCode": "abc123"
},
"mailingAddress": {
"lineOne": "xyz789",
"lineTwo": "xyz789",
"city": "abc123",
"stateCode": "abc123",
"zipCode": "xyz789",
"addressType": "PHYSICAL",
"isInternational": false,
"countryCode": "abc123"
}
}
}
},
"initialFunding": {
"totalBalance": Decimal,
"allTimeInterestPortion": Decimal,
"ytdInterestPortion": Decimal
}
}

Mutation

mutation addExternalComplianceSubaccount($addExternalComplianceSubaccount: AddExternalComplianceSubaccountInput!) {
addExternalComplianceSubaccount(addExternalComplianceSubaccount: $addExternalComplianceSubaccount) {
beneficiaryResult {
...ResultModelFragment
}
isSuccessful
subaccount {
...SubaccountFragment
}
subaccountResult {
...ResultModelFragment
}
}
}

Example Response

{
"data": {
"addExternalComplianceSubaccount": {
"beneficiaryResult": {
"isSuccessful": true,
"pendingSteps": ["abc123"]
},
"isSuccessful": true,
"subaccount": Subaccount,
"subaccountResult": {
"isSuccessful": true,
"pendingSteps": ["abc123"]
}
}
}
}

Adding a folder

Mutation Variables

{
"addSubaccountFolder": {
"bankAccountIdentifier": "abc123",
"organizationIdentifier": "abc123",
"fullFolderPath": "xyz789",
"subaccountFolder": {
"name": "xyz789",
"parentIdentifier": "4"
}
}
}

Mutation

mutation addSubaccountFolder($addSubaccountFolder: AddSubaccountFolderInput!) {
addSubaccountFolder(addSubaccountFolder: $addSubaccountFolder) {
identifier
name
parentIdentifier
}
}

Example Response

{
"data": {
"addSubaccountFolder": {
"identifier": 4,
"name": "xyz789",
"parentIdentifier": 4
}
}
}