Creates a referral
POST {{api_url}}/v1/referrals
Referral response if successful
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
referral_code | string | ||
applicant.last_name | string | ||
applicant.first_name | string | ||
applicant.email | string | ||
business.incorporation_type | string |
Request Body
{"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"}}]}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"expires_at":"1954-10-19T14:33:34.147Z","id":"non cillum fugiat","products":[{"cash":{"accounts":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]}},{"cash":{"accounts":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]}}],"referral_signup_url":"nostrud eiusmod in","status":"CLOSED"}