Risk Score

Body

application/json

transaction_ifa{} is required when the client is configured with Identity Fraud Assessment (ifa_enabled flag). transaction_open_banking{} is conditional based on client open banking configuration. Contact your Ingo integration manager to confirm which objects apply to your integration.

request

object

required

General information associated with the API request.

Hide child attributes

request.participant_id

string

required

Unique participant identifier assigned by Ingo.

Maximum string length: 5

Example:

"12345"

request.timestamp

string

required

Unix timestamp of the request.

Maximum string length: 32

Example:

"1721337427"

transaction

object

required

General transaction and risk assessment information.

Hide child attributes

transaction.account_type

enum<string>

required

Account type of the transaction being assessed. CA = Card, AC = ACH. Only these two account types are supported by the risk scoring flow.

Available options:

CA,

AC

Minimum string length: 1

Example:

"AC"

transaction.transaction_amount

object

required

Hide child attributes

transaction.transaction_amount.currency_code

string

required

3-character ISO-4217 (alpha) currency code.

Required string length: 3

Pattern: ^[A-Z]{3}$

Example:

"USD"

transaction.transaction_amount.amount

string

required

Transaction amount. Must be greater than 0 with a maximum of 2 decimal places.

Required string length: 1 - 12

Example:

"15.00"

transaction.customer_account_token

string

required

Token representing the account number and customer data as provided in the response from a previous Verify API call.

Required string length: 1 - 50

Example:

"f40810e6-b382-4dd5-8012-9d8518136fdc"

transaction.customer_id

string

required

Client provided unique identifier for the customer.

Maximum string length: 64

Example:

"bb79062e-938c-427e-8494-1d69fa3f2295"

transaction.phone

string

required

Customer phone number. Accepted formats: (1) 10-character all-digit string treated as US number (e.g. 4151231234), or (2) ISO E.164 format (e.g. +14151231234). Accepted characters: 0-9, +.

Maximum string length: 16

Example:

"4045555555"

transaction.phone_verified

enum<string>

required

Indicates whether the customer phone number has been verified.

Available options:

true,

false

Example:

"false"

transaction.email

string

required

Customer primary email address from profile.

Maximum string length: 150

Example:

"customer@example.com"

transaction.email_verified

enum<string>

required

Indicates whether the customer email has been verified.

Available options:

true,

false

Example:

"true"

transaction.dob

string

required

Customer date of birth. Accepted formats: MM/dd/yyyy or MM-dd-yyyy.

Maximum string length: 10

Pattern: ^([0-9]{2}\/[0-9]{2}\/[0-9]{4})|(([0-9]{2}\-[0-9]{2}\-[0-9]{4}))$

Example:

"01/02/2000"

transaction.risk_session_token

string | null

The risk_session_token from the Risk Session Method response. Recommended to include for accurate device fingerprinting correlation.

Maximum string length: 36

Example:

"e9751823-fed0-4982-802b-6a4bb1cdc86c"

transaction_ifa

object

Additional risk information for Ingo Fraud Alert (IFA). Required when the client is configured with ifa_enabled. When required, ssn must be provided. dob is conditionally required when providing last-4 SSN only.

Hide child attributes

transaction_ifa.ssn

string

required

Full SSN (9 digits, no dashes), full SSN with dashes (XXX-XX-XXXX), or last-4 digits only (4 digits). When providing last-4, dob is required.

Required string length: 4 - 11

Pattern: ^(([0-9]{4})|([0-9]{9})|([0-9]{3}\-[0-9]{2}\-[0-9]{4}))$

Example:

"6789"

transaction_ifa.dob

string

Date of birth in MM/DD/YYYY or MM-DD-YYYY format. Required when using SSN last-4.

Required string length: 10

Pattern: ^([0-9]{2}\/[0-9]{2}\/[0-9]{4})|(([0-9]{2}\-[0-9]{2}\-[0-9]{4}))$

Example:

"01/02/2000"

transaction_ifa.device_id

string | null

The ID of the device, captured by the Sardine device fingerprinting SDK.

Required string length: 1 - 100

Example:

"99ABCDEF-01234567-89ABCDE"

transaction_ifa.geo_location

object

Geo-location information associated with the transaction.

Hide child attributes

transaction_ifa.geo_location.latitude

string

required

Latitude of the location. Range: -90 to 90 with a precision of up to 18 decimal places.

Required string length: 1 - 22

Pattern: ^-?[0-9]{0,2}\.[0-9]{0,18}$

Example:

"33.76272140863938"

transaction_ifa.geo_location.longitude

string

required

Longitude of the location. Range: -180 to 180 with a precision of up to 18 decimal places.

Required string length: 1 - 23

Pattern: ^-?[0-9]{0,3}\.[0-9]{0,18}$

Example:

"-84.39188882939422"

transaction_open_banking

object

Open banking data for risk score assessment enrichment. Conditional based on client configuration and open banking partner. Passed through to the Sardine risk scoring vendor for downstream open banking enrichment. Exactly one of open_banking_plaid or open_banking_other should be provided — not both.

Hide child attributes

transaction_open_banking.open_banking_plaid

object

Account data from Plaid open banking. Provides Sardine with direct access to Plaid account data for enhanced risk signal enrichment. Currently live for clients configured with Plaid.

Hide child attributes

transaction_open_banking.open_banking_plaid.processor_token

string

required

The processor token for the account as provided by Plaid.

Maximum string length: 36

Example:

"5964250f-18b3-419c-913c-92f4143ecfd3"

transaction_open_banking.open_banking_plaid.account_id

string

required

The unique identifier of the account for the customer as provided by Plaid.

Maximum string length: 36

Example:

"47507fce-a89c-4fd5-b0c7-5b179da4c6a1"

transaction_open_banking.open_banking_other

object

Account data from an alternative open banking provider (non-Plaid). Supports bank_data, mx_data, stripe_data, and teller_data sub-objects depending on the provider used. Exactly one sub-object should be provided.

Hide child attributes

transaction_open_banking.open_banking_other.bank_data

object

Generic bank account and transaction data for providers not using Plaid (e.g. Finicity, Yodlee, or other).

Hide child attributes

transaction_open_banking.open_banking_other.bank_data.source

string

required

Open banking data provider name (e.g. Finicity, Yodlee, or other).

Example:

"Finicity"

transaction_open_banking.open_banking_other.bank_data.accounts

object[]

required

List of bank accounts and related information.

Hide child attributes

transaction_open_banking.open_banking_other.bank_data.accounts.id

string

required

ID of bank account as defined by you or the financial data provider.

Example:

"acct_001"

transaction_open_banking.open_banking_other.bank_data.accounts.account_number

string

required

Bank account number.

Example:

"123456789"

transaction_open_banking.open_banking_other.bank_data.accounts.routing_number

string

required

Bank routing number.

Example:

"011000015"

transaction_open_banking.open_banking_other.bank_data.accounts.account_type

string

required

Account type — checking, saving, or other.

Example:

"checking"

transaction_open_banking.open_banking_other.bank_data.accounts.name

string

required

Name of the bank account.

Example:

"Wells Fargo high-interest savings account"

transaction_open_banking.open_banking_other.bank_data.accounts.balance

object

required

Hide child attributes

transaction_open_banking.open_banking_other.bank_data.accounts.balance.currency_code

string

required

Currency code in ISO 3-digit format (e.g. USD).

Example:

"USD"

transaction_open_banking.open_banking_other.bank_data.accounts.balance.current

string

required

Current balance in minor currency unit (e.g. cents).

Example:

"150000"

transaction_open_banking.open_banking_other.bank_data.accounts.balance.available

string

required

Available balance in minor currency unit (e.g. cents).

Example:

"148500"

transaction_open_banking.open_banking_other.bank_data.accounts.balance.last_updated

string

required

Unix timestamp indicating when balance was last updated.

Example:

"1721337427"

transaction_open_banking.open_banking_other.bank_data.accounts.owners

object

required

Hide child attributes

transaction_open_banking.open_banking_other.bank_data.accounts.owners.names

string

required

Names associated with the account. Note: string not array as many banks don't return names as an array.

Example:

"Jane Doe"

transaction_open_banking.open_banking_other.bank_data.accounts.owners.addresses

object[]

required

Hide child attributes

transaction_open_banking.open_banking_other.bank_data.accounts.owners.addresses.city

string

Example:

"Atlanta"

transaction_open_banking.open_banking_other.bank_data.accounts.owners.addresses.country

string

Example:

"US"

transaction_open_banking.open_banking_other.bank_data.accounts.owners.addresses.postal_code

string

Example:

"30313"

transaction_open_banking.open_banking_other.bank_data.accounts.owners.addresses.region

string

Example:

"GA"

transaction_open_banking.open_banking_other.bank_data.accounts.owners.addresses.is_primary

string

Example:

"true"

transaction_open_banking.open_banking_other.bank_data.accounts.owners.emails

object[]

required

Hide child attributes

transaction_open_banking.open_banking_other.bank_data.accounts.owners.emails.email

string

Example:

"jane.doe@example.com"

transaction_open_banking.open_banking_other.bank_data.accounts.owners.emails.is_primary

string

Example:

"true"

transaction_open_banking.open_banking_other.bank_data.accounts.owners.phone_numbers

object[]

required

Hide child attributes

transaction_open_banking.open_banking_other.bank_data.accounts.owners.phone_numbers.phone_number

string

Phone number in ISO E.164 format.

Example:

"+14151231234"

transaction_open_banking.open_banking_other.bank_data.accounts.owners.phone_numbers.is_primary

string

Example:

"true"

transaction_open_banking.open_banking_other.bank_data.transactions

object

required

List of transactions.

Hide child attributes

transaction_open_banking.open_banking_other.bank_data.transactions.id

string

required

ID of the transaction.

Example:

"txn_001"

transaction_open_banking.open_banking_other.bank_data.transactions.account_id

string

required

ID of the bank account.

Example:

"acct_001"

transaction_open_banking.open_banking_other.bank_data.transactions.amount

string

required

Amount in minor currency unit (e.g. cents).

Example:

"5000"

transaction_open_banking.open_banking_other.bank_data.transactions.currency_code

string

required

Currency code in ISO 3-digit format (e.g. USD).

Example:

"USD"

transaction_open_banking.open_banking_other.bank_data.transactions.status

string

required

Transaction status — active or pending.

Example:

"active"

transaction_open_banking.open_banking_other.bank_data.transactions.description

string

required

Description of transaction given by financial institution.

Example:

"Direct deposit"

transaction_open_banking.open_banking_other.bank_data.transactions.posted_date

string

required

Date when transaction was posted in YYYY-MM-DD format.

Example:

"2026-04-22"

transaction_open_banking.open_banking_other.bank_data.transactions.transaction_date

string

required

Date when transaction took place in YYYY-MM-DD format.

Example:

"2026-04-21"

transaction_open_banking.open_banking_other.bank_data.transactions.type

string

required

Type of transaction. One of: atm, cash, check, credit, debit, deposit, directDebit, directDeposit, dividend, fee, intrest, payment, pointOfSale, repeatPayment, serviceCharge, transfer, or other.

Example:

"directDeposit"

transaction_open_banking.open_banking_other.bank_data.transactions.merchant_name

string

required

Name of merchant.

Example:

"Ingo Money"

transaction_open_banking.open_banking_other.bank_data.transactions.categories

string[]

required

List of categories (e.g. overdraft, bankFee).

Example:

["directDeposit"]

transaction_open_banking.open_banking_other.bank_data.transactions.location

object[]

required

Hide child attributes

transaction_open_banking.open_banking_other.bank_data.transactions.location.street

string

Example:

"123 Main St"

transaction_open_banking.open_banking_other.bank_data.transactions.location.city

string

Example:

"Atlanta"

transaction_open_banking.open_banking_other.bank_data.transactions.location.region

string

Example:

"GA"

transaction_open_banking.open_banking_other.bank_data.transactions.location.postal_code

string

Example:

"30313"

transaction_open_banking.open_banking_other.bank_data.transactions.location.country

string

Example:

"US"

transaction_open_banking.open_banking_other.bank_data.transactions.location.latitude

string

Example:

"33.76272140863938"

transaction_open_banking.open_banking_other.bank_data.transactions.location.longitude

string

Example:

"-84.39188882939422"

transaction_open_banking.open_banking_other.mx_data

object

JSON responses from MX APIs for open banking enrichment.

Hide child attributes

transaction_open_banking.open_banking_other.mx_data.accounts_response

object

required

JSON from MX GET /users/{user_guid}/accounts. All pages of results required.

transaction_open_banking.open_banking_other.mx_data.transactions_response

object

required

JSON from MX GET /users/{user_guid}/accounts/{account_guid}/transactions. All pages of results required.

transaction_open_banking.open_banking_other.mx_data.account_owners_response

object

required

JSON from MX GET /users/{user_guid}/members/{member_guid}/account_owners.

transaction_open_banking.open_banking_other.mx_data.list_account_numbers_response

object

required

JSON from MX GET /users/{user_guid}/members/{member_guid}/account_numbers.

transaction_open_banking.open_banking_other.stripe_data

object

JSON responses from Stripe Financial Connections APIs for open banking enrichment.

Hide child attributes

transaction_open_banking.open_banking_other.stripe_data.accounts_response

object

required

JSON from Stripe Financial Connections GET/v1/financial_connections/accounts/:id with balance and ownership refresh. Always send latest balance; ownership only required on first call.

transaction_open_banking.open_banking_other.stripe_data.account_number

string

required

Bank account number. Required on first call only. Ingo links the Stripe account ID to the account number for subsequent calls.

Example:

"123456789"

transaction_open_banking.open_banking_other.stripe_data.routing_number

string

required

Bank routing number. Required on first call only. Ingo links the Stripe account ID to the routing number for subsequent calls.

Example:

"011000015"

transaction_open_banking.open_banking_other.stripe_data.transactions_response

object

required

JSON list of transactions from Stripe Financial Connections at the account ID level. All pages of results required.

transaction_open_banking.open_banking_other.teller_data

object

JSON responses from Teller APIs for open banking enrichment.

Hide child attributes

transaction_open_banking.open_banking_other.teller_data.account_number

string

required

Bank account number. Required on first call only. Ingo links the Teller account ID for subsequent calls.

Example:

"123456789"

transaction_open_banking.open_banking_other.teller_data.routing_number

string

required

Bank routing number. Required on first call only.

Example:

"011000015"

transaction_open_banking.open_banking_other.teller_data.account_response

object

required

Teller's Account API response.

transaction_open_banking.open_banking_other.teller_data.balance_response

object

required

Teller's Account Balance API response.

transaction_open_banking.open_banking_other.teller_data.transactions_response

object

required

Teller's Transactions API response.

Response

Risk score returned successfully

request

object

Hide child attributes

request.participant_id

string

Example:

"12345"

request.timestamp

string

Example:

"1721337427"

response

object

Hide child attributes

response.status

string

Numeric code describing the status of the API request. 100 = Success.

Example:

"100"

response.message

string

Text description associated with the status code.

Example:

"Success"

response.duration

string

Time in seconds to complete the request.

Example:

"0.074021816253662"

transaction

object

Risk assessment results.

Hide child attributes

transaction.score

string

Ingo risk score for the transaction. Scores 2–299 indicate high risk / fraud. Scores 300–3000 are continuous risk scores — 3000 is best.

Example:

"3000"

transaction.risk_assessment_token

string

Ingo-assigned ID for the risk assessment. Must be included in the subsequent debit Process request via transaction.risk_assessment_token.

Example:

"de1a802d-e6d3-4bd7-8ee9-53171952d812"

transaction.fraud_guarantee

object

Indicators associated with transaction fraud guarantee.

Hide child attributes

transaction.fraud_guarantee.guarantee_requested

string

Indicates whether a guarantee against fraud was requested. 1 = requested, 0 = not requested.

Example:

"1"

transaction.fraud_guarantee.transaction_guaranteed

string

Indicates whether the transaction was guaranteed against fraud. Only present when guarantee_requested = 1.

Example:

"1"

Overview

Verify

Process

Debit

Risk

Ancillary

Webhooks

Body

Response

Overview

Verify

Process

Debit

Risk

Ancillary

Webhooks

Documentation Index

Body

Response