Objects

The asset type; one of fiat or crypto.

The unique code for the asset.

The name of the asset.

The currency symbol for the asset.

The number of decimals for the default unit of the asset.

The type of the limit; one of rolling, daily, weekly, or monthly.

The name of the limit.

The asset code for the limit.

The limit amount for the asset.

The limit interval in seconds for the asset.

The activities associated with the limit.

The sides associated with the limit.

The total number of records available.

The page index to retrieve.

The number of entities per page to return.

Auto-generated unique identifier for the bank.

The organization's identifier.

The bank's name.

The bank type; one of sandbox or production.

The bank's list of supported trading symbols.

The bank's list of supported payout symbols.

The bank's list of supported fiat symbols.

The bank's list of supported country codes.

The bank's enabled features.

The bank's list of CORS allowed origins.

ISO8601 datetime the record was created at.

ISO8601 datetime the record was last updated at.

The total number of records available.

The page index to retrieve.

The number of entities per page to return.

Auto-generated unique identifier for the counterparty.

The counterparty type; one of business or individual.

Auto-generated unique identifier for the counterparty's bank.

Auto-generated unique identifier for the counterparty's customer.

ISO8601 datetime the record was created at.

ISO8601 datetime the record was last updated at.

The counterparty state; one of storing, unverified, verified, or rejected.

The counterparty's name. Only available for GET operations when 'include_pii' is set.

The counterparty's address. Only available for GET operations when 'include_pii' is set.

The counterparty's aliases. Only available for GET operations when 'include_pii' is set.

The counterparty's DOB. Only available for GET operations when 'include_pii' is set.

The labels associated with the counterparty.

The compliance decisions associated with the counterparty.

The total number of records available.

The page index to retrieve.

The number of entities per page to return.

Auto-generated unique identifier for the customer.

Auto-generated unique identifier for the customer's bank.

The customer type; one of business or individual.

ISO8601 datetime the record was created at.

ISO8601 datetime the record was last updated at.

The customer state; one of storing, unverified, verified, rejected, or frozen.

The customer's name. Only available for GET operations when 'include_pii' is set.

The customer's address. Only available for GET operations when 'include_pii' is set.

The customer's aliases. Only available for GET operations when 'include_pii' is set.

The customer's website. Only available for GET operations when 'include_pii' is set.

The customer's DOB. Only available for GET operations when 'include_pii' is set.

The customer's phone number. Only available for GET operations when 'include_pii' is set.

The customer's email address. Only available for GET operations when 'include_pii' is set.

The labels associated with the customer.

The compliance decisions associated with the customer.

The customer's identification numbers. Only available for GET operations when 'include_pii' is set and bank has access.

The asset limits associated with the customer.

The legal entity's first name.

The legal entity's middle name.

The legal entity's last name.

The legal entity's full name.

The first line of the address.

The optional second line of the address.

The city of the address.

The ISO 3166-2 subdivision code of the address; not used by all countries.

The postal/post/zip code of the address; not used by all countries.

The ISO 3166 country 2-Alpha country code of the address.

The total number of records available.

The page index to retrieve.

The number of entities per page to return.

Auto-generated unique identifier for the identity verification.

The identity verification type; one of kyc, bank_account, or counterparty.

The identity verification method; one of attested, document_submission, enhanced_due_diligence, id_and_selfie, tax_id_and_selfie, business_registration, attested_id_and_selfie, attested_business_registration, attested_business_associate, attested_id_and_database, watchlists, attested_ownership, or account_ownership.

ISO8601 datetime the record was created at.

ISO8601 datetime the record was last updated at.

The customer's identifier.

The counterparty's identifier.

The external bank account's identifier.

The identity verification state; one of storing, waiting, pending, reviewing, expired, or completed.

The identity verification outcome; one of passed or failed.

The reason codes explaining the outcome.

The compliance decisions associated with the identity verification.

Options for the identity verification.

Auto-generated unique identifier for the identity verification.

The identity verification type; one of kyc, bank_account, or counterparty.

The identity verification method; one of attested, document_submission, enhanced_due_diligence, id_and_selfie, tax_id_and_selfie, business_registration, attested_id_and_selfie, attested_business_registration, attested_business_associate, attested_id_and_database, watchlists, attested_ownership, or account_ownership.

ISO8601 datetime the record was created at.

ISO8601 datetime the record was last updated at.

The identity verification's identifier.

The identity verification's identifier.

The identity verification's identifier.

The identity verification state; one of storing, waiting, pending, reviewing, expired, or completed.

The identity verification outcome; one of passed or failed.

The reason codes explaining the outcome.

The compliance checks associated with the identity verification.

The compliance decisions associated with the identity verification.

The Persona identifier of the backing inquiry.

The Persona state of the backing inquiry; one of waiting, pending, reviewing, processing, expired, completed, or unknown.

List of associates declared for the business customer.

The personally identifiable information associated with the identity verification.

The documents associated with the identity verification.

The supporting documents associated with the attested identity verification.

Options for the identity verification.

Auto-generated unique identifier for the document.

The document type; one of drivers_license, passport, passport_card, residence_card, visa, social_security_number, tax_identification_number, selfie, proof_of_address, formation_document, employer_identification_number, indigenous_document_number, or work_permit.

Whether the document has been validated.

The document expiration date.

The files associated with the document.

The unique identifier for the file.

The file type; one of drivers_license_front, drivers_license_back, drivers_license, passport, passport_card, identification_card, residence_card, work_permit, indigenous_id_document, selfie, selfie_video, selfie_left, selfie_right, proof_of_address, or incorporation_certificate.

The media type; one of image/jpeg, image/png, application/pdf, application/json, or video/mp4.

The name of the file.

File metadata (e.g., {"part": "front"})

The Persona identifier of the business associate backing inquiry. Available only for attested_business_registration verification method

The Persona state of the backing inquiry; one of waiting, pending, reviewing, processing, expired, completed, or unknown. Available only for attested_business_registration verification method

The business associate's customer identifier. Available only for attested_business_registration verification method

The business associate role; one of director or owner.

The business associate email address. Available only for business_registration verification method

The business associate state; one of completed, waiting, or pending.

The total number of records available.

The page index to retrieve.

The number of entities per page to return.

The type of compliance check; one of business_watchlists, business_verification, business_tax_id_verification, business_attested, business_tax_id_attested, business_watchlists_attested, person_attested, person_tax_id_attested, person_gov_id_attested, person_authentication_attested, person_watchlists_attested, person_watchlists, person_verification, person_authentication, person_gov_id_verification, person_tax_id_verification, business_associate_gov_id_attested, business_associate_authentication_attested, business_associate_attested, business_associate_tax_id_attested, business_associate_watchlists_attested, external_bank_account_verification, or external_bank_account_attested.

The outcome of the compliance check; one of passed, failed, insufficient, or inconclusive.

The reason codes explaining the outcome.

The type of verification check; one of business_watchlists, business_verification, business_tax_id_verification, business_attested, business_tax_id_attested, business_watchlists_attested, person_attested, person_tax_id_attested, person_gov_id_attested, person_authentication_attested, person_watchlists_attested, person_watchlists, person_verification, person_authentication, person_gov_id_verification, person_tax_id_verification, business_associate_gov_id_attested, business_associate_authentication_attested, business_associate_attested, business_associate_tax_id_attested, business_associate_watchlists_attested, external_bank_account_verification, or external_bank_account_attested.

The state of the verification check; one of passed, failed, expired, or invalidated.

The reason codes explaining the outcome.

ISO8601 datetime the compliance decision is expired.

The name of the deposit bank account.

The account type. To generate deposit bank accounts with their own unique account number set this to "main". To generate deposit bank accounts with the same account number as the parent deposit bank account set this to "sub_account". This setting will only generate a unique identifier for the deposit bank and will not result in a unique account number being generated. "sub_account" is only available for customer-level deposit bank accounts.

The fiat or reserve account guid.

The unique identifier for the customer.

The unique identifier for the bank-level deposit bank account. This is only required for sub-accounts. Required when type is sub_account.

The labels associated with the bank account.

The asset code the customer will receive the funds in.

The unique identifier for the customer.

The amount to be received in base units of the asset, i.e., the amount the customer will receive after fees. ONLY one of receive_amount or deliver_amount is required.

The amount to be delivered in base units of the asset, i.e., the amount the customer will receive before fees. ONLY one of receive_amount or deliver_amount is required.

The identifier for the account to use for the transfer. Required if the customer has multiple fiat accounts. Currently only valid for invoices paid to a fiat account.

The labels associated with the invoice.

The invoice guid.

The optional expected behaviour to simulate.

Auto-generated unique identifier for the payment instruction.

The customer identifier.

The account payment will ultimately be received into.

ISO8601 datetime the record was created at.

ISO8601 datetime the record was last updated at.

The type of invoice; one of lightning.

The asset code the customer will receive the funds in.

The amount to be received in base units of the asset, i.e., the amount the customer will receive after fees. ONLY one of receive_amount or deliver_amount is required.

The amount to be delivered in base units of the asset, i.e., the amount the customer will receive before fees. ONLY one of receive_amount or deliver_amount is required.

The fee associated with this invoice in base units of the asset.

The state of the invoice; one of storing, unpaid, cancelling, cancelled, settling, or paid.

The labels associated with the invoice.

The total number of records available.

The page index to retrieve.

The number of entities per page to return.

Auto-generated unique identifier for the payment instruction.

The customer identifier.

The invoice identifier.

ISO8601 datetime the record was created at.

ISO8601 datetime the record was last updated at.

ISO8601 datetime the instructions expired at.

ISO8601 datetime the instructions failed to be created at.

The network address to pay the invoice to.

The asset the payor must pay the invoice in, e.g., BTC.

The amount to be paid in base units of expected_payment_asset.

The reason code explaining the failure; ond of invoice_paid, invoice_cancelled, or invalid_amount.

The state of the payment instruction; one of storing, created, expired, or failed.

The total number of records available.

The page index to retrieve.

The number of entities per page to return.

Auto-generated unique identifier for the identity verification.

The name of the deposit bank account.

The account type; one of main or sub_account.

The address' bank identifier.

The address' customer identifier.

The address' account identifier.

ISO8601 datetime the record was created at.

ISO8601 datetime the record was last updated at.

ISO8601 datetime the record was last deleted at.

The asset the transfer is related to, e.g., USD.

The state of the deposit bank account; one of storing, created, deleting, or deleted.

The unique memo identifier for the deposit bank account. This is used to identify the recipient when sending funds to the account. This value MUST be included in all wire transfers to this account.

The name of the account holder.

The counterparty's address on the account.

The account details for the bank account.

The account details for the bank account.

The unique identifier for the bank-level deposit bank account. This is only set for sub-accounts.

The labels associated with the address.

The total number of records available.

The page index to retrieve.

The number of entities per page to return.

Auto-generated unique identifier for the identity verification.

The name of the deposit address.

The address' bank identifier.

The address' customer identifier.

The address' account identifier.

ISO8601 datetime the record was created at.

ISO8601 datetime the record was last updated at.

The asset the transfer is related to, e.g., USD.

The state of the address; one of storing or created.

The blockchain address.

The blockchain address format; one of standard or legacy.

The blockchain address tag.

The labels associated with the address.

The total number of records available.

The page index to retrieve.

The number of entities per page to return.

The trade symbol the pricing is related to. Format is asset-counter_asset, e.g., BTC-USD.

The type of price; one of trading or payout.

The purchase price (in base units) for the asset denominated in the counter asset currency.

The sale price (in base units) for the asset denominated in the counter asset currency.

ISO8601 datetime the purchase price was generated at.

ISO8601 datetime the sale price was generated at.

The ISO 3166 country 2-Alpha country code of the price.

The type of participants the price is for; one of C2C, C2B, B2C, or B2B.

The route the price is for; one of bank_account or mobile_wallet.

The type of product the quote is for.

The unique identifier for the bank.

The unique identifier for the customer.

The amount to be received in base units of the currency: currency is "asset" for buy and "counter_asset" for sell for trade quotes.

The amount to be delivered in base units of the currency: currency is "counter_asset" for buy and "asset" for sell for trade quotes.

The asset code the quote was requested for. Required when product_type is lightning_transfer, product_type is book_transfer, product_type is funding, product_type is crypto_transfer, or product_type is inter_account.

The network address to pay the invoice to. Required when product_type is lightning_transfer.

The custom fees associated with the quote Optional when product_type is lightning_transfer, product_type is funding, product_type is trading, product_type is crypto_transfer, or product_type is trading_exit.

The direction for trade quotes: either 'buy' or 'sell'. The direction for funding quotes: either 'deposit' or 'withdrawal'. The direction for crypto transfer quotes: 'withdrawal'. Book transfers do not require a side. They are all 'deposit's. Required when product_type is funding, product_type is trading, or product_type is crypto_transfer.

The unique identifier for the destination account. Used to determine routing-specific fees for EFT withdrawals. Required when product_type is inter_account. Optional when product_type is funding.

The payment rail the resulting transfer will execute on. Required when the downstream transfer will be an e-transfer withdrawal. Optional when product_type is funding.

Symbol the quote is being requested for. Format is "asset-counter_asset" in uppercase. See the Symbols API for a complete list of cryptocurrencies supported. Required when product_type is trading.

Destination accounts for batch transactions on UTXO-based blockchains. A single destination account is required for Base blockchain assets. Optional when product_type is crypto_transfer.

The guid of the related trade. Only present on `exit` trades. Required when product_type is trading_exit.

The source account's identifier. Required when product_type is inter_account.

The type of account

The guid of the account

The amount to be received in base units of the currency: currency is "asset" for buy and "counter_asset" for sell for trade quotes.

The amount to be delivered in base units of the currency: currency is "counter_asset" for buy and "asset" for sell for trade quotes.

The fee's type

The percentage amount, in basis points, to apply when charging a fee. Required when type is spread.

The fixed amount to apply when charging a fee; for trades, the fiat asset is used. Required when type is fixed.

Auto-generated unique identifier for the quote.

The type of product the quote is for; one of trading, trading_exit, funding, crypto_transfer, inter_account, lightning_transfer, or book_transfer.

The unique identifier for the bank.

The unique identifier for the customer.

Symbol the quote was requested for. Format is "asset-counter_asset" in uppercase. Populated for trade quotes.

The direction of the quote; one of buy, sell, deposit, or withdrawal.

The amount to be received in base units of the currency: currency is "asset" for buy and "counter_asset" for sell for trade quotes.

The amount to be delivered in base units of the currency: currency is "counter_asset" for buy and "asset" for sell for trade quotes.

The fee associated with the trade. Denominated in "counter_asset" base units for trade quotes.

The fees associated with the quote.

ISO8601 datetime the record was created at.

ISO8601 datetime the record was last updated at.

ISO8601 datetime the quote was created at.

ISO8601 datetime the quote is expiring at. Populated for trading quotes.

The asset code the quote was requested for. Populated for book transfer and funding quotes.

The network fee in base units of network_fee_asset. Only present on `crypto_transfer` quotes.

The asset code of the network fee.

The network address to pay the invoice to. Populated for lightning_transfer quotes.

The quote entries for a batch transfer quote

The unique identifier for the trade.

The unique identifier for the transfer.

The type of product the plan is for.

The unique identifier for the bank.

The unique identifier for the customer.

Source account

Destination account

Travel rule information

The purpose of transaction for the plan.

The labels associated with the plan.

Supporting documents to attach to the plan. Optional when type is remittance.

Auto-generated unique identifier for the entity.

The type of product the plan is for; one of remittance, deposit_return, or withdrawal_return.

The unique identifier for the bank.

The unique identifier for the customer.

ISO8601 datetime the record was created at.

ISO8601 datetime the record was last updated at.

ISO8601 datetime the plan will expire at. Null for return plans, which do not expire.

The state of the plan; one of storing, planning, completed, or failed.

The failure code for failed plans.

The stages of the plan.

The fees associated with the plan.

The travel rule information associated with the plan.

The purpose of transaction for the plan.

Supporting documents attached to the plan. Optional when type is remittance.

The labels associated with the plan.

The kind of supporting document.

File guids backing this document.

A reference number identifying this document (e.g. an invoice number). Required for payouts to certain corridors.

Auto-generated unique identifier for the document.

The kind of supporting document; one of invoice, purchase_order, delivery_slip, contract, bill_of_lading, or others.

The files backing this document.

A reference number identifying this document (e.g. an invoice number).

Auto-generated unique identifier for the file.

The original filename.

The MIME content type.

The total number of records available.

The page index to retrieve.

The number of entities per page to return.

The unique identifier for the plan.

The GUID of a previously created Sardine session. Used to correlate device signals from the Sardine SDK with the execution screening.

The total number of records available.

The page index to retrieve.

The number of entities per page to return.

Auto-generated unique identifier for the quote.

The type of product the plan is for; one of remittance, deposit_return, or withdrawal_return.

The unique identifier for the plan.

The unique identifier for the bank.

The unique identifier for the customer.

ISO8601 datetime the record was created at.

ISO8601 datetime the record was last updated at.

The state of the execution; one of storing, executing, completed, failed, or reviewing.

The failure code for failed executions.

The stages of the execution.

The fees associated with the execution.

The holds placed on the execution.

The travel rule information associated with the execution.

The purpose of transaction for the execution.

Objects this return execution references (the returned execution and stage). Optional when type is deposit_return or type is withdrawal_return.

The labels associated with the execution.

The type of object being referenced; one of returned_execution or returned_stage.

The guid of the referenced object.

The unique identifier for the stage.

The type of stage; one of payout, deposit, withdrawal, trade, deposit_return, loss_recovery, or withdrawal_return.

The state of the stage; one of storing, planning, planned, executing, completed, or failed.

The failure code for failed stages.

Provider-issued identifiers associated with this stage. Always present, possibly empty.

Provider-issued links associated with this stage. Always present, possibly empty.

The ISO8601 datetime the stage was created at.

The ISO8601 datetime the stage was last updated at.

The fees associated with the stage.

The kind of identifier.

The identifier value as issued by the rail.

The kind of link.

The URL.

The timestamp when the return was initiated by the provider.

The ACH/EFT return code (e.g. R01, R10) received from the provider. Absent when the provider did not report a return code.

The type of fee; one of platform, network, or bank.

The asset the fee is denominated in, e.g., USD.

The quoted amount in base units for the fee.

The executed amount in base units for the fee.

The type of fee; one of bank, platform, or network.

The asset the fee is denominated in, e.g., USD.

The fee amount in base units of the asset.

The type of hold; one of customer_hold_duration, reserve_below_minimum, screening_administrative, or screening_non_administrative.

The state of the hold; one of active, completed, or storing

ISO8601 datetime the hold was started at.

ISO8601 datetime the hold was completed at.

ISO8601 datetime the hold is expected to complete at.

Auto-generated unique identifier for the transfer account.

The type of transfer account; one of trading, fiat, external_bank_account, or external_wallet.

The account's organization identifier.

The account's bank identifier.

The account's customer identifier.

The account's counterparty identifier.

The account asset, e.g., USD.

The requested amount in base units intended to transfer from or to the account.

The quoted amount in base units to transfer from or to the account.

The executed amount in base units transferred from or to the account.

The desired payment rail to use to initiate a fiat transfer.

The type of entity; one of bank, customer, or counterparty.

The unique identifier for the participant.

The source account in the batch transfer entry.

The destination account entry in the batch transfer.

The amount to be received in base units of the currency

The amount to be delivered in base units of the currency

The fee associated with the account entry.

The total number of records available.

The page index to retrieve.

The number of entities per page to return.

Auto-generated unique identifier for the workflow.

The associated banks's identifier.

The associated customer's identifier.

The type of workflow; one of plaid.

The state of the workflow; one of storing, completed, or failed.

The failure code for failed workflows.

ISO8601 datetime the record was created at.

ISO8601 datetime the record was last updated at.

The unique identifier for the identity verification.

The unique identifier for the Persona inquiry.

The token to be used in the Persona session.

The ID of the Persona inquiry to create a session for

The GUID of the identity verification associated with the session

Auto-generated unique identifier for the sardine session key.

The session key to initialize the Sardine SDK with.

The unique identifier for the customer.

The expiration datetime of the session key. Null if the session key does not expire.

The GUID of the customer the session is for. Required for organization and bank subject tokens. For customer subject tokens, this is inferred from the token.

Auto-generated unique identifier for the transfer.

The type of transfer; one of funding, book, crypto, instant_funding, funding_return, crypto_return, loss_recovery, inter_account, lightning, or instant_funding_return.

The associated bank's identifier.

The associated customer's identifier.

The associated quote's identifier.

The associated external bank account's identifier.

The asset the transfer is related to, e.g., USD.

The direction of the quote; one of deposit or withdrawal.

The state of the transfer; one of storing, pending, reviewing, completed, or failed.

The failure code for failed transfers; one of non_sufficient_funds, refresh_required, party_name_invalid, payment_rail_invalid, compliance_rejection, cancelled, reversed, limit_exceeded, network_fee_too_low, amount_too_low, internal_error, invalid_address, invalid_destination, customer_action_required, external_vendor_error, or payment_request_expired.

The return code for reversed transfers

The actual amount in base units of the asset.

The estimated amount in base units of the asset.

The fee associated with the transfer. Represents the sum of the bank and platform fees.

The fees associated with the transfer.

The estimated network fee in base units of network_fee_asset. Only present on `crypto` transfers.

The actual network fee in base units of network_fee_asset. Only present on `crypto` transfers that have successfully completed.

The asset code of the network fee. Only present on `crypto` transfers that have successfully completed.

The equivalent fiat network fee in base units of network_fee_liability_amount_asset. Only present on `crypto` transfers that have successfully completed.

The fiat asset the network_fee_liability_amount is denominated in. Only present on `crypto` transfers that have successfully completed.

The hash of the blockchain transaction (deprecated: use identifiers array)

Array of identifiers associated with this transfer (transaction hash, wire reference numbers)

The guid of the related transfer. Only present on return type transfers.

The source account in the transfer. Can be omitted for crypto deposits.

The participants in the source account.

The destination account in the transfer.

The participants in the source account.

The guid of the deposit address. Only present on crypto deposits.

ISO8601 datetime the record was created at.

ISO8601 datetime the record was last updated at.

The hold details if a transfer is or will be placed on a hold.

The raw details on the transfer from the bank.

The rail the payment was done on. One of: ach, eft, wire, rtp, etransfer

The external identifier for the transfer.

The labels associated with the transfer.

Transfer entries associated with the batch transfer

The actual amount in base units of the asset.

The fee associated with the transfer entry.

The source account in the batch transfer entry.

The destination account entry in the batch transfer.

The type of participant; one of unknown, bank, customer, or counterparty.

The amount in base units of the asset.

The participant's identifier.

Auto-generated unique identifier for the trade.

The type of trade; one of platform, liquidation, or exit.

The associated customer's identifier.

The associated quote's identifier.

The trade symbol the pricing is related to. Format is asset-counter_asset, e.g., BTC-USD.

The direction of the trade; one of buy or sell.

The state of the trade; one of storing, pending, cancelled, completed, settling, or failed.

The failure code for failed trades; one of non_sufficient_funds, unsupported, limit_exceeded, expired_quote, market_volatility, or not_filled.

The amount to be received in base units of the currency: currency is "asset" for buy and "counter_asset" for sell.

The amount to be delivered in base units of the currency: currency is "counter_asset" for buy and "asset" for sell.

The fee associated with the trade. Denominated in "counter_asset" base units. Represents the sum of the bank and platform fees.

The fees associated with the trade.

The guid of the related trade. Only present on `exit` trades.

ISO8601 datetime the record was created at.

ISO8601 datetime the record was last updated at.

The labels associated with the trade.

The total number of records available.

The page index to retrieve.

The number of entities per page to return.

The total number of records available.

The page index to retrieve.

The number of entities per page to return.

The total number of records available.

The page index to retrieve.

The number of entities per page to return.

The total number of records available.

The page index to retrieve.

The number of entities per page to return.

The total number of records available.

The page index to retrieve.

The number of entities per page to return.

The account type; one of trading, fee, fiat, gas, reserve, invoice_operations, or storage.

Auto-generated unique identifier for the account.

ISO8601 datetime the record was created at.

ISO8601 datetime the record was last updated at.

The asset code.

The name of the account.

The bank identifier associated with the account.

The customer identifier associated with the account.

The amount of funds that are in the account, in base units of the asset.

The minimum balance for no-hold ACH pulls, in base units of the account asset. Only returned for reserve accounts.

The amount of funds that are in the account, in base units of the asset, that are available for use on the platform.

The state of the account; one of storing or created.

The labels associated with the account.

The total number of records available.

The page index to retrieve.

The number of entities per page to return.

Auto-generated unique identifier for the account.

The name of the account.

The asset code.

The type of account; one of plaid, plaid_processor_token, or raw_routing_details.

The environment that the external bank account is operating in; one of sandbox or production.

The bank identifier.

The customer identifier.

The counterparty identifier.

ISO8601 datetime the record was created at.

ISO8601 datetime the record was last updated at.

The Plaid institution ID for the account.

The account number mask for the account.

The name for the account.

The state of the external bank account; one of storing, completed, failed, refresh_required, unverified, deleting, or deleted.

The failure code for failed transfers.

The timestamp that the balance information was last updated at.

Balance information for the account.

The account holder information.

The source of the identification number; one of drivers_license, passport, passport_card, visa, residence_card, social_security_number, tax_identification_number, identification_card, work_permit, indigenous_document_number, national_identification_number, employer_identification_number, or business_registration_number.

The ISO 3166 country 2-Alpha country code of the identification number issuer.

The identification number.

The ISO 3166-2 subdivision code of the identification number issuer.

Auto-generated unique identifier for the wallet.

The name of the wallet.

The asset code.

The environment that the wallet is configured for; one of sandbox or production.

The bank identifier.

The customer identifier.

The counterparty identifier.

The blockchain wallet address for the wallet.

The blockchain tag to use when transferring crypto to the wallet.

ISO8601 datetime the record was created at.

ISO8601 datetime the record was last updated at.

The state of the external wallet; one of storing, pending, failed, completed, deleting, or deleted.

The failure code of an external wallet (if any)

The type of bank.

The name of the bank.

The trading symbols supported by the bank.

The payout symbols supported by the bank. This is not yet supported and should be nil or empty.

The fiat account assets supported by the bank.

The country codes supported by the bank.

The features supported by the bank.

The list of allowed CORS origin URIs.

The name of the bank.

The trading symbols supported by the bank.

The payout symbols supported by the bank. This is not yet supported and should be nil or empty.

The list of allowed CORS origin URIs.

The type of customer.

The customer's address.

The customer's phone number.

The customer's email address.

The customer's identification numbers.

The customer's name. Optional when type is individual or type is business.

The customer's date of birth. Optional when type is individual.

The aliases of the customer. Optional when type is business.

The customer's website. Optional when type is business.

The labels associated with the customer.

The customer's state.

The counterparty's type.

The owning customer's identifier.

The address of the counterparty.

The name of the counterparty. Required when type is business or type is individual.

The aliases of the counterparty. Optional when type is business.

The counterparty's date of birth. Optional when type is individual.

The counterparty's email address.

The counterparty's identification numbers.

The labels associated with the counterparty.

The type of identity verification.

The customer's identifier. Required when type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, or type is kyc and method is attested_id_and_database.

The optional expected behaviour to simulate.

The identity verification method. Required when type is counterparty, type is kyc, or type is bank_account.

The counterparty's identifier. Required when type is counterparty.

The ISO 3166 country 2-Alpha country the customer is being verified in. If not present, will default to the Bank's configured country code. Optional when type is kyc and method is id_and_selfie, type is kyc and method is tax_id_and_selfie, or type is kyc and method is business_registration.

Whether the collection of the tax id is required during identity verification. This will default to SSN in USA and SIN in Canada. It's not used elsewhere. Optional when type is kyc and method is id_and_selfie.

The customer's name. Required when type is kyc and method is attested, type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, type is kyc and method is attested_id_and_database, or type is bank_account and method is attested_ownership. Optional when type is kyc and method is watchlists.

The customer's address. Required when type is kyc and method is attested, type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, or type is kyc and method is attested_id_and_database. Optional when type is kyc and method is watchlists or type is bank_account and method is attested_ownership.

The customer's date of birth. Required when type is kyc and method is attested, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, or type is kyc and method is attested_id_and_database.

The customer's identification numbers. Required when type is kyc and method is attested, type is kyc and method is attested_business_registration, type is kyc and method is attested_business_associate, or type is kyc and method is attested_id_and_database. Optional when type is kyc and method is attested_id_and_selfie.

The aliases of the customer. Optional when type is kyc and method is attested_business_registration or type is kyc and method is watchlists.

The customer's phone number. Required when type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, or type is kyc and method is attested_id_and_database. Optional when type is bank_account and method is attested_ownership.

The customer's email address. Required when type is kyc and method is attested_business_registration, type is kyc and method is attested_id_and_selfie, type is kyc and method is attested_business_associate, or type is kyc and method is attested_id_and_database. Optional when type is bank_account and method is attested_ownership.

The customer's website. Required for attested business registration V2, optional for V3. Optional when type is kyc and method is attested_business_registration.

The customer's nature of business. Required when type is kyc and method is attested_business_registration.

The customer guids of the directors of the business Required when type is kyc and method is attested_business_registration.

The ultimate beneficial owners of the business with 25% or more ownership. Required for attested business registration V2, optional for V3. Optional when type is kyc and method is attested_business_registration.

File guids supporting the verification Required when type is kyc and method is attested_business_registration, type is kyc and method is attested_business_associate, or type is kyc and method is attested_id_and_database. Optional when type is kyc and method is attested_id_and_selfie.

The customer's registered address. Required for attested business registration V3. Optional when type is kyc and method is attested_business_registration.

The industry the business operates in. Required for attested business registration V3. e.g. 'Crypto / Digital Assets / Blockchain', 'Education', 'Gaming', 'Healthcare / Hospitality', 'Lending / Investments', 'Retail / E-Commerce', etc. Optional when type is kyc and method is attested_business_registration.

The source of business funds. Required for attested business registration V3. e.g. 'Funds from individual customers', 'Funds from business customers', 'Funds from both individual and business customers', etc. Optional when type is kyc and method is attested_business_registration.

The destination of business funds. Required for attested business registration V3. e.g. 'To your business account (bank or wallet)', 'To vendors or suppliers', 'To employees or contractors', 'To sellers or merchants', 'Bulk payments or payouts', etc. Optional when type is kyc and method is attested_business_registration.

The customer's occupation. Required when type is kyc and method is attested_business_associate. Optional when type is kyc and method is attested_id_and_selfie.

Whether biometrics have been verified Required when type is kyc and method is attested_business_associate or type is kyc and method is attested_id_and_database.

The external bank account's identifier. Required when type is bank_account.

The source of the identification number.

The ISO 3166 country 2-Alpha country code of the identification number issuer.

The identification number.

The ISO 3166-2 subdivision code of the identification number issuer.

The customer identifier.

The ownership percentage.

The type of file.

The customer identifier.

The name of the file.

The content type of the file.

Base64 encoded file content

File metadata (e.g., {"part": "front"})

The name of the deposit address.

The trading account guid.

The labels associated with the address.

The name of the deposit address.

The name of the deposit bank account.

The primary asset of the payout symbol, e.g., MXN.

The counter asset of the payout symbol, e.g., USD.

The ISO 3166 country 2-Alpha country code is permitted in, e.g., MX.

The participants the symbol is permitted for.

The route the symbol is permitted for.

The account type.

The customer identifier associated with the account.

The asset code.

The name of the account.

The labels associated with the account.

The name of the account.

The workflow type.

The Plaid workflow kind. Required when type is plaid.

The customer identifier associated with the workflow. Optional when type is plaid and kind is link_token_create.

The external bank account identifier associated with the workflow. Required when type is plaid and kind is link_token_update.

The language to initialize Plaid link. Required when type is plaid.

The customization name for Plaid link. For English, use "default". For Spanish, use "spanish_customization". Required when type is plaid.

The redirect URI for Plaid link. Optional when type is plaid.

The Android package name for Plaid link. Optional when type is plaid.

The source participants for the transfer.

The destination participants for the transfer.

The type of participant.

The amount in base units of the asset.

The participant's identifier.

The associated quote's identifier.

The type of transfer.

The customer's 'plaid', 'plaid_processor_token', or 'raw_routing_details' external bank account's identifier. Required for ACH, EFT, WIRE, and RTP payment rails. Not used for e-transfer rail. Required when transfer_type is instant_funding. Optional when transfer_type is funding.

The identifier for the fiat account to use for the transfer. Required if the customer or bank has multiple fiat accounts. Optional when transfer_type is funding.

The deposit bank account's identifier. Only valid for withdrawals. The deposit bank account must be owned by the customer or bank initiating the transfer. Optional when transfer_type is funding.

The desired payment rail to initiate the transfer for. Optional when transfer_type is funding.

The memo to send to the counterparty. Optional when transfer_type is funding.

The security question to send with an Interac E-Transfer withdrawal. Only accepted for e-transfer rail withdrawals; must be paired with security_answer. Optional when transfer_type is funding.

The security answer the recipient must provide to claim an Interac E-Transfer. Only accepted for e-transfer rail withdrawals; must be paired with security_question. Optional when transfer_type is funding.

The source participants for the transfer. Required when transfer_type is funding, transfer_type is instant_funding, transfer_type is book, transfer_type is crypto, or transfer_type is lightning.

The destination participants for the transfer. Required when transfer_type is funding, transfer_type is instant_funding, transfer_type is book, transfer_type is crypto, or transfer_type is lightning.

The GUID of a previously created Sardine session. Used to correlate device signals from the Sardine SDK with the transfer screening. Optional when transfer_type is funding or transfer_type is instant_funding.

The identifier for the fiat account to use for the transfer. Required if the bank has multiple fiat accounts. Optional when transfer_type is instant_funding or transfer_type is lightning.

The identifier for the fiat account to use for the transfer. Required if the customer has multiple fiat accounts. Optional when transfer_type is instant_funding or transfer_type is lightning.

The source account's identifier. Required when transfer_type is book or transfer_type is inter_account.

The destination account's identifier. Required when transfer_type is book or transfer_type is inter_account.

The customer's external wallet's identifier. Optional when transfer_type is crypto.

The customer's identifier. Required when transfer_type is lightning.

The network fee account's identifier. Required for network fee transfers. Must be the identifier for the customer's or bank's fiat or trading account. For customer's to pay the network fees, include the customer's fiat or trading account guid. For bank's to pay the network fees, include the bank's fiat or trading account guid. Required when transfer_type is lightning.

The optional expected behaviour to simulate. Only applicable for transfers under sandbox banks. The force_review behaviour will force the transfer to be reviewed for funding and instant_funding transfers.

The labels associated with the transfer.

The type of participant.

The amount in base units of the asset.

The participant's identifier.

The type of trade.

The associated quote's identifier.

The identifier for the fiat account to use for the trade. Required if the customer or bank has multiple fiat accounts.

The optional expected error to simulate trade failure.

The labels associated with the trade.

The state of the external bank account. If set to "completed," the returned state of the external bank account will be either "completed", if the bank account has been verified, or "unverified" if the bank account has not been verified.

The name of the external bank account.

The name of the account.

The account type

The customer identifier.

The asset code. If not set will try and default to the Bank's configured fiat asset.

The public token for the account. Required for 'plaid' accounts. Required when account_kind is plaid.

The account identifier in plaid. Required for 'plaid' accounts. Required when account_kind is plaid.

The Plaid processor token used to access the account. Required when account_kind is plaid_processor_token.

Plaid's institution ID for the account's institution. Required when account_kind is plaid_processor_token.

The account mask for the account. Required when account_kind is plaid_processor_token.

The name of the account. Required when account_kind is plaid_processor_token.

The counterparty identifier. Optional when account_kind is raw_routing_details.

The counterparty's checking bank account information. Required when account_kind is raw_routing_details.

The counterparty's name on their checking account. Required when account_kind is raw_routing_details and counterparty_guid is not present.

The counterparty's address on their checking account. Required when account_kind is raw_routing_details and counterparty_guid is not present.

The counterparty's email address on their checking account. Optional when account_kind is raw_routing_details and counterparty_guid is not present.

The bank code.

The account number or unique identifier for the account.

The type of account identifier. Must be PHONE_NUMBER for mobile wallet rails. Required when payment_rail is EASY_PAISA, payment_rail is FINJA, payment_rail is JAZZ_CASH, payment_rail is NAYA_PAY, payment_rail is SADA_PAY, payment_rail is MPESA, or payment_rail is ALIPAY.

The payment rail used for the account.

The type of bank code. Required when payment_rail is EFT, payment_rail is ACH, payment_rail is RTP, payment_rail is FEDNOW, payment_rail is WIRE, payment_rail is SPEI, payment_rail is PIX, payment_rail is COELSA, payment_rail is PSE, payment_rail is ETRANSFER, payment_rail is IFSC, payment_rail is SBP, payment_rail is BEFTN, payment_rail is NGBANK, payment_rail is LBTR, payment_rail is SEPA, payment_rail is KEBANK, payment_rail is HKBANK, payment_rail is CNBANK, payment_rail is FPS, or payment_rail is UNSPECIFIED.

The type of account. Required when payment_rail is PSE or payment_rail is LBTR. Optional when payment_rail is ACH.

Name of the external wallet.

The customer identifier.

The counterparty identifier.

The asset code.

The blockchain wallet address for the wallet.

The blockchain tag to use when transferring crypto to the wallet.

The optional expected behaviour to simulate. Only applicable wallets under sandbox banks.

The name of the external wallet.

The unique identifier for the file.

The organization identifier.

The bank identifier.

The customer identifier.

The file type; one of drivers_license_front, drivers_license_back, drivers_license, passport, passport_card, visa, identification_card, residence_card, work_permit, indigenous_id_document, selfie, selfie_video, selfie_left, selfie_right, utility_bill, proof_of_address, bank_statement, property_tax, tax_document, ein_letter, incorporation_certificate, invoice, purchase_order, delivery_slip, contract, bill_of_lading, others, persona_inquiry_report, or persona_inquiry_export.

The media type; one of image/jpeg, image/png, application/pdf, application/json, or video/mp4.

The name of the file.

The ISO8601 datetime the file was completed at.

The ISO8601 datetime the file failed at.

The state of the file. One of storing, completed, or failed.

The failure code for failed files.

The URL to upload the file to.

The ISO8601 datetime the upload URL expires at.

The URL to download the file from.

The ISO8601 datetime the download URL expires at.

The total number of records available.

The page index to retrieve.

The number of entities per page to return.

Status code for Http Request

Error message

Message code for Error