v1

latestOpenAPI 3.1.02026-08-06911,228852.2 KB
ID Cards

Create ID Cards

Creates a specified number of ID cards for an existing ID card batch.

post/id-cards/v1/business-locations/{businessLocationId}/batches/{batchId}/cards

Path parameters

businessLocationIdinteger required

The unique identifier for the business location.

batchIdinteger required

The unique identifier for the ID card batch.

Request body

cardCountinteger required

The number of ID cards to create.

Example request

{
  "cardCount": 1
}

Response

Successfully created ID cards.

batchIdinteger

The unique identifier for the batch the cards were added to.

Example response

{
  "batchId": 12345,
  "cards": [
    {
      "id": 98765,
      "consumerRecordId": 54321,
      "consumerId": 13579,
      "url": "https://example.com/id-cards/98765/qr-code"
    }
  ]
}