Qodex.ai
Qodex.ai
Introduction
Core Exchange
test_user_1-all accounts list
all accounts
test_user_1-checking acct details
balancescontactspayment networkstransactions
test_user_1-savings acct details
balancescontactspayment networkstransactions
test_user_1-any other deposit acct type
balancescontactstransactions
test_user_1-student loan details
in-depth balancescontactstransactions
test_user_1-mortgage loan details
in-depth balancescontactstransactions
test_user_1-any other loan acct type
balancescontactstransactions
test_user_1-credit card details
in-depth balancescontactstransactions
test_user_1-any other line-of-credit acct type
balancescontactstransactions
test_user_1-investment acct details
balancescontactstransactions
Plaid API Endpoints
Link Tokens-Income Link Tokens
Create Link Token - Bank Income
Link Tokens
Create Link Token - Plaid CheckGet Link Token (for Hosted Link and Multi-Item Link)
Items-Item Creation
Create Item Custom [Sandbox Only]Exchange Token
Items-Item Management
Retrieve ItemRetrieve an Item's AccountsRotate Access TokenUpdate an Item's WebhookSimulate ITEM_LOGIN_REQUIRED [Sandbox only]Remove ItemSimulate automated deposit verification [Sandbox only]
Auth-Using an Auth payment partner
Create processor token (for Sandbox)Create processor token (for Development / Production)Create Stripe bank account token
Auth
Create Auth public token [Sandbox Only]Exchange public token for access tokenRetrieve Auth data (account + routing number)
Balance
Create Auth + Balance public token [Sandbox Only]Exchange public token for access tokenRetrieve Balance
Identity
Create Identity public token [Sandbox only]Exchange public token for access tokenRetrieve IdentityMatch Identity
Transactions
Create Transactions public token [Sandbox Only]Exchange public token for access tokenRetrieve Transactions (/transactions/sync)Retrieve Transactions (/transactions/get)Retrieve recurring transaction streamsForce refresh TransactionsRetrieve Legacy Categories
Assets
Create Assets public token [Sandbox only]Exchange public token for access tokenCreate Asset ReportRetrieve an Asset Report (JSON)Retrieve an Asset Report (PDF)Create Audit CopyRemove Asset ReportRemove Audit Copy Refresh Asset Report
Liabilities
Create Liabilities public token [Sandbox only]Exchange public token for access tokenRetrieve Liabilities
Investments
Create Investments public token [Sandbox only] CopyExchange public token for access tokenRetrieve Investments HoldingsRefresh Investments data
Investments move (beta)
Create Link Token for Investments move (beta)Exchange public token for access tokenGet investments details
Income-Bank Income
(Start here) Create User TokenInitialize User Token for Bank Income [Sandbox Only]Retrieve Bank Income as a PDFRetrieve Bank Income
Income-Document Income
(Start here) Create User TokenInitialize User Token for Document Income [Sandbox Only]Retrieve parsed data from uploaded W2s, 1099s, or pay stubsRetrieve parsed data from uploaded bank statementsEnable or disable document parsing or fraud risk detectionDetect potentially fraudulent uploaded income documents
Income-Payroll Income
(Start here) Create User TokenInitialize User Token for Payroll Income [Sandbox Only]Retrieve Payroll Income
Income
Enable or disable webhook notifications for a userFire Income webhook [Sandbox only]
Plaid Check
Create User TokenCreate Link TokenGet Base Report (JSON)Get Base Report and Income Report (PDF)Get Income InsightsGet Partner InsightsRefresh Check Report
User management (for Check, Income, and Multi-Item Link)
Get Items associated with a user tokenUpdate user tokenRemove user token
Transfer-[START HERE] Create and send a transfer
Create Transfer public token [Sandbox only]Exchange public token for access tokenRetrieve an Item's AccountsAuthorize a transferInitiate a transfer
Transfer-View or modify transfers
Get a transferList transfersCancel a transfer
Transfer-Transfer events
List transfer eventsSync transfer eventsSimulate a transfer event in Sandbox
Transfer-Transfer sweeps
Get a sweepSimulate a sweep in SandboxList transfer sweeps
Transfer-Transfer UI
Create Transfer intentGet existing Transfer intent
Transfer-Transfer metrics and limits
Get Transfer MetricsGet Transfer configuration and limits
Transfer-Recurring Transfers
Create recurring transferGet recurring transferList recurring transfersCancel recurring transfer
Transfer-Ledger
Make a Ledger depositMake a Ledger withdrawalGet a Ledger balance(Platform Payments) Move funds between Ledgers(Sandbox) Simulate a ledger deposit(Sandbox) Simulate a ledger withdrawal(Sandbox) Simulate converting pending balance to available balance
Transfer-Refunds
Create a refundGet a refundCancel a refund(Sandbox) Simulate a refund event
Transfer-Platform payments
Create an originatorGet an orginatorList originatorsChange the funding account for an originatorCreate an originator onboarding questionnaireSubmit diligence information you collected about an originatorUpload a document showing your due diligence performed on the originator
Transfer-(Sandbox) Simulate the passage of time
Advance a test clockGet a test clockList test clocks
Transfer
See if an Item supports real-time paymentsMigrate A/R number pair to Transfer (account manager must enable)
Signal
Create Auth public token for use with Signal [Sandbox only]Exchange public token for access token(Optional) Initialize an existing Auth Item with SignalRetrieve account id to use with SignalEvaluate a planned ACH transactionReport whether you initiated an ACH transactionReport an ACH return
Payment Initiation (UK and Europe only)
Create Payment RecipientCreate PaymentCreate Link Token - Payment InitiationGet PaymentList PaymentsGet Payment RecipientList Payment RecipientsCreate Payment ConsentGet Payment ConsentRevoke Payment ConsentExecute Consent Based Payment
Virtual Accounts (wallets) (UK and Europe only)
Create walletGet walletList walletsExecute wallet transactionGet wallet transactionList wallet transactions
Identity Verification
Create a new Identity VerificationRetrieve an Identity VerificationList Identity VerificationsRetry an Identity Verification
Monitor-Individual Watchlist Screenings
List Individual Watchlist Screening ProgramsGet Individual Watchlist Screening ProgramCreate a Watchlist Screening for an IndividualGet an Individual Watchlist ScreeningUpdate Individual Watchlist ScreeningList History for Individual Watchlist ScreeningsList Individual Watchlist ScreeningsList Hits for Individual Watchlist ScreeningCreate a Review for an Individual Watchlist ScreeningList Reviews for Individual Watchlist Screenings
Monitor-Entity Watchlist Screenings
List Entity Watchlist Screening ProgramsGet Entity Watchlist Screening ProgramCreate a Watchlist Screening for an EntityGet an Entity ScreeningUpdate an Entity ScreeningList History for Entity Watchlist ScreeningsList Entity Watchlist ScreeningsList Hits for Entity Watchlist ScreeningsCreate a Review for an Entity Watchlist ScreeningList Reviews for Entity Watchlist Screenings
Monitor-Manage Dashboard Users
List dashboard usersRetrieve a dashboard user
Enrich
Enrich transactions
Layer
Create Link TokenGet user account
Statements
Create Statements public token [Sandbox only]Exchange public token for access tokenList statementsRefresh statementsDownload a statement PDF
Institutions
Search Institution by NameSearch Institution by IDRetrieve Insitution List
Webhooks
Fire Webhook [Sandbox Only]Get Webhook Verification Key
Reseller partners
Create an end customerGet the status of an end customerGet OAuth registration status for an end customerEnable an end customer in ProductionRemove an end customer
Processor tokens
Create a Sandbox test Item and processor tokenCreate processor token (for Development / Production)Create Stripe bank account token
Endpoints for use by Processors only-Auth/Balance/Identity
Get Auth dataGet Identity dataMatch Identity dataGet Balance data
Endpoints for use by Processors only-Signal
Evaluate a planned ACH transactionReport whether you initiated an ACH transactionReport an ACH return(Optional) Initialize an existing Auth Item with Signal
Endpoints for use by Processors only-Transactions
Retrieve Transactions By Incremental UpdatesRetrieve Transactions by Date RangeRetrieve recurring transaction streamsForce refresh Transactions
Endpoints for use by Processors only
Get account dataUpdate an Item's Webhook
Beacon (beta)
Create Beacon userGet Beacon userCreate Beacon fraud report
Introduction
Core Exchange
test_user_1-all accounts list
all accounts
test_user_1-checking acct details
balancescontactspayment networkstransactions
test_user_1-savings acct details
balancescontactspayment networkstransactions
test_user_1-any other deposit acct type
balancescontactstransactions
test_user_1-student loan details
in-depth balancescontactstransactions
test_user_1-mortgage loan details
in-depth balancescontactstransactions
test_user_1-any other loan acct type
balancescontactstransactions
test_user_1-credit card details
in-depth balancescontactstransactions
test_user_1-any other line-of-credit acct type
balancescontactstransactions
test_user_1-investment acct details
balancescontactstransactions
Plaid API Endpoints
Link Tokens-Income Link Tokens
Create Link Token - Bank Income
Link Tokens
Create Link Token - Plaid CheckGet Link Token (for Hosted Link and Multi-Item Link)
Items-Item Creation
Create Item Custom [Sandbox Only]Exchange Token
Items-Item Management
Retrieve ItemRetrieve an Item's AccountsRotate Access TokenUpdate an Item's WebhookSimulate ITEM_LOGIN_REQUIRED [Sandbox only]Remove ItemSimulate automated deposit verification [Sandbox only]
Auth-Using an Auth payment partner
Create processor token (for Sandbox)Create processor token (for Development / Production)Create Stripe bank account token
Auth
Create Auth public token [Sandbox Only]Exchange public token for access tokenRetrieve Auth data (account + routing number)
Balance
Create Auth + Balance public token [Sandbox Only]Exchange public token for access tokenRetrieve Balance
Identity
Create Identity public token [Sandbox only]Exchange public token for access tokenRetrieve IdentityMatch Identity
Transactions
Create Transactions public token [Sandbox Only]Exchange public token for access tokenRetrieve Transactions (/transactions/sync)Retrieve Transactions (/transactions/get)Retrieve recurring transaction streamsForce refresh TransactionsRetrieve Legacy Categories
Assets
Create Assets public token [Sandbox only]Exchange public token for access tokenCreate Asset ReportRetrieve an Asset Report (JSON)Retrieve an Asset Report (PDF)Create Audit CopyRemove Asset ReportRemove Audit Copy Refresh Asset Report
Liabilities
Create Liabilities public token [Sandbox only]Exchange public token for access tokenRetrieve Liabilities
Investments
Create Investments public token [Sandbox only] CopyExchange public token for access tokenRetrieve Investments HoldingsRefresh Investments data
Investments move (beta)
Create Link Token for Investments move (beta)Exchange public token for access tokenGet investments details
Income-Bank Income
(Start here) Create User TokenInitialize User Token for Bank Income [Sandbox Only]Retrieve Bank Income as a PDFRetrieve Bank Income
Income-Document Income
(Start here) Create User TokenInitialize User Token for Document Income [Sandbox Only]Retrieve parsed data from uploaded W2s, 1099s, or pay stubsRetrieve parsed data from uploaded bank statementsEnable or disable document parsing or fraud risk detectionDetect potentially fraudulent uploaded income documents
Income-Payroll Income
(Start here) Create User TokenInitialize User Token for Payroll Income [Sandbox Only]Retrieve Payroll Income
Income
Enable or disable webhook notifications for a userFire Income webhook [Sandbox only]
Plaid Check
Create User TokenCreate Link TokenGet Base Report (JSON)Get Base Report and Income Report (PDF)Get Income InsightsGet Partner InsightsRefresh Check Report
User management (for Check, Income, and Multi-Item Link)
Get Items associated with a user tokenUpdate user tokenRemove user token
Transfer-[START HERE] Create and send a transfer
Create Transfer public token [Sandbox only]Exchange public token for access tokenRetrieve an Item's AccountsAuthorize a transferInitiate a transfer
Transfer-View or modify transfers
Get a transferList transfersCancel a transfer
Transfer-Transfer events
List transfer eventsSync transfer eventsSimulate a transfer event in Sandbox
Transfer-Transfer sweeps
Get a sweepSimulate a sweep in SandboxList transfer sweeps
Transfer-Transfer UI
Create Transfer intentGet existing Transfer intent
Transfer-Transfer metrics and limits
Get Transfer MetricsGet Transfer configuration and limits
Transfer-Recurring Transfers
Create recurring transferGet recurring transferList recurring transfersCancel recurring transfer
Transfer-Ledger
Make a Ledger depositMake a Ledger withdrawalGet a Ledger balance(Platform Payments) Move funds between Ledgers(Sandbox) Simulate a ledger deposit(Sandbox) Simulate a ledger withdrawal(Sandbox) Simulate converting pending balance to available balance
Transfer-Refunds
Create a refundGet a refundCancel a refund(Sandbox) Simulate a refund event
Transfer-Platform payments
Create an originatorGet an orginatorList originatorsChange the funding account for an originatorCreate an originator onboarding questionnaireSubmit diligence information you collected about an originatorUpload a document showing your due diligence performed on the originator
Transfer-(Sandbox) Simulate the passage of time
Advance a test clockGet a test clockList test clocks
Transfer
See if an Item supports real-time paymentsMigrate A/R number pair to Transfer (account manager must enable)
Signal
Create Auth public token for use with Signal [Sandbox only]Exchange public token for access token(Optional) Initialize an existing Auth Item with SignalRetrieve account id to use with SignalEvaluate a planned ACH transactionReport whether you initiated an ACH transactionReport an ACH return
Payment Initiation (UK and Europe only)
Create Payment RecipientCreate PaymentCreate Link Token - Payment InitiationGet PaymentList PaymentsGet Payment RecipientList Payment RecipientsCreate Payment ConsentGet Payment ConsentRevoke Payment ConsentExecute Consent Based Payment
Virtual Accounts (wallets) (UK and Europe only)
Create walletGet walletList walletsExecute wallet transactionGet wallet transactionList wallet transactions
Identity Verification
Create a new Identity VerificationRetrieve an Identity VerificationList Identity VerificationsRetry an Identity Verification
Monitor-Individual Watchlist Screenings
List Individual Watchlist Screening ProgramsGet Individual Watchlist Screening ProgramCreate a Watchlist Screening for an IndividualGet an Individual Watchlist ScreeningUpdate Individual Watchlist ScreeningList History for Individual Watchlist ScreeningsList Individual Watchlist ScreeningsList Hits for Individual Watchlist ScreeningCreate a Review for an Individual Watchlist ScreeningList Reviews for Individual Watchlist Screenings
Monitor-Entity Watchlist Screenings
List Entity Watchlist Screening ProgramsGet Entity Watchlist Screening ProgramCreate a Watchlist Screening for an EntityGet an Entity ScreeningUpdate an Entity ScreeningList History for Entity Watchlist ScreeningsList Entity Watchlist ScreeningsList Hits for Entity Watchlist ScreeningsCreate a Review for an Entity Watchlist ScreeningList Reviews for Entity Watchlist Screenings
Monitor-Manage Dashboard Users
List dashboard usersRetrieve a dashboard user
Enrich
Enrich transactions
Layer
Create Link TokenGet user account
Statements
Create Statements public token [Sandbox only]Exchange public token for access tokenList statementsRefresh statementsDownload a statement PDF
Institutions
Search Institution by NameSearch Institution by IDRetrieve Insitution List
Webhooks
Fire Webhook [Sandbox Only]Get Webhook Verification Key
Reseller partners
Create an end customerGet the status of an end customerGet OAuth registration status for an end customerEnable an end customer in ProductionRemove an end customer
Processor tokens
Create a Sandbox test Item and processor tokenCreate processor token (for Development / Production)Create Stripe bank account token
Endpoints for use by Processors only-Auth/Balance/Identity
Get Auth dataGet Identity dataMatch Identity dataGet Balance data
Endpoints for use by Processors only-Signal
Evaluate a planned ACH transactionReport whether you initiated an ACH transactionReport an ACH return(Optional) Initialize an existing Auth Item with Signal
Endpoints for use by Processors only-Transactions
Retrieve Transactions By Incremental UpdatesRetrieve Transactions by Date RangeRetrieve recurring transaction streamsForce refresh Transactions
Endpoints for use by Processors only
Get account dataUpdate an Item's Webhook
Beacon (beta)
Create Beacon userGet Beacon userCreate Beacon fraud report
HomeCore Exchangetest_user_1-savings acct detailscontacts

contacts

GET https://api.{{YOUR_ORGANIZATION}}/fdx/v5/accounts/{{ACCT_ID_SAVINGS}}/contact

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring
Previous
balances
Next
payment networks