Skip to main content

CreateReferralDto

agentIdstringrequired
insurerProductIdstringrequired

Insurer product ID — required. Referrals cannot select a bare product category.

productPlanIdstring
clientFirstNamestringrequired

Possible values: non-empty and <= 100 characters

clientLastNamestringrequired

Possible values: non-empty and <= 100 characters

clientEmailstring
clientPhonestringrequired

Possible values: >= 6 characters and <= 30 characters

clientNationalIdstring
clientDobstring
clientAddressstring
requestedCoveragenumber

Possible values: >= 0

currencystring
duplicateOverrideReasonstring

Ops override reason when the referral duplicates a recent one for the same client + product. Required + audited when ReferralOverrideDuplicate is used to bypass the block.

Possible values: >= 10 characters and <= 500 characters

consentEvidenceIdstring

DataTransferConsent id proving fresh consent from a client whose prior consent was withdrawn. Required only when the client's phone hash matches a withdrawn-consent Client row.

CreateReferralDto
{
"agentId": "string",
"insurerProductId": "string",
"productPlanId": "string",
"clientFirstName": "string",
"clientLastName": "string",
"clientEmail": "string",
"clientPhone": "string",
"clientNationalId": "string",
"clientDob": "string",
"clientAddress": "string",
"requestedCoverage": 0,
"currency": "string",
"duplicateOverrideReason": "string",
"consentEvidenceId": "string"
}