Get FAQ

Get FAQ

This endpoint retrieves all available FAQ entries along with their answers and category assignments. FAQs are organized by topic to support structured browsing within a banking application. An optional language parameter allows partners to serve localized FAQ content to their customers.

Endpoint

GET /api/support/faq

Authentication

Bearer token required. Obtain via:

POST https://api.banking.netevia.dev/api/auth/v2

Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.

When to use

Use this endpoint to populate an in-app FAQ or help center screen for end users. It is suitable for both business and personal customer contexts where users need quick access to common questions about account management, transfers, cards, or other banking features. Call this endpoint at page load time and cache the response to minimize repeated requests.

Query Parameters

ParameterTypeRequiredDescription
langstring (enum)NoLanguage code for localized FAQ content. Accepted values: En, Es, Ru, Zh, Pt, Fr, De, Ja, Tr, Ko, It, Pl, Uk, Th, Az. Defaults to En if omitted.

Response

200 OK

Returns an array of FAQ objects.

FieldTypeDescription
idinteger (int32)Unique identifier for the FAQ entry
questionstring / nullThe frequently asked question text
answerstring / nullThe answer corresponding to the question
categorystring / nullCategory or topic grouping for the FAQ entry (max 128 characters)
[
  {
    "id": 1,
    "question": "How do I add an external bank account?",
    "answer": "You can link an external account using Finicity or Plaid from the Linked Accounts section in your profile settings. The account will go through underwriting verification before it becomes active.",
    "category": "Linked Accounts"
  },
  {
    "id": 2,
    "question": "What types of payment cards are available?",
    "answer": "Netevia offers three card types: Physical Cards (tangible plastic shipped to your address), Virtual Cards (digital-only for online use), and Burner Cards (temporary cards active until the end of the following month).",
    "category": "Payment Cards"
  },
  {
    "id": 3,
    "question": "How do I initiate an ACH transfer?",
    "answer": "ACH transfers can be initiated to pre-added payees or from accounts connected via Finicity or Plaid. Navigate to the Transfers section and select ACH Transfer to get started.",
    "category": "Transfers"
  }
]

Error Codes

CodeWhen it happens
400Invalid lang parameter value supplied (not one of the accepted language codes)
401Token missing, expired, or invalid
403Insufficient permissions
500Internal server error

Common Mistakes

  • Supplying an unsupported language code for the lang parameter — only the exact enum values listed above are accepted (e.g., En, not en or english).
  • Assuming the response is paginated — this endpoint returns all FAQ entries in a single array; no pagination parameters are supported.
  • Not caching the response — FAQ content changes infrequently; calling this endpoint on every user interaction adds unnecessary latency and load.

Related Endpoints

  • GET /api/support/ticket — Retrieve support tickets submitted by the customer
  • POST /api/support/ticket — Submit a new support ticket

Example

curl -X GET "https://api.banking.netevia.dev/api/support/faq?lang=En" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"
Query Params
string
enum
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json