Generate marriage compatibility report

Start a marriage compatibility analysis. Pass family_key to use an existing family member, or provide partner details to add them automatically. Report is generated in the background - you will be notified when ready.

Request: Bearer token

Body - two mutually exclusive modes:

Existing member: family_key (e.g. Family-12345). All partner_* fields are ignored.

New partner: partner_name + partner_dob (both required) plus optional partner_birth_time, partner_birth_place, partner_latitude, partner_longitude, partner_timezone. The partner is auto-added to the family list (relation inferred from the user's gender - M→Wife, F→Husband).

Success: 200 - returns prediction_key (Match-XXXXX) and a message. Generation runs in the background; poll GET /marriage/report/{prediction_key} and/or wait for the push notification.

Errors:

401 - invalid/expired token

404 - family_key does not match any family member of this user

409 - a report for this same partner is already pending/processing

422 - neither family_key nor partner_name+partner_dob supplied

Responses

🟢200OK

application/json

Successful Response

Bodyapplication/json

Example

{
    "success": true,
    "message": "Success",
    "data": {
        "prediction_key": "Match-12345",
        "message": "Report generation started. \n                                You will be notified when ready."
    }
}

🟠401Unauthorized

🟠404Record Not Found

🟠409

🟠422Parameter Error

Generate marriage compatibility report

Request

Request Code Samples

Responses