Sign in
latestOpenAPI 3.0.12026-08-0852621.9 KB

9a5329a23c39

Referrals

Creates a referral

This creates new referrals. The response will contain an identifier and a unique personalized link to an application flow. Many fields are optional and when they're provided they'll prefill the application flow for Brex. You should handle and store these references securely as they contain sensitive information about the referral.

post/v1/referrals

Request body

referral_codestring required

Referral code that attributes credit to you if the prospect signs up for a Brex account.

contact_preference'NO_OUTBOUND' | 'EMAIL_OUTBOUND'

When set to EMAIL_OUTBOUND, Brex will email the referred prospective customer directly to prompt them to create their account rather than rely on you to direct them to claim the account. If not provided, you are responsible for contacting the prospect and the value defaults to NO_OUTBOUND.

Example request

{
  "referral_code": "partner_abc123",
  "applicant": {
    "last_name": "Smith",
    "first_name": "Jane",
    "email": "jane.smith@example.com"
  },
  "business": {
    "legal_name": "Acme Corporation",
    "employer_identification_number": "123456789",
    "website_url": "https://www.acmecorp.com",
    "activity_description": "Software as a Service platform for project management",
    "incorporation_year": 2023,
    "incorporation_state": "CA",
    "beneficial_owners": [
      {
        "ownership_percentage": 25
      }
    ]
  }
}

Response

Success

idstring required

Unique identifier for the referral.

referral_signup_urlstring required

Signup URL to redirect prospects to complete their onboarding flow.

Note: Necessary disclosures must be shown when the prospect clicks on this link.

expires_atstring date-time required

The time at which this referral link expires.

customer_emailstring email nullable

Customer's email address registered for the Brex application. This field is available only if there's a signup completed.

status'UNCLAIMED' | 'EXPIRED' | 'ACTIVE' | 'CLOSED' required

Status of the referral. UNCLAIMED or EXPIRED unless the customer completes signup. Customers are attributed once ACTIVE until the account is CLOSED.

Example response

{
  "id": "a1b2c3d4e5f6g7",
  "referral_signup_url": "https://brex.com/signup?pref_token=a1b2c3d4e5f6g7"
}