Skip to main content
POST
/
fdx
/
v6
/
customer
/
{customerId}
/
accounts
Fetch specific accounts
curl --request POST \
  --url https://api.provider.fiskil.com/fdx/v6/customer/{customerId}/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "accountIds": [
      "depositAccount0000001",
      "loanAccount0000001"
    ]
  }
}
'
{
  "page": {
    "nextOffset": "B47D80MVP23T"
  },
  "accounts": [
    {
      "accountCategory": "DEPOSIT_ACCOUNT",
      "accountId": "depositAccount0000001",
      "accountType": "CHECKING",
      "accountNumberDisplay": "5820",
      "productName": "Checking",
      "nickname": "Main Checking",
      "status": "OPEN",
      "currency": {
        "currencyCode": "USD"
      }
    },
    {
      "accountCategory": "LOAN_ACCOUNT",
      "accountId": "loanAccount0000001",
      "accountType": "LOAN",
      "accountNumberDisplay": "4704",
      "productName": "Loan",
      "nickname": "Primary Loan",
      "status": "OPEN",
      "currency": {
        "currencyCode": "USD"
      }
    },
    {
      "accountCategory": "LOC_ACCOUNT",
      "accountId": "locAccount0000001",
      "accountType": "LINEOFCREDIT",
      "accountNumberDisplay": "8200",
      "productName": "Line of Credit",
      "nickname": "First plaidypus LOC",
      "status": "OPEN",
      "currency": {
        "currencyCode": "USD"
      }
    },
    {
      "accountCategory": "INVESTMENT_ACCOUNT",
      "accountId": "investmentAccount0000001",
      "accountType": "TAXABLE",
      "accountNumberDisplay": "1050",
      "productName": "Brokerage Account",
      "nickname": "First plaidypus Brokerage",
      "status": "OPEN",
      "currency": {
        "currencyCode": "USD"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The Fiskil Data Provider will include a self-signed JWT as a Bearer token in the Authorization header. You should verify this JWT using the JWKS URL you can find for your Data Provider instance in the Fiskil Console. To verify the JWT you must:

  • Verify the signature
  • Ensure the token has not expired by checking the exp claim
  • The sub and iss claims are your data provider subdomain
  • The aud claim is the URI of the resource being requested (excluding any query parameters)
  • The jti value is unique For further detail on security and authentication refer to our Authentication documentation

Path Parameters

​
customerId
string
required

Unique identifier for the user the account belongs to. This will be the user that authorized the data sharing.

Value for a unique identifier

Maximum string length: 256
Example:

"someLongTermUniqueIDString"

Query Parameters

​
offset
string

An opaque ID that indicates there is at least one more page of data available. This value does not need to be numeric or have any specific pattern. If provided, the Data Provider will use this value to send a new request and retrieve the next page. Omitting this value indicates that there is no more data to retrieve.

Example:

"qwer123454q2f"

​
limit
integer

The number of elements that the API consumer wishes to receive. To retrieve multiple pages, the Data Provider will use the opaque nextOffset field to send a subsequent request until the nextOffset is no longer included.

Body

application/json
​
data
object
required

The set of accounts to fetch

Response

An array of accounts.

Note: Each object in the accounts array is expected to contain at least one account type.

An optionally paginated array of accounts.

​
accounts
(Annuity account · object | Commercial account · object | Deposit account · object | Insurance account · object | Investment account · object | Loan account · object | Line-of-credit account · object)[]
required

An optionally paginated array of accounts.

Minimum array length: 1

An annuity account. For example, a fixed or variable annuity account.

The accountType field for annuity accounts may be set to any of the following:

  • ANNUITY: A form of insurance or investment entitling the investor to a series of annual sums.
  • FIXEDANNUITY: A type of insurance contract that promises to pay the buyer a specific, guaranteed interest rate on their contributions to the account.
  • VARIABLEANNUITY: A type of insurance contract that promises to pay back the buyer based on the performance of an underlying portfolio of mutual funds selected by the buyer.
​
page
Page Metadata · object

Contains the opaque identifier, nextOffset, to indicate a paginated result set.