Compact Semantic Credentials Google Pass templates

Create a Google Pass template

Creates a Google Pass template based on the provided .zip file. Refer to our Design a Google Pass template guide for more information on how to design the template and how to structure the .zip file.

Analytic events

  • CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_CREATE_START
  • CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_CREATE_SUCCESS
  • CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_CREATE_FAIL
SecuritybearerAuth
Request
Request Body schema: multipart/form-data
required
template
required
string <binary>

Includes your template files.

name
required
string [ 1 .. 1024 ] characters

Insert a name to identify this Google Pass template.

issuerId
required
string

Google Wallet Pass signer issuer ID.

serviceAccountClientEmail
required
string

Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.

serviceAccountPrivateKey
required
string

Private key PEM of the Google Cloud Platform service account.

Responses
201

Google Pass template created

400

Bad Request

post/v2/credentials/compact-semantic/digital-pass/google/templates
Request samples
Response samples
application/json
{
  • "id": "3812166c-ac9f-4e4e-96dd-c1336b5be378",
  • "passType": "apple",
  • "name": "Certificate of participation",
  • "metadata": {
    }
}

Retrieve all Google Pass templates

Retrieves a list of all Google Pass templates available on your tenant.

Analytic events

  • CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_START
  • CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_SUCCESS
  • CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_FAIL
SecuritybearerAuth
Request
query Parameters
limit
number [ 1 .. 1000 ]
Default: 100

Range size of the list, default 100

Example: limit=2
cursor
string

Starting point for the list

Example: cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h
Responses
200

Google Pass templates retrieved

400

Bad Request

get/v2/credentials/compact-semantic/digital-pass/google/templates
Request samples
Response samples
application/json
{
  • "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h",
  • "data": [
    ]
}

Update a Google Pass template

Updates a existing Google Pass template by providing its ID and a .zip file. Refer to our Design a Google Pass template guide for more information on how to design the template and how to structure the .zip file.

Analytic events

  • CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_UPDATE_START
  • CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_UPDATE_SUCCESS
  • CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_UPDATE_FAIL
SecuritybearerAuth
Request
path Parameters
id
required
string

Google Pass template ID

Request Body schema: multipart/form-data
required
template
required
string <binary>

Includes your template files.

name
required
string [ 1 .. 1024 ] characters

Insert a name to identify this Google Pass template.

issuerId
required
string

Google Wallet Pass signer issuer ID.

serviceAccountClientEmail
required
string

Email address of the Google Cloud Platform service account for accessing the Google Pay Passes API.

serviceAccountPrivateKey
required
string

Private key PEM of the Google Cloud Platform service account.

Responses
200

Google Pass template updated

400

Bad Request

404

Not Found

put/v2/credentials/compact-semantic/digital-pass/google/templates/{id}
Request samples
Response samples
application/json
{
  • "id": "3812166c-ac9f-4e4e-96dd-c1336b5be378",
  • "passType": "apple",
  • "name": "Certificate of participation",
  • "metadata": {
    }
}

Retrieve a Google Pass template

Retrieves an existing Google Pass template by providing its ID.

Analytic events

  • CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_RETRIEVE_START
  • CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_RETRIEVE_SUCCESS
  • CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_RETRIEVE_FAIL
SecuritybearerAuth
Request
path Parameters
id
required
string <uuid>

Google Pass template ID

Responses
200

Google Pass templated retrieved

400

Bad Request

404

Not Found

get/v2/credentials/compact-semantic/digital-pass/google/templates/{id}
Request samples
Response samples
application/json
{
  • "id": "3812166c-ac9f-4e4e-96dd-c1336b5be378",
  • "passType": "apple",
  • "name": "Certificate of participation",
  • "metadata": {
    }
}

Delete a Google Pass template

Delete a Google Pay Pass template by ID

Analytic events

  • CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_DELETE_START
  • CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_DELETE_SUCCESS
  • CREDENTIAL_COMPACT_SEMANTIC_GOOGLE_PASS_TEMPLATE_DELETE_FAIL
SecuritybearerAuth
Request
path Parameters
id
required
string <uuid>

Google Pass template ID

Responses
204

Google Pass template deleted

400

Bad Request

404

Not Found

delete/v2/credentials/compact-semantic/digital-pass/google/templates/{id}
Request samples
Response samples
application/json
{
  • "code": "string",
  • "message": "string",
  • "details": [
    ]
}