Creates a referral
POST
{{api_url}}/v1/referrals
Referral response if successful
Body
PARAM
| Key |
Datatype |
Required |
Description |
referral_code
|
string |
|
|
applicant.last_name
|
string |
|
|
applicant.first_name
|
string |
|
|
applicant.email
|
string |
|
|
business.incorporation_type
|
string |
|
|
HEADERS
| Key |
Datatype |
Required |
Description |
Content-Type
|
string |
|
|
RESPONSES
curl -X POST 'api_url/v1/referrals?referral_code=brexdev&applicant.last_name=spirig&applicant.first_name=milo&applicant.email=developer-access+test1@brex.com&business.incorporation_type=C_CORP' -H 'Content-Type: application/json' -d '{"contact_preference":"EMAIL_OUTBOUND","applicant":{"email":"customer@email.com","first_name":"First","last_name":"Last"},"referral_code":"refcode","business":{"legal_name":"Acme Inc","incorporation_type":"C_CORP","website_url":"acme.run","employer_identification_number":"100000000","activity_description":"my company description","address":{"line1":"home","line2":"home2","city":"new york","state":"NY","country":"US","postal_code":"11101","phone_number":"6466469639"},"beneficial_owners":[{"legal_name":"John Doe","prong":"BOTH","company_relationship":"FOUNDER","date_of_birth":"2000-11-21","identity_document":{"country":"US","number":"123123123","type":"SSN"},"address":{"line1":"home","line2":"home2","city":"new york","state":"NY","country":"US","postal_code":"11101","phone_number":"6466469639"}}]}}'
