List Cards API V2

List Cards API V2 Introduction

This API is used to retrieve all cards information (limited info) for the specified template id that exists within an institution’s account. The API request includes pagination options for cards. A ‘limit’ and ‘offset’ can be passed along with the api-key to retrieve a set of card data from the system. These fields are optional. If nothing passed in the request then the first 10 cards will be returned in the response.

Request Format

POST /api/v2/ HTTP/1.1
Host: secure-{REGION}.id123.io
X-API-KEY: API_KEY
Content-Type: application/json
Content-Length: 141

{
   "action": "list-cards",
   "limit": 0, //(optional),
   "offset": 10, //(optional),
   "card-template-id": "906c56c2d85817633abc07978f4899ff89cff060"
}

Success Response

{
   "status": "success",
   "code": "SUCCESS CODE",
   "message": "Template cards were retrieved successfully.",
   "data": [
       {
            "card-template-id": "CARD_TEMPLATE_ID",
            "card-id": "CARD_ID",
            "card-status": "CARD STATUS",
            "card-sub-status": "CARD SUB STATUS",
            "institution": "INSTITUTION NAME",
            "issuance-type": "ISSUANCE TYPE",
            "card-title": "CARD TITLE",
            "created-at": "2019-12-09T06:43:19+00:00",
            "last-updated": "2020-10-20T03:37:43+00:00",
            "card-expiration": "EXPIRATION TIMESTAMP",
            "barcode": [
                {
                    "key": "barcode",
                    "value": "BARCODE_VALUE,
                    "label": "Barcode Value"
                }
            ],
            "image": [
                {
                    "key": "id-photo",
                    "value": "PHOTO URL",
                    "label": "ID PHOTO"
                }
            ],
            "name-fields": [
                {
                    "key": "name",
                    "value": "FIELD VALUE",
                    "label": "FIELD LABEL"
                }
            ],
            "front-fields": [
                {
                    "key": "front-1",
                    "label": "FIELD LABEL",
                    "type": "FIELD TYPE",
                    "value": "FIELD VALUE"
                }
            ]
        }
   ]
}

Failure Response

{
	"status":"failure",
        "code":"ERROR CODE",
        "message":"ERROR MESSAGE"
}

.

.

.