View Card API V2 Introduction
This API is used to retrieve detailed card information that already exists in the institution’s account. If you do not pass the correct ‘card-id’ or ‘card-template-id’ for the card that you are trying to retrieve, you will receive an error. All request parameters are mandatory to get the right card. A “list-cards” API returns limited information about cards and users must use the “view-card” API to get detailed information.
Request Format
POST /api/v2/ HTTP/1.1
Host: secure-{REGION}.id123.io
X-API-KEY: API_KEY
Content-Type: application/json
Content-Length: 63
{
"action": "view-card",
"card-template-id": "CARD_TEMPLATE_ID",
"card-id": "CARD_ID",
}
Success Response
{
"action": "view-card",
"status": "success",
"status-code": "SUCCESS CODE",
"message": "SUCCESS MESSAGE",
"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": "INSTITUTION ISSUED",
"card-title": "CARD TITLE",
"created-at": "yyyy-mm-ddThh:mm:ss+00:00", //UTC,
"last-updated": "UPDATED AT TIME",
"card-expiration": "yyyy-mm-ddThh:mm:ss+00:00", UTC
"card-data": {
"barcode": [
{
"key": "barcode",
"value": "",
"label": "barcode"
}
],
"image": [
{
"key": "id-photo",
"value": "PHOTO URL",
"label": "ID PHOTO"
}
],
"name-fields": [
{
"key": "name",
"value": "VALUE",
"label": "Name"
}
],
"front-fields": [
{
"key": "front-1",
"label": "FIELD LABEL",
"type": "FIELD TYPE",
"value": "FIELD VALUE"
}
],
"secondary-fields": [
{
"key": "secondary-1",
"label": "FIELD LABEL",
"type": "FIELD TYPE",
"value": "FIELD VALUE"
}
],
"back-fields": [
{
"key": "back-1",
"label": "FIELD LABEL",
"type": "FIELD TYPE",
"value": "FIELD VALUE"
},
{
"key": "back-2",
"label": "FIELD LABEL",
"type": "FIELD TYPE",
"value": "FIELD VALUE"
},
{
"key": "back-3",
"label": "FIELD LABEL",
"type": "FIELD TYPE",
"value": "FIELD VALUE"
},
{
"key": "back-4",
"label": "FIELD LABEL",
"type": "FIELD TYPE",
"value": "FIELD VALUE"
}
]
}
}
}
Failure Response
{
"status": "failure",
"code": "ERROR CODE",
"message": "ERROR MESSAGE",
"card-id”: "CARD_ID",
"card-template-id": "CARD_TEMPLATE_ID"
}
.
.
.