Developer API

Digital Business Card API

Create and update digital business cards programmatically. Post your own JSON, map its paths to card fields once, and QRBold ingests records from your HRIS, CRM, or internal service — with a dry-run mode that shows exactly what a payload would produce before anything is written.

Start Free

Last updated

Your schema

Map JSON paths, no reshaping

Dry run

See the result before writing

Idempotent

External IDs prevent duplicates

Scoped keys

Credentials that cannot widen themselves

Does QRBold have a digital business card API?

Yes. QRBold provides a JSON ingestion API that creates and updates digital business cards programmatically. You map paths in your own payload shape to card fields, so no transformation layer is needed, and a dry-run mode returns the resolved card without writing anything. Access is controlled with scoped API keys.

Why teams choose QRBold for digital business card api

Send the payload you already have

Most APIs make you transform your data into their schema, which means writing and maintaining a mapping layer in your own codebase. QRBold inverts it: you post your existing JSON and configure the path-to-field mapping in the dashboard. Nested objects and arrays are addressed by path, so a webhook body from your HRIS usually works as-is.

Dry-run before you write

Post a payload in dry-run mode and get back the resolved field values, the external ID that was matched, the short code that would be assigned, any unmapped paths, and any warnings. Nothing is created. This is what makes integrating against production data safe on the first attempt.

Idempotent by external ID

Nominate a path in your payload as the external ID — an employee number, a CRM record ID, whatever your system already uses as a stable key. Re-sending the same record updates the existing card instead of creating a second one, so retries and replays are safe.

Credentials that cannot escalate

API keys ingest data. They cannot rewrite the field mapping or alter the template, because a credential that could change what it is allowed to write into would not be a scoped credential at all. Configuration changes require a dashboard session.

Integrate the API in four steps

1

Create a campaign and a card template

The template defines what every card produced through this endpoint looks like and which fields it exposes. The campaign is the container the API writes into, so its API configuration is scoped to it rather than global.

2

Post a sample payload

Send one representative record. QRBold parses it and lists every JSON path it found, including paths inside nested objects and arrays, so the mapping step works against your actual data rather than documentation you have to translate.

3

Map paths to card fields

Point each JSON path at a card field. Nominate which path carries the external ID for idempotency, and decide whether short links are auto-generated or supplied in the payload. The configuration is versioned.

4

Dry-run, then enable ingestion

Run the dry-run against real payloads and check the resolved fields, warnings, and unmapped paths. When it looks right, mint an API key and switch ingestion on. Each campaign has its own API documentation page with the endpoint and the current configuration.

API specification

The technical detail an evaluation actually turns on, in one place.

StyleREST over HTTPS, JSON request and response bodies
AuthenticationAPI key, minted and scoped in the dashboard
Payload shapeYour own — mapped via dotted JSON paths, including nested objects and arrays
IdempotencyExternal ID path nominated per campaign; re-sends update rather than duplicate
Dry runReturns resolved fields, matched external ID, prospective short code, unmapped paths, warnings
Short linksAuto-generated, or read from a path in your payload
Configuration versioningEach mapping change increments a version recorded against the campaign
Staleness detectionFlagged when the config was validated against a template the campaign no longer uses; ingestion continues
Privilege separationAPI keys ingest only; mapping and template changes require a dashboard session
Per-campaign docsGenerated documentation page showing the endpoint and live configuration

Why the mapping lives on our side

The conventional design is for an API to publish a schema and require callers to conform to it. It is simple to document and simple to validate, and it pushes the entire cost of integration onto the caller — who now maintains a transformation layer, in their codebase, that breaks when either side changes.

For this particular problem that trade is a bad one. The systems that hold employee data — HRIS platforms, CRMs, internal directories — emit their own deeply nested shapes, and those shapes are not negotiable. Requiring a flat, prescribed body means every customer writes the same adapter.

Configuring the mapping on the QRBold side moves that work into a UI where a non-developer can inspect and adjust it, and where the sample payload makes the available paths explicit rather than a guess. When your HRIS adds a field, you point at it in the dashboard rather than shipping code.

What dry-run returns

Dry-run is the difference between integrating confidently and integrating by creating test records you then have to clean up. Post a real payload and QRBold answers with what would have happened.

  • Resolved fields. Every card field with the value your payload produced for it. The fastest way to catch a path pointing one level too deep.
  • External ID. The key extracted for idempotency, or null if the path did not resolve — which is the usual cause of accidental duplicate cards.
  • Short code. The link this card would receive, so custom short-link schemes can be verified before going live.
  • Unmapped paths. Paths present in your payload that no field consumes. Usually harmless, occasionally the signal that a field you meant to map is silently being dropped.
  • Warnings. Non-fatal problems — a value that will be truncated, a field the template locks — that would not stop ingestion but that you probably want to know about.

Configuration versioning and stale configs

The API configuration is validated against a specific card template. Templates are editable, and someone will eventually edit one in a way the mapping did not anticipate — locking a field the API writes into, most commonly.

QRBold marks the configuration stale rather than rejecting traffic. That is a deliberate choice: refusing live ingestion because an administrator edited a template in another tab would turn a cosmetic change into an outage, and the integration would fail at the worst possible moment for reasons the caller cannot see. Ingestion continues, the dashboard says clearly that the configuration was validated against a template the campaign no longer uses, and you re-validate when convenient.

When to use the API instead of CSV import

Both create cards from structured data, and for a one-off batch the spreadsheet is genuinely faster to get working. The API earns its integration cost when the data has an owner that is a system rather than a person.

The concrete test: if a human has a recurring calendar reminder to export a file, that is a job for the API. If the export happens once for a specific event and then never again, it is a job for CSV import. Most organisations end up running both — the API for the continuous employee card programme, imports for the event batches alongside it.

Digital Business Card API questions, answered

The questions that come up in real evaluations, answered directly.

Wire cards into the systems you already run

Post your own JSON, map it once, dry-run it against real data, and let your HRIS or CRM keep every card current.

Start Free

No credit card required