🏠 Vastu API and ✋ Palmistry API are now live. Ship them in your app today.

Get Compatibility ID

The Get Compatibility ID API starts the partner compatibility flow. It scans both palm images, creates a stored hand profile for each partner, and returns one shared compatibility ID for the couple. Each partner can also include optional date of birth and gender details.

The response includes compatibility_id, which is required by the Compatibility Connection, Compatibility Life, and Compatibility Guidance APIs. The palm images are checked using the same scan process as Get Palm ID, including hand type, major lines, mounts, fingers, and special markings.

This is the starting layer of the Partner Compatibility API. Submit two different, clear palm images to create the compatibility profile used by all later couple readings.
POSThttps://vision.astrologyapi.com/palmistry/get-compatibility-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

partner_1_image_urlstringrequired

Partner 1 palm image URL or base64 data URL

partner_1_genderstring

Partner 1 gender: male, female, or other

partner_1_dayint

Partner 1 birth day

partner_1_monthint

Partner 1 birth month

partner_1_yearint

Partner 1 birth year

partner_2_image_urlstringrequired

Partner 2 palm image URL or base64 data URL; must differ from partner 1

partner_2_genderstring

Partner 2 gender: male, female, or other

partner_2_dayint

Partner 2 birth day

partner_2_monthint

Partner 2 birth month

partner_2_yearint

Partner 2 birth year

← Previous
Delete Palm ID
Next →
Compatibility Connection
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
}'
Try it

Runs with sample data — no API key needed

{
  "status": true,
  "message": "success",
  "data": {
    "compatibility_id": "c5d096cc-0ef2-4c0e-a86b-dcef63e550bc"
  }
}