Get Account Connectivity Status

Returns the current Finicity connectivity status for a specified merchant, including whether the financial account link is active and the details of any connected bank accounts. This endpoint is used to verify that a merchant has successfully completed the bank account connection flow before proceeding with banking-dependent boarding steps.

Endpoint

GET /api/v1/getAccountConnectivityStatus

Authentication

Basic HTTP Authentication required.
Encode username:password in Base64 and pass in the Authorization header:

Authorization: Basic {base64(username:password)}

When to use

Call this endpoint after initiating the Finicity account connection flow (GET /api/v1/connectFinancialAccount) and receiving the callback. It confirms that the merchant's bank account was linked successfully and provides the routing and account number details captured during the connection. This check is typically performed as part of the banking verification step in the underwriting or banking submission workflow.

Query Parameters

Response

200 OK

{
  "data": {
    "status": "connected",
    "connected": true,
    "accounts": [
      {
        "bankName": "First National Bank",
        "routing": "021000021",
        "account": "4072819305"
      }
    ]
  },
  "status": "OK",
  "error": null,
  "warning": null,
  "validationResults": [],
  "requestId": 91384
}

Error Codes

Common Mistakes

• Calling this endpoint before the merchant has completed the Finicity connection flow — connected will be false and accounts will be empty until the merchant finishes linking their bank.
• Treating an empty accounts array as an error — it is a normal response when the merchant has not yet connected an account.
• Not polling this endpoint after sending the merchant through the connection flow — the callback updates the record, but you should verify the status before proceeding with banking submission.
• Confusing data.status (a string description) with connected (the authoritative boolean) — always check connected to determine whether an account is linked.

Related Endpoints

• GET /api/v1/connectFinancialAccount — generate the Finicity link to send to the merchant for account connection
• POST /api/v1/banking/submitBanking — submit banking information after connectivity is confirmed
• GET /api/v1/merchant/status — check the overall boarding status of the merchant

Example

curl -X GET "https://hq.staging.netevia.dev/api/v1/getAccountConnectivityStatus?id=48291" \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)"