✋ Palmistry API and 🎧 Audio Reports API are now live. Ship them in your app today.

Face Report

You must provide a valid face_id to call this API. How to get Face ID →

The Face Report API creates a PDF reading from the face stored under the supplied face_id. It brings the face analysis and life-area readings together in one report.

Send the person’s name, birth date (day, month and year) and report language with the face ID. The example request uses en for English.

The API accepts the request immediately and returns a generation message, request_id and language. Supply a public HTTPS webhook_url to receive the finished PDF. When generation completes, this URL receives a POST with event: face_report.completed, state: completed and the PDF link in pdf_url. Match its request_id with the ID returned when you submitted the report.

Branding is optional. Use logo_url, company_name, company_info, domain_url, company_email, company_landline, company_mobile and footer_link to personalize the PDF.

Completion webhook example

{
  "event": "face_report.completed",
  "request_id": "12881bd3-f21e-4536-8873-b7329f3120d5",
  "report_type": "face_report",
  "face_id": "5cec8e8b-e01d-4a98-8cb6-4b2f57a7f837",
  "language": "en",
  "state": "completed",
  "status": true,
  "pdf_url": "https://pub-25798a11dfd546a4b6764f1fd24e5cc5.r2.dev/face-reports/5cec8e8b-e01d-4a98-8cb6-4b2f57a7f837_report_a72fb0a53ffa.pdf",
  "sent_at": "2026-11-20T07:10:12Z"
}
POSThttps://vision.astrologyapi.com/face-reading/face-report

Authentication

x-astrologyapi-keystringrequired

API access token used to authenticate requests. Send your access token in this custom header.

Accept-Languagestring

Preferred language for the response content. Supported: English - en.

Body parameters

face_idstringrequired

Valid face ID returned by the Get Face ID API.

namestring

Person's name.

dayint

Birth day (1–31).

monthint

Birth month (1–12).

yearint

Birth year.

languagestring

Language for the report. The supplied request uses English.

  • en - English
webhook_urlstring

Public HTTPS endpoint that receives the completion webhook with request_id and pdf_url.

logo_urlstring

Optional logo image URL for branding the PDF report.

company_namestring

Optional company name displayed in the PDF report.

company_infostring

Optional company information displayed in the PDF report.

domain_urlstring

Optional company website URL displayed in the PDF report.

company_emailstring

Optional company email address displayed in the PDF report.

company_landlinestring

Optional company landline number. Send as a string.

company_mobilestring

Optional company mobile number. Send as a string.

footer_linkstring

Optional link displayed in the PDF footer.

curl --location 'https://vision.astrologyapi.com/face-reading/face-report' \
  --header 'Content-Type: application/json' \
  --header 'x-astrologyapi-key: <YOUR_ACCESS_TOKEN>' \
  --data '{
    "face_id": "5cec8e8b-e01d-4a98-8cb6-4b2f57a7f837",
    "name": "Akash Mishra",
    "day": 30,
    "month": 7,
    "year": 2001,
    "language": "en",
    "webhook_url": "https://example.com/webhooks/face-report",
    "logo_url": "https://astro-vedicrishi-in.b-cdn.net/web-vedicrishi/images/logo/vedic-rishi-logo.png",
    "company_name": "company name",
    "company_info": "company info",
    "domain_url": "https://www.astrologyapi.com",
    "company_email": "mail@astrologyapi.com",
    "company_landline": "123456789",
    "company_mobile": "123456789",
    "footer_link": "https://www.astrologyapi.com"
}'
Try it

Runs with sample data — no API key needed

{
  "status": true,
  "message": "Your report is being generated",
  "request_id": "df194379-7cdd-4301-9c17-78c6df019f8c",
  "language": "en"
}