Skip to main content
POST
Scan Business Card
This endpoint consumes 1 enrichment credit per successful scan. Requests that fail to detect any card fields return 409 no_match and do not consume credits. If the workspace balance is zero, the API returns 402 insufficient_credits.

Request

Upload either a base64-encoded image or a URL. The endpoint runs OCR, parses the result with an LLM, and returns structured contact fields. It does not create a contact automatically - call POST /v1/contacts with the returned data to persist it.

Headers

string
Optional UUID. Same image and key returns the cached result within 24 hours without consuming additional credits.

Body Parameters

string
Base64-encoded image bytes. Supported formats: PNG, JPG, WEBP, HEIC. Maximum 10 MB. Either image_base64 or image_url is required.
string
Public HTTPS URL to fetch the image from. The URL must be reachable within 5 seconds.
string
default:"auto"
ISO 639-1 language hint for OCR (e.g. en, de, fr). Defaults to automatic detection.
boolean
default:"false"
When true, the extracted data is used to create a new contact and the resulting contact_id is returned alongside the raw fields.

Response

object
Responses include X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, and X-Request-ID.

Example Response

Errors