Submit a referral
POST /referrals
POST
/referrals
Authorizations
Parameters
Header Parameters
Ocp-Apim-Subscription-Key
required
string
Subscription key for API access. Issued by the API administrator. Request access through the developer portal or by the contact email.
Request Body required
object
firstName
required
string
Testxxx-Firstname lastName
required
string
Testxxx-Lastname phoneNumber
required
Phone number in E.164 format (e.g. +16045559999). Must include country code.
string format: phone
+16045559999 emailAddress
required
string format: email
Testxxx@example.com city
required
string
Vancouver province
required
string
BC referralPartner
required
Must be the partner identifier provided by the API administrator when given API key. Any other value returns 400. The test value can be used in development or sandbox environments.
string
Testxxx-Referral-Partner notes
string
Client called in requesting debt consolidation informationResponses
200
Referral submitted successfully
400
Invalid request — missing required fields, invalid phone number format (must be E.164), or referralPartner is not an allowed value
401
Unauthorized - missing or invalid subscription key