List Accounts

Request URL

GET /account/list/:customerId (deprecated)

Description

This endpoint is deprecated. Instead of using /customer/kyc and /document endpoints, we recommend the use of the /akepa endpoints for KYC/KYB verification and document upload.

This endpoint returns a list of accounts opened for the given customer.

Request Body

HEADERS

{
    "x-connectfi-token": "a long random string" //Authorization token received from /auth/get-token request
}

REQUEST BODY

none

Successful Response Examples

200 (HTTP response status code) -- Success, customer accounts are returned

{
    "code": "0", //Success
    "data": {
        "accounts": [ //all accounts of the customer in connectFi
            {
                "id": "acca-6HZVIVmmKm4KQjd7XZdAF2", //id of the account in connectFi
                "cFiBoisId": "condor", //backend system which keeps the account
                "accountNumber": "12345678901234", //account number
                "customerId": "csta-3gVU1HabOU7phfGj6jWOvu", //customer ID in connectFi
                "cFiCardIds": [ //list of ids of cards linked to the account
                    "crda-cGlZwbpxTx6P3v39kZPqU"
                ],
                "routingParams": { //additional account parameters
                    "routingNumber": "123456789" //US ABA account routing number
                }
            },
            {
                "id": "acca-7j92ec6vyEMDTBRTRKSNlu", //id of the account in connectFi
                "cFiBoisId": "condor", //backend system which keeps the account
                "accountNumber": "12345678901234", //account number
                "customerId": "csta-3gVU1HabOU7phfGj6jWOvu", //customer ID in connectFi
                "cFiCardIds": [ //list of IDs of cards linked to the account
                    "crda-7hVIUPmJSXYBCQC5Q0NSMo"
                ],
                "routingParams": { //additional account parameters
                    "routingNumber": "123456789" //US ABA account routing number
                }
            }
        ]
    }
    "requestId": "dc411f60b86011ed94b4966a132cde12"
}

US accounts get routingParams.routingNumber attribute. Accounts opened in other jurisdictions may have other attributes.

200 (HTTP response status code) -- Success, customer has no accounts

If the customer does not possess any accounts, an empty array is returned for data.accounts. An empty array with status code 200 is returned if no accounts are possessed, regardless of whether the customer exists or not. If you receive an empty array for a customer who is expected to possess at least one account, check the requested customer ID to make sure the customer ID is correctly entered.

{
    "code": "0", //Success
    "data": {
        "accounts": []
    },
    "requestId": "dc411f60b86011ed94b4966a132cde12"
}