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

Compatibility Report

You must provide a valid compatibility_id to call this API. How to get Compatibility ID →

The Compatibility Report API creates a complete A4 PDF reading for a couple from the stored compatibility_id. It combines the relationship score, compatibility dimensions, partner hand profiles, relationship strengths, growth areas, and practical guidance into one downloadable report.

The API accepts the request immediately and returns a request_id with the compatibility_id. When the report is ready, a POST request to the supplied webhook_url contains the report status and pdf_url. Send language as hi for a Hindi report; en is the default.

This API forms the full couple-report layer of the Partner Compatibility API. It turns the stored palm profiles into a detailed relationship document covering communication, affection, commitment, life goals, lifestyle, and shared growth.

POSThttps://vision.astrologyapi.com/palmistry/compatibility-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, Hindi - hi.

Request Parameters

compatibility_idstringrequired

Compatibility ID returned by Get Compatibility ID. Use this instead of the two partner palm IDs.

Prefer a compatibility ID. Use two distinct palm IDs only when a compatibility ID is unavailable; also provide a public HTTPS webhook URL and optional names and language.
← Previous
Palm Report
Next →
Palm Query
curl --location 'https://vision.astrologyapi.com/palmistry/compatibility-report' \
  --header 'Content-Type: application/json' \
  --header 'x-astrologyapi-key: <YOUR_ACCESS_TOKEN>' \
  --data '{
    "compatibility_id": "c5d096cc-0ef2-4c0e-a86b-dcef63e550bc"
}'
Try it

Runs with sample data — no API key needed

{
  "status": true,
  "message": "Your report is being generated",
  "request_id": "3f1cb055-8ca0-4ec6-abc6-53dae971a141",
  "compatibility_id": "c5d096cc-0ef2-4c0e-a86b-dcef63e550bc"
}