🌍 Astrocartography API, πŸ”· Human Design API and βœ‹ Palmistry API are now live. Ship them in your app today.

Get Face ID

Scans a face image, stores extracted face-reading data, and returns a face_id used by all other face reading endpoints. Optional birth details may be sent with the image.
POSThttps://vision.astrologyapi.com/face-reading/get-face-id

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

image_urlstringrequired

Public image URL or base64 data URL (data:image/...;base64,...) of the palm photo. Aliases: url, img_url, image. Accepted formats: jpeg, jpg, png, webp. Maximum size: 5MB.

daynumberrequired

Day of birth. If birth details are supplied, day, month, year, and gender must all be valid.

monthnumberrequired

Month of birth.

yearnumberrequired

Year of birth.

genderstringrequired

Gender value used with optional birth details.

curl --location 'https://vision.astrologyapi.com/face-reading/get-face-id' \
  --header 'Content-Type: application/json' \
  --header 'x-astrologyapi-key: <YOUR_ACCESS_TOKEN>' \
  --data '{
    "image_url": "https://sample-image.jpg",
    "day": 15,
    "month": 8,
    "year": 1995,
    "gender": "male"
}'
Try it

Runs with sample data β€” no API key needed

{
  "status": true,
  "message": "success",
  "data": {
    "face_id": "c48d0b80-1d49-4af8-8c05-e778b3d7a00f"
  }
}