Get an object as an Apple Wallet pass

Turn an owned object into an Apple Wallet pass its owner can keep on their iPhone, next to boarding cards and other passes. The person asking has to own the object — anybody else gets a `403`. This works with a signed-in person only, not with an API key. The pass carries the object's name, description and issue date, and links back to the object itself. It arrives ready to install, already signed. What comes back is the pass file. Pass it on to the browser exactly as it arrives, keeping the `application/vnd.apple.pkpass` content type — with anything else, the phone will not know to open it in Wallet. Requires the `integrations.objects.pkpass.read` permission.

GET
/integrations/objects/{objectId}/pkpass

Authorization

bearer-auth
AuthorizationBearer <token>

The access token returned after a successful sign-in, sent as Authorization: Bearer <access_token>.

It identifies the person and the organization they are working in, and it lasts about fifteen minutes. When it runs out, use their refresh token at POST /auth/refresh-token instead of asking them to sign in again.

In: header

Path Parameters

objectId*string

Identifier of the smart object.

Query Parameters

token?string

An access token, for a browser that cannot send an Authorization header.

Response Body

application/vnd.apple.pkpass

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.dual.network/integrations/objects/665f1c2d4b1a2c3d4e5f6a90/pkpass"
"string"
{
  "code": 3,
  "message": "Key: 'limit' Error:Field validation for 'limit' failed on the 'lte' tag"
}

{
  "code": 16,
  "message": "no auth provided"
}

{
  "code": 7,
  "message": "forbidden"
}
{
  "code": 5,
  "message": "object not found"
}
{
  "code": 13,
  "message": "internal error"
}