LIlightspeed
ID Cards

Get an ID Card

Changed on

Returns an ID card of a specific business location, with the identifiers of the consumer it is currently linked to. The response contains no personal data.

get/id-cards/v1/business-locations/{businessLocationId}/cards/{cardId}

Request

  • Base URL
    https://api.trial.lsk.lightspeed.app
  • URL
    https://api.trial.lsk.lightspeed.app/id-cards/v1/business-locations/{businessLocationId}/cards/{cardId}
  • Auth
    OAuth 2
    Authorization code: https://auth.lsk-prod.app/realms/k-series/protocol/openid-connect/auth
    Token URL: https://auth.lsk-prod.app/realms/k-series/protocol/openid-connect/token scopes: id-cards

Path parameters

businessLocationIdinteger required

The unique identifier for the business location.

cardIdinteger required

The unique identifier for the ID card.

Response

The ID card.

idinteger

The unique identifier for the ID card.

batchIdinteger

The unique identifier for the batch the card belongs to.

consumerIdinteger

The unique identifier for the consumer the card is currently linked to. It can differ from the one returned when the card was created if the card was linked to another consumer since. null when the card is not linked to a consumer.

consumerRecordIdinteger

The unique identifier for the consumer record of the consumer the card is currently linked to. null when the card is not linked to a consumer or the consumer has no record at the card's business.

revokedboolean

Whether the card is revoked.

Example response

{
  "id": 98765,
  "batchId": 12345,
  "consumerId": 13579,
  "consumerRecordId": 54321
}

Changes