The Get Compatibility ID API starts the partner compatibility flow. It reads one submitted palm image for each partner with a vision model and creates one stored compatibility record. The request is a flat object with fields prefixed by partner_1_ and partner_2_; it accepts each partner’s palm image and optional date of birth and gender.
The scan extracts hand type, palm lines, mounts, finger features, and special markings for both palms. The response returns a unique compatibility_id, which connects both stored palm profiles with every later compatibility endpoint.
In palmistry terms, this step creates the base hand profile for the couple. Submit two different, clear, open palm images to start a couple compatibility reading.
https://vision.astrologyapi.com/palmistry/get-compatibility-idx-astrologyapi-keystringrequiredAPI access token used to authenticate requests. Send your access token in this custom header.
Accept-LanguagestringPreferred language for the response content. Supported: English - en.
partner_1_image_urlstringrequiredPartner 1 palm image URL or base64 data URL
partner_1_genderstringPartner 1 gender: male, female, or other
partner_1_dayintPartner 1 birth day
partner_1_monthintPartner 1 birth month
partner_1_yearintPartner 1 birth year
partner_2_image_urlstringrequiredPartner 2 palm image URL or base64 data URL; must differ from partner 1
partner_2_genderstringPartner 2 gender: male, female, or other
partner_2_dayintPartner 2 birth day
partner_2_monthintPartner 2 birth month
partner_2_yearintPartner 2 birth year
curl --location 'https://vision.astrologyapi.com/palmistry/get-compatibility-id' \
--header 'Content-Type: application/json' \
--header 'x-astrologyapi-key: <YOUR_ACCESS_TOKEN>' \
--data '{
"partner_1_image_url": "https://sample_image_partner_1.jpg",
"partner_1_gender": "female",
"partner_1_day": 12,
"partner_1_month": 3,
"partner_1_year": 1996,
"partner_2_image_url": "https://sample_image_partner_2.jpg",
"partner_2_gender": "male",
"partner_2_day": 5,
"partner_2_month": 8,
"partner_2_year": 1994
}'
Runs with sample data — no API key needed
{
"status": true,
"message": "success",
"data": {
"compatibility_id": "c5d096cc-0ef2-4c0e-a86b-dcef63e550bc"
}
}