← Back to Documentations

vCard API

Generate vCard 3.0 contact strings for sharing names, phone numbers, emails, and company details.

Internet
V1

V1

/api/v1

First stable version for vCard 3.0 generation requests.

GET /api/v1/vcard/generate Auth Required
Generate vCard

Creates a vCard 3.0 text payload from contact details such as full name, company, email, phone, address, and note.

Authentication
X-Api-Key: your_api_key
Query Parameters
Name Type Required Example Description
full_name string required Jane Doe Full name to use in the FN field.
first_name string optional Jane Optional first name for the structured N field.
last_name string optional Doe Optional last name for the structured N field.
organization string optional Netbioca Organization name for the ORG field.
job_title string optional Sales Manager Job title for the TITLE field.
phone string optional +902124445566 Work phone number.
mobile string optional +905551112233 Mobile phone number.
email string optional jane@example.com Email address.
website string optional https://netbioca.com Website URL.
street string optional Maslak Mahallesi Street address.
city string optional Istanbul City name.
region string optional Sariyer Region or state name.
postal_code string optional 34485 Postal code.
country string optional Turkey Country name.
note string optional Available on weekdays. Additional contact note.
Request Example
GET /api/v1/vcard/generate?full_name=Jane%20Doe&organization=Netbioca&job_title=Sales%20Manager&email=jane@example.com&mobile=%2B905551112233&website=https://netbioca.com
Response Example
{
    "success": true,
    "message": "vCard generated successfully.",
    "data": {
        "full_name": "Jane Doe",
        "version": "3.0",
        "mime_type": "text/vcard",
        "file_name": "jane-doe.vcf",
        "vcard": "BEGIN:VCARD\r\nVERSION:3.0\r\nFN:Jane Doe\r\nN:;Jane Doe;;;\r\nORG:Netbioca\r\nTITLE:Sales Manager\r\nTEL;TYPE=CELL:+905551112233\r\nEMAIL;TYPE=INTERNET:jane@example.com\r\nURL:https://netbioca.com\r\nEND:VCARD\r\n"
    }
}
Error Response
{
    "success": false,
    "message": "The full name field is required.",
    "error_code": "VALIDATION_ERROR"
}