{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Passport API Documentation","colors":{"primary":"#367CFF","light":"#367CFF","dark":"#367CFF"},"logo":{"light":"https://mintcdn.com/unblockedbrands/gtu0hwK9wYwAN1IU/logo/light.svg?fit=max\u0026auto=format\u0026n=gtu0hwK9wYwAN1IU\u0026q=85\u0026s=fc2bc30f86e845dd67e4eca1fec434c6","dark":"https://mintcdn.com/unblockedbrands/gtu0hwK9wYwAN1IU/logo/dark.svg?fit=max\u0026auto=format\u0026n=gtu0hwK9wYwAN1IU\u0026q=85\u0026s=f887f568cf687c7f9408bf840743c063"},"favicon":"/favicon.svg","navbar":{"links":[{"href":"mailto:hi@mintlify.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.mintlify.com"}},"footer":{"socials":{"x":"https://x.com/mintlify","github":"https://github.com/mintlify","linkedin":"https://linkedin.com/company/mintlify"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"unblockedbrands","hasAudioNarration":false,"actualSubdomain":"unblockedbrands","customDomains":["docs.unblockedbrands.com"],"gitSource":{"type":"github","owner":"unblockedbrands","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e717044dd579e9b5887a","collectionId":"0b52f758-f035-4abd-b09e-b99526d85f78","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21e717044dd579e9b5887a:success","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"API Reference","count":27},{"language":"default","tag":"Passport - Push Notifications","count":6},{"language":"default","tag":"Passport - Locations","count":5},{"language":"default","tag":"Passport - Passes","count":5},{"language":"default","tag":"Pique","count":5},{"language":"default","tag":"Upload APIs","count":4},{"language":"default","tag":"Getting Started","count":2}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/passport--passes/create-a-wallet-pass","slug":"/api-reference/passport--passes/create-a-wallet-pass","pageMetadata":{"title":"Create a wallet pass","description":"Create a new wallet pass for both Apple and Google platforms.\n","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /wallet-pass","href":"/api-reference/passport--passes/create-a-wallet-pass","autogeneratedByOpenApi":true,"hidden":false},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Create a new wallet pass for both Apple and Google platforms.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a wallet pass","description":"Create a new wallet pass for both Apple and Google platforms.\n","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /wallet-pass","href":"/api-reference/passport--passes/create-a-wallet-pass","autogeneratedByOpenApi":true,"hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Passport - Passes"],"summary":"Create a wallet pass","description":"Create a new wallet pass for both Apple and Google platforms.\n","operationId":"createWalletPass","parameters":["e7887942-5c62-4c16-8dcd-56726cd138c3"],"requestBody":"72cbd01a-c97f-47b8-9865-512e1b554628","responses":{"201":"c5f2cbbf-a81c-4201-9d53-6422279eb1e8","400":"2dc9ec34-6571-421c-94c9-adbd67f72105","401":"9cf05cc3-1e4b-436d-9ffb-883ce7d25c11"},"method":"post","type":"path","servers":["941c2dd2-5001-4bd3-a6cc-ef4009c675b7"],"security":["60d1a0e8-d1e9-4094-9d51-48bba759de68","407649c1-ed42-4564-8023-b8cd627cbd0c"],"path":"/wallet-pass","baseUrlOptions":["https://api.ubpass.co/v1"],"title":"Create a wallet pass","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"e7887942-5c62-4c16-8dcd-56726cd138c3":{"name":"x-workspace-id","in":"header","description":"Workspace ID to perform the operation in. If not provided, system will use the first one assigned to the user","required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9-_]+$","isRequired":false,"description":"Workspace ID to perform the operation in. If not provided, system will use the first one assigned to the user","uniqueKey":"","typeLabel":"string"},"example":"1f089d29-6f9c-66c2-af59-99631cec7ab5"}},"requestBody":{"description":"Wallet pass creation data including metadata, fields, and uploaded asset references","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"id","typeLabel":"string"},"createdTime":{"type":"string","format":"date-time","description":"The time when the entity was created in ISO 8601 format including milliseconds and timezone offset.","example":"2025-05-13T15:07:15.036Z","uniqueKey":"createdTime","typeLabel":"string\u003cdate-time>"},"updatedTime":{"type":"string","format":"date-time","description":"The time when the entity was last updated in ISO 8601 format including milliseconds and timezone offset.","example":"2025-05-13T15:07:15.036Z","uniqueKey":"updatedTime","typeLabel":"string\u003cdate-time>"},"createdBy":{"type":"string","description":"The user who created the entity.","uniqueKey":"createdBy","typeLabel":"string"},"updatedBy":{"type":"string","description":"The user who last updated the entity.","uniqueKey":"updatedBy","typeLabel":"string"},"workspaceId":{"type":"string","description":"Workspace the pass belongs to. ","uniqueKey":"workspaceId","typeLabel":"string"},"passName":{"type":"string","description":"Name of the pass, the name has to be unique within the workspace.","example":"My Wallet Pass","uniqueKey":"passName","typeLabel":"string"},"passMetadata":{"type":"object","properties":{"description":{"type":"string","description":"Pass description. Apple: Displayed on the back of the pass, providing additional details. Google: Used as the main description of the pass, visible in the pass details.","uniqueKey":"passMetadata.description","typeLabel":"string"},"organizationName":{"type":"string","description":"Organization name. Apple: Displayed on the lock screen and in the Wallet app, identifying the issuer. Google: Displayed at the top of the pass, identifying the issuer.","uniqueKey":"passMetadata.organizationName","typeLabel":"string"},"backgroundColor":{"type":"string","description":"Background color of the pass.","uniqueKey":"passMetadata.backgroundColor","typeLabel":"string"},"displayTextColor":{"type":"string","description":"Text color of the pass.","uniqueKey":"passMetadata.displayTextColor","typeLabel":"string"},"topField":{"type":"object","properties":{"key":{"type":"string","uniqueKey":"passMetadata.topField.key","typeLabel":"string"},"label":{"type":"string","uniqueKey":"passMetadata.topField.label","typeLabel":"string"},"value":{"type":"string","uniqueKey":"passMetadata.topField.value","typeLabel":"string"},"changeMessage":{"type":"string","uniqueKey":"passMetadata.topField.changeMessage","typeLabel":"string"}},"description":"Top field. Apple: It appears at the right top of the pass. Google: Top field appears below the pass description.","uniqueKey":"passMetadata.topField","typeLabel":"object"},"secondaryFields":{"type":"array","description":"Secondary fields.","items":{"type":"object","properties":{"key":{"type":"string","uniqueKey":"passMetadata.secondaryFields.items.[INDEX].key","typeLabel":"string"},"label":{"type":"string","uniqueKey":"passMetadata.secondaryFields.items.[INDEX].label","typeLabel":"string"},"value":{"type":"string","uniqueKey":"passMetadata.secondaryFields.items.[INDEX].value","typeLabel":"string"},"changeMessage":{"type":"string","uniqueKey":"passMetadata.secondaryFields.items.[INDEX].changeMessage","typeLabel":"string"}},"uniqueKey":"passMetadata.secondaryFields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"passMetadata.secondaryFields","typeLabel":"object[]"},"backFields":{"type":"array","description":"Back fields.","items":{"type":"object","properties":{"key":{"type":"string","uniqueKey":"passMetadata.backFields.items.[INDEX].key","typeLabel":"string"},"label":{"type":"string","uniqueKey":"passMetadata.backFields.items.[INDEX].label","typeLabel":"string"},"value":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string","uniqueKey":"passMetadata.backFields.items.[INDEX].value.items.[INDEX].text","typeLabel":"string"},"link":{"type":"string","uniqueKey":"passMetadata.backFields.items.[INDEX].value.items.[INDEX].link","typeLabel":"string"},"slug":{"type":"string","uniqueKey":"passMetadata.backFields.items.[INDEX].value.items.[INDEX].slug","typeLabel":"string"},"shortLinkValue":{"type":"string","uniqueKey":"passMetadata.backFields.items.[INDEX].value.items.[INDEX].shortLinkValue","typeLabel":"string"},"shortLinkId":{"type":"string","uniqueKey":"passMetadata.backFields.items.[INDEX].value.items.[INDEX].shortLinkId","typeLabel":"string"},"utmSource":{"type":"string","uniqueKey":"passMetadata.backFields.items.[INDEX].value.items.[INDEX].utmSource","typeLabel":"string"}},"uniqueKey":"passMetadata.backFields.items.[INDEX].value.items.[INDEX]","typeLabel":"object"},"uniqueKey":"passMetadata.backFields.items.[INDEX].value","typeLabel":"object[]"},"changeMessage":{"type":"string","uniqueKey":"passMetadata.backFields.items.[INDEX].changeMessage","typeLabel":"string"}},"uniqueKey":"passMetadata.backFields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"passMetadata.backFields","typeLabel":"object[]"},"qrUrl":{"type":"string","description":"URL or text for the QR code.","uniqueKey":"passMetadata.qrUrl","typeLabel":"string"},"qrText":{"type":"string","description":"QR text. It appears below the QR code.","uniqueKey":"passMetadata.qrText","typeLabel":"string"},"locations":{"type":"array","description":"Locations. Apple: Defines geographic locations where the pass is relevant. The pass can appear on the lock screen when the user is near one of these locations. Google: Not supported.","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the location. This field is required and has a maximum length of 255 characters.","example":"Main Store","maxLength":255,"minLength":0,"isRequired":true,"uniqueKey":"passMetadata.locations.items.[INDEX].name","typeLabel":"string"},"latitude":{"type":"number","format":"double","description":"Latitude of the location in degrees. This field is required.","example":37.7749,"isRequired":true,"uniqueKey":"passMetadata.locations.items.[INDEX].latitude","typeLabel":"number\u003cdouble>"},"longitude":{"type":"number","format":"double","description":"Longitude of the location in degrees. This field is required.","example":-122.4194,"isRequired":true,"uniqueKey":"passMetadata.locations.items.[INDEX].longitude","typeLabel":"number\u003cdouble>"},"relevantText":{"type":"string","description":"Text to display on the lock screen when the user is near this location. This field is required and has a maximum length of 255 characters.","example":"You are near Main Store!","maxLength":255,"minLength":0,"isRequired":true,"uniqueKey":"passMetadata.locations.items.[INDEX].relevantText","typeLabel":"string"},"id":{"type":"string","uniqueKey":"passMetadata.locations.items.[INDEX].id","typeLabel":"string"},"createdTime":{"type":"string","format":"date-time","description":"The time when the entity was created in ISO 8601 format including milliseconds and timezone offset.","example":"2025-05-13T15:07:15.036Z","uniqueKey":"passMetadata.locations.items.[INDEX].createdTime","typeLabel":"string\u003cdate-time>"},"updatedTime":{"type":"string","format":"date-time","description":"The time when the entity was last updated in ISO 8601 format including milliseconds and timezone offset.","example":"2025-05-13T15:07:15.036Z","uniqueKey":"passMetadata.locations.items.[INDEX].updatedTime","typeLabel":"string\u003cdate-time>"},"createdBy":{"type":"string","description":"The user who created the entity.","uniqueKey":"passMetadata.locations.items.[INDEX].createdBy","typeLabel":"string"},"updatedBy":{"type":"string","description":"The user who last updated the entity.","uniqueKey":"passMetadata.locations.items.[INDEX].updatedBy","typeLabel":"string"},"workspaceId":{"type":"string","description":"The ID of the workspace to which this entity belongs.","uniqueKey":"passMetadata.locations.items.[INDEX].workspaceId","typeLabel":"string"},"enabled":{"type":"boolean","description":"Indicates whether the location is enabled. If true, the pass may trigger a notification when the user is near this location. Default is true if not specified.","example":true,"uniqueKey":"passMetadata.locations.items.[INDEX].enabled","typeLabel":"boolean"},"altitude":{"type":"number","format":"double","description":"Altitude of the location in meters. Optional.","example":10.5,"uniqueKey":"passMetadata.locations.items.[INDEX].altitude","typeLabel":"number\u003cdouble>"}},"required":["latitude","longitude","name","relevantText"],"uniqueKey":"passMetadata.locations.items.[INDEX]","typeLabel":"object"},"uniqueKey":"passMetadata.locations","typeLabel":"object[]"},"appDeepLinks":{"type":"object","properties":{"appleDeepLinkData":{"type":"object","properties":{"appStoreId":{"type":"string","uniqueKey":"passMetadata.appDeepLinks.appleDeepLinkData.appStoreId","typeLabel":"string"},"launchUrl":{"type":"string","uniqueKey":"passMetadata.appDeepLinks.appleDeepLinkData.launchUrl","typeLabel":"string"}},"uniqueKey":"passMetadata.appDeepLinks.appleDeepLinkData","typeLabel":"object"},"googleDeepLinkData":{"type":"object","properties":{"androidPackageName":{"type":"string","uniqueKey":"passMetadata.appDeepLinks.googleDeepLinkData.androidPackageName","typeLabel":"string"},"webAppUrl":{"type":"string","uniqueKey":"passMetadata.appDeepLinks.googleDeepLinkData.webAppUrl","typeLabel":"string"},"displayText":{"type":"string","uniqueKey":"passMetadata.appDeepLinks.googleDeepLinkData.displayText","typeLabel":"string"}},"uniqueKey":"passMetadata.appDeepLinks.googleDeepLinkData","typeLabel":"object"}},"uniqueKey":"passMetadata.appDeepLinks","typeLabel":"object"},"userDeepLink":{"type":"object","properties":{"appType":{"type":"string","description":"Type of application for the deep link","enum":["Website","Mobile App","Tiktok","Instagram","X","Youtube","Spotify"],"uniqueKey":"passMetadata.userDeepLink.appType","typeLabel":"enum\u003cstring>"},"inputLink":{"type":"string","description":"The input link URL for the deep link","uniqueKey":"passMetadata.userDeepLink.inputLink","typeLabel":"string"},"appleAppStoreUrl":{"type":"string","description":"Apple App Store URL (for Mobile App type)","uniqueKey":"passMetadata.userDeepLink.appleAppStoreUrl","typeLabel":"string"},"launchUrl":{"type":"string","description":"Launch URL (for Mobile App type)","uniqueKey":"passMetadata.userDeepLink.launchUrl","typeLabel":"string"},"googlePlayStoreUrl":{"type":"string","description":"Google Play Store URL (for Mobile App type)","uniqueKey":"passMetadata.userDeepLink.googlePlayStoreUrl","typeLabel":"string"}},"description":"User deep link configuration containing app type and input link","uniqueKey":"passMetadata.userDeepLink","typeLabel":"object"}},"description":"Pass metadata.","uniqueKey":"passMetadata","typeLabel":"object"},"uploadInfoList":{"type":"array","description":"Wallet pass images. each pass has to have a logo, icon, and strip images in png format. footer.png is optional.","items":{"type":"object","properties":{"fileKey":{"type":"string","uniqueKey":"uploadInfoList.items.[INDEX].fileKey","typeLabel":"string"},"fileName":{"type":"string","uniqueKey":"uploadInfoList.items.[INDEX].fileName","typeLabel":"string"},"url":{"type":"string","uniqueKey":"uploadInfoList.items.[INDEX].url","typeLabel":"string"}},"uniqueKey":"uploadInfoList.items.[INDEX]","typeLabel":"object"},"uniqueKey":"uploadInfoList","typeLabel":"object[]"},"passLink":{"type":"string","description":"The link where passes can be downloaded. This link will be generated after passes are created.","uniqueKey":"passLink","typeLabel":"string"},"notificationHeader":{"type":"string","description":"This is used for Apple passes. The notification header is displayed on the lock screen when a notification is sent to the pass.","uniqueKey":"notificationHeader","typeLabel":"string"},"account":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"account.id","typeLabel":"string"},"createdTime":{"type":"string","format":"date-time","description":"The time when the entity was created in ISO 8601 format including milliseconds and timezone offset.","example":"2025-05-13T15:07:15.036Z","uniqueKey":"account.createdTime","typeLabel":"string\u003cdate-time>"},"updatedTime":{"type":"string","format":"date-time","description":"The time when the entity was last updated in ISO 8601 format including milliseconds and timezone offset.","example":"2025-05-13T15:07:15.036Z","uniqueKey":"account.updatedTime","typeLabel":"string\u003cdate-time>"},"createdBy":{"type":"string","description":"The user who created the entity.","uniqueKey":"account.createdBy","typeLabel":"string"},"updatedBy":{"type":"string","description":"The user who last updated the entity.","uniqueKey":"account.updatedBy","typeLabel":"string"},"workspaceId":{"type":"string","description":"The ID of the workspace to which this entity belongs.","uniqueKey":"account.workspaceId","typeLabel":"string"},"name":{"type":"string","description":"Account name","uniqueKey":"account.name","typeLabel":"string"},"clientContact":{"type":"string","description":"Client contact","uniqueKey":"account.clientContact","typeLabel":"string"},"clientContactDetails":{"type":"string","description":"Client contact details","uniqueKey":"account.clientContactDetails","typeLabel":"string"}},"description":"Account which the pass belongs to. If it's not provided the system will automatically use the default account for the workspace.","uniqueKey":"account","typeLabel":"object"},"appleIssuedCount":{"type":"integer","format":"int32","description":"Total number of users who have added this pass to their Apple Wallets","uniqueKey":"appleIssuedCount","typeLabel":"integer\u003cint32>"},"googleIssuedCount":{"type":"integer","format":"int32","description":"Total number of users who have added this pass to their Google Wallets","uniqueKey":"googleIssuedCount","typeLabel":"integer\u003cint32>"},"totalIssuedCount":{"type":"integer","format":"int32","description":"Total number of users who have added this pass to their wallets (Apple + Google)","uniqueKey":"totalIssuedCount","typeLabel":"integer\u003cint32>"},"appleActiveCount":{"type":"integer","format":"int32","description":"Total number of users who have added this pass to their Apple Wallets and have not removed it","uniqueKey":"appleActiveCount","typeLabel":"integer\u003cint32>"},"googleActiveCount":{"type":"integer","format":"int32","description":"Total number of users who have added this pass to their Google Wallets and have not removed it","uniqueKey":"googleActiveCount","typeLabel":"integer\u003cint32>"},"totalActiveCount":{"type":"integer","format":"int32","description":"Total number of users who have added this pass to their wallets (Apple + Google) and have not removed it","uniqueKey":"totalActiveCount","typeLabel":"integer\u003cint32>"},"passLinkSlug":{"type":"string","description":"Slug to be used for the pass link. This is used to generate the pass link, if not provided the system will generate a random slug.","uniqueKey":"passLinkSlug","typeLabel":"string"},"googlePassLink":{"type":"string","description":"Raw link to Google Pass. This link is provided by Google API.","uniqueKey":"googlePassLink","typeLabel":"string"},"status":{"type":"string","description":"Pass status","enum":["Draft","Published"],"example":"Draft, Published","uniqueKey":"status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Create Pass Request":{"title":"Create Pass Request","description":"Create Pass Request","value":{"notificationHeader":"BLUE PASS","passName":"VIP MEMBERSHIP PASS","passMetadata":{"description":"Exclusive VIP membership pass with premium benefits","organizationName":"Premium Brands Inc","backgroundColor":"#4a32A8","displayTextColor":"#FFFFFF","topField":{"key":"tabKey","label":"SEE OFFERS","value":"Tab (...)"},"secondaryFields":[{"key":"auxiliaryFieldKey","label":"Member Level","value":"VIP Gold"},{"key":"auxiliaryFieldKey2","label":"Expires","value":"Dec 31, 2025"}],"backFields":[{"key":"featured","label":"Featured","value":[{"link":"https://premiumbrands.com/","text":"Visit Our Website"}]},{"key":"connectWithUs","label":"Connect","value":[{"link":"https://x.com/premiumbrands/","text":"X"},{"link":"https://www.instagram.com/premiumbrands/","text":"Instagram"}],"changeMessage":null}],"qrUrl":"https://premiumbrands.com/vip-benefits","qrText":"Scan for VIP benefits"},"uploadInfoList":[{"fileName":"icon.png","uploadKey":"1f089d37-8a1b-4c2d-9e3f-123456789abc"},{"fileName":"logo.png","uploadKey":"1f089d37-8a1b-4c2d-9e3f-123456789def"},{"fileName":"strip.png","uploadKey":"1f089d37-8a1b-4c2d-9e3f-123456789ghi"}]}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"c5f2cbbf-a81c-4201-9d53-6422279eb1e8":{"description":"Wallet pass created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"id","typeLabel":"string"},"createdTime":{"type":"string","format":"date-time","description":"The time when the entity was created in ISO 8601 format including milliseconds and timezone offset.","example":"2025-05-13T15:07:15.036Z","uniqueKey":"createdTime","typeLabel":"string\u003cdate-time>"},"updatedTime":{"type":"string","format":"date-time","description":"The time when the entity was last updated in ISO 8601 format including milliseconds and timezone offset.","example":"2025-05-13T15:07:15.036Z","uniqueKey":"updatedTime","typeLabel":"string\u003cdate-time>"},"createdBy":{"type":"string","description":"The user who created the entity.","uniqueKey":"createdBy","typeLabel":"string"},"updatedBy":{"type":"string","description":"The user who last updated the entity.","uniqueKey":"updatedBy","typeLabel":"string"},"workspaceId":{"type":"string","description":"Workspace the pass belongs to. ","uniqueKey":"workspaceId","typeLabel":"string"},"passName":{"type":"string","description":"Name of the pass, the name has to be unique within the workspace.","example":"My Wallet Pass","uniqueKey":"passName","typeLabel":"string"},"passMetadata":{"type":"object","properties":{"description":{"type":"string","description":"Pass description. Apple: Displayed on the back of the pass, providing additional details. Google: Used as the main description of the pass, visible in the pass details.","uniqueKey":"passMetadata.description","typeLabel":"string"},"organizationName":{"type":"string","description":"Organization name. Apple: Displayed on the lock screen and in the Wallet app, identifying the issuer. Google: Displayed at the top of the pass, identifying the issuer.","uniqueKey":"passMetadata.organizationName","typeLabel":"string"},"backgroundColor":{"type":"string","description":"Background color of the pass.","uniqueKey":"passMetadata.backgroundColor","typeLabel":"string"},"displayTextColor":{"type":"string","description":"Text color of the pass.","uniqueKey":"passMetadata.displayTextColor","typeLabel":"string"},"topField":{"type":"object","properties":{"key":{"type":"string","uniqueKey":"passMetadata.topField.key","typeLabel":"string"},"label":{"type":"string","uniqueKey":"passMetadata.topField.label","typeLabel":"string"},"value":{"type":"string","uniqueKey":"passMetadata.topField.value","typeLabel":"string"},"changeMessage":{"type":"string","uniqueKey":"passMetadata.topField.changeMessage","typeLabel":"string"}},"description":"Top field. Apple: It appears at the right top of the pass. Google: Top field appears below the pass description.","uniqueKey":"passMetadata.topField","typeLabel":"object"},"secondaryFields":{"type":"array","description":"Secondary fields.","items":{"type":"object","properties":{"key":{"type":"string","uniqueKey":"passMetadata.secondaryFields.items.[INDEX].key","typeLabel":"string"},"label":{"type":"string","uniqueKey":"passMetadata.secondaryFields.items.[INDEX].label","typeLabel":"string"},"value":{"type":"string","uniqueKey":"passMetadata.secondaryFields.items.[INDEX].value","typeLabel":"string"},"changeMessage":{"type":"string","uniqueKey":"passMetadata.secondaryFields.items.[INDEX].changeMessage","typeLabel":"string"}},"uniqueKey":"passMetadata.secondaryFields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"passMetadata.secondaryFields","typeLabel":"object[]"},"backFields":{"type":"array","description":"Back fields.","items":{"type":"object","properties":{"key":{"type":"string","uniqueKey":"passMetadata.backFields.items.[INDEX].key","typeLabel":"string"},"label":{"type":"string","uniqueKey":"passMetadata.backFields.items.[INDEX].label","typeLabel":"string"},"value":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string","uniqueKey":"passMetadata.backFields.items.[INDEX].value.items.[INDEX].text","typeLabel":"string"},"link":{"type":"string","uniqueKey":"passMetadata.backFields.items.[INDEX].value.items.[INDEX].link","typeLabel":"string"},"slug":{"type":"string","uniqueKey":"passMetadata.backFields.items.[INDEX].value.items.[INDEX].slug","typeLabel":"string"},"shortLinkValue":{"type":"string","uniqueKey":"passMetadata.backFields.items.[INDEX].value.items.[INDEX].shortLinkValue","typeLabel":"string"},"shortLinkId":{"type":"string","uniqueKey":"passMetadata.backFields.items.[INDEX].value.items.[INDEX].shortLinkId","typeLabel":"string"},"utmSource":{"type":"string","uniqueKey":"passMetadata.backFields.items.[INDEX].value.items.[INDEX].utmSource","typeLabel":"string"}},"uniqueKey":"passMetadata.backFields.items.[INDEX].value.items.[INDEX]","typeLabel":"object"},"uniqueKey":"passMetadata.backFields.items.[INDEX].value","typeLabel":"object[]"},"changeMessage":{"type":"string","uniqueKey":"passMetadata.backFields.items.[INDEX].changeMessage","typeLabel":"string"}},"uniqueKey":"passMetadata.backFields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"passMetadata.backFields","typeLabel":"object[]"},"qrUrl":{"type":"string","description":"URL or text for the QR code.","uniqueKey":"passMetadata.qrUrl","typeLabel":"string"},"qrText":{"type":"string","description":"QR text. It appears below the QR code.","uniqueKey":"passMetadata.qrText","typeLabel":"string"},"locations":{"type":"array","description":"Locations. Apple: Defines geographic locations where the pass is relevant. The pass can appear on the lock screen when the user is near one of these locations. Google: Not supported.","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the location. This field is required and has a maximum length of 255 characters.","example":"Main Store","maxLength":255,"minLength":0,"isRequired":true,"uniqueKey":"passMetadata.locations.items.[INDEX].name","typeLabel":"string"},"latitude":{"type":"number","format":"double","description":"Latitude of the location in degrees. This field is required.","example":37.7749,"isRequired":true,"uniqueKey":"passMetadata.locations.items.[INDEX].latitude","typeLabel":"number\u003cdouble>"},"longitude":{"type":"number","format":"double","description":"Longitude of the location in degrees. This field is required.","example":-122.4194,"isRequired":true,"uniqueKey":"passMetadata.locations.items.[INDEX].longitude","typeLabel":"number\u003cdouble>"},"relevantText":{"type":"string","description":"Text to display on the lock screen when the user is near this location. This field is required and has a maximum length of 255 characters.","example":"You are near Main Store!","maxLength":255,"minLength":0,"isRequired":true,"uniqueKey":"passMetadata.locations.items.[INDEX].relevantText","typeLabel":"string"},"id":{"type":"string","uniqueKey":"passMetadata.locations.items.[INDEX].id","typeLabel":"string"},"createdTime":{"type":"string","format":"date-time","description":"The time when the entity was created in ISO 8601 format including milliseconds and timezone offset.","example":"2025-05-13T15:07:15.036Z","uniqueKey":"passMetadata.locations.items.[INDEX].createdTime","typeLabel":"string\u003cdate-time>"},"updatedTime":{"type":"string","format":"date-time","description":"The time when the entity was last updated in ISO 8601 format including milliseconds and timezone offset.","example":"2025-05-13T15:07:15.036Z","uniqueKey":"passMetadata.locations.items.[INDEX].updatedTime","typeLabel":"string\u003cdate-time>"},"createdBy":{"type":"string","description":"The user who created the entity.","uniqueKey":"passMetadata.locations.items.[INDEX].createdBy","typeLabel":"string"},"updatedBy":{"type":"string","description":"The user who last updated the entity.","uniqueKey":"passMetadata.locations.items.[INDEX].updatedBy","typeLabel":"string"},"workspaceId":{"type":"string","description":"The ID of the workspace to which this entity belongs.","uniqueKey":"passMetadata.locations.items.[INDEX].workspaceId","typeLabel":"string"},"enabled":{"type":"boolean","description":"Indicates whether the location is enabled. If true, the pass may trigger a notification when the user is near this location. Default is true if not specified.","example":true,"uniqueKey":"passMetadata.locations.items.[INDEX].enabled","typeLabel":"boolean"},"altitude":{"type":"number","format":"double","description":"Altitude of the location in meters. Optional.","example":10.5,"uniqueKey":"passMetadata.locations.items.[INDEX].altitude","typeLabel":"number\u003cdouble>"}},"required":["latitude","longitude","name","relevantText"],"uniqueKey":"passMetadata.locations.items.[INDEX]","typeLabel":"object"},"uniqueKey":"passMetadata.locations","typeLabel":"object[]"},"appDeepLinks":{"type":"object","properties":{"appleDeepLinkData":{"type":"object","properties":{"appStoreId":{"type":"string","uniqueKey":"passMetadata.appDeepLinks.appleDeepLinkData.appStoreId","typeLabel":"string"},"launchUrl":{"type":"string","uniqueKey":"passMetadata.appDeepLinks.appleDeepLinkData.launchUrl","typeLabel":"string"}},"uniqueKey":"passMetadata.appDeepLinks.appleDeepLinkData","typeLabel":"object"},"googleDeepLinkData":{"type":"object","properties":{"androidPackageName":{"type":"string","uniqueKey":"passMetadata.appDeepLinks.googleDeepLinkData.androidPackageName","typeLabel":"string"},"webAppUrl":{"type":"string","uniqueKey":"passMetadata.appDeepLinks.googleDeepLinkData.webAppUrl","typeLabel":"string"},"displayText":{"type":"string","uniqueKey":"passMetadata.appDeepLinks.googleDeepLinkData.displayText","typeLabel":"string"}},"uniqueKey":"passMetadata.appDeepLinks.googleDeepLinkData","typeLabel":"object"}},"uniqueKey":"passMetadata.appDeepLinks","typeLabel":"object"},"userDeepLink":{"type":"object","properties":{"appType":{"type":"string","description":"Type of application for the deep link","enum":["Website","Mobile App","Tiktok","Instagram","X","Youtube","Spotify"],"uniqueKey":"passMetadata.userDeepLink.appType","typeLabel":"enum\u003cstring>"},"inputLink":{"type":"string","description":"The input link URL for the deep link","uniqueKey":"passMetadata.userDeepLink.inputLink","typeLabel":"string"},"appleAppStoreUrl":{"type":"string","description":"Apple App Store URL (for Mobile App type)","uniqueKey":"passMetadata.userDeepLink.appleAppStoreUrl","typeLabel":"string"},"launchUrl":{"type":"string","description":"Launch URL (for Mobile App type)","uniqueKey":"passMetadata.userDeepLink.launchUrl","typeLabel":"string"},"googlePlayStoreUrl":{"type":"string","description":"Google Play Store URL (for Mobile App type)","uniqueKey":"passMetadata.userDeepLink.googlePlayStoreUrl","typeLabel":"string"}},"description":"User deep link configuration containing app type and input link","uniqueKey":"passMetadata.userDeepLink","typeLabel":"object"}},"description":"Pass metadata.","uniqueKey":"passMetadata","typeLabel":"object"},"uploadInfoList":{"type":"array","description":"Wallet pass images. each pass has to have a logo, icon, and strip images in png format. footer.png is optional.","items":{"type":"object","properties":{"fileKey":{"type":"string","uniqueKey":"uploadInfoList.items.[INDEX].fileKey","typeLabel":"string"},"fileName":{"type":"string","uniqueKey":"uploadInfoList.items.[INDEX].fileName","typeLabel":"string"},"url":{"type":"string","uniqueKey":"uploadInfoList.items.[INDEX].url","typeLabel":"string"}},"uniqueKey":"uploadInfoList.items.[INDEX]","typeLabel":"object"},"uniqueKey":"uploadInfoList","typeLabel":"object[]"},"passLink":{"type":"string","description":"The link where passes can be downloaded. This link will be generated after passes are created.","uniqueKey":"passLink","typeLabel":"string"},"notificationHeader":{"type":"string","description":"This is used for Apple passes. The notification header is displayed on the lock screen when a notification is sent to the pass.","uniqueKey":"notificationHeader","typeLabel":"string"},"account":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"account.id","typeLabel":"string"},"createdTime":{"type":"string","format":"date-time","description":"The time when the entity was created in ISO 8601 format including milliseconds and timezone offset.","example":"2025-05-13T15:07:15.036Z","uniqueKey":"account.createdTime","typeLabel":"string\u003cdate-time>"},"updatedTime":{"type":"string","format":"date-time","description":"The time when the entity was last updated in ISO 8601 format including milliseconds and timezone offset.","example":"2025-05-13T15:07:15.036Z","uniqueKey":"account.updatedTime","typeLabel":"string\u003cdate-time>"},"createdBy":{"type":"string","description":"The user who created the entity.","uniqueKey":"account.createdBy","typeLabel":"string"},"updatedBy":{"type":"string","description":"The user who last updated the entity.","uniqueKey":"account.updatedBy","typeLabel":"string"},"workspaceId":{"type":"string","description":"The ID of the workspace to which this entity belongs.","uniqueKey":"account.workspaceId","typeLabel":"string"},"name":{"type":"string","description":"Account name","uniqueKey":"account.name","typeLabel":"string"},"clientContact":{"type":"string","description":"Client contact","uniqueKey":"account.clientContact","typeLabel":"string"},"clientContactDetails":{"type":"string","description":"Client contact details","uniqueKey":"account.clientContactDetails","typeLabel":"string"}},"description":"Account which the pass belongs to. If it's not provided the system will automatically use the default account for the workspace.","uniqueKey":"account","typeLabel":"object"},"appleIssuedCount":{"type":"integer","format":"int32","description":"Total number of users who have added this pass to their Apple Wallets","uniqueKey":"appleIssuedCount","typeLabel":"integer\u003cint32>"},"googleIssuedCount":{"type":"integer","format":"int32","description":"Total number of users who have added this pass to their Google Wallets","uniqueKey":"googleIssuedCount","typeLabel":"integer\u003cint32>"},"totalIssuedCount":{"type":"integer","format":"int32","description":"Total number of users who have added this pass to their wallets (Apple + Google)","uniqueKey":"totalIssuedCount","typeLabel":"integer\u003cint32>"},"appleActiveCount":{"type":"integer","format":"int32","description":"Total number of users who have added this pass to their Apple Wallets and have not removed it","uniqueKey":"appleActiveCount","typeLabel":"integer\u003cint32>"},"googleActiveCount":{"type":"integer","format":"int32","description":"Total number of users who have added this pass to their Google Wallets and have not removed it","uniqueKey":"googleActiveCount","typeLabel":"integer\u003cint32>"},"totalActiveCount":{"type":"integer","format":"int32","description":"Total number of users who have added this pass to their wallets (Apple + Google) and have not removed it","uniqueKey":"totalActiveCount","typeLabel":"integer\u003cint32>"},"passLinkSlug":{"type":"string","description":"Slug to be used for the pass link. This is used to generate the pass link, if not provided the system will generate a random slug.","uniqueKey":"passLinkSlug","typeLabel":"string"},"googlePassLink":{"type":"string","description":"Raw link to Google Pass. This link is provided by Google API.","uniqueKey":"googlePassLink","typeLabel":"string"},"status":{"type":"string","description":"Pass status","enum":["Draft","Published"],"example":"Draft, Published","uniqueKey":"status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Created Pass Response":{"title":"Created Pass Response","description":"Created Pass Response","value":{"id":"1f089d37-5ebe-6778-af59-99631cec7ab5","createdTime":"2025-09-04T21:09:36.027Z","updatedTime":"2025-09-04T21:09:36.027Z","createdBy":"1ef58ae6-40ac-6fd2-96af-45801844c4e2","updatedBy":"1ef58ae6-40ac-6fd2-96af-45801844c4e2","workspaceId":"1f089d29-6f9c-66c2-af59-99631cec7ab5","accountId":"1f089d29-6fa8-6a13-af59-99631cec7ab5","notificationHeader":"BLUE PASS","passName":"VIP MEMBERSHIP PASS","status":"Published","passMetadata":{"description":"Exclusive VIP membership pass with premium benefits","organizationName":"Premium Brands Inc","backgroundColor":"#4a32A8","displayTextColor":"#FFFFFF","topField":{"key":"tabKey","label":"SEE OFFERS","value":"Tab (...)"},"secondaryFields":[{"key":"auxiliaryFieldKey","label":"Member Level","value":"VIP Gold"},{"key":"auxiliaryFieldKey2","label":"Expires","value":"Dec 31, 2025"}],"backFields":[{"key":"featured","label":"Featured","value":[{"link":"https://premiumbrands.com/","text":"Visit Our Website"}]}],"qrUrl":"https://premiumbrands.com/vip-benefits","qrText":"Scan for VIP benefits"},"uploadInfoList":[{"fileName":"icon.png","uploadKey":"1f089d37-8a1b-4c2d-9e3f-123456789abc"},{"fileName":"logo.png","uploadKey":"1f089d37-8a1b-4c2d-9e3f-123456789def"},{"fileName":"strip.png","uploadKey":"1f089d37-8a1b-4c2d-9e3f-123456789ghi"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"2dc9ec34-6571-421c-94c9-adbd67f72105":{"description":"Bad Request - Invalid input data","content":{"application/json":{"schema":{"type":"object","properties":{"txId":{"type":"string","uniqueKey":"txId","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"errorCode":{"type":"string","uniqueKey":"errorCode","typeLabel":"string"},"errorMessage":{"type":"string","uniqueKey":"errorMessage","typeLabel":"string"},"context":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"context.additionalProperties","typeLabel":"any"},"uniqueKey":"context","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Bad Request Error":{"title":"Bad Request Error","description":"Bad Request Error","value":{"txId":"1f098faa-8f33-6425-b4ff-533200846d35","timestamp":"24-09-2025 03:57:59","errorCode":"INVALID_INPUT","context":{"passName":"must not be null"}}}},"exampleType":"examples"}},"exampleType":"examples"},"9cf05cc3-1e4b-436d-9ffb-883ce7d25c11":{"description":"Unauthorized - Invalid or missing authentication","content":{"application/json":{"schema":{"type":"object","properties":{"txId":{"type":"string","uniqueKey":"txId","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"errorCode":{"type":"string","uniqueKey":"errorCode","typeLabel":"string"},"errorMessage":{"type":"string","uniqueKey":"errorMessage","typeLabel":"string"},"context":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"context.additionalProperties","typeLabel":"any"},"uniqueKey":"context","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Unauthorized Error":{"title":"Unauthorized Error","description":"Unauthorized Error","value":{"txId":"Root=1-68d3693c-26a3db2278c7668f5e086711","timestamp":"24-09-2025 03:45:00","errorCode":"UNAUTHORIZED","errorMessage":"UNAUTHORIZED."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"60d1a0e8-d1e9-4094-9d51-48bba759de68":{"AccessToken":{"type":"http","description":"Bearer token authentication","scheme":"bearer","bearerFormat":"JWT","scopes":[]}},"407649c1-ed42-4564-8023-b8cd627cbd0c":{"APIKey":{"type":"apiKey","description":"API Key authentication","name":"api-key","in":"header","scopes":[]}}},"servers":{"941c2dd2-5001-4bd3-a6cc-ef4009c675b7":{"url":"https://api.ubpass.co/v1","description":"Generated server url"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"Bearer token authentication","scheme":"bearer","bearerFormat":"JWT","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer token authentication","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"AccessToken","name":"Authorization"}],"title":"AccessToken"},{"schemes":[{"scheme":{"type":"apiKey","description":"API Key authentication","name":"api-key","in":"header","scopes":[]},"schema":{"title":"api-key","type":"string","description":"API Key authentication","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"APIKey","name":"api-key"}],"title":"APIKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"unblockedbrands","siteName":"Passport API Documentation","title":"Create a wallet pass - Passport API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-11-17T07:56:08.326Z","originalFileLocation":"api-reference/passport--passes/create-a-wallet-pass.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create a new wallet pass for both Apple and Google platforms.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Passport API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/unblockedbrands/QG6AMyWUHQwPSq9P/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/unblockedbrands/QG6AMyWUHQwPSq9P/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/unblockedbrands/QG6AMyWUHQwPSq9P/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/unblockedbrands/QG6AMyWUHQwPSq9P/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/unblockedbrands/QG6AMyWUHQwPSq9P/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/unblockedbrands/QG6AMyWUHQwPSq9P/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/unblockedbrands/QG6AMyWUHQwPSq9P/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/unblockedbrands/QG6AMyWUHQwPSq9P/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/unblockedbrands/QG6AMyWUHQwPSq9P/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a wallet pass - Passport API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a new wallet pass for both Apple and Google platforms.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Passport API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.unblockedbrands.com/api-reference/passport--passes/create-a-wallet-pass\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://unblockedbrands.mintlify.app/_mintlify/api/og/v2?division=Passport+-+Passes\u0026amp;title=Create+a+wallet+pass\u0026amp;description=Create+a+new+wallet+pass+for+both+Apple+and+Google+platforms.%0A\u0026amp;theme=dda4ad265c91f7b9b402560c\u0026amp;signature=fc0f945818407684190b63d85bc15f39eb83fc90f61918e0c7d7ea8fc934c6c9\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a wallet pass - Passport API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a new wallet pass for both Apple and Google platforms.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://unblockedbrands.mintlify.app/_mintlify/api/og/v2?division=Passport+-+Passes\u0026amp;title=Create+a+wallet+pass\u0026amp;description=Create+a+new+wallet+pass+for+both+Apple+and+Google+platforms.%0A\u0026amp;theme=dda4ad265c91f7b9b402560c\u0026amp;signature=fc0f945818407684190b63d85bc15f39eb83fc90f61918e0c7d7ea8fc934c6c9\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/unblockedbrands/QG6AMyWUHQwPSq9P/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Passport API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#367CFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.unblockedbrands.com/api-reference/passport--passes/create-a-wallet-pass\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/passport--passes/create-a-wallet-pass.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.unblockedbrands.com/#organization\",\"name\":\"Passport API Documentation\",\"url\":\"https://docs.unblockedbrands.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/unblockedbrands/gtu0hwK9wYwAN1IU/logo/light.svg?fit=max\u0026auto=format\u0026n=gtu0hwK9wYwAN1IU\u0026q=85\u0026s=fc2bc30f86e845dd67e4eca1fec434c6\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.unblockedbrands.com#website\",\"name\":\"Passport API Documentation\",\"url\":\"https://docs.unblockedbrands.com\",\"publisher\":{\"@id\":\"https://docs.unblockedbrands.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.unblockedbrands.com/api-reference/passport--passes/create-a-wallet-pass#webpage\",\"url\":\"https://docs.unblockedbrands.com/api-reference/passport--passes/create-a-wallet-pass\",\"name\":\"Create a wallet pass\",\"description\":\"Create a new wallet pass for both Apple and Google platforms.\",\"dateModified\":\"2025-11-17T07:56:08.326Z\",\"isPartOf\":{\"@id\":\"https://docs.unblockedbrands.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.unblockedbrands.com/api-reference/passport--passes/create-a-wallet-pass#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.unblockedbrands.com/api-reference/passport--passes/create-a-wallet-pass#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Passport - Passes\",\"item\":\"https://docs.unblockedbrands.com/api-reference/passport--passes/search-and-filter-wallet-passes\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a wallet pass\",\"item\":\"https://docs.unblockedbrands.com/api-reference/passport--passes/create-a-wallet-pass\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.unblockedbrands.com/api-reference/passport--passes/create-a-wallet-pass#apireference\",\"headline\":\"Create a wallet pass\",\"name\":\"Create a wallet pass\",\"description\":\"Create a new wallet pass for both Apple and Google platforms.\",\"url\":\"https://docs.unblockedbrands.com/api-reference/passport--passes/create-a-wallet-pass\",\"mainEntityOfPage\":{\"@id\":\"https://docs.unblockedbrands.com/api-reference/passport--passes/create-a-wallet-pass#webpage\"},\"dateModified\":\"2025-11-17T07:56:08.326Z\",\"publisher\":{\"@id\":\"https://docs.unblockedbrands.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.unblockedbrands.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Passport API Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Passport API Documentation","nav":{"global":null,"tabs":[{"tab":"API Reference","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","icon":"book-open","href":"/api-reference/introduction"},{"title":"API keys","icon":"key","href":"/api-reference/api-keys"}]},{"group":"Pique","pages":[{"title":"Search and filter Pique Campaigns","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /pique-campaign","href":"/api-reference/pique/search-and-filter-pique-campaigns"},{"title":"Create Pique Campaign","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /pique-campaign","href":"/api-reference/pique/create-pique-campaign"},{"title":"Get Pique Campaign by ID","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /pique-campaign/{id}","href":"/api-reference/pique/get-pique-campaign-by-id"},{"title":"Update Pique Campaign","deprecated":null,"version":null,"openapi":"api-reference/openapi.json patch /pique-campaign/{id}","href":"/api-reference/pique/update-pique-campaign"},{"title":"Get Pique Campaign video performance data","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /pique-campaign/{id}/video-performance","href":"/api-reference/pique/get-pique-campaign-video-performance-data"}]},{"group":"Passport - Passes","pages":[{"title":"Search and filter Wallet Passes","description":"Search and retrieve Wallet Passes with optional filtering and pagination.\n\n**Features:**\n- Search passes by name using keyword query (case-insensitive)\n- Filter by pass status (Draft, Published)\n- Filter by specific pass ID or pass name\n- Pagination support with cursor-based navigation\n- Option to include pass assets (images) in response\n- Option to return summary-only information\n\n**Pagination:**\n- Use `cursor` parameter for next page navigation\n- `limit` controls page size (default: 20, max: 20)\n- Response includes `items` array, `cursor`, and `hasMore` fields\n","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /wallet-pass","href":"/api-reference/passport--passes/search-and-filter-wallet-passes"},{"title":"Create a wallet pass","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /wallet-pass","href":"/api-reference/passport--passes/create-a-wallet-pass"},{"title":"Create a wallet pass asynchronously","description":"Create a new wallet pass for both Apple and Google platforms asynchronously.\nThis operation will queue the pass creation for background processing.\n","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /wallet-pass/async","href":"/api-reference/passport--passes/create-a-wallet-pass-asynchronously"},{"title":"Get wallet pass","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /wallet-pass/{id}","href":"/api-reference/passport--passes/get-wallet-pass"},{"title":"Update Wallet Pass","deprecated":null,"version":null,"openapi":"api-reference/openapi.json patch /wallet-pass/{id}","href":"/api-reference/passport--passes/update-wallet-pass"}]},{"group":"Passport - Push Notifications","pages":[{"title":"Search and filter wallet pass notifications","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /wallet-pass/notifications","href":"/api-reference/passport--push-notifications/search-and-filter-wallet-pass-notifications"},{"title":"Create a notification for a wallet pass","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /wallet-pass/notifications","href":"/api-reference/passport--push-notifications/create-a-notification-for-a-wallet-pass"},{"title":"Get wallet pass notification by ID","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /wallet-pass/notifications/{id}","href":"/api-reference/passport--push-notifications/get-wallet-pass-notification-by-id"},{"title":"Delete wallet pass notification","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /wallet-pass/notifications/{id}","href":"/api-reference/passport--push-notifications/delete-wallet-pass-notification"},{"title":"Update wallet pass notification","deprecated":null,"version":null,"openapi":"api-reference/openapi.json patch /wallet-pass/notifications/{id}","href":"/api-reference/passport--push-notifications/update-wallet-pass-notification"},{"title":"Get notification statistics","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /wallet-pass/notifications/{id}/stats","href":"/api-reference/passport--push-notifications/get-notification-statistics"}]},{"group":"Passport - Locations","pages":[{"title":"Search and filter Wallet Pass Locations","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /wallet-pass-location","href":"/api-reference/passport--locations/search-and-filter-wallet-pass-locations"},{"title":"Create a wallet pass location","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /wallet-pass-location","href":"/api-reference/passport--locations/create-a-wallet-pass-location"},{"title":"Get a wallet pass location","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /wallet-pass-location/{locationId}","href":"/api-reference/passport--locations/get-a-wallet-pass-location"},{"title":"Update a wallet pass location","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /wallet-pass-location/{locationId}","href":"/api-reference/passport--locations/update-a-wallet-pass-location"},{"title":"Delete a wallet pass location","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /wallet-pass-location/{locationId}","href":"/api-reference/passport--locations/delete-a-wallet-pass-location"}]},{"group":"Upload APIs","pages":[{"title":"Upload a file to the server","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /uploads","href":"/api-reference/upload-apis/upload-a-file-to-the-server"},{"title":"Upload a file to S3","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /uploads/s3","href":"/api-reference/upload-apis/upload-a-file-to-s3"},{"title":"Finalize the S3 copy operation","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /uploads/finalize/s3-copy","href":"/api-reference/upload-apis/finalize-the-s3-copy-operation"},{"title":"Get a pre-signed URL to upload a file to S3","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /uploads/s3-url","href":"/api-reference/upload-apis/get-a-pre-signed-url-to-upload-a-file-to-s3"}]}]}]},"title":"Create a wallet pass - Passport API Documentation","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}