Overview
The /v1/numerology/compatibility endpoint takes two people’s numerology inputs and returns a structured comparison. It is available on the pro tier. Examples use one sample profile, Aarav Sharma, born 1990-08-15, and a second shown with placeholder values.
Use this to understand the request and result shape and the plan gate. See Documentation for the exact fields and error codes.
Sending Two Profiles
Send both people in one request, each in the same shape you use for a core profile, and pass the system explicitly:
curl -X POST https://panchang.devdarsha.com/v1/numerology/compatibility \
-H "content-type: application/json" \
-H "x-api-key: YOUR_API_KEY" \
-d '{
"system": "pythagorean",
"person_a": {"name":"Aarav Sharma","date":"1990-08-15"},
"person_b": {"name":"FULL NAME","date":"YYYY-MM-DD"}
}'Replace person_b with the second person’s real details at request time. Use the same system for both people so the comparison is consistent.
Reading the Result
The response returns the compared numbers and a structured summary. Surface the underlying numbers, not only a headline figure, so users can see what the comparison is based on. Keep the wording factual and let users interpret the outcome.
Compatibility uses two people’s details. Collect the second person’s name and date only with appropriate consent, keep the input server-side, and store no more than your product needs.
How to Use It in a Product
Compute a comparison when two users connect, or on demand when someone enters a second person. Cache the result against the pair of inputs and the system, since the calculation is deterministic. Because it is a pro-tier feature, gate the UI so free-tier users see an appropriate prompt rather than an error.
Related Endpoints
Several related capabilities are live alongside compatibility. Access to some depends on plan, so gate the UI accordingly:
/report: a structured section-based profile report — live./bulk: processing many profiles in one request — live./cycles: personal time cycles — live./name-correction: deterministic name-adjustment candidates — live.
All eight endpoints are live today: core, name, cycles, compatibility, Lo Shu, report, name-correction, and bulk. Design around the plan tier each endpoint requires.