Search…
Covid Vaccination Card Scan
This document explains how to enable CDC Covid Vaccination Card Scan in the verification flow and Passbase API

Overview

Digital credential solutions will become the norm as borders and businesses reopen. To help support businesses deliver safe and frictionless experiences for customers, we are excited to announce that Passbase now offers CDC Covid-19 vaccination card scans for proof of vaccination.

Enable CDC Card Scan

Within the customization additional checks page, you can enable the Covid Vaccination Card Scan by dragging the CDC Scan check to the Live Version section. Click the Publish Changes button when complete. Your users will now be prompted to scan the front of their CDC Covid Vaccination Card as the final step of the verification flow.

CDC Card Scan API Response

The CDC Covid Vaccination Card data for each Verification is accessible using the below Passbase API endpoints. You can find more information about the endpoints in our API explorer, and you can use one of our server-side libraries to interact with the Passbase API.
1
// List all identities
2
https://api.passbase.com/verification/v1/identities
3
4
// Get identity for a specific id / key
5
https://api.passbase.com/verification/v1/identities/{id}
Copied!
The response of the API will have the following parameters:

Response parameters

Parameter
Description
first_names
First names of the user the CDC Card belongs to
last_name
Last name of the user the CDC Card belongs to
date_of_birth
Date of birth of the user the CDC Card belongs to
patient_number
Patient number of the user the CDC Card belongs to
first_vaccination
Object of data points relating to the first vaccination dose
second_vaccination
Object of data points relating to the second vaccination dose
date
Date of vaccination dose
product_name
Product name or manufacturer of vaccination dose
healthcare_professional
Healthcare professional or clinic where vaccination dose was administered
lot_number
Lot number of vaccination dose
1
{
2
"id": "a44c2593-e2ae-4ed9-b81b-c1330580338a",
3
"status": "approved",
4
"score": 0.86,
5
"created": 1621017727,
6
"updated": 1621143649,
7
"owner": {
8
"email": "[email protected]",
9
"first_name": "JOHN",
10
"last_name": "DOE"
11
},
12
"resources": [
13
{
14
"id": "cd7f5b2c-6029-4b7a-bd78-ac343f50edf4",
15
"status": "processed",
16
"created": 1621017766,
17
"updated": 1621017769,
18
"type": "PASSPORT",
19
"datapoints": {
20
"authority": "United States Department of State",
21
"place_of_birth": "MASSACHUSETTS, U.S.A.",
22
"nationality": "us",
23
"sex": "male",
24
"date_of_expiry": "2017-09-30",
25
"date_of_issue": "2007-09-30",
26
"date_of_birth": "2000-01-01",
27
"face_match_factor": 0.8,
28
"id_authenticity_factor": 0.94,
29
"last_name": "Doe",
30
"first_names": "John",
31
"country": "US"
32
},
33
"resource_files": [...
34
]
35
},
36
{
37
"id": "35e9fce3-489a-490d-ab19-739d63e2f6a0",
38
"status": "processed",
39
"created": 1621017767,
40
"updated": 1621017769,
41
"type": "COVID_VACCINATION_CARD",
42
"datapoints": {
43
"first_names": "JOHN",
44
"last_name": "DOE",
45
"date_of_birth": "2000-01-01",
46
"patient_number": null,
47
"first_vaccination": {
48
"date": "2021-04-12",
49
"product_name": "pfizer",
50
"healthcare_professional": "LD 6:45 J.N",
51
"lot_number": "Lot# ER 2815"
52
},
53
"second_vaccination": {
54
"date": "2021-05-03",
55
"product_name": "pfizer",
56
"healthcare_professional": "LD 6:18pm ",
57
"lot_number": "Lot# EW 0306"
58
}
59
},
60
"resource_files": [...
61
]
62
}
63
],
64
"watchlist": null,
65
"metadata": null
66
}
Copied!
Last modified 4mo ago