List Cards

Request URL

GET /card/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 cards issued 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, array of cards returned

{
    "code": "0", //Success
    "data": {
        "cards": [ //array includes all cards issued for the customer
            {
                "id": "crda-cGlZwbpxTx6P3v39kZPqU", //id of the card in connectFi
                "cFiBoisId": "condor", //backend system which keeps the card information
                "customerId": "csta-3gVU1HabOU7phfGj6jWOvu", //customer ID in connectFi
                "cFiAccountIds": [ //array of ids of accounts linked to the card
                    "acca-6HZVIVmmKm4KQjd7XZdAF2"
                ]
            },
            {
                "id": "crda-7hVIUPmJSXYBCQC5Q0NSMo", //id of the card in connectFi
                "cFiBoisId": "condor", //backend system which keeps the card information
                "customerId": "csta-3gVU1HabOU7phfGj6jWOvu", //customer ID in connectFi
                "cFiAccountIds": [ //array of ids of accounts linked to the card
                    "acca-7j92ec6vyEMDTBRTRKSNlu"
                ]
            }
        ]
    },
    "requestId": "37b05e70b86011ed94b4966a132cde12"
}

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

If the customer does not possess any cards, an empty array is returned for data.cards. An empty array with status code 200 is returned if no cards 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 card, check the requested customer ID to make sure the customer ID is correctly entered.

{
    "code": "0",
    "data": {
        "cards": []
    },
    "requestId": "37b05e70b86011ed94b4966a132cde12"
}