The scope name https://apis.ingo.money/auth/deposit-underwriting needs to be used in the API authorization request to retrieve the Bearer access token.
| Field Name |
Type |
Description |
| clientId |
string(50), required |
The Ingo Assigned Client Id (GUID) |
| transactionId |
string(50), required |
A unique Client Transaction Id |
| customerId |
string(50), required |
A unique Client Customer Id |
| depositChannel |
string, required |
One of MOBILE, ATM_KIOSK or BRANCH |
| atmKiosk |
object, conditionally required |
Required when Deposit Channel = ATM_KIOSK |
| bankInfo |
object, conditionally required |
Required when Deposit Channel = BRANCH |
| depositAccounts |
collection obj, required |
A collection of Deposit Accounts |
| profile |
object, required |
The Customer Profile Information |
| deviceInfo |
object, conditionally required |
Required when Deposit Channel = MOBILE |
| geoLocation |
object, conditionally required |
Required when Deposit Channel = MOBILE |
| checkDetails |
object, required |
The Check Details object |
| correlationData |
collection object, optional |
The Correlation Data object |
{
"atmNumber": "12345",
"atmAddress": {
"addressLine1": "123 Sesame St",
"addressLine2": "Line 2 - optional",
"city": "Denver",
"stateCode": "CO",
"zipCode": "12345",
"isStandardized": false
}
}
| Field Name |
Type |
Description |
| atmNumber |
string(50), required |
The ATM Number |
| atmAddress |
object, required |
The Address of the ATM |
| Field Name |
Type |
Description |
| addressLine1 |
string(75), required |
Address Line 1 |
| addressLine2 |
string(75), optional |
Address Line 2 |
| city |
string(75), required |
City |
| stateCode |
string(2), required |
Must be a valid 2 character State Code |
| zipCode |
string(10), required |
Must be either 5 digits or 9 digits with or without a dash after 5th |
{
"bankCode": "Bank001",
"branchCode": "Branch 001",
"bankAddress": {
"addressLine1": "123 Sesame St",
"addressLine2": "Line 2 - optional",
"city": "Denver",
"stateCode": "CO",
"zipCode": "12345",
"isStandardized": false
}
}
| Field Name |
Type |
Description |
| bankCode |
string(50), required |
The Bank Code |
| branchCode |
string(50), required |
The Banks Branch Code |
| bankAddress |
object, required |
The Address of the Bank |
| Field Name |
Type |
Description |
| addressLine1 |
string(75), required |
Address Line 1 |
| addressLine2 |
string(75), optional |
Address Line 2 |
| city |
string(75), required |
City |
| stateCode |
string(2), required |
Must be a valid 2 character State Code |
| zipCode |
string(10), required |
Must be either 5 digits or 9 digits with or without a dash after 5th |
depositAccounts & profileRelationship Attributes_Definitions.pdf
[
{
"accountNumberLast4": "7777",
"accountType": "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,
"currentBalanceInCents": 59695,
"isDirectDepositEnabled": false,
"checksSubmittedCountLast2Years": 25,
"checksAcceptedCountLast2Years": 20,
"averageChecksAcceptedAmountInCentsLast2Years": 250000,
"checksReturnedCountLast2Years": 5,
"averageCheckReturnAmountInCentsLast2Years": 65840,
"customAttributes": [
{
"attributeName": "tenureInMonths",
"attributeValue": "5"
}
]
}
}
]
| Field Name |
Type |
Description |
| accountNumberLast4 |
string(4), required |
The last 4 numbers of the account |
| accountType |
string(15), required |
Refer to Account Types Table |
| accountAddress |
object, required |
The physical address associated with the account |
| Account Type |
| DDA |
| SAVINGS |
| MONEY_MARKET |
| INVESTMENT |
| DEBIT_CARD |
| PREPAID_CARD |
| DIGITAL_WALLET |
| Field Name |
Type |
Description |
| addressLine1 |
string(75), required |
Address Line 1 |
| addressLine2 |
string(75), optional |
Address Line 2 |
| city |
string(75), required |
City |
| stateCode |
string(2), required |
Must be a valid 2 character State Code |
| zipCode |
string(10), required |
Must be either 5 digits or 9 digits with or without a dash after 5th |
| addressType |
string, required |
Must be either PERSONAL or BUSINESS |
| isStandardized |
boolean |
A flag to indicate whether an address has been standardized or not |
| Field Name |
Type |
| tenureInDays |
int |
| totalTransactionCountPerMonth |
int |
| averageMonthlyDepositAmountInCents |
int |
| currentBalanceInCents |
int |
| isDirectDepositEnabled |
boolean |
| checksSubmittedCountLast2Years |
int |
| checksAcceptedCountLast2Years |
int |
| averageChecksAcceptedAmountInCentsLast2Years |
int |
| checksReturnedCountLast2Years |
int |
| averageCheckReturnAmountInCentsLast2Years |
int |
| customAttributes |
collection object, optional |
| Field Name |
Type |
| attributeName |
string(75), required |
| attributeValue |
string(75), required |
{
"firstName": "Jim",
"middleName": "Allen",
"lastName": "LaDue",
"email": "someone@email.com",
"ssn": "555555555",
"dob": "05-05-1985",
"mobilePhoneNumber": "6158675309",
"alternatePhoneNumber": null,
"profileAddress": {
"addressType": "PERSONAL",
"addressLine1": "123 Sesame St",
"addressLine2": null,
"city": "Denver",
"stateCode": "CO",
"zipCode": "12345",
"isStandardized": false
},
"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"
}
]
}
}
| Field Name |
Type |
Description |
| firstName |
string(75), required |
First Name |
| middleName |
string(75), optional |
Middle Name |
| lastName |
string(75), required |
Last Name |
| email |
string(320), required, valid email |
Email Address |
| ssn |
string(9), required, numbers only |
Social Security Number |
| dob |
string(10), required |
Date of Birth in mm/dd/yyyy or mm-dd-yyyy |
| mobilePhoneNumber |
string(10), required, numbers only |
Mobile Number |
| alternatePhoneNumber |
string(10), optional, numbers only |
Alternate Contact Number |
| profileAddress |
object, required |
Profile Address |
| profileRelationshipAttributes |
object, required |
Profile Risk Attributes |
| Field Name |
Type |
Description |
| addressLine1 |
string(75), required |
Address Line 1 |
| addressLine2 |
string(75), optional |
Address Line 2 |
| city |
string(75), required |
City |
| stateCode |
string(2), required |
Must be a valid 2 character State Code |
| zipCode |
string(10), required |
Must be either 5 digits or 9 digits with or without a dash after 5th |
| addressType |
string, required |
Must be either PERSONAL or BUSINESS |
| isStandardized |
boolean |
A flag to indicate whether an address has been standardized or not |
| Field Name |
Type |
| tenureInDays |
int |
| totalActiveAccounts |
int |
| totalClosedAccountsCount |
int |
| totalTransactionCountPerMonthAllAccounts |
int |
| averageMonthlyDepositAmountInCentsAllAccounts |
boolean |
| currentBalanceInCentsAllAccounts |
int |
| isDirectDepositEnabled |
int |
| totalChecksSubmittedCountLast2Years |
int |
| totalChecksAcceptedCountLast2Years |
int |
| averageTotalChecksAcceptedAmountInCentsLast2Years |
int |
| totalChecksReturnedCountLast2Years |
int |
| averageTotalCheckReturnAmountInCentsLast2Years |
int |
| customAttributes |
collection object, optional |
| Field Name |
Type |
| attributeName |
string(75), required |
| attributeValue |
string(75), required |
"deviceInfo": {
"fingerPrinting": {
"iovation": {
"blackBoxValue": "BLACK_BOX_VALUE_GOES_HERE"
}
}
}
| Field Name |
Type |
| statedIp |
string(39), optional |
| fingerPrinting |
object, required |
| Field Name |
Type |
| blackBoxValue |
string(4000), required |
"geoLocation": {
"latitude": "89.998998",
"longitude": "179.21212121"
}
| Field Name |
Type |
| latitude |
decimal, inclusive between -90 and 90, required |
| longitude |
decimal, inclusive between -180 and 180, required |
{
"endorsementCheckRequired": true,
"accountNumber": "11223333",
"checkNumber": "1234",
"aba": "123456789",
"micr": "MICR",
"ocrAmountInCents": 50000,
"checkAmountInCents": 50000,
"checkDate": "01-10-2020",
"checkImages": {
"frontImageJpg": "base64EncodedFrontJPG | URL",
"backImageJpg": "base64EncodedBackJPG | URL",
"frontImageTiff": "base64EncodedFrontTiff | URL",
"backImageTiff": "base64EncodedBackTiff | URL"
},
"checkMaker": {
"makerName": "Chuck Jones",
"makerAddress": {
"addressLine1": "123 Sesame St",
"addressLine2": "Optional",
"city": "Denver",
"stateCode": "CO",
"zipCode": "12345"
}
}
}
| Field Name |
Type |
Description |
| endorsementCheckRequired |
bool, optional |
A client provided indicator to trigger manual review of the check images (default=false) |
| accountNumber |
string(25), required |
The Account Number of the Check |
| checkNumber |
string(15), required |
The Check Number |
| aba |
string(10), required |
The Check ABA |
| micr |
string(75), required |
The Check MICR |
| ocrAmountInCents |
int, optional > 0 |
The Check Amount In Cents |
| checkAmountInCents |
int, required > 0 |
The Check Amount In Cents |
| checkDate |
string, required |
The Check Date in either 'mm/dd/yyyy' or 'mm-dd-yyyy' format |
| checkImages |
object, required |
The Check Images data object |
| checkMaker |
object, optional |
The Check Maker data object |
| Field Name |
Type |
| frontImageJpg |
string |
| backImageJpg |
string |
| frontImageTiff |
string |
| backImageTiff |
string |
The JPG Images are required for Manual Reviews
The Tiff images are optional but if provided could provide better automated decisioning
It is preferable to make images available via short-lived or pre-signed url's for direct access rather than base64 Encoding the image data.
| Field Name |
Type |
| makerName |
string(150), optional |
| makerAddress |
object, optional |
| Field Name |
Type |
Description |
| addressLine1 |
string(75), required |
Address Line 1 |
| addressLine2 |
string(75), optional |
Address Line 2 |
| city |
string(75), required |
City |
| stateCode |
string(2), required |
Must be a valid 2 character State Code |
| zipCode |
string(10), required |
Must be either 5 digits or 9 digits with or without a dash after 5th |
| Field Name |
Type |
| scoreRangeMax |
int, optional |
| accountNumberScore |
int, optional |
| checkNumberScore |
int, optional |
| abaScoreScore |
int, optional |
| micrScore |
int, optional |
| checkAmountScore |
int, optional |
| checkDateScore |
int, optional |
{
"clientId": "9f6ca047-7f0a-40a4-9685-6894f228d588",
"transactionId": "ef17e5bf-97e6-4a7a-bfb0-24faa09fe3ee",
"customerId": "4dc95598-bb5b-4eea-97e7-08bc94c6bcf4",
"depositChannel": "MOBILE",
"atmKiosk": {
"atmNumber": "4dc95598-bb5b-4eea-97e7-08bc94c6bcf4",
"atmAddress": {
"addressLine1": "123 Sesame St",
"addressLine2": "Line 2 - optional",
"city": "Denver",
"stateCode": "CO",
"zipCode": "12345"
}
},
"bankInfo": {
"bankCode": "Bank001",
"branchCode": "Branch 001",
"bankAddress": {
"addressLine1": "123 Sesame St",
"addressLine2": "Line 2 - optional",
"city": "Denver",
"stateCode": "CO",
"zipCode": "12345"
}
},
"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,
"currentBalanceInCents": 59695,
"isDirectDepositEnabled": false,
"checksSubmittedCountLast2Years": 25,
"checksAcceptedCountLast2Years": 20,
"averageChecksAcceptedAmountInCentsLast2Years": 250000,
"checksReturnedCountLast2Years": 5,
"averageCheckReturnAmountInCentsLast2Years": 65840,
"customAttributes": [
{
"attributeName": "tenureInMonths",
"attributeValue": "5"
}
]
}
}
],
"profile": {
"firstName": "Jim",
"middleName": "Allen",
"lastName": "LaDue",
"email": "someone@email.com",
"ssn": "555555555",
"dob": "05-05-1985",
"mobilePhoneNumber": "6158675309",
"alternatePhoneNumber": null,
"profileAddress": {
"addressType": "PERSONAL",
"addressLine1": "123 Sesame St",
"addressLine2": null,
"city": "Denver",
"stateCode": "CO",
"zipCode": "12345",
"isStandardized": false
},
"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"
}
]
}
},
"deviceInfo": {
"fingerPrinting": {
"iovation": {
"blackBoxValue": "BLACK_BOX_VALUE_GOES_HERE"
}
}
},
"geoLocation": {
"latitude": "89.998998",
"longitude": "179.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"
},
"checkMaker": {
"makerName": "Chuck Jones",
"makerAddress": {
"addressLine1": "123 Sesame St",
"addressLine2": "Optional",
"city": "Denver",
"stateCode": "CO",
"zipCode": "12345"
}
}
},
"correlationData": [
{
"attributeName": "correlationId1",
"attributeValue": "12345"
}
]
}