API Specifications

Request Example

{
  "clientId": "9f6ca047-7f0a-40a4-9685-6894f228d588",
  "transactionId": "ef17e5bf-97e6-4a7a-bfb0-24faa09fe3ee",
  "customerId": "4dc95598-bb5b-4eea-97e7-08bc94c6bcf4",
  "depositChannel": " Mobile, ATM_Kiosk, Branch",
  "atmKiosk": {
    "atmNumber": "12345",
    "address": {
      "addressLine1": "123 Sesame St",
      "addressLine2": "Line 2 - optional",
      "city": "Denver",
      "stateCode": "CO",
      "zipCode": "12345",
      "isStandardized": false
    }
  },
  "bankInfo": {
    "bankCode": "Bank001",
    "branchCode": "Branch 001",
    "address": {
      "addressLine1": "123 Sesame St",
      "addressLine2": "Line 2 - optional",
      "city": "Denver",
      "stateCode": "CO",
      "zipCode": "12345",
      "isStandardized": false
    }
  },
  "depositAccounts": [
    {
      "accountNumberLast4Digits": "7777",
      "depositAccountType": "DDA",
      "accountAddress": {
        "addressType": "Personal",
        "addressLine1": "123 Sesame St",
        "addressLine2": "Line 2 - optional",
        "city": "Denver",
        "stateCode": "CO",
        "zipCode": "12345",
        "isStandardized": false
      },
      "depositAccountAttributes": {
        "tenureInDays": 370,
        "totalTransactionCountPerMonth": 5,
        "averageMonthlyDepositAmountInCents": 65840,
        "averageMonthlyDepositAmountInCentsAllAccounts": 65840,
        "currentBalanceInCents": 59695,
        "isDirectDepositEnabled": false,
        "checksSubmittedCountLast2Years": 25,
        "checksAcceptedCountLast2Years": 20,
        "averageChecksAcceptedAmountInCentsLast2Years": 250000,
        "checksReturnedCountLast2Years": 5,
        "averageCheckReturnAmountInCentsLast2Years": 65840,
        "customAttributes": [
          {
            "attributeName": "tenureInMonths",
            "attributeValue": "5"
          }
        ]
      }
    }
  ],
  "profile": {
    "firstName": "Jim",
    "middleInitial": "G",
    "lastName": "LaDue",
    "email": "someone@email.com",
    "ssn": "555555555",
    "dob": "05-05-1985",
    "mobilePhoneNumber": "6158675309",
    "alternatePhoneNumber": null,
    "profileRelationshipAttributes": {
      "tenureInDays": 345,
      "totalActiveAccounts": 5,
      "totalClosedAccountsCount": 10,
      "totaltransactionCountPerMonthAllAccounts": 5,
      "averageMonthlyDepositAmountInCentsAllAccounts": 65840,
      "currentBalanceInCentsAllAccounts": 59695,
      "isDirectDepositEnabled": true,
      "totalChecksSubmittedCountLast2Years": 8,
      "totalChecksAcceptedCountLast2Years": 7,
      "averageTotalChecksAcceptedAmountInCentsLast2Years": 512670,
      "totalChecksReturnedCountLast2Years": 1,
      "averageTotalCheckReturnAmountInCentsLast2Years": 50087,
      "customAttributes": [
        {
          "attributeName": "hasGoldAccountStatus",
          "attributeValue": "false"
        }
      ]
    },
    "address": {
      "addressType": "Personal",
      "addressLine1": "123 Sesame St",
      "addressLine2": null,
      "city": "Denver",
      "stateCode": "CO",
      "zipCode": "12345",
      "isStandardized": false
    }
  },
  "deviceInfo": {
    "modelNumber": "iPhone 4",
    "platformVersion": "Android | iOS | Other",
    "osVersion": "14.0",
    "fingerPrinting": {
      "iovation": {
        "blackBoxValue": "BLACK_BOX_VALUE_GOES_HERE"
      }
    }
  },
  "geoLocation": {
    "latitude": "89.998998",
    "longitude": "189.21212121"
  },
  "checkDetails": {
    "endorsementCheckRequired": true,
    "accountNumber": "11223333",
    "checkNumber": "1234",
    "aba": "123456789",
    "micr": "MICR",
    "ocrAmountInCents": 50000,
    "checkAmountInCents": 50000,
    "checkDate": "01-10-2020",
    "checkImages": {
      "frontImageJpg": "base64EncodedJPG|URL",
      "backImageJpg": "base64EncodedJPG|URL"
    },
    "metaData": {
      "ocrDocumentType": "Payroll_Printed, MoneyOrder, BankDraft, PersonalCheck, DepositTicket, CashiersCheck, TravellersCheck, BusinessCheck, CashInOutTicket, SaveBond, PAD, BusinessCheck"
    },
    "checkMaker": {
      "makerName": "Chuck Jones",
      "addressLine": "25 Music Square E",
      "addressCity": "Nashville",
      "addressState": "TN",
      "addressZipCode": "37203"
    },
    "ocrScores": {
      "scoreRangeMax": 999,
      "accountNumberScore": 950,
      "checkNumberScore": 999,
      "abaScoreScore": 980,
      "micrScore": 900,
      "checkAmountScore": 890,
      "checkDateScore": null,
      "checkMakerScores": {
        "makerNameScore": 750,
        "addressLine1Score": null,
        "addressCityScore": null,
        "addressStateScore": null,
        "addressZipScore": null
      }
    }
  },
  "correlationData": [
   {
    "attributeName": "correlationId1",
    "attributeValue": "12345"
   }
  ]
}

Account Types

Account Type Sub Type
CardAccount
PrePaid
Debit
Credit
EncryptedAccount (Tokenized)
PayPal

Check Types

Address Types
Personal
Business