Logo Passcreator

Check if a Pass is Known to a Given ID

Checks if a pass is found for the given ID. This function can e.g. be used to check if a pass that is shown on admittance of a event is valid. To use this it is required that the ID is encoded in the passes' barcode. Please note that this only works reliable if you're using unique IDs as Barcode values. You can either use the unique IDs that are created by Passcreator for every pass or provide your own IDs.

This endpoint is deprecated and should no longer be used. Please use the endpoint to get data about a specific pass which returns data in a more helpful way.

GET/api/pass/checkbyid/{id-to-check-for}

Check if a Pass is Known to a Given ID

Checks if a pass is found for the given ID.

Path Parameters

  • Name
    id-to-check-for
    Type
    string
    (mandatory)
    Description

    ID that should be searched for.

Example URL

Request URL

https://app.passcreator.com/api/pass/checkbyid/552428addf5cd4.83175649


Authorization

  • Name
    Authorization
    Type
    string
    (mandatory)
    Description

    HTTP Header containing your API key. Replace yourApiKeyHere with your actual API key.

Example HTTP Header

HTTP header

GET /api/pass/checkbyid/{id-to-check-for} HTTP/1.1
Host: app.passcreator.com
Authorization: yourApiKeyHere


Returned Values

JSON-Array containing an array for every pass. The array for the passes contain these fields:

  • Name
    error
    Type
    string
    (mandatory)
    Description

    If an error occurred it is specified here. If the field is empty, no error occurred.

  • Name
    identifier
    Type
    string
    (mandatory)
    Description

    The UID of the pass that has the given ID.

  • Name
    uri
    Type
    string
    (mandatory)
    Description

    The URI of the pass that can be used to update or delete the pass.

  • Name
    generatedId
    Type
    string
    (mandatory)
    Description

    The ID (this is the one that was given in the request).

  • Name
    voided
    Type
    boolean
    (mandatory)
    Description

    false, if the pass is not voided, means it has not been used. true, if the pass is voided, means it has been used already.

  • Name
    passTemplateGuid
    Type
    string
    (mandatory)
    Description

    The GUID of the pass-template that was used to create the pass.

  • Name
    searchString
    Type
    string
    (mandatory)
    Description

    Contains all data on the pass separated by pipe symbols |.

Example Response

Response

{
  "error": "",
  "identifier": "caf45b94-79b1-dc0a-e003-9dd02b2792ae",
  "uri": "https://app.passcreator.com/api/pass/caf45b94-79b1-dc0a-e003-9dd02b2792ae",
  "generatedId": "552428addf5cd4.83175649",
  "searchString": "552428addf5cd4.83175649|www.passcreator.de",
  "voided": false,
  "passTemplateGuid": "36d35326-16f6-4cc2-ae74-28dfc3873be3"
}

Code Examples

Here you can find examples of how to call this endpoint using different programming languages and tools.

Replace 552428addf5cd4.83175649 with your actual pass ID and yourApiKeyHere with your actual API key.

Request Examples

GET
/api/pass/checkbyid/{id-to-check-for}
curl -X GET "https://app.passcreator.com/api/pass/checkbyid/552428addf5cd4.83175649" \
  -H "Authorization: yourApiKeyHere"