apyhub
SMART GENERATION

Check Numerology Compatibility API

What it does

Numerology Compatibility Checker scores the compatibility between two people using their full names and birth dates. Send person_a and person_b, each with a full_name and birth_date, and get back a numeric compatibility_score plus a written summary.

The response also includes strengths and cautions as arrays of strings, along with person_a_numbers and person_b_numbers objects for the underlying numerology values used in the analysis. That makes it easier to surface both the headline result and the supporting details in a relationship app, matchmaking flow, or horoscope feature.

Use it when you want a lightweight compatibility readout without building your own numerology logic. The output is structured for display, filtering, or further processing: you can show the score, explain the main positives and risks, and store the per-person number breakdown alongside the result.

Numerology Compatibility Checker is suited to consumer apps, entertainment experiences, and profile-based recommendation flows where a simple 0–100 compatibility score is enough to drive the next step.

POST
Score numerology compatibility between two people
http://localhost:8080/dosvak/score-numerology-compatibility

QUICKSTART

GUIDE

Quickstart

Compare the numerology compatibility of two people by sending each person’s full name and birth date.

curl -X POST "http://localhost:8080/dosvak/score-numerology-compatibility" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "person_a": {
      "full_name": "Aditi Sharma",
      "birth_date": "1990-05-14"
    },
    "person_b": {
      "full_name": "Rahul Mehta",
      "birth_date": "1988-11-22"
    }
  }'

What you'll get back

Returns a JSON object with these top-level fields: summary as a string, cautions and strengths as string arrays, person_a_numbers and person_b_numbers as objects, and compatibility_score as an integer from 0 to 100.

{
  "summary": "High compatibility with strong communication alignment.",
  "cautions": ["Be mindful of different pacing."],
  "strengths": ["Shared values", "Good emotional balance"],
  "person_a_numbers": {},
  "person_b_numbers": {},
  "compatibility_score": 82
}
TRY ITLIVE · 100 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
body*
person_a*
person_b*

About this endpoint

What it does

Scores the numerology compatibility between two people based on each person’s full name and birth date. The response returns a compatibility summary along with each person’s numerology numbers, strengths, cautions, and an overall score.

Request Body

ParameterTypeMandatoryDescription
person_aObjectYesThe first person’s details. Contains full_name and birth_date.
person_a.full_nameStringYesThe first person’s full name.
person_a.birth_dateStringYesThe first person’s birth date in date format.
person_bObjectYesThe second person’s details. Contains full_name and birth_date.
person_b.full_nameStringYesThe second person’s full name.
person_b.birth_dateStringYesThe second person’s birth date in date format.

Response

Returns a JSON object with summary as a string, cautions and strengths as string arrays, person_a_numbers and person_b_numbers as objects with additional properties, and compatibility_score as an integer from 0 to 100.

ParameterTypeMandatoryDescription
summaryStringNoA textual summary of the compatibility result.
cautionsString ArrayNoA list of cautionary points.
strengthsString ArrayNoA list of strengths in the pairing.
person_a_numbersObjectNoNumerology numbers for person A. The object may contain additional properties.
person_b_numbersObjectNoNumerology numbers for person B. The object may contain additional properties.
compatibility_scoreIntegerNoThe compatibility score, ranging from 0 to 100.

Body

Name
Type
Description
bodyREQUIRED
object
▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.