POST /v1/codes/qr-vcard
Contact QR code
A full contact card in a square, correctly escaped so every phone reads it the same way.
Make a scan-to-save contact code now No key, no code — 2 credits either way.
curl -X POST "$DOATHING_API/v1/codes/qr-vcard" \
-H "x-api-key: $DOATHING_KEY" \
-H "content-type: application/json" \
-d '{"name": "Ada Lovelace", "email": "ada@example.test", "phone": "+44 20 7123 4567", "organisation": "Analytical Engines"}'
A full contact card in a square, correctly escaped so every phone reads it the same way.
Generate a vCard 3.0 QR code from contact fields, with correct escaping of separators.
Response
The result carries your remaining balance alongside it, so you can track spend without a second call.
{
"fields": [
"name",
"email",
"phone",
"organisation"
],
"version": 5,
"encoded_bytes": 168,
"request_id": "37f01edb-0163-42a1-ac51-0acaef979800",
"credits_remaining": 96
}
Cost
2 credits per call, whether it is run from the site or from the API — the credential differs, the price does not. A new account starts with 20 credits.
A rejected request still costs a credit: the authorizer decrements before the tool validates. A call rejected for a missing or invalid key is free.
Parameters
Generated from the endpoint’s own validation, so this is exactly what it accepts. A body field goes at the top level; an option goes inside options.
| Name | In | Type | Default | Notes |
|---|---|---|---|---|
| name * | body | string | — | |
| body | string | — | ||
| phone | body | string | — | |
| organisation | body | string | — | |
| title | body | string | — | |
| url | body | string | — | |
| address | body | string | — | |
| note | body | string | — | |
| error_correction | options | string | "M" | one of L, M, Q, H |
| scale | options | integer | 8 | Pixels per module. 1 to 40 |
| border | options | integer | 4 | 0 to 20 |
| dark | options | string | "#000000" | |
| light | options | string | "#FFFFFF" |