API Documentation

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

Parameters

Parameter	Type	Description
compatibility_idrequired	string	Unique compatibility ID returned by get-compatibility-id.
webhook_urlrequired	string	Public HTTPS URL that receives the completed report. Maximum length: 2048 characters.
partner_1_name	string	Optional name for partner 1 printed in the report. Maximum length: 60 characters.
partner_2_name	string	Optional name for partner 2 printed in the report. Maximum length: 60 characters.
language	string	Optional report language: en (English, default) or hi (Hindi).

Sample PDFs

Compatibility Report PDF Samples

Download a sample palm compatibility report in English or Hindi.

English PDF SampleDownload PDF

Hindi PDF SampleDownload PDF

Supported Languages

enhi

Request

{
  "compatibility_id": "c5d096cc-0ef2-4c0e-a86b-dcef63e550bc",
  "webhook_url": "https://your-domain.com/palm-webhook",
  "partner_1_name": "Priya",
  "partner_2_name": "Rahul",
  "language": "hi"
}

Code samples

curl --location 'https://vision.astrologyapi.com/palmistry/compatibility-report' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'Authorization: Basic <YOUR_API_KEY>' \
  --data 'compatibility_id=c5d096cc-0ef2-4c0e-a86b-dcef63e550bc&webhook_url=https%3A%2F%2Fyour-domain.com%2Fpalm-webhook&partner_1_name=Priya&partner_2_name=Rahul&language=hi'

Response

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

Webhook payload

When the PDF is ready, a POST request with the following JSON body is sent to the webhook_url supplied in your report request. This callback is separate from the initial API response, which confirms that report generation has started.

Use request_id to match the callback to your original request. The pdf_url points to the completed report, and sent_at is the UTC timestamp when the callback was sent. Example completion payload:

{
  "event": "compatibility_report.completed",
  "request_id": "1b4248d8-6235-4ca9-8179-1dbc6df8a850",
  "compatibility_id": "876297c3-146f-4ede-8d4e-8486e75417d5",
  "status": true,
  "pdf_url": "https://pub-25798a11dfd546a4b6764f1fd24e5cc5.r2.dev/876297c3-146f-4ede-8d4e-8486e75417d5_couple_report_hi_e2e25ec74361.pdf",
  "sent_at": "2026-10-21T14:33:34Z"
}