ZEscrow Docs

Get Data

To access data using our GraphQL API you can very easily access all data in our platform using different flavors of the same root query.

All data is accessible through the institution query. Below is a big list of all the data included in that query. Don’t worry you likely won’t run a query this big in your code!

Query

query institution($useMock: Boolean) {
institution(useMock: $useMock) {
fdicNcuaId
identifier
name
ofacWatches {
...OfacWatchFragment
}
organizations {
...OrganizationFragment
}
routingNumber
type
type
url
}
}

Response

{
"data": {
"institution": {
"fdicNcuaId": "xyz789",
"identifier": 4,
"name": "xyz789",
"ofacWatches": [OfacWatch],
"organizations": [
{
"address": {
"addressType": "UNKNOWN",
"city": "abc123",
"countryCode": "abc123",
"isInternational": false,
"lineOne": "xyz789",
"lineTwo": "abc123",
"stateCode": "xyz789",
"zipCode": "abc123"
},
"bankAccounts": [
{
"accountName": "abc123",
"balance": {
"availableBalance": Decimal,
"settledBalance": Decimal
},
"bankAccountType": "Z_ESCROW",
"bankBalance": Decimal,
"identifier": 4,
"isStandalone": false,
"subaccountFolders": [
{
"identifier": "1",
"name": "root",
"parentIdentifier": 1
},
{
"identifier": "2",
"name": "Group 1",
"parentIdentifier": 1
},
{
"identifier": "3",
"name": "Group 2",
"parentIdentifier": 1
}
],
"subaccounts": [
{
"accruedInterest": Decimal,
"authorizer": {
"address": Address,
"dateOfBirth": "abc123",
"emailAddress": "xyz789",
"etag": "xyz789",
"externalId": "xyz789",
"firstName": "xyz789",
"identifier": "4",
"lastName": "abc123",
"mobileNumber": "abc123",
"phoneNumber": "xyz789",
"sSN": "xyz789"
},
"authorizerIdentifier": 4,
"balance": {
"availableBalance": Decimal,
"settledBalance": Decimal
},
"beneficiary": {
"address": {
"addressType": "UNKNOWN",
"city": "abc123",
"countryCode": "abc123",
"isInternational": false,
"lineOne": "xyz789",
"lineTwo": "abc123",
"stateCode": "xyz789",
"zipCode": "abc123"
},
"beneficialOwnerInfoRequired": false,
"beneficiaryType": "UNKNOWN",
"businessName": "xyz789",
"citizenship": "xyz789",
"dateOfBirth": "2007-12-03T10:15:30Z",
"ein": "xyz789",
"emailAddress": "abc123",
"firstName": "abc123",
"hasCompletedBenOwnerForm": false,
"hasCompletedW8": false,
"hasCompletedW9": false,
"identifier": 4,
"itin": "abc123",
"lastName": "xyz789",
"mailingAddress": {
"addressType": "UNKNOWN",
"city": "abc123",
"countryCode": "abc123",
"isInternational": false,
"lineOne": "xyz789",
"lineTwo": "abc123",
"stateCode": "xyz789",
"zipCode": "abc123"
},
"phoneNumber": "xyz789",
"residentType": "UNKNOWN",
"ssn": "xyz789",
"ssnOrItinNotRequired": false,
"status": "UNKNOWN"
},
"closeDate": null,
"complianceAttestment": true,
"complianceDocuments": [
{
"document": {
"createdDate": "2007-12-03T10:15:30Z",
"documentId": "xyz789",
"documentName": "abc123",
"documentType": "UNKNOWN",
"domain": "xyz789",
"filePath": "abc123",
"hierarchy": "abc123",
"originalDocumentName": "abc123",
"ownerId": "abc123",
"storageLocation": "xyz789"
},
"documentLink": {
"documentUrl": "abc123",
"expirationDateTimeUtc": DateTimeOffset,
"minutesTilExpiration": 987
}
}
],
"config": {
"identifier": "4",
"name": "abc123",
"organizationIdentifier": 4,
"organizationType": "UNKNOWN",
"rules": [
{
"apr": Decimal,
"doesOrgCollectPortion": true,
"identifier": "4",
"orgPortion": Decimal,
"orgPortionCalcType": "UNKNOWN",
"taxOwnerType": "UNKNOWN"
}
],
"stateCode": "abc123"
},
"createdAt": "2007-12-03T10:15:30Z",
"earnedInterest": Decimal,
"externalCompliance": false,
"folderPath": "xyz789",
"hasCompletedSignatureCard": true,
"identifier": "4",
"initialAccruedInterest": Decimal,
"initialBalance": Decimal,
"interestRate": Decimal,
"nickname": "abc123",
"openedDate": "2007-12-03T10:15:30Z",
"result": subaccountPendingSteps,
"status": "OPEN",
"subaccountFolder": SubaccountFolder,
"subaccountFolderIdentifier": 4,
"subaccountType": "UNKNOWN",
"transactions": [
{
"bankPostedDate": "2007-12-03T10:15:30Z",
"effectiveDate": "2007-12-03T10:15:30Z",
"entries": [Entry],
"identifier": 4,
"interestRate": Decimal,
"isAvailable": true,
"isSettled": false,
"memo": "xyz789",
"organizationIdentifier": 4,
"pendingDate": "2007-12-03T10:15:30Z",
"previousTransaction": 4,
"reconciliationId": "abc123",
"resolvedDate": "2007-12-03T10:15:30Z",
"status": "UNKNOWN",
"type": "EXTERNAL"
}
]
"updatedAt": "2007-12-03T10:15:30Z"
}
],
"transactions": [
{
"bankPostedDate": "2007-12-03T10:15:30Z",
"effectiveDate": "2007-12-03T10:15:30Z",
"entries": [Entry],
"identifier": 4,
"interestRate": Decimal,
"isAvailable": true,
"isSettled": false,
"memo": "xyz789",
"organizationIdentifier": 4,
"pendingDate": "2007-12-03T10:15:30Z",
"previousTransaction": 4,
"reconciliationId": "abc123",
"resolvedDate": "2007-12-03T10:15:30Z",
"status": "UNKNOWN",
"type": "EXTERNAL"
}
]
},
{
"accountName": "OPERATIONAL",
"balance": {
"availableBalance": Decimal,
"settledBalance": Decimal
},
"bankAccountType": "OPERATIONAL",
"bankBalance": Decimal,
"identifier": 4,
"isStandalone": false,
}
],
"canViewOrganizationDashboard": AuthorizationResult,
"contacts": [Contact],
"documents": [Document],
"eIN": "abc123",
"externalId": "xyz789",
"financialInstitutionIdentifier": "4",
"hasStandaloneHoldingAccount": false,
"identifier": "4",
"isBeneficialOwnerFormRequired": true,
"isSigCardRequired": false,
"name": "abc123",
"payPartialInterestAtClosing": true,
"phoneNumber": "abc123",
"status": "PENDING",
"type": "UNKNOWN"
}
]
"routingNumber": "abc123",
"type": "UNKNOWN",
"url": "abc123"
}
}
}