API

This feature is available with the IDC Professional and IDC Enterprise plans. The IDC API feature provides a simple RESTful interface with lightweight JSON or XML formatted responses, enabling you to read and write data to/from the program. This feature allows you to integrate IDC into your system, saving you considerable time and effort.

  • GET a data structure (JSON or XML) from a Project Record.
    A Base64 Photo ID and/or Badge Preview can be included in the data structure.
  • GET a data structure (JSON or XML) of all Records from a Project (no Photo ID or Badge Preview).
  • GET a 240×300 pixels (portrait) or 300×300 pixels (square) Photo ID (WebP, PNG, or JPEG) in a Base64 format from a Project Record.
  • GET a 1013×639 pixels (landscape) or 639×1013 pixels (portrait) Badge Preview (WebP, PNG, JPEG, or PDF) in a Base64 format from a Project Record.
  • POST (Insert) a data structure into a Project (projects are unlimited).
    A Base64 Photo ID and the status: ACTIVE and TRASH can also be included in the data structure.
  • PUT (Update) a data structure from a Project Record (projects are unlimited).
    A Base64 Photo ID and the status: ACTIVE, TRASH, and DELETE can also be included in the data structure.
Related topics