List Cards API V2

Table of Contents

List Cards API V2 Introduction
Request Format
Success Response
Failure Response

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

Copy to Clipboard

Success Response

Copy to Clipboard

{
   "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

Copy to Clipboard

Updated on August 6, 2024

ID Card App

Digital ID Card Solution

App Security

Types of ID Cards

App Accessibility

Multi-Language Support

Identity Authentication

Types of ID Card Apps

ID Management Platform

Design Mobile ID Cards

Import Card Data

ID Photo Management

ID Card Printing Software

Issue Digital IDs via Email

Manage Issued ID Cards

Send In-App Messages

ID Barcode Scanner

Integrations

Cloud Printing

Card Data Sync

View All Integrations

Resources

Resources

Get In Touch

Support

Company

About Us

Contact Us

Partner With Us

Knowledge Base

List Cards API V2 Introduction

Request Format

Success Response

Failure Response

Didn’t find what you were looking for?

ID CARD TYPES

COMPANY

RESOURCES

ACCOUNT

GET SOCIAL