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.
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.
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.
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Ingo Payments Developer Hub","description":"Ingo Payments Developer Hub — APIs, SDKs, and integration guides.","colors":{"primary":"#23ad4b","light":"#5dcaa5","dark":"#058237"},"logo":{"light":"https://mintcdn.com/ingopayments/iShoHhbLzbG-YOtN/logo/light.svg?fit=max\u0026auto=format\u0026n=iShoHhbLzbG-YOtN\u0026q=85\u0026s=556c65165f3a5daf3e33eaf145664046","dark":"https://mintcdn.com/ingopayments/iShoHhbLzbG-YOtN/logo/dark.svg?fit=max\u0026auto=format\u0026n=iShoHhbLzbG-YOtN\u0026q=85\u0026s=52323e8aa1687a6fbdd29a6351b84fcf"},"favicon":"https://mintcdn.com/ingopayments/V3R8LABa_ahl2WE8/favicon.svg?fit=max\u0026auto=format\u0026n=V3R8LABa_ahl2WE8\u0026q=85\u0026s=b46af7ead1c5e85e3fe5d6813b1be106","api":{"openapi":["specs/iframe-session-create.yaml","specs/ingo-banking-merchant-ledgering.yaml","specs/ingopay-check-cancel.yaml","specs/ingopay-check-stop.yaml","specs/ingopay-debit-process-ach.yaml","specs/ingopay-debit-process-card.yaml","specs/ingopay-notify-v3.yaml","specs/ingopay-notify-v4.yaml","specs/ingopay-process-ach.yaml","specs/ingopay-process-billpay.yaml","specs/ingopay-process-card.yaml","specs/ingopay-process-check.yaml","specs/ingopay-process-paypal-venmo.yaml","specs/ingopay-process-retail-card-present.yaml","specs/ingopay-risk.yaml","specs/ingopay-search-v11.yaml","specs/ingopay-verify-ach.yaml","specs/ingopay-verify-billpay.yaml","specs/ingopay-verify-card.yaml","specs/ingopay-verify-check.yaml","specs/ingopay-verify-paypal-venmo.yaml","specs/ingopay-verify-retail-card-present.yaml","specs/ingopay-open-banking-account.yaml","specs/crms-check-maker-alert.yaml","specs/crms-check-protect.yaml","specs/crms-duplicate-exchange.yaml","specs/crms-fraud-alert.yaml","specs/crms-sdk-card-add-or-update-tokenized.yaml","specs/crms-sdk-card-add-or-update.yaml","specs/crms-sdk-card-delete.yaml","specs/crms-sdk-card-get-registered-cards.yaml","specs/crms-sdk-card-update-account.yaml","specs/crms-sdk-partners-add-customer-attributes.yaml","specs/crms-sdk-partners-add-session-attributes.yaml","specs/crms-sdk-partners-authenticate-obo.yaml","specs/crms-sdk-partners-authenticate.yaml","specs/crms-sdk-partners-enroll-customer.yaml","specs/crms-sdk-partners-find-customer.yaml","specs/crms-sdk-partners-get-transaction-history.yaml","specs/crms-sdk-paypal-register-customer.yaml"],"asyncapi":["specs/asyncapi-ingopay.yaml","specs/asyncapi-notify-v3.yaml","specs/asyncapi-notify-v4.yaml","specs/asyncapi-iframe.yaml","specs/asyncapi-banking.yaml","specs/asyncapi-crms-sdk.yaml","specs/asyncapi-crms-check-protect.yaml"],"playground":{"display":"simple"}},"appearance":{"default":"dark"},"contextual":{"options":["copy","view","claude","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ingopayments","hasAudioNarration":false,"actualSubdomain":"ingopayments","customDomains":["developers.ingopayments.com"],"gitSource":{"type":"github","owner":"ingopayments","repo":"ingo-developer-center","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ada84e0793a44c014900f96","collectionId":"78d95d12-1fbc-4af9-94cd-d9532bf64744","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ada84e0793a44c014900f96"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae1f353201cdb70a522441a","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"Webhooks","count":242},{"language":"default","tag":"Banking Platform","count":81},{"language":"default","tag":"API Reference","count":74},{"language":"default","tag":"Notify — Managed Parties","count":56},{"language":"default","tag":"Notify — Classic","count":42},{"language":"default","tag":"IngoPay API","count":37},{"language":"default","tag":"Embedded Account Capture","count":22},{"language":"default","tag":"Overview","count":20},{"language":"default","tag":"Hub","count":17},{"language":"default","tag":"Business Owners \u0026 Documents","count":9}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"#navbar>div>div:first-child{border-bottom:3px solid #23ad4b!important;border-color:#23ad4b!important}nav a.link.rounded-full{height:40px!important;font-size:13.5px!important;padding-left:16px!important;padding-right:16px!important;transition:background .15s ease,color .15s ease,border-color .15s ease!important}nav a.link.rounded-full:not(.text-gray-600){background-color:#23ad4b!important;color:#fff!important;font-weight:700!important}nav a.link.rounded-full.text-gray-600{border:1px solid transparent!important;background-color:transparent!important}nav a.link.rounded-full.text-gray-600:hover{border-color:#23ad4b!important;color:#23ad4b!important;background-color:transparent!important}.spec-btn,.spec-btn:hover{text-decoration:none!important}.spec-btn{display:inline-block;background:0 0;border:1px solid #23ad4b;color:#23ad4b!important;font-size:12px;font-weight:600;padding:5px 14px;border-radius:20px;transition:background .15s ease,color .15s ease,border-color .15s ease}.spec-btn:hover{background:#23ad4b;color:#fff!important}.dark table th{color:#e2e8f0!important}img[src*=\"/crms/sdk/screens/\"]{border-radius:24px;max-width:280px;background:#fff;border:1px solid rgba(0,0,0,.18);box-shadow:0 6px 16px rgba(0,0,0,.12)}.dark img[src*=\"/crms/sdk/screens/\"]{border:1px solid rgba(255,255,255,.15);box-shadow:0 6px 16px rgba(0,0,0,.4)}.screen-row{display:grid;grid-template-columns:repeat(auto-fit,minmax(420px,1fr));gap:36px;margin:28px 0}.screen-card{display:grid;grid-template-columns:160px 1fr;gap:20px;align-items:start}.screen-card img{max-width:160px!important;width:100%}.screen-card .screen-text h4,.screen-card .screen-text strong:first-child{display:block;font-size:15px;font-weight:700;margin-top:0;margin-bottom:8px;line-height:1.3}.screen-card .screen-text p{margin:0 0 8px;font-size:14px;line-height:1.55}@media (max-width:540px){.screen-card{grid-template-columns:1fr;gap:12px}.screen-card img{max-width:200px!important;margin:0 auto}}.mermaid svg,div[class*=mermaid] svg,pre.mermaid svg{height:auto!important;margin:0 auto;display:block}.diagram-links{margin:8px 0 4px;font-size:.85rem;text-align:right}.diagram-links a{font-weight:500;text-decoration:none;border-bottom:1px solid currentColor}.diagram-accordion{position:relative;padding-left:14px;margin:28px 0;transition:transform .18s ease}.diagram-accordion::before{content:\"\";position:absolute;left:0;top:6px;bottom:6px;width:4px;background:#1a73e8;border-radius:2px;pointer-events:none;transition:background .18s ease,width .18s ease}.diagram-accordion:hover,.sdk-download-cta:hover{transform:translateY(-1px)}.diagram-accordion:hover::before{background:#4a90f0;width:5px}.sdk-download-cta{position:relative;margin:24px 0;padding:6px;border:2px solid #23ad4b;border-radius:14px;background:rgba(35,173,75,.06);box-shadow:0 4px 14px rgba(35,173,75,.18);transition:transform .18s ease,box-shadow .18s ease}.sdk-download-cta:hover{box-shadow:0 6px 20px rgba(35,173,75,.28)}.dark .sdk-download-cta{background:rgba(35,173,75,.12);box-shadow:0 4px 14px rgba(0,0,0,.4)}.report-downloads{display:flex;flex-wrap:wrap;gap:14px;margin:20px 0 4px}.report-downloads a.report-dl-btn{display:inline-flex;align-items:center;gap:9px;background:#23ad4b;color:#fff!important;font-size:14px;font-weight:600;padding:11px 20px;border-radius:10px;text-decoration:none!important;border:1px solid #23ad4b;box-shadow:0 2px 8px rgba(35,173,75,.2);transition:transform .15s ease,box-shadow .15s ease,background .15s ease}.report-downloads a.report-dl-btn::before{content:\"\\2193\";font-size:15px;font-weight:700;line-height:1}.report-downloads a.report-dl-btn:hover{background:#1c8f3d;transform:translateY(-1px);box-shadow:0 5px 16px rgba(35,173,75,.32);text-decoration:none!important}.dark .report-downloads a.report-dl-btn{box-shadow:0 2px 8px rgba(0,0,0,.4)}"}],"page":{"pagePath":"docs/ingopay/risk/risk-score","slug":"/docs/ingopay/risk/risk-score","pageMetadata":{"title":"Risk Score","description":"Evaluate the risk of a transaction and obtain a risk assessment token for use in subsequent process calls.","openapi":"specs/ingopay-risk.yaml POST /risk/riskscore/v2","href":"/docs/ingopay/risk/risk-score"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Evaluate the risk of a transaction and obtain a risk assessment token for use in subsequent process calls.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Risk Score","description":"Evaluate the risk of a transaction and obtain a risk assessment token for use in subsequent process calls.","openapi":"specs/ingopay-risk.yaml POST /risk/riskscore/v2","href":"/docs/ingopay/risk/risk-score"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/ingopayments/6302b08f7c932246/scripts/convert.js","/_mintlify/custom/ingopayments/803ba8a0d7080d96/scripts/generate-from-code.js","/_mintlify/custom/ingopayments/20b0b95f387de69d/scripts/validate.js","/_mintlify/custom/ingopayments/e31e657fa2223781/scripts/export-diagrams.js"],"openApiReferenceData":{"operation":{"summary":"Submit transaction data for risk scoring","description":"Evaluate the risk of a transaction and obtain a risk assessment token for use in subsequent process calls.","operationId":"riskScore","tags":["Risk"],"requestBody":"60cd0499-e765-43a0-a41a-129e067a1736","responses":{"200":"a1dff7b2-d8d8-45fe-8ad3-c5a981f46654","400":"708fb346-08a3-4254-a894-58a0e2db0575"},"method":"post","type":"path","servers":["c1f05497-00df-4f38-8619-d18783d07787","66ffb805-616a-4426-a4be-15f431eb301f"],"security":["ff5c20b2-f56c-4b33-b5e0-497d0daf44c3"],"path":"/risk/riskscore/v2","baseUrlOptions":["https://payapi-sandbox.ingo.money","https://payapi.ingo.money"],"title":"Submit transaction data for risk scoring","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["request","transaction"],"description":"`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.\n","properties":{"request":{"type":"object","required":["participant_id","timestamp"],"description":"General information associated with the API request.","properties":{"participant_id":{"type":"string","maxLength":5,"description":"Unique participant identifier assigned by Ingo.","example":"12345","isRequired":true,"uniqueKey":"request.participant_id","typeLabel":"string"},"timestamp":{"type":"string","maxLength":32,"description":"Unix timestamp of the request.","example":"1721337427","isRequired":true,"uniqueKey":"request.timestamp","typeLabel":"string"}},"isRequired":true,"uniqueKey":"request","typeLabel":"object"},"transaction":{"type":"object","required":["account_type","transaction_amount","customer_account_token","customer_id","phone","phone_verified","email","email_verified","dob"],"description":"General transaction and risk assessment information.","properties":{"account_type":{"type":"string","enum":["CA","AC"],"minLength":1,"description":"Account type of the transaction being assessed. `CA` = Card, `AC` = ACH. Only these two account types are supported by the risk scoring flow.\n","example":"AC","isRequired":true,"uniqueKey":"transaction.account_type","typeLabel":"enum\u003cstring>"},"transaction_amount":{"type":"object","required":["currency_code","amount"],"properties":{"currency_code":{"type":"string","minLength":3,"maxLength":3,"pattern":"^[A-Z]{3}$","description":"3-character ISO-4217 (alpha) currency code.","example":"USD","isRequired":true,"uniqueKey":"transaction.transaction_amount.currency_code","typeLabel":"string"},"amount":{"type":"string","minLength":1,"maxLength":12,"description":"Transaction amount. Must be greater than 0 with a maximum of 2 decimal places.\n","example":"15.00","isRequired":true,"uniqueKey":"transaction.transaction_amount.amount","typeLabel":"string"}},"isRequired":true,"uniqueKey":"transaction.transaction_amount","typeLabel":"object"},"customer_account_token":{"type":"string","minLength":1,"maxLength":50,"description":"Token representing the account number and customer data as provided in the response from a previous Verify API call.\n","example":"f40810e6-b382-4dd5-8012-9d8518136fdc","isRequired":true,"uniqueKey":"transaction.customer_account_token","typeLabel":"string"},"customer_id":{"type":"string","maxLength":64,"description":"Client provided unique identifier for the customer.\n","example":"bb79062e-938c-427e-8494-1d69fa3f2295","isRequired":true,"uniqueKey":"transaction.customer_id","typeLabel":"string"},"phone":{"type":"string","maxLength":16,"description":"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, +.\n","example":"4045555555","isRequired":true,"uniqueKey":"transaction.phone","typeLabel":"string"},"phone_verified":{"type":"string","enum":["true","false"],"description":"Indicates whether the customer phone number has been verified.\n","example":"false","isRequired":true,"uniqueKey":"transaction.phone_verified","typeLabel":"enum\u003cstring>"},"email":{"type":"string","maxLength":150,"description":"Customer primary email address from profile.","example":"customer@example.com","isRequired":true,"uniqueKey":"transaction.email","typeLabel":"string"},"email_verified":{"type":"string","enum":["true","false"],"description":"Indicates whether the customer email has been verified.\n","example":"true","isRequired":true,"uniqueKey":"transaction.email_verified","typeLabel":"enum\u003cstring>"},"dob":{"type":"string","maxLength":10,"pattern":"^([0-9]{2}\\/[0-9]{2}\\/[0-9]{4})|(([0-9]{2}\\-[0-9]{2}\\-[0-9]{4}))$","description":"Customer date of birth. Accepted formats: `MM/dd/yyyy` or `MM-dd-yyyy`.\n","example":"01/02/2000","isRequired":true,"uniqueKey":"transaction.dob","typeLabel":"string"},"risk_session_token":{"oneOf":[{"type":"string","maxLength":36,"description":"The `risk_session_token` from the Risk Session Method response. Recommended to include for accurate device fingerprinting correlation.\n","example":"e9751823-fed0-4982-802b-6a4bb1cdc86c","uniqueKey":"transaction.risk_session_token.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":36,"description":"The `risk_session_token` from the Risk Session Method response. Recommended to include for accurate device fingerprinting correlation.\n","example":"e9751823-fed0-4982-802b-6a4bb1cdc86c","uniqueKey":"transaction.risk_session_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"transaction.risk_session_token","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"transaction","typeLabel":"object"},"transaction_ifa":{"type":"object","description":"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.\n","required":["ssn"],"properties":{"ssn":{"type":"string","minLength":4,"maxLength":11,"pattern":"^(([0-9]{4})|([0-9]{9})|([0-9]{3}\\-[0-9]{2}\\-[0-9]{4}))$","description":"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.\n","example":"6789","isRequired":true,"uniqueKey":"transaction_ifa.ssn","typeLabel":"string"},"dob":{"type":"string","minLength":10,"maxLength":10,"pattern":"^([0-9]{2}\\/[0-9]{2}\\/[0-9]{4})|(([0-9]{2}\\-[0-9]{2}\\-[0-9]{4}))$","description":"Date of birth in MM/DD/YYYY or MM-DD-YYYY format. Required when using SSN last-4.\n","example":"01/02/2000","uniqueKey":"transaction_ifa.dob","typeLabel":"string"},"device_id":{"oneOf":[{"type":"string","minLength":1,"maxLength":100,"description":"The ID of the device, captured by the Sardine device fingerprinting SDK.\n","example":"99ABCDEF-01234567-89ABCDE","uniqueKey":"transaction_ifa.device_id.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":100,"description":"The ID of the device, captured by the Sardine device fingerprinting SDK.\n","example":"99ABCDEF-01234567-89ABCDE","uniqueKey":"transaction_ifa.device_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"transaction_ifa.device_id","typeLabel":"string | null"},"geo_location":{"oneOf":[{"type":"object","description":"Geo-location information associated with the transaction.","required":["latitude","longitude"],"properties":{"latitude":{"type":"string","minLength":1,"maxLength":22,"pattern":"^-?[0-9]{0,2}\\.[0-9]{0,18}$","description":"Latitude of the location. Range: -90 to 90 with a precision of up to 18 decimal places.\n","example":"33.76272140863938","isRequired":true,"uniqueKey":"transaction_ifa.geo_location.oneOf.0.latitude","typeLabel":"string"},"longitude":{"type":"string","minLength":1,"maxLength":23,"pattern":"^-?[0-9]{0,3}\\.[0-9]{0,18}$","description":"Longitude of the location. Range: -180 to 180 with a precision of up to 18 decimal places.\n","example":"-84.39188882939422","isRequired":true,"uniqueKey":"transaction_ifa.geo_location.oneOf.0.longitude","typeLabel":"string"}},"uniqueKey":"transaction_ifa.geo_location.oneOf.0","typeLabel":"object"},{"type":"null","description":"Geo-location information associated with the transaction.","required":["latitude","longitude"],"properties":{"latitude":{"type":"string","minLength":1,"maxLength":22,"pattern":"^-?[0-9]{0,2}\\.[0-9]{0,18}$","description":"Latitude of the location. Range: -90 to 90 with a precision of up to 18 decimal places.\n","example":"33.76272140863938"},"longitude":{"type":"string","minLength":1,"maxLength":23,"pattern":"^-?[0-9]{0,3}\\.[0-9]{0,18}$","description":"Longitude of the location. Range: -180 to 180 with a precision of up to 18 decimal places.\n","example":"-84.39188882939422"}},"uniqueKey":"transaction_ifa.geo_location.oneOf.1","typeLabel":"null"}],"uniqueKey":"transaction_ifa.geo_location","typeLabel":"object | null"}},"uniqueKey":"transaction_ifa","typeLabel":"object"},"transaction_open_banking":{"oneOf":[{"type":"object","description":"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.\n","properties":{"open_banking_plaid":{"type":"object","description":"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.\n","required":["processor_token","account_id"],"properties":{"processor_token":{"type":"string","maxLength":36,"description":"The processor token for the account as provided by Plaid.\n","example":"5964250f-18b3-419c-913c-92f4143ecfd3","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_plaid.processor_token","typeLabel":"string"},"account_id":{"type":"string","maxLength":36,"description":"The unique identifier of the account for the customer as provided by Plaid.\n","example":"47507fce-a89c-4fd5-b0c7-5b179da4c6a1","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_plaid.account_id","typeLabel":"string"}},"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_plaid","typeLabel":"object"},"open_banking_other":{"x-status":"planned","x-status-note":"Structure defined by Sardine's open banking API contract. Not yet implemented — included to preserve Layer 1 field definitions ahead of development. Do not use in production.\n","type":"object","description":"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.\n","properties":{"bank_data":{"type":"object","description":"Generic bank account and transaction data for providers not using Plaid (e.g. Finicity, Yodlee, or other).\n","required":["source","accounts","transactions"],"properties":{"source":{"type":"string","description":"Open banking data provider name (e.g. Finicity, Yodlee, or other).\n","example":"Finicity","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.source","typeLabel":"string"},"accounts":{"type":"array","description":"List of bank accounts and related information.","items":{"type":"object","required":["id","account_number","routing_number","account_type","name","balance","owners"],"properties":{"id":{"type":"string","description":"ID of bank account as defined by you or the financial data provider.","example":"acct_001","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts.items.[INDEX].id","typeLabel":"string"},"account_number":{"type":"string","description":"Bank account number.","example":"123456789","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts.items.[INDEX].account_number","typeLabel":"string"},"routing_number":{"type":"string","description":"Bank routing number.","example":"011000015","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts.items.[INDEX].routing_number","typeLabel":"string"},"account_type":{"type":"string","description":"Account type — checking, saving, or other.","example":"checking","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts.items.[INDEX].account_type","typeLabel":"string"},"name":{"type":"string","description":"Name of the bank account.","example":"Wells Fargo high-interest savings account","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts.items.[INDEX].name","typeLabel":"string"},"balance":{"type":"object","required":["currency_code","current","available","last_updated"],"properties":{"currency_code":{"type":"string","description":"Currency code in ISO 3-digit format (e.g. USD).","example":"USD","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts.items.[INDEX].balance.currency_code","typeLabel":"string"},"current":{"type":"string","description":"Current balance in minor currency unit (e.g. cents).","example":"150000","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts.items.[INDEX].balance.current","typeLabel":"string"},"available":{"type":"string","description":"Available balance in minor currency unit (e.g. cents).","example":"148500","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts.items.[INDEX].balance.available","typeLabel":"string"},"last_updated":{"type":"string","description":"Unix timestamp indicating when balance was last updated.","example":"1721337427","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts.items.[INDEX].balance.last_updated","typeLabel":"string"}},"isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts.items.[INDEX].balance","typeLabel":"object"},"owners":{"type":"object","required":["names","addresses","emails","phone_numbers"],"properties":{"names":{"type":"string","description":"Names associated with the account. Note: string not array as many banks don't return names as an array.\n","example":"Jane Doe","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts.items.[INDEX].owners.names","typeLabel":"string"},"addresses":{"type":"array","items":{"type":"object","properties":{"city":{"type":"string","example":"Atlanta","uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts.items.[INDEX].owners.addresses.items.[INDEX].city","typeLabel":"string"},"country":{"type":"string","example":"US","uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts.items.[INDEX].owners.addresses.items.[INDEX].country","typeLabel":"string"},"postal_code":{"type":"string","example":"30313","uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts.items.[INDEX].owners.addresses.items.[INDEX].postal_code","typeLabel":"string"},"region":{"type":"string","example":"GA","uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts.items.[INDEX].owners.addresses.items.[INDEX].region","typeLabel":"string"},"is_primary":{"type":"string","example":"true","uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts.items.[INDEX].owners.addresses.items.[INDEX].is_primary","typeLabel":"string"}},"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts.items.[INDEX].owners.addresses.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts.items.[INDEX].owners.addresses","typeLabel":"object[]"},"emails":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"jane.doe@example.com","uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts.items.[INDEX].owners.emails.items.[INDEX].email","typeLabel":"string"},"is_primary":{"type":"string","example":"true","uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts.items.[INDEX].owners.emails.items.[INDEX].is_primary","typeLabel":"string"}},"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts.items.[INDEX].owners.emails.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts.items.[INDEX].owners.emails","typeLabel":"object[]"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","description":"Phone number in ISO E.164 format.","example":"+14151231234","uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts.items.[INDEX].owners.phone_numbers.items.[INDEX].phone_number","typeLabel":"string"},"is_primary":{"type":"string","example":"true","uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts.items.[INDEX].owners.phone_numbers.items.[INDEX].is_primary","typeLabel":"string"}},"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts.items.[INDEX].owners.phone_numbers.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts.items.[INDEX].owners.phone_numbers","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts.items.[INDEX].owners","typeLabel":"object"}},"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.accounts","typeLabel":"object[]"},"transactions":{"type":"object","required":["id","account_id","amount","currency_code","status","description","posted_date","transaction_date","type","merchant_name","categories","location"],"description":"List of transactions.","properties":{"id":{"type":"string","description":"ID of the transaction.","example":"txn_001","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.transactions.id","typeLabel":"string"},"account_id":{"type":"string","description":"ID of the bank account.","example":"acct_001","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.transactions.account_id","typeLabel":"string"},"amount":{"type":"string","description":"Amount in minor currency unit (e.g. cents).","example":"5000","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.transactions.amount","typeLabel":"string"},"currency_code":{"type":"string","description":"Currency code in ISO 3-digit format (e.g. USD).","example":"USD","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.transactions.currency_code","typeLabel":"string"},"status":{"type":"string","description":"Transaction status — active or pending.","example":"active","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.transactions.status","typeLabel":"string"},"description":{"type":"string","description":"Description of transaction given by financial institution.","example":"Direct deposit","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.transactions.description","typeLabel":"string"},"posted_date":{"type":"string","description":"Date when transaction was posted in YYYY-MM-DD format.","example":"2026-04-22","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.transactions.posted_date","typeLabel":"string"},"transaction_date":{"type":"string","description":"Date when transaction took place in YYYY-MM-DD format.","example":"2026-04-21","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.transactions.transaction_date","typeLabel":"string"},"type":{"type":"string","description":"Type of transaction. One of: atm, cash, check, credit, debit, deposit, directDebit, directDeposit, dividend, fee, intrest, payment, pointOfSale, repeatPayment, serviceCharge, transfer, or other.\n","example":"directDeposit","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.transactions.type","typeLabel":"string"},"merchant_name":{"type":"string","description":"Name of merchant.","example":"Ingo Money","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.transactions.merchant_name","typeLabel":"string"},"categories":{"type":"array","items":{"type":"string","uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.transactions.categories.items.[INDEX]","typeLabel":"string"},"description":"List of categories (e.g. overdraft, bankFee).","example":["directDeposit"],"isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.transactions.categories","typeLabel":"string[]"},"location":{"type":"array","items":{"type":"object","properties":{"street":{"type":"string","example":"123 Main St","uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.transactions.location.items.[INDEX].street","typeLabel":"string"},"city":{"type":"string","example":"Atlanta","uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.transactions.location.items.[INDEX].city","typeLabel":"string"},"region":{"type":"string","example":"GA","uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.transactions.location.items.[INDEX].region","typeLabel":"string"},"postal_code":{"type":"string","example":"30313","uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.transactions.location.items.[INDEX].postal_code","typeLabel":"string"},"country":{"type":"string","example":"US","uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.transactions.location.items.[INDEX].country","typeLabel":"string"},"latitude":{"type":"string","example":"33.76272140863938","uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.transactions.location.items.[INDEX].latitude","typeLabel":"string"},"longitude":{"type":"string","example":"-84.39188882939422","uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.transactions.location.items.[INDEX].longitude","typeLabel":"string"}},"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.transactions.location.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.transactions.location","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data.transactions","typeLabel":"object"}},"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.bank_data","typeLabel":"object"},"mx_data":{"type":"object","description":"JSON responses from MX APIs for open banking enrichment.\n","required":["accounts_response","transactions_response","account_owners_response","list_account_numbers_response"],"properties":{"accounts_response":{"type":"object","description":"JSON from MX GET /users/{user_guid}/accounts. All pages of results required.\n","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.mx_data.accounts_response","typeLabel":"object"},"transactions_response":{"type":"object","description":"JSON from MX GET /users/{user_guid}/accounts/{account_guid}/transactions. All pages of results required.\n","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.mx_data.transactions_response","typeLabel":"object"},"account_owners_response":{"type":"object","description":"JSON from MX GET /users/{user_guid}/members/{member_guid}/account_owners.\n","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.mx_data.account_owners_response","typeLabel":"object"},"list_account_numbers_response":{"type":"object","description":"JSON from MX GET /users/{user_guid}/members/{member_guid}/account_numbers.\n","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.mx_data.list_account_numbers_response","typeLabel":"object"}},"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.mx_data","typeLabel":"object"},"stripe_data":{"type":"object","description":"JSON responses from Stripe Financial Connections APIs for open banking enrichment.\n","required":["accounts_response","account_number","routing_number","transactions_response"],"properties":{"accounts_response":{"type":"object","description":"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.\n","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.stripe_data.accounts_response","typeLabel":"object"},"account_number":{"type":"string","description":"Bank account number. Required on first call only. Ingo links the Stripe account ID to the account number for subsequent calls.\n","example":"123456789","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.stripe_data.account_number","typeLabel":"string"},"routing_number":{"type":"string","description":"Bank routing number. Required on first call only. Ingo links the Stripe account ID to the routing number for subsequent calls.\n","example":"011000015","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.stripe_data.routing_number","typeLabel":"string"},"transactions_response":{"type":"object","description":"JSON list of transactions from Stripe Financial Connections at the account ID level. All pages of results required.\n","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.stripe_data.transactions_response","typeLabel":"object"}},"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.stripe_data","typeLabel":"object"},"teller_data":{"type":"object","description":"JSON responses from Teller APIs for open banking enrichment.\n","required":["account_number","routing_number","account_response","balance_response","transactions_response"],"properties":{"account_number":{"type":"string","description":"Bank account number. Required on first call only. Ingo links the Teller account ID for subsequent calls.\n","example":"123456789","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.teller_data.account_number","typeLabel":"string"},"routing_number":{"type":"string","description":"Bank routing number. Required on first call only.\n","example":"011000015","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.teller_data.routing_number","typeLabel":"string"},"account_response":{"type":"object","description":"Teller's Account API response.","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.teller_data.account_response","typeLabel":"object"},"balance_response":{"type":"object","description":"Teller's Account Balance API response.","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.teller_data.balance_response","typeLabel":"object"},"transactions_response":{"type":"object","description":"Teller's Transactions API response.","isRequired":true,"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.teller_data.transactions_response","typeLabel":"object"}},"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other.teller_data","typeLabel":"object"}},"uniqueKey":"transaction_open_banking.oneOf.0.open_banking_other","typeLabel":"object"}},"uniqueKey":"transaction_open_banking.oneOf.0","typeLabel":"object"},{"type":"null","description":"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.\n","properties":{"open_banking_plaid":{"type":"object","description":"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.\n","required":["processor_token","account_id"],"properties":{"processor_token":{"type":"string","maxLength":36,"description":"The processor token for the account as provided by Plaid.\n","example":"5964250f-18b3-419c-913c-92f4143ecfd3"},"account_id":{"type":"string","maxLength":36,"description":"The unique identifier of the account for the customer as provided by Plaid.\n","example":"47507fce-a89c-4fd5-b0c7-5b179da4c6a1"}}},"open_banking_other":{"x-status":"planned","x-status-note":"Structure defined by Sardine's open banking API contract. Not yet implemented — included to preserve Layer 1 field definitions ahead of development. Do not use in production.\n","type":"object","description":"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.\n","properties":{"bank_data":{"type":"object","description":"Generic bank account and transaction data for providers not using Plaid (e.g. Finicity, Yodlee, or other).\n","required":["source","accounts","transactions"],"properties":{"source":{"type":"string","description":"Open banking data provider name (e.g. Finicity, Yodlee, or other).\n","example":"Finicity"},"accounts":{"type":"array","description":"List of bank accounts and related information.","items":{"type":"object","required":["id","account_number","routing_number","account_type","name","balance","owners"],"properties":{"id":{"type":"string","description":"ID of bank account as defined by you or the financial data provider.","example":"acct_001"},"account_number":{"type":"string","description":"Bank account number.","example":"123456789"},"routing_number":{"type":"string","description":"Bank routing number.","example":"011000015"},"account_type":{"type":"string","description":"Account type — checking, saving, or other.","example":"checking"},"name":{"type":"string","description":"Name of the bank account.","example":"Wells Fargo high-interest savings account"},"balance":{"type":"object","required":["currency_code","current","available","last_updated"],"properties":{"currency_code":{"type":"string","description":"Currency code in ISO 3-digit format (e.g. USD).","example":"USD"},"current":{"type":"string","description":"Current balance in minor currency unit (e.g. cents).","example":"150000"},"available":{"type":"string","description":"Available balance in minor currency unit (e.g. cents).","example":"148500"},"last_updated":{"type":"string","description":"Unix timestamp indicating when balance was last updated.","example":"1721337427"}}},"owners":{"type":"object","required":["names","addresses","emails","phone_numbers"],"properties":{"names":{"type":"string","description":"Names associated with the account. Note: string not array as many banks don't return names as an array.\n","example":"Jane Doe"},"addresses":{"type":"array","items":{"type":"object","properties":{"city":{"type":"string","example":"Atlanta"},"country":{"type":"string","example":"US"},"postal_code":{"type":"string","example":"30313"},"region":{"type":"string","example":"GA"},"is_primary":{"type":"string","example":"true"}}}},"emails":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","example":"jane.doe@example.com"},"is_primary":{"type":"string","example":"true"}}}},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","description":"Phone number in ISO E.164 format.","example":"+14151231234"},"is_primary":{"type":"string","example":"true"}}}}}}}}},"transactions":{"type":"object","required":["id","account_id","amount","currency_code","status","description","posted_date","transaction_date","type","merchant_name","categories","location"],"description":"List of transactions.","properties":{"id":{"type":"string","description":"ID of the transaction.","example":"txn_001"},"account_id":{"type":"string","description":"ID of the bank account.","example":"acct_001"},"amount":{"type":"string","description":"Amount in minor currency unit (e.g. cents).","example":"5000"},"currency_code":{"type":"string","description":"Currency code in ISO 3-digit format (e.g. USD).","example":"USD"},"status":{"type":"string","description":"Transaction status — active or pending.","example":"active"},"description":{"type":"string","description":"Description of transaction given by financial institution.","example":"Direct deposit"},"posted_date":{"type":"string","description":"Date when transaction was posted in YYYY-MM-DD format.","example":"2026-04-22"},"transaction_date":{"type":"string","description":"Date when transaction took place in YYYY-MM-DD format.","example":"2026-04-21"},"type":{"type":"string","description":"Type of transaction. One of: atm, cash, check, credit, debit, deposit, directDebit, directDeposit, dividend, fee, intrest, payment, pointOfSale, repeatPayment, serviceCharge, transfer, or other.\n","example":"directDeposit"},"merchant_name":{"type":"string","description":"Name of merchant.","example":"Ingo Money"},"categories":{"type":"array","items":{"type":"string"},"description":"List of categories (e.g. overdraft, bankFee).","example":["directDeposit"]},"location":{"type":"array","items":{"type":"object","properties":{"street":{"type":"string","example":"123 Main St"},"city":{"type":"string","example":"Atlanta"},"region":{"type":"string","example":"GA"},"postal_code":{"type":"string","example":"30313"},"country":{"type":"string","example":"US"},"latitude":{"type":"string","example":"33.76272140863938"},"longitude":{"type":"string","example":"-84.39188882939422"}}}}}}}},"mx_data":{"type":"object","description":"JSON responses from MX APIs for open banking enrichment.\n","required":["accounts_response","transactions_response","account_owners_response","list_account_numbers_response"],"properties":{"accounts_response":{"type":"object","description":"JSON from MX GET /users/{user_guid}/accounts. All pages of results required.\n"},"transactions_response":{"type":"object","description":"JSON from MX GET /users/{user_guid}/accounts/{account_guid}/transactions. All pages of results required.\n"},"account_owners_response":{"type":"object","description":"JSON from MX GET /users/{user_guid}/members/{member_guid}/account_owners.\n"},"list_account_numbers_response":{"type":"object","description":"JSON from MX GET /users/{user_guid}/members/{member_guid}/account_numbers.\n"}}},"stripe_data":{"type":"object","description":"JSON responses from Stripe Financial Connections APIs for open banking enrichment.\n","required":["accounts_response","account_number","routing_number","transactions_response"],"properties":{"accounts_response":{"type":"object","description":"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.\n"},"account_number":{"type":"string","description":"Bank account number. Required on first call only. Ingo links the Stripe account ID to the account number for subsequent calls.\n","example":"123456789"},"routing_number":{"type":"string","description":"Bank routing number. Required on first call only. Ingo links the Stripe account ID to the routing number for subsequent calls.\n","example":"011000015"},"transactions_response":{"type":"object","description":"JSON list of transactions from Stripe Financial Connections at the account ID level. All pages of results required.\n"}}},"teller_data":{"type":"object","description":"JSON responses from Teller APIs for open banking enrichment.\n","required":["account_number","routing_number","account_response","balance_response","transactions_response"],"properties":{"account_number":{"type":"string","description":"Bank account number. Required on first call only. Ingo links the Teller account ID for subsequent calls.\n","example":"123456789"},"routing_number":{"type":"string","description":"Bank routing number. Required on first call only.\n","example":"011000015"},"account_response":{"type":"object","description":"Teller's Account API response."},"balance_response":{"type":"object","description":"Teller's Account Balance API response."},"transactions_response":{"type":"object","description":"Teller's Transactions API response."}}}}}},"uniqueKey":"transaction_open_banking.oneOf.1","typeLabel":"null"}],"uniqueKey":"transaction_open_banking","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"standard":{"title":"standard","value":{"request":{"participant_id":"12345","timestamp":"1721337427"},"transaction":{"account_type":"AC","transaction_amount":{"currency_code":"USD","amount":"15.00"},"customer_account_token":"f40810e6-b382-4dd5-8012-9d8518136fdc","customer_id":"bb79062e-938c-427e-8494-1d69fa3f2295","risk_session_token":"e9751823-fed0-4982-802b-6a4bb1cdc86c","phone":"5555550100","phone_verified":"false","email":"customer@example.com","email_verified":"true","dob":"01/02/2000"},"transaction_ifa":{"ssn":"6789","dob":"01/02/2000","device_id":"99ABCDEF-01234567-89ABCDE","geo_location":{"latitude":"33.76272140863938","longitude":"-84.39188882939422"}}}},"with_open_banking_plaid":{"title":"with_open_banking_plaid","value":{"request":{"participant_id":"12345","timestamp":"1721337427"},"transaction":{"account_type":"AC","transaction_amount":{"currency_code":"USD","amount":"15.00"},"customer_account_token":"f40810e6-b382-4dd5-8012-9d8518136fdc","customer_id":"bb79062e-938c-427e-8494-1d69fa3f2295","risk_session_token":"e9751823-fed0-4982-802b-6a4bb1cdc86c","phone":"5555550100","phone_verified":"false","email":"customer@example.com","email_verified":"true","dob":"01/02/2000"},"transaction_ifa":{"ssn":"6789","dob":"01/02/2000","device_id":"99ABCDEF-01234567-89ABCDE","geo_location":{"latitude":"33.76272140863938","longitude":"-84.39188882939422"}},"transaction_open_banking":{"open_banking_plaid":{"processor_token":"5964250f-18b3-419c-913c-92f4143ecfd3","account_id":"47507fce-a89c-4fd5-b0c7-5b179da4c6a1"}}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"a1dff7b2-d8d8-45fe-8ad3-c5a981f46654":{"description":"Risk score returned successfully","content":{"application/json":{"schema":{"type":"object","properties":{"request":{"type":"object","properties":{"participant_id":{"type":"string","example":"12345","uniqueKey":"request.participant_id","typeLabel":"string"},"timestamp":{"type":"string","example":"1721337427","uniqueKey":"request.timestamp","typeLabel":"string"}},"uniqueKey":"request","typeLabel":"object"},"response":{"type":"object","properties":{"status":{"type":"string","description":"Numeric code describing the status of the API request. 100 = Success.\n","example":"100","uniqueKey":"response.status","typeLabel":"string"},"message":{"type":"string","description":"Text description associated with the status code.","example":"Success","uniqueKey":"response.message","typeLabel":"string"},"duration":{"type":"string","description":"Time in seconds to complete the request.","example":"0.074021816253662","uniqueKey":"response.duration","typeLabel":"string"}},"uniqueKey":"response","typeLabel":"object"},"transaction":{"type":"object","description":"Risk assessment results.","properties":{"score":{"type":"string","description":"Ingo risk score for the transaction. Scores 2–299 indicate high risk / fraud. Scores 300–3000 are continuous risk scores — 3000 is best.\n","example":"3000","uniqueKey":"transaction.score","typeLabel":"string"},"risk_assessment_token":{"type":"string","description":"Ingo-assigned ID for the risk assessment. Must be included in the subsequent debit Process request via `transaction.risk_assessment_token`.\n","example":"de1a802d-e6d3-4bd7-8ee9-53171952d812","uniqueKey":"transaction.risk_assessment_token","typeLabel":"string"},"fraud_guarantee":{"type":"object","description":"Indicators associated with transaction fraud guarantee.","properties":{"guarantee_requested":{"type":"string","description":"Indicates whether a guarantee against fraud was requested. 1 = requested, 0 = not requested.\n","example":"1","uniqueKey":"transaction.fraud_guarantee.guarantee_requested","typeLabel":"string"},"transaction_guaranteed":{"type":"string","description":"Indicates whether the transaction was guaranteed against fraud. Only present when `guarantee_requested` = 1.\n","example":"1","uniqueKey":"transaction.fraud_guarantee.transaction_guaranteed","typeLabel":"string"}},"uniqueKey":"transaction.fraud_guarantee","typeLabel":"object"}},"uniqueKey":"transaction","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"request":{"participant_id":"12345","timestamp":"1721337427"},"response":{"status":"100","message":"Success","duration":"0.074021816253662"},"transaction":{"score":"3000","risk_assessment_token":"de1a802d-e6d3-4bd7-8ee9-53171952d812","fraud_guarantee":{"guarantee_requested":"1","transaction_guaranteed":"1"}}},"examples":{"Example":{"title":"Example","value":{"request":{"participant_id":"12345","timestamp":"1721337427"},"response":{"status":"100","message":"Success","duration":"0.074021816253662"},"transaction":{"score":"3000","risk_assessment_token":"de1a802d-e6d3-4bd7-8ee9-53171952d812","fraud_guarantee":{"guarantee_requested":"1","transaction_guaranteed":"1"}}}}},"exampleType":"examples"}},"exampleType":"examples"},"708fb346-08a3-4254-a894-58a0e2db0575":{"description":"Validation error","content":{"application/json":{"schema":{"type":"object","properties":{"request":{"type":"object","properties":{"participant_id":{"type":"string","example":"12345","uniqueKey":"request.participant_id","typeLabel":"string"},"timestamp":{"type":"string","example":"1721337427","uniqueKey":"request.timestamp","typeLabel":"string"}},"uniqueKey":"request","typeLabel":"object"},"response":{"type":"object","properties":{"status":{"type":"string","example":"400","uniqueKey":"response.status","typeLabel":"string"},"message":{"type":"string","example":"Validation Error","uniqueKey":"response.message","typeLabel":"string"}},"uniqueKey":"response","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"request":{"participant_id":"12345","timestamp":"1721337427"},"response":{"status":"400","message":"Validation Error"}},"examples":{"Example":{"title":"Example","value":{"request":{"participant_id":"12345","timestamp":"1721337427"},"response":{"status":"400","message":"Validation Error"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"ff5c20b2-f56c-4b33-b5e0-497d0daf44c3":{"HmacAuth":{"type":"http","scheme":"hmac-sha512","description":"HMAC-SHA512 signed Authorization header. See the Authentication page for the complete signing guide.","scopes":[]}}},"servers":{"c1f05497-00df-4f38-8619-d18783d07787":{"url":"https://payapi-sandbox.ingo.money","description":"Sandbox"},"66ffb805-616a-4426-a4be-15f431eb301f":{"url":"https://payapi.ingo.money","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"hmac-sha512","description":"HMAC-SHA512 signed Authorization header. See the Authentication page for the complete signing guide.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"HMAC-SHA512 signed Authorization header. See the Authentication page for the complete signing guide.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"HmacAuth","name":"Authorization"}],"title":"HmacAuth"}]},"originalFileLocation":"specs/ingopay-risk.yaml"},"subdomain":"ingopayments","siteName":"Ingo Payments Developer Hub","title":"Risk Score - Ingo Payments Developer Hub","contextualStarterQuestions":[{"_id":"69f1321120d5d5d066b6f70b","deploymentId":"69de7f66155c3ba96bc71012","questionText":"What is a risk assessment token?","status":"active","generatedBy":"contextual","path":"docs/ingopay/risk/risk-score","createdAt":"2026-04-28T22:17:53.325Z","updatedAt":"2026-04-28T22:17:53.325Z","__v":0},{"_id":"69f1321120d5d5d066b6f70a","deploymentId":"69de7f66155c3ba96bc71012","questionText":"How do I evaluate transaction risk?","status":"active","generatedBy":"contextual","path":"docs/ingopay/risk/risk-score","createdAt":"2026-04-28T22:17:53.325Z","updatedAt":"2026-04-28T22:17:53.325Z","__v":0},{"_id":"69f1321120d5d5d066b6f70c","deploymentId":"69de7f66155c3ba96bc71012","questionText":"How do I use risk scores?","status":"active","generatedBy":"contextual","path":"docs/ingopay/risk/risk-score","createdAt":"2026-04-28T22:17:53.325Z","updatedAt":"2026-04-28T22:17:53.325Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-28T22:17:29.805Z","originalFileLocation":"docs/ingopay/risk/risk-score.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Evaluate the risk of a transaction and obtain a risk assessment token for use in subsequent process calls.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Ingo Payments Developer Hub\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ingopayments/iHiCiEx6lpf9Tbeq/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/ingopayments/iHiCiEx6lpf9Tbeq/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ingopayments/iHiCiEx6lpf9Tbeq/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ingopayments/iHiCiEx6lpf9Tbeq/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ingopayments/iHiCiEx6lpf9Tbeq/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ingopayments/iHiCiEx6lpf9Tbeq/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ingopayments/iHiCiEx6lpf9Tbeq/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ingopayments/iHiCiEx6lpf9Tbeq/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ingopayments/iHiCiEx6lpf9Tbeq/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Risk Score - Ingo Payments Developer Hub\">\u003cmeta data-mint-head property=\"og:description\" content=\"Evaluate the risk of a transaction and obtain a risk assessment token for use in subsequent process calls.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ingo Payments Developer Hub\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.ingopayments.com/docs/ingopay/risk/risk-score\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ingopayments.mintlify.app/_mintlify/api/og/v2?division=Risk+%26+Compliance\u0026amp;title=Risk+Score\u0026amp;description=Evaluate+the+risk+of+a+transaction+and+obtain+a+risk+assessment+token+for+use+in+subsequent+process+calls.\u0026amp;theme=ffb6732ea583e2d7404edaa7\u0026amp;signature=810bc623955a1efbe8a3e0ee62f3544fe941687fc16fe265ebe89d4258c54613\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Risk Score - Ingo Payments Developer Hub\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Evaluate the risk of a transaction and obtain a risk assessment token for use in subsequent process calls.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ingopayments.mintlify.app/_mintlify/api/og/v2?division=Risk+%26+Compliance\u0026amp;title=Risk+Score\u0026amp;description=Evaluate+the+risk+of+a+transaction+and+obtain+a+risk+assessment+token+for+use+in+subsequent+process+calls.\u0026amp;theme=ffb6732ea583e2d7404edaa7\u0026amp;signature=810bc623955a1efbe8a3e0ee62f3544fe941687fc16fe265ebe89d4258c54613\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/ingopayments/iHiCiEx6lpf9Tbeq/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ingo Payments Developer Hub\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#23ad4b\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.ingopayments.com/docs/ingopay/risk/risk-score\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/ingopay/risk/risk-score.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.ingopayments.com/#organization\",\"name\":\"Ingo Payments Developer Hub\",\"url\":\"https://developers.ingopayments.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ingopayments/iShoHhbLzbG-YOtN/logo/light.svg?fit=max\u0026auto=format\u0026n=iShoHhbLzbG-YOtN\u0026q=85\u0026s=556c65165f3a5daf3e33eaf145664046\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.ingopayments.com#website\",\"name\":\"Ingo Payments Developer Hub\",\"url\":\"https://developers.ingopayments.com\",\"publisher\":{\"@id\":\"https://developers.ingopayments.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.ingopayments.com/docs/ingopay/risk/risk-score#webpage\",\"url\":\"https://developers.ingopayments.com/docs/ingopay/risk/risk-score\",\"name\":\"Risk Score\",\"description\":\"Evaluate the risk of a transaction and obtain a risk assessment token for use in subsequent process calls.\",\"dateModified\":\"2026-04-28T22:17:29.805Z\",\"isPartOf\":{\"@id\":\"https://developers.ingopayments.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.ingopayments.com/docs/ingopay/risk/risk-score#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.ingopayments.com/docs/ingopay/risk/risk-score#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://developers.ingopayments.com/docs/ingopay/verify/card\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Risk \u0026 Compliance\",\"item\":\"https://developers.ingopayments.com/docs/ingopay/risk/overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Risk Score\",\"item\":\"https://developers.ingopayments.com/docs/ingopay/risk/risk-score\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.ingopayments.com/docs/ingopay/risk/risk-score#apireference\",\"headline\":\"Risk Score\",\"name\":\"Risk Score\",\"description\":\"Evaluate the risk of a transaction and obtain a risk assessment token for use in subsequent process calls.\",\"url\":\"https://developers.ingopayments.com/docs/ingopay/risk/risk-score\",\"mainEntityOfPage\":{\"@id\":\"https://developers.ingopayments.com/docs/ingopay/risk/risk-score#webpage\"},\"dateModified\":\"2026-04-28T22:17:29.805Z\",\"publisher\":{\"@id\":\"https://developers.ingopayments.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.ingopayments.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ingo Payments Developer Hub\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Ingo Payments Developer Hub","nav":{"global":{},"tabs":[{"tab":"Hub","pages":[{"title":"Hub","href":"/docs/hub/overview"}]},{"tab":"IngoPay API","groups":[{"group":"Overview","pages":[{"title":"IngoPay API","mode":"wide","href":"/docs/ingopay/overview"},{"title":"Quick Start","href":"/docs/ingopay/quick-start"},{"title":"Payment Methods","href":"/docs/ingopay/payment-methods"},{"title":"Testing","href":"/docs/ingopay/testing"}]},{"group":"API Reference","pages":[{"group":"Account Tokenization","expanded":false,"pages":[{"title":"Verify — Card","sidebarTitle":"Debit \u0026 Prepaid Card","openapi":"specs/ingopay-verify-card.yaml POST /gateway/verify--card","href":"/docs/ingopay/verify/card"},{"title":"Verify — ACH","sidebarTitle":"Bank Account · All Speeds","openapi":"specs/ingopay-verify-ach.yaml POST /gateway/verify--ach","href":"/docs/ingopay/verify/ach"},{"title":"Verify — BillPay","sidebarTitle":"BillPay","openapi":"specs/ingopay-verify-billpay.yaml POST /gateway/verify--billpay","href":"/docs/ingopay/verify/billpay"},{"title":"Verify — Check by Mail","sidebarTitle":"Check by Mail","openapi":"specs/ingopay-verify-check.yaml POST /gateway/verify--check","href":"/docs/ingopay/verify/check"},{"title":"Verify — PayPal / Venmo","sidebarTitle":"PayPal \u0026 Venmo","openapi":"specs/ingopay-verify-paypal-venmo.yaml POST /gateway/verify--paypal-venmo","href":"/docs/ingopay/verify/paypal-venmo"},{"title":"Verify — Retail Card Present","sidebarTitle":"Card · In-Person","openapi":"specs/ingopay-verify-retail-card-present.yaml POST /gateway/verify--retail","href":"/docs/ingopay/verify/retail-card-present"}]},{"group":"Push Payments","expanded":false,"pages":[{"title":"Process — Card","sidebarTitle":"To Card","openapi":"specs/ingopay-process-card.yaml POST /gateway/process--card","href":"/docs/ingopay/process/card"},{"title":"Process — ACH","sidebarTitle":"To Bank Account · All Speeds","openapi":"specs/ingopay-process-ach.yaml POST /gateway/process--ach","href":"/docs/ingopay/process/ach"},{"title":"Process — BillPay","sidebarTitle":"Bill Payment","openapi":"specs/ingopay-process-billpay.yaml POST /gateway/process--billpay","href":"/docs/ingopay/process/billpay"},{"title":"Process — Check by Mail","sidebarTitle":"Check by Mail","openapi":"specs/ingopay-process-check.yaml POST /gateway/process--check","href":"/docs/ingopay/process/check"},{"title":"Process — PayPal / Venmo","sidebarTitle":"To PayPal \u0026 Venmo","openapi":"specs/ingopay-process-paypal-venmo.yaml POST /gateway/process--paypal-venmo","href":"/docs/ingopay/process/paypal-venmo"},{"title":"Process — Retail Card Present","sidebarTitle":"Card — In-Person","openapi":"specs/ingopay-process-retail-card-present.yaml POST /gateway/process--retail","href":"/docs/ingopay/process/retail-card-present"}]},{"group":"Pull Payments","expanded":false,"pages":[{"title":"Debit Process — Card","sidebarTitle":"From Card","openapi":"specs/ingopay-debit-process-card.yaml POST /gateway/v12/debit/process--card","href":"/docs/ingopay/debit/process-card"},{"title":"Debit Process — ACH","sidebarTitle":"From Bank Account","openapi":"specs/ingopay-debit-process-ach.yaml POST /gateway/v12/debit/process--ach","href":"/docs/ingopay/debit/process-ach"}]},{"group":"Risk \u0026 Compliance","expanded":false,"pages":[{"title":"Risk Integration Overview","href":"/docs/ingopay/risk/overview"},{"title":"Risk Session","description":"Initialize a risk evaluation session token for use with the Risk Score endpoint.","openapi":"specs/ingopay-risk.yaml POST /risk/risksession/v2","href":"/docs/ingopay/risk/risk-session"},{"title":"Risk Score","openapi":"specs/ingopay-risk.yaml POST /risk/riskscore/v2","href":"/docs/ingopay/risk/risk-score"}]},{"group":"Ancillary Services","expanded":false,"pages":[{"title":"Search","sidebarTitle":"Biller Search","description":"Search the Ingo biller/payee database and retrieve the payee_id required for BillPay verify.","openapi":"specs/ingopay-search-v11.yaml POST /gateway/search","href":"/docs/ingopay/ancillary/search"},{"title":"Check Stop","sidebarTitle":"Stop a Check","openapi":"specs/ingopay-check-stop.yaml POST /gateway/checkstop","href":"/docs/ingopay/ancillary/check-stop"},{"title":"Check Cancel","sidebarTitle":"Cancel a Check","openapi":"specs/ingopay-check-cancel.yaml POST /gateway/checkcancel","href":"/docs/ingopay/ancillary/check-cancel"},{"title":"Retrieve Account Data via Open Banking","sidebarTitle":"Open Banking Account Data","openapi":"specs/ingopay-open-banking-account.yaml POST /gateway/v1/open-banking-account","href":"/docs/ingopay/ancillary/open-banking-account"}]}]},{"group":"Webhooks","pages":[{"title":"Webhooks","sidebarTitle":"Overview","href":"/docs/ingopay/webhooks/overview"},{"group":"Webhooks","pages":[{"asyncapi":"specs/asyncapi-ingopay.yaml GatewayTransactionRecipientPaymentNoticeSettlementAdjustment","href":"/ingopay-webhooks/webhooks/settlement-adjustment","title":"Settlement Adjustment","version":null},{"asyncapi":"specs/asyncapi-ingopay.yaml GatewayTransactionRecipientPaymentNoticeAchNocV1","href":"/ingopay-webhooks/webhooks/ach-notice-of-change","title":"ACH Notice of Change","version":null},{"asyncapi":"specs/asyncapi-ingopay.yaml GatewayTransactionRecipientPaymentStatusCheckIssued","href":"/ingopay-webhooks/webhooks/check-issued","title":"Check Issued","version":null},{"asyncapi":"specs/asyncapi-ingopay.yaml GatewayTransactionRecipientPaymentStatusCheckPaid","href":"/ingopay-webhooks/webhooks/check-paid","title":"Check Paid","version":null},{"asyncapi":"specs/asyncapi-ingopay.yaml GatewayTransactionRecipientPaymentStatusCheckCanceled","href":"/ingopay-webhooks/webhooks/check-canceled","title":"Check Canceled","version":null},{"asyncapi":"specs/asyncapi-ingopay.yaml GatewayTransactionRecipientPaymentStatusCheckStopped","href":"/ingopay-webhooks/webhooks/check-stopped","title":"Check Stopped","version":null},{"asyncapi":"specs/asyncapi-ingopay.yaml GatewayTransactionRecipientStatusPaymentCheckReturned","href":"/ingopay-webhooks/webhooks/check-returned","title":"Check Returned","version":null},{"asyncapi":"specs/asyncapi-ingopay.yaml GatewayTransactionRecipientPaymentStatusReturned","href":"/ingopay-webhooks/webhooks/payment-returned","title":"Payment Returned","version":null},{"asyncapi":"specs/asyncapi-ingopay.yaml GatewayTransactionRecipientVerificationOfacStatusSuspended","href":"/ingopay-webhooks/webhooks/ofac-suspended","title":"OFAC Suspended","version":null},{"asyncapi":"specs/asyncapi-ingopay.yaml GatewayTransactionRecipientVerificationOfacStatusCleared","href":"/ingopay-webhooks/webhooks/ofac-cleared","title":"OFAC Cleared","version":null},{"asyncapi":"specs/asyncapi-ingopay.yaml GatewayTransactionRecipientVerificationOfacStatusFailure","href":"/ingopay-webhooks/webhooks/ofac-failure","title":"OFAC Failure","version":null}]}]}]},{"tab":"Embedded Account Capture","pages":[{"title":"Embedded Account Capture","href":"/docs/iframe/overview"}]},{"tab":"Notify — Classic","pages":[{"title":"Notify — Classic","href":"/docs/notify-classic/overview"}]},{"tab":"Notify — Managed Parties","pages":[{"title":"Notify — Managed Parties","href":"/docs/notify-managed/overview"}]},{"tab":"Banking Platform","pages":[{"title":"Banking Platform","href":"/docs/banking/overview"}]},{"tab":"Check Risk Management Services","hidden":true,"pages":[{"title":"Check Risk Management Services","href":"/docs/crms/overview"}]}]},"title":"Risk Score - Ingo Payments Developer Hub","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-CBCH2P7b.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}