# Lead | API Docs

> Documentation on integrating with Lead.

## Docs

- [Controls](https://docs.lead.bank/api-integrations/account-number/controls.md): Block or allow transactions at the account number level.
- [Overview](https://docs.lead.bank/api-integrations/account-number/overview.md): Create and assign account numbers for your end customers.
- [Statuses](https://docs.lead.bank/api-integrations/account-number/statuses.md): Description of statuses and lifecycle for account numbers.
- [Best Practices](https://docs.lead.bank/api-integrations/accounts/best-practices.md): Best practices for integrating with the Accounts API.
- [Overview](https://docs.lead.bank/api-integrations/accounts/overview.md): Report account data for credit and deposit products.
- [Validations](https://docs.lead.bank/api-integrations/accounts/validations.md): Validation rules for the Accounts API.
- [Notification of Change](https://docs.lead.bank/api-integrations/ach/notification-of-change.md): Understand Nacha's non-monetary Notification of Change message.
- [Overview](https://docs.lead.bank/api-integrations/ach/overview.md): Receive or send ACH transfers through the FedACH network.
- [Processing Windows](https://docs.lead.bank/api-integrations/ach/processing-windows.md): Timing of ACH processing and system behavior.
- [Returns & Reversals](https://docs.lead.bank/api-integrations/ach/returns-and-reversals.md): Details about processing or receiving ACH returns.
- [Sandbox Simulation](https://docs.lead.bank/api-integrations/ach/sandbox-simulation.md): Test ACH transactions to a posted state.
- [Statuses](https://docs.lead.bank/api-integrations/ach/statuses.md): Description of ACH statuses and transitions.
- [Validations](https://docs.lead.bank/api-integrations/ach/validations.md): Best practices to reduce ACH validation exceptions.
- [Best Practices](https://docs.lead.bank/api-integrations/applications/best-practices.md): Best practices for integrating with the Applications API.
- [Overview](https://docs.lead.bank/api-integrations/applications/overview.md): Submit terminal credit application data for compliance reporting.
- [Validations](https://docs.lead.bank/api-integrations/applications/validations.md): Validation rules for the Applications API.
- [Overview](https://docs.lead.bank/api-integrations/entity/overview.md): Legal persons or organizations related to Lead products.
- [Roles](https://docs.lead.bank/api-integrations/entity/roles.md): Govern which financial products an entity may use.
- [Troubleshooting](https://docs.lead.bank/api-integrations/entity/troubleshooting.md): The most common errors when calling the Entity API.
- [Workflow](https://docs.lead.bank/api-integrations/entity/workflow.md): How to create or update entities.
- [Errors](https://docs.lead.bank/api-integrations/errors.md): Understand how Lead handles errors and error messages.
- [Idempotency](https://docs.lead.bank/api-integrations/idempotency.md): Safely retry requests without creating duplicate operations.
- [Overview](https://docs.lead.bank/api-integrations/instant-payments/overview.md): Receive or send Instant Payments through the FedNow network.
- [Receiving & Returning Instant Payments](https://docs.lead.bank/api-integrations/instant-payments/receiving-and-returning.md): Configure your system to receive and return Instant Payments.
- [Sending Instant Payments](https://docs.lead.bank/api-integrations/instant-payments/sending-instant-payments.md): Configure your system to send Instant Payments.
- [Overview](https://docs.lead.bank/api-integrations/internal-transfer/overview.md): Move money between your own accounts held at Lead.
- [Overview](https://docs.lead.bank/api-integrations/lending/overview.md): Originate and disburse loans.
- [Overview](https://docs.lead.bank/api-integrations/originators/overview.md): Create and manage ACH origination parameters.
- [Overview & Auth](https://docs.lead.bank/api-integrations/overview.md): Get started with Lead's APIs
- [Webhooks & Events](https://docs.lead.bank/api-integrations/webhooks.md): Learn how to receive webhooks and review various events.
- [USD International Wires](https://docs.lead.bank/api-integrations/wire/international-wires.md): Send and receive USD international wires.
- [Overview](https://docs.lead.bank/api-integrations/wire/overview.md): Receive or send wire transfers through the Fedwire network.
- [Processing Windows](https://docs.lead.bank/api-integrations/wire/processing-windows.md): Understand when wires can be processed.
- [Return Codes](https://docs.lead.bank/api-integrations/wire/rejection-and-return-codes.md): Details about processing or receiving wire returns.
- [Statuses](https://docs.lead.bank/api-integrations/wire/statuses.md): Description of wire statuses and transitions.
- [Activate an Account Number](https://docs.lead.bank/api-reference/endpoint/account-number/activate-an-account-number.md): Activate an Account Number.
- [Assign an Account Number](https://docs.lead.bank/api-reference/endpoint/account-number/assign-an-account-number.md): Assigns an Account Number with either a ClientCustomerID or EntityID. Only one of these should be provided
- [Cancel an Account Number](https://docs.lead.bank/api-reference/endpoint/account-number/cancel-an-account-number.md): Cancel an Account Number.
- [Create an Account Number](https://docs.lead.bank/api-reference/endpoint/account-number/create-an-account-number.md): Creates an Account Number. Optionally also assigns either a ClientCustomerID or EntityID to the Account Number
- [Deactivate an Account Number](https://docs.lead.bank/api-reference/endpoint/account-number/deactivate-an-account-number.md): Deactivate an Account Number.
- [List all Account Numbers](https://docs.lead.bank/api-reference/endpoint/account-number/list-all-account-number.md): List all Account Numbers.
- [Register an Account Number](https://docs.lead.bank/api-reference/endpoint/account-number/register-an-account-number.md): Registers an Account Number.
- [Retrieve an Account Number](https://docs.lead.bank/api-reference/endpoint/account-number/retrieve-an-account-number.md): Retrieve an Account Number.
- [Update an Account Number](https://docs.lead.bank/api-reference/endpoint/account-number/update-an-account-number.md): Update an Account Number's metadata.
- [Activate an Account](https://docs.lead.bank/api-reference/endpoint/account/activate-an-account.md): Transitions an account from `inactive` to `active` status.
- [Close an Account](https://docs.lead.bank/api-reference/endpoint/account/close-an-account.md): Transitions an account to `closed` status (terminal state). This action cannot be undone.
- [Create an Account](https://docs.lead.bank/api-reference/endpoint/account/create-an-account.md): Creates a new account.
- [Deactivate an Account](https://docs.lead.bank/api-reference/endpoint/account/deactivate-an-account.md): Transitions an account from `active` to `inactive` status.
- [List Account Entity Relationships](https://docs.lead.bank/api-reference/endpoint/account/list-account-entity-relationships.md): Lists all entity relationships for a specific account.
- [Retrieve an Account](https://docs.lead.bank/api-reference/endpoint/account/retrieve-an-account.md): Retrieves a specific account by its ID. Accepts a server-generated ID (account_*).
- [Update an Account](https://docs.lead.bank/api-reference/endpoint/account/update-an-account.md): Updates properties on an existing account.
- [Cancel an ACH](https://docs.lead.bank/api-reference/endpoint/ach/cancel-an-ach.md): Cancel an outgoing ACH.
- [Create an ACH](https://docs.lead.bank/api-reference/endpoint/ach/create-an-ach.md): Creates an outgoing ACH.
- [List all ACH](https://docs.lead.bank/api-reference/endpoint/ach/list-all-ach.md): List all ACH objects.
- [Retrieve an ACH](https://docs.lead.bank/api-reference/endpoint/ach/retrieve-an-ach.md): Retrieve an ACH object.
- [Return an ACH](https://docs.lead.bank/api-reference/endpoint/ach/return-an-ach.md): Issue a return against an incoming ACH.
- [Reverse an ACH](https://docs.lead.bank/api-reference/endpoint/ach/reverse-an-ach.md): Reverse an outgoing ACH.
- [Update an ACH](https://docs.lead.bank/api-reference/endpoint/ach/update-an-ach.md): Update an ACH object.
- [Create an Application](https://docs.lead.bank/api-reference/endpoint/application/create-an-application.md): Creates a new credit application in terminal status.
- [List Application Entity Relationships](https://docs.lead.bank/api-reference/endpoint/application/list-application-entity-relationships.md): Lists all entity relationships for a specific application.
- [Retrieve an Application](https://docs.lead.bank/api-reference/endpoint/application/retrieve-an-application.md): Retrieves a specific application by its ID. Accepts either a server-generated ID (application_*) or client-provided application ID. The server detects the ID type by prefix.
- [Create an Entity](https://docs.lead.bank/api-reference/endpoint/entity/create-an-entity.md): Create an Individual, Sole Prop or Business Entity.
- [Retrieve an Entity by Client Customer ID](https://docs.lead.bank/api-reference/endpoint/entity/retrieve-an-entity-by-client-customer-id.md): Retrieve an entity by the client customer id
- [Retrieve an Entity by Entity ID](https://docs.lead.bank/api-reference/endpoint/entity/retrieve-an-entity-by-entity-id.md): Retrieve an entity by entity id
- [Update an Entity](https://docs.lead.bank/api-reference/endpoint/entity/update-an-entity.md): Certain updates on Entity trigger KYC re-screening, requiring an updated kyc_details.result and kyc_details.screened_at.
- [List all Events](https://docs.lead.bank/api-reference/endpoint/events/list-all-events.md): List all event objects.
- [Retrieve an Event](https://docs.lead.bank/api-reference/endpoint/events/retrieve-an-event.md): Retrieves an event object.
- [Simulate Advance Funding](https://docs.lead.bank/api-reference/endpoint/funding/advance-a-funding.md): Advances a Funding object from processing to posted status in the Sandbox environment.
- [Create a Funding](https://docs.lead.bank/api-reference/endpoint/funding/create-a-funding.md): Creates a Funding object to request that Lead move funds from a Lead GL to the partner's funding FBO account.
- [Retrieve a Funding](https://docs.lead.bank/api-reference/endpoint/funding/retrieve-a-funding.md): Retrieve a Funding object.
- [Cancel an Instant Payment](https://docs.lead.bank/api-reference/endpoint/instant-payment/cancel-an-instant-payment.md): Attempt to cancel an outgoing instant payment that is currently in "created" or "under_review" status.
- [Check Instant Payment Availability](https://docs.lead.bank/api-reference/endpoint/instant-payment/check-instant-payment-availability.md): Check if a given routing number is eligible to receive an instant payment.
- [Create an Instant Payment](https://docs.lead.bank/api-reference/endpoint/instant-payment/create-an-instant-payment.md): Initiates an outgoing instant payment.
- [List all Instant Payments](https://docs.lead.bank/api-reference/endpoint/instant-payment/list-all-instant-payments.md): List instant payments with optional filtering.
- [Reject Return Request for Instant Payment](https://docs.lead.bank/api-reference/endpoint/instant-payment/reject-return-request-for-instant-payment.md): Reject the active return request associated with an incoming instant payment. Returns the updated instant payment object with the status of the active return request set to "rejected".
- [Request Return for Instant Payment](https://docs.lead.bank/api-reference/endpoint/instant-payment/request-return-for-instant-payment.md): Send a return request to the counterparty for a previously posted outgoing instant payment. Returns the updated instant payment object with a new entry in the return_requests array.
- [Retrieve an Instant Payment](https://docs.lead.bank/api-reference/endpoint/instant-payment/retrieve-an-instant-payment.md): Retrieve the details of an instant payment.
- [Return an Instant Payment](https://docs.lead.bank/api-reference/endpoint/instant-payment/return-an-instant-payment.md): Initiates an outgoing instant payment return. If there is an outstanding return request, invoking this endpoint is also understood as accepting the active return request.
- [Create an Internal Transfer](https://docs.lead.bank/api-reference/endpoint/internal-transfer/create-an-internal-transfer-v1.md): Creates an asynchronous Internal Transfer.
- [List all Internal Transfers](https://docs.lead.bank/api-reference/endpoint/internal-transfer/list-all-internal-transfers-v1.md): List all Internal Transfers.
- [Retrieve an Internal Transfer](https://docs.lead.bank/api-reference/endpoint/internal-transfer/retrieve-an-internal-transfer-v1.md): Retrieve an Internal Transfer.
- [Simulate Advance Disbursement](https://docs.lead.bank/api-reference/endpoint/lending-simulation/advance-a-disbursement.md): Advances a disbursement object status in the sandbox environment.
- [Cancel a Disbursement](https://docs.lead.bank/api-reference/endpoint/lending/cancel-a-disbursement.md): Cancel a disbursement.
- [Create a Disbursement](https://docs.lead.bank/api-reference/endpoint/lending/create-a-disbursement.md): Creates a disbursement for a loan
- [Retrieve a Disbursement](https://docs.lead.bank/api-reference/endpoint/lending/retrieve-a-disbursement.md): Retrieve a disbursement object.
- [Get an Access Token](https://docs.lead.bank/api-reference/endpoint/oauth/get-an-access-token.md): Exchange your client credentials for an access code.
- [Activate an Originator](https://docs.lead.bank/api-reference/endpoint/originator/activate-an-originator.md): Activate an Originator.
- [Cancel an Originator](https://docs.lead.bank/api-reference/endpoint/originator/cancel-an-originator.md): Cancel an Originator.
- [Create an Originator](https://docs.lead.bank/api-reference/endpoint/originator/create-an-originator.md)
- [Deactivate an Originator](https://docs.lead.bank/api-reference/endpoint/originator/deactivate-an-originator.md): Deactivate an Originator.
- [List all Originators](https://docs.lead.bank/api-reference/endpoint/originator/list-all-originators.md): List all Originators.
- [Retrieve an Originator](https://docs.lead.bank/api-reference/endpoint/originator/retrieve-an-originator.md): Retrieve an Originator.
- [Update an Originator](https://docs.lead.bank/api-reference/endpoint/originator/update-an-originator.md): Update an Originator's parameters.
- [Simulate Advance ACH](https://docs.lead.bank/api-reference/endpoint/simulation/simulate-advance-ach.md): Advance an ACH in Sandbox.
- [Simulate Advance Wire](https://docs.lead.bank/api-reference/endpoint/simulation/simulate-advance-wire.md): Advance a Wire in Sandbox.
- [Simulate Incoming ACH](https://docs.lead.bank/api-reference/endpoint/simulation/simulate-incoming-ach.md): Simulate an incoming ACH.
- [Simulate Incoming ACH Return](https://docs.lead.bank/api-reference/endpoint/simulation/simulate-incoming-ach-return.md): Simulate an incoming Return.
- [Simulate Incoming Instant Payment](https://docs.lead.bank/api-reference/endpoint/simulation/simulate-incoming-instant-payment.md): Simulate an incoming instant payment.
- [Simulate Incoming Instant Payment Return](https://docs.lead.bank/api-reference/endpoint/simulation/simulate-incoming-instant-payment-return.md): Simulate an incoming instant payment return.
- [Simulate Incoming Instant Payment Return Request](https://docs.lead.bank/api-reference/endpoint/simulation/simulate-incoming-instant-payment-return-request.md): Simulate an incoming instant payment return request.
- [Simulate Incoming Instant Payment Return Request Acceptance](https://docs.lead.bank/api-reference/endpoint/simulation/simulate-incoming-instant-payment-return-request-acceptance.md): Simulate an incoming instant payment return request acceptance.
- [Simulate Incoming Instant Payment Return Request Rejection](https://docs.lead.bank/api-reference/endpoint/simulation/simulate-incoming-instant-payment-return-request-rejection.md): Simulate an incoming instant payment return request rejection.
- [Simulate Incoming Wire](https://docs.lead.bank/api-reference/endpoint/simulation/simulate-incoming-wire.md): Simulate an incoming Wire.
- [Simulate Incoming Wire Return](https://docs.lead.bank/api-reference/endpoint/simulation/simulate-incoming-wire-return.md): Simulate an incoming Wire Return.
- [Create a Subledger Balance](https://docs.lead.bank/api-reference/endpoint/subledger-balance/create-a-subledger-balance.md): Create a Subledger Balance object.
- [Retrieve a Subledger Balance](https://docs.lead.bank/api-reference/endpoint/subledger-balance/retrieve-a-subledger-balance.md): Retrieve a Subledger Balance object.
- [Cancel a Wire](https://docs.lead.bank/api-reference/endpoint/wire/cancel-a-wire-v1.md): Cancel a wire object.
- [Create a Wire](https://docs.lead.bank/api-reference/endpoint/wire/create-a-wire-v1.md): Create a new outgoing wire.
- [List all Wires](https://docs.lead.bank/api-reference/endpoint/wire/list-all-wires-v1.md): List all wire objects.
- [Retrieve a Wire](https://docs.lead.bank/api-reference/endpoint/wire/retrieve-a-wire-v1.md): Retrieve a wire object.
- [Return a Wire](https://docs.lead.bank/api-reference/endpoint/wire/return-a-wire-v1.md): Initiate a return against an incoming wire.
- [Update a Wire](https://docs.lead.bank/api-reference/endpoint/wire/update-a-wire-v1.md): Update a wire.
- [Changelog](https://docs.lead.bank/changelog.md): Stay up to date with Lead product updates, new features, platform improvements, and bug fixes.
- [Overview](https://docs.lead.bank/file-integrations/account/overview.md): Overview of account files.
- [Schema](https://docs.lead.bank/file-integrations/account/schema.md)
- [Statuses](https://docs.lead.bank/file-integrations/account/statuses.md): The statuses for account files.
- [Validations](https://docs.lead.bank/file-integrations/account/validations.md): Validating account files.
- [Overview](https://docs.lead.bank/file-integrations/application/overview.md): Overview of application files.
- [Schema](https://docs.lead.bank/file-integrations/application/schema.md)
- [Statuses](https://docs.lead.bank/file-integrations/application/statuses.md): The statuses for application files.
- [Validations](https://docs.lead.bank/file-integrations/application/validations.md): Validating application files.
- [Schema](https://docs.lead.bank/file-integrations/authorized-users/schema.md)
- [Validations](https://docs.lead.bank/file-integrations/authorized-users/validations.md): Validating authorized users.
- [Balance Reconciliation](https://docs.lead.bank/file-integrations/balances-and-transactions/balance-reconciliation.md): Understand end-of-day account balances.
- [Balance Statuses](https://docs.lead.bank/file-integrations/balances-and-transactions/balance-statuses.md): Understand statuses for balances.
- [Balance & Transaction Validations](https://docs.lead.bank/file-integrations/balances-and-transactions/balance-validations.md): Understand validations for balances and transactions.
- [Balances Schema](https://docs.lead.bank/file-integrations/balances-and-transactions/balances-schema.md)
- [Non-Posted Transactions Schema](https://docs.lead.bank/file-integrations/balances-and-transactions/non-posted-transactions-schema.md)
- [Transaction Types](https://docs.lead.bank/file-integrations/balances-and-transactions/transaction-types.md)
- [Transactions Schema](https://docs.lead.bank/file-integrations/balances-and-transactions/transactions-schema.md)
- [Transactions Update Schema](https://docs.lead.bank/file-integrations/balances-and-transactions/transactions-update-schema.md)
- [Schema](https://docs.lead.bank/file-integrations/card-files/schema.md)
- [Validations](https://docs.lead.bank/file-integrations/card-files/validations.md): Validating card files.
- [Schema](https://docs.lead.bank/file-integrations/collaterals/schema.md)
- [Customer Relationship Schema](https://docs.lead.bank/file-integrations/customer/customer-relationship-schema.md)
- [Customer Schema](https://docs.lead.bank/file-integrations/customer/customer-schema.md)
- [Overview](https://docs.lead.bank/file-integrations/customer/overview.md): Overview of Customers and Customer Relationships files.
- [Validations](https://docs.lead.bank/file-integrations/customer/validations.md): Validating customer and customer relationship files
- [Credit or Charge Cards](https://docs.lead.bank/file-integrations/data-flows/credit-or-charge-cards.md): How to exchange information with Lead to support credit or charge card programs.
- [Deposit or Payments](https://docs.lead.bank/file-integrations/data-flows/deposit-or-payments.md): Data flow for deposit or payments products.
- [Lending and Overdraft](https://docs.lead.bank/file-integrations/data-flows/lending-and-overdraft.md): How to exchange information with Lead to support lending (term loans and lines of credit) or overdraft programs.
- [Data Objects](https://docs.lead.bank/file-integrations/data-objects.md): Understand Lead's data objects.
- [Currencies](https://docs.lead.bank/file-integrations/file-delivery/currencies.md): Understand which currencies are accepted in file validations.
- [Overview](https://docs.lead.bank/file-integrations/file-delivery/overview.md): Understand how to exchange data with Lead via SFTP.
- [Slack Alerts](https://docs.lead.bank/file-integrations/file-delivery/slack-alerts.md): Monitor your program.
- [Compliance Documents](https://docs.lead.bank/file-integrations/file-guides/documents/compliance-documents.md): Understand the JSON structure expected for Documents provided in the `applications` and `accounts` files.
- [Overview](https://docs.lead.bank/file-integrations/file-guides/documents/overview.md): Details on SFTP document delivery.
- [Nacha Files](https://docs.lead.bank/file-integrations/nacha-files.md): Overview of ACH file processing using Nacha files.
- [Funding](https://docs.lead.bank/file-integrations/network-settlement/funding.md): Network settlement funding explained.
- [Reconciliation](https://docs.lead.bank/file-integrations/network-settlement/reconciliation.md): Network settlement reconciliation explained.
- [Reports](https://docs.lead.bank/file-integrations/network-settlement/reports.md): Lead's network settlement reports explained.
- [Program Files](https://docs.lead.bank/file-integrations/program-files.md): Understand which files and APIs you'll use to support your program.
- [ACH Cash Reconciliation](https://docs.lead.bank/file-integrations/reporting/ach-cash-reconciliation.md): Definition of fields provided in the ACH Settlement Cash Reconciliation report.
- [Daily Activity](https://docs.lead.bank/file-integrations/reporting/daily-activity.md): Definition of fields provided in the Daily Activity report.
- [Daily Balance](https://docs.lead.bank/file-integrations/reporting/daily-balance.md): Definition of fields provided in the Daily Balance report.
- [Overview](https://docs.lead.bank/file-integrations/reporting/overview.md): Reporting from Lead.
- [Platform Reconciliation](https://docs.lead.bank/file-integrations/reporting/platform-reconciliation.md): Reconciliation for platform-issued account numbers.
- [Request Schema](https://docs.lead.bank/file-integrations/sales-request-and-response/request-schema.md)
- [Response Schema](https://docs.lead.bank/file-integrations/sales-request-and-response/response-schema.md)
- [Settlement Amount](https://docs.lead.bank/file-integrations/sales-request-and-response/settlement-amount.md): Understand how settlement works.
- [SFTP Setup](https://docs.lead.bank/file-integrations/sftp-setup.md): Steps for setting up SFTP with Lead.
- [Deposit Accounts](https://docs.lead.bank/file-integrations/use-cases/deposit-accounts.md): How to set up a deposit account program with Lead.
- [Deposit Accounts With Debit Card](https://docs.lead.bank/file-integrations/use-cases/deposit-accounts-with-debit-card.md): How to set up a deposit account with debit card program with Lead.
- [Implementation](https://docs.lead.bank/onboarding/implementation.md): An overview of key implementation milestones.
- [Testing & Go-Live](https://docs.lead.bank/onboarding/testing-go-live.md): Understand the required testing process leading up to your go-live launch.
- [Welcome to Lead](https://docs.lead.bank/onboarding/welcome.md): Join the boldest fintechs using Lead to Lend, Move, Issue, and Store money.

## OpenAPI Specs

- [openapi](https://docs.lead.bank/openapi.json)