Create Card API V2

Table of Contents

Create Card API V2 Introduction
Request Format
Success Response
Failure Response

Create Card API V2 Introduction

This API will generate a new card for a given card template. When you call this API, you have to call it with a unique “card-id” field and it will generate a new card data record. The “card-id” must be unique per Card Template. If you try to call this API again with the same “card-id” field, it will return an error message and fail to generate a new card record. There is an optional parameter ‘upsert-record’, if it passed as true and the card already exists then it will update the existing record. To call this API again successfully without ‘upsert-record’, you will need to use a different “card-id’. If you want to retrieve the data from this “card-id”, use the API – Get Card Data. If you want to update the data in this “card-id” use the API – Update Card Data.

Request Format

Copy to Clipboard

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

{  
   "action": "create-card",
   "upsert-record":"true/false", // optional
   "card-template-id": "CARD_TEMPLATE_ID", 
   "card-id": "CARD_ID",
   "unique-identifier": "UNIQUE IDENTIFIER",
   "security-question-1": "SECURITY QUESTION 1",
   "security-question-2": "SECURITY QUESTION 2",
   "card-expiration": "yyyy-mm-ddThh:mm:ss+00:00", //UTC
   "recipient-email": "RECIPIENT EMAIL",
   "access-control":{ 
           "acs-identifier":"ACCESS_CONTROL_SYSTEM_USER_IDENTIFIER", // Unique Identifier under ACS
           "acs-groups":"ACCESS_CONTROL_SYSTEM_PERMISSION_GROUPS" // comma-separated list of access groups
   },
   "card-data": {
    "barcode": [
      {
        "key": "barcode",
        "value": "VALUE"
      }
    ],
    "image": [
      // An image can be passed as a photo URL.
      { 
        "key": "id-photo",
        "value": "PHOTO URL"
      },
      // Alternatively, an image can be passed as base64 encoded data.
      {
        "key": "id-photo",
        "value": "BASE64_IMAGE_DATA", // Sample : data:image/png;base64,iVBORw0KGgoAAAA.....JRU5ErkJggg==
        "type": "base64-encoded-image"
      }
    ],
    "name-fields": [
      {
        "key": "name",
        "value": "NAME"
      }
    ],
    "front-fields": [// 3 front fields
      {
        "key": "front-1",
        "value": "VALUE"
      },
      {
        "key": "front-2", 
        "value": "VALUE"
      }
    ],
    "secondary-fields": [// 4 secondary fields
      {
        "key": "secondary-1",
        "value": "VALUE"
      },
      {
        "key": "secondary-2",
        "value": "VALUE"
      }
    ],
    "back-fields": [ // 4 back fields
      {
        "key": "back-1",
        "value": "VALUE"
      },
      {
        "key": "back-2",
        "value": "VALUE"
      }
    ]
  }

Success Response

Copy to Clipboard

Failure Response

Copy to Clipboard

Updated on August 5, 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

Create Card 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