Create a new pass

post

https://api.ethpass.xyz/v0/passes

POST /v0/passes

This endpoint allows you to generate an Apple or Google pass based on specific wallet signatures.

Using this feature, you can create a digital representation of ownership or affiliation, similar to a digital card or pass, which can be added to a user's Apple Wallet or Google Pay. This pass can be created to represent various forms of ownership or involvement, such as the ownership of a wallet, possession of a particular NFT, or even attachment to one or multiple existing policies.

Body Params

wallet

object

nft

object

NFT Details

policies

array of strings

Policy IDs

policies

barcode

object

Barcode message

image

string

You can display a custom image on your pass. The file size of the image should not exceed 2MB, and it should be in one of the following formats. (.png, .jpg, .webp, .svg, .gif, .tiff)

externalId

string

Use this parameter to grant custom identifiers to passes.

templateId

string

The unique identifier (ID) for a custom pass template. This ID corresponds to templates that have been specifically designed and customized by users through our interactive dashboard interface. It allows for referencing and utilization of these custom designs when generating or managing passes.

layout

object

The configuration and structure of the pass's visual appearance. This includes specifications for different platforms like universal, Apple, and Google. Each platform-specific layout defines elements such as logos, colors, and fields to be displayed on the pass.

Please note that this will override any defaults you have setup through your template. Read more about pass layouts in our here.

apple

object

Customize passes using Apples native API. Note: This will override template and layout settings.

Apple Documentation

google

object

Customize passes using Googles native API. Note: This will override template and layout settings.

Google Documentation

Responses

401

Unauthorized

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Bad Request