OnboardingPaths
Defined in: src/onboarding/types.gen.ts:2
Properties
Section titled “Properties”/v1/referrals
Section titled “/v1/referrals”/v1/referrals:
object
Defined in: src/onboarding/types.gen.ts:3
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
List referrals
Description
Section titled “Description”Returns referrals created. Note: This doesn’t include referrals that have expired.
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path?
Section titled “get.parameters.path?”
optionalpath?:undefined
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:object
get.parameters.query.cursor?
Section titled “get.parameters.query.cursor?”
optionalcursor?:string|null
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”Success
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.items
Section titled “get.responses.200.content.application/json.items”items:
object[]
get.responses.200.content.application/json.next_cursor?
Section titled “get.responses.200.content.application/json.next_cursor?”
optionalnext_cursor?:string|null
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.400
Section titled “get.responses.400”400:
object
Description
Section titled “Description”Invalid cursor
get.responses.400.content?
Section titled “get.responses.400.content?”
optionalcontent?:undefined
get.responses.400.headers
Section titled “get.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.401
Section titled “get.responses.401”401:
object
Description
Section titled “Description”Unauthorized
get.responses.401.content?
Section titled “get.responses.401.content?”
optionalcontent?:undefined
get.responses.401.headers
Section titled “get.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
post:
object
Creates a referral
Description
Section titled “Description”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.parameters
Section titled “post.parameters”parameters:
object
post.parameters.cookie?
Section titled “post.parameters.cookie?”
optionalcookie?:undefined
post.parameters.header?
Section titled “post.parameters.header?”
optionalheader?:undefined
post.parameters.path?
Section titled “post.parameters.path?”
optionalpath?:undefined
post.parameters.query?
Section titled “post.parameters.query?”
optionalquery?:undefined
post.requestBody
Section titled “post.requestBody”requestBody:
object
post.requestBody.content
Section titled “post.requestBody.content”content:
object
post.requestBody.content.application/json
Section titled “post.requestBody.content.application/json”application/json:
object
post.requestBody.content.application/json.applicant
Section titled “post.requestBody.content.application/json.applicant”applicant:
object
post.requestBody.content.application/json.applicant.email
Section titled “post.requestBody.content.application/json.applicant.email”email:
string
Format: email
Description
Section titled “Description”Business email of the applying customer.
Example
Section titled “Example”jane.smith@example.compost.requestBody.content.application/json.applicant.first_name
Section titled “post.requestBody.content.application/json.applicant.first_name”first_name:
string
Description
Section titled “Description”First name of the applying customer.
Example
Section titled “Example”Janepost.requestBody.content.application/json.applicant.last_name
Section titled “post.requestBody.content.application/json.applicant.last_name”last_name:
string
Description
Section titled “Description”Last name of the applying customer.
Example
Section titled “Example”Smithpost.requestBody.content.application/json.business?
Section titled “post.requestBody.content.application/json.business?”
optionalbusiness?: {activity_description?:string|null;address?: {city?:string|null;country?:string|null;line1?:string|null;line2?:string|null;phone_number?:string|null;postal_code?:string|null;state?:string|null; } |null;alternate_address?: {city?:string|null;country?:string|null;line1?:string|null;line2?:string|null;phone_number?:string|null;postal_code?:string|null;state?:string|null; } |null;beneficial_owners?:object[] |null;employer_identification_number?:string|null;incorporation_state?:string|null;incorporation_type?:"C_CORP"|"S_CORP"|"B_CORP"|"LLC"|"LLP"|"SOLE_PROP"|"ORG_501C3"|"LP"|null;incorporation_year?:number|null;legal_name?:string|null;website_url?:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ activity_description?: string | null; address?: { city?: string | null; country?: string | null; line1?: string | null; line2?: string | null; phone_number?: string | null; postal_code?: string | null; state?: string | null; } | null; alternate_address?: { city?: string | null; country?: string | null; line1?: string | null; line2?: string | null; phone_number?: string | null; postal_code?: string | null; state?: string | null; } | null; beneficial_owners?: object[] | null; employer_identification_number?: string | null; incorporation_state?: string | null; incorporation_type?: "C_CORP" | "S_CORP" | "B_CORP" | "LLC" | "LLP" | "SOLE_PROP" | "ORG_501C3" | "LP" | null; incorporation_year?: number | null; legal_name?: string | null; website_url?: string | null; }
activity_description?
Section titled “activity_description?”
optionalactivity_description?:string|null
Description
Section titled “Description”Brief description of the business activity.
Example
Section titled “Example”Software as a Service platform for project managementaddress?
Section titled “address?”
optionaladdress?: {city?:string|null;country?:string|null;line1?:string|null;line2?:string|null;phone_number?:string|null;postal_code?:string|null;state?:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ city?: string | null; country?: string | null; line1?: string | null; line2?: string | null; phone_number?: string | null; postal_code?: string | null; state?: string | null; }
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
country?
Section titled “country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
line1?
Section titled “line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
line2?
Section titled “line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
phone_number?
Section titled “phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
postal_code?
Section titled “postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
state?
Section titled “state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
null
alternate_address?
Section titled “alternate_address?”
optionalalternate_address?: {city?:string|null;country?:string|null;line1?:string|null;line2?:string|null;phone_number?:string|null;postal_code?:string|null;state?:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ city?: string | null; country?: string | null; line1?: string | null; line2?: string | null; phone_number?: string | null; postal_code?: string | null; state?: string | null; }
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
country?
Section titled “country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
line1?
Section titled “line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
line2?
Section titled “line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
phone_number?
Section titled “phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
postal_code?
Section titled “postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
state?
Section titled “state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
null
beneficial_owners?
Section titled “beneficial_owners?”
optionalbeneficial_owners?:object[] |null
Description
Section titled “Description”List of beneficial owners of the company
employer_identification_number?
Section titled “employer_identification_number?”
optionalemployer_identification_number?:string|null
Description
Section titled “Description”Company Employer Identification Number(EIN).
Example
Section titled “Example”123456789incorporation_state?
Section titled “incorporation_state?”
optionalincorporation_state?:string|null
Description
Section titled “Description”State of incorporation (US state abbreviation).
Example
Section titled “Example”CAincorporation_type?
Section titled “incorporation_type?”
optionalincorporation_type?:"C_CORP"|"S_CORP"|"B_CORP"|"LLC"|"LLP"|"SOLE_PROP"|"ORG_501C3"|"LP"|null
incorporation_year?
Section titled “incorporation_year?”
optionalincorporation_year?:number|null
Format: int32
Description
Section titled “Description”Year of incorporation (YYYY format).
Example
Section titled “Example”2023legal_name?
Section titled “legal_name?”
optionallegal_name?:string|null
Description
Section titled “Description”Company legal name.
Example
Section titled “Example”Acme Corporationwebsite_url?
Section titled “website_url?”
optionalwebsite_url?:string|null
Description
Section titled “Description”Business website (or link to ecommerce store for sellers).
Example
Section titled “Example”https://www.acmecorp.comnull
post.requestBody.content.application/json.contact_preference?
Section titled “post.requestBody.content.application/json.contact_preference?”
optionalcontact_preference?:"NO_OUTBOUND"|"EMAIL_OUTBOUND"|null
post.requestBody.content.application/json.referral_code
Section titled “post.requestBody.content.application/json.referral_code”referral_code:
string
Description
Section titled “Description”Referral code that attributes credit to you if the prospect signs up for a Brex account.
Example
Section titled “Example”partner_abc123post.responses
Section titled “post.responses”responses:
object
post.responses.200
Section titled “post.responses.200”200:
object
Description
Section titled “Description”Success
post.responses.200.content
Section titled “post.responses.200.content”content:
object
post.responses.200.content.application/json
Section titled “post.responses.200.content.application/json”application/json:
object
post.responses.200.content.application/json.customer_email?
Section titled “post.responses.200.content.application/json.customer_email?”
optionalcustomer_email?:string|null
Format: email
Description
Section titled “Description”Customer’s email address registered for the Brex application. This field is available only if there’s a signup completed.
post.responses.200.content.application/json.expires_at
Section titled “post.responses.200.content.application/json.expires_at”expires_at:
string
Format: date-time
Description
Section titled “Description”The time at which this referral link expires.
post.responses.200.content.application/json.id
Section titled “post.responses.200.content.application/json.id”id:
string
Description
Section titled “Description”Unique identifier for the referral.
Example
Section titled “Example”a1b2c3d4e5f6g7post.responses.200.content.application/json.products
Section titled “post.responses.200.content.application/json.products”products:
object[]
post.responses.200.content.application/json.referral_signup_url
Section titled “post.responses.200.content.application/json.referral_signup_url”referral_signup_url:
string
Description
Section titled “Description”Signup URL to redirect prospects to complete their onboarding flow.
*Note*: Necessary disclosures must be shown when the prospect clicks on this link.Example
Section titled “Example”https://brex.com/signup?pref_token=a1b2c3d4e5f6g7post.responses.200.content.application/json.status
Section titled “post.responses.200.content.application/json.status”status:
"ACTIVE"|"EXPIRED"|"CLOSED"|"UNCLAIMED"
post.responses.200.headers
Section titled “post.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.401
Section titled “post.responses.401”401:
object
Description
Section titled “Description”Unauthorized
post.responses.401.content?
Section titled “post.responses.401.content?”
optionalcontent?:undefined
post.responses.401.headers
Section titled “post.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v1/referrals/{id}
Section titled “/v1/referrals/{id}”/v1/referrals/{id}:
object
Defined in: src/onboarding/types.gen.ts:28
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
Gets a referral by ID
Description
Section titled “Description”Returns a referral object by ID if it exists.
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path
Section titled “get.parameters.path”path:
object
get.parameters.path.id
Section titled “get.parameters.path.id”id:
string
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:undefined
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”Success
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.customer_email?
Section titled “get.responses.200.content.application/json.customer_email?”
optionalcustomer_email?:string|null
Format: email
Description
Section titled “Description”Customer’s email address registered for the Brex application. This field is available only if there’s a signup completed.
get.responses.200.content.application/json.expires_at
Section titled “get.responses.200.content.application/json.expires_at”expires_at:
string
Format: date-time
Description
Section titled “Description”The time at which this referral link expires.
get.responses.200.content.application/json.id
Section titled “get.responses.200.content.application/json.id”id:
string
Description
Section titled “Description”Unique identifier for the referral.
Example
Section titled “Example”a1b2c3d4e5f6g7get.responses.200.content.application/json.products
Section titled “get.responses.200.content.application/json.products”products:
object[]
get.responses.200.content.application/json.referral_signup_url
Section titled “get.responses.200.content.application/json.referral_signup_url”referral_signup_url:
string
Description
Section titled “Description”Signup URL to redirect prospects to complete their onboarding flow.
*Note*: Necessary disclosures must be shown when the prospect clicks on this link.Example
Section titled “Example”https://brex.com/signup?pref_token=a1b2c3d4e5f6g7get.responses.200.content.application/json.status
Section titled “get.responses.200.content.application/json.status”status:
"ACTIVE"|"EXPIRED"|"CLOSED"|"UNCLAIMED"
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.401
Section titled “get.responses.401”401:
object
Description
Section titled “Description”Unauthorized
get.responses.401.content?
Section titled “get.responses.401.content?”
optionalcontent?:undefined
get.responses.401.headers
Section titled “get.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
get.responses.404
Section titled “get.responses.404”404:
object
Description
Section titled “Description”Referral not found
get.responses.404.content?
Section titled “get.responses.404.content?”
optionalcontent?:undefined
get.responses.404.headers
Section titled “get.responses.404.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
optionalpost?:undefined
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v1/referrals/{id}/document_upload
Section titled “/v1/referrals/{id}/document_upload”/v1/referrals/{id}/document_upload:
object
Defined in: src/onboarding/types.gen.ts:48
delete?
Section titled “delete?”
optionaldelete?:undefined
optionalget?:undefined
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
post:
object
Create a new document upload
Description
Section titled “Description”The uri will be a presigned S3 URL allowing you to upload the referral doc securely. This URL can only be used for a PUT operation and expires 30 minutes after its creation. Once your upload is complete, we will use this to prefill the application.
Refer to these [docs](https://docs.aws.amazon.com/AmazonS3/latest/dev/PresignedUrlUploadObject.html) on how to upload to this presigned S3 URL. We highly recommend using one of AWS SDKs if they're available for your language to upload these files.post.parameters
Section titled “post.parameters”parameters:
object
post.parameters.cookie?
Section titled “post.parameters.cookie?”
optionalcookie?:undefined
post.parameters.header?
Section titled “post.parameters.header?”
optionalheader?:undefined
post.parameters.path
Section titled “post.parameters.path”path:
object
post.parameters.path.id
Section titled “post.parameters.path.id”id:
string
post.parameters.query?
Section titled “post.parameters.query?”
optionalquery?:undefined
post.requestBody
Section titled “post.requestBody”requestBody:
object
post.requestBody.content
Section titled “post.requestBody.content”content:
object
post.requestBody.content.application/json
Section titled “post.requestBody.content.application/json”application/json:
object
post.requestBody.content.application/json.type
Section titled “post.requestBody.content.application/json.type”type:
"ARTICLES_OF_INCORPORATION"|"IRS_EIN_CONFIRMATION"|"IRS_EIN_APPLICATION"|"CERTIFICATE_GOOD_STANDING"
post.responses
Section titled “post.responses”responses:
object
post.responses.200
Section titled “post.responses.200”200:
object
Description
Section titled “Description”Success
post.responses.200.content
Section titled “post.responses.200.content”content:
object
post.responses.200.content.application/json
Section titled “post.responses.200.content.application/json”application/json:
object
post.responses.200.content.application/json.id
Section titled “post.responses.200.content.application/json.id”id:
string
Description
Section titled “Description”Unique identifier for the document.
Example
Section titled “Example”prefdoc_a1b2c3d4e5post.responses.200.content.application/json.uri
Section titled “post.responses.200.content.application/json.uri”uri:
string
Description
Section titled “Description”This is a presigned S3 link that should be used to attach the document. The maximum size accepted for this document is 50 MB.
Example
Section titled “Example”https://brex-documents.s3.amazonaws.com/upload/abc123?AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE&Expires=1234567890&Signature=examplepost.responses.200.headers
Section titled “post.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.401
Section titled “post.responses.401”401:
object
Description
Section titled “Description”Unauthorized
post.responses.401.content?
Section titled “post.responses.401.content?”
optionalcontent?:undefined
post.responses.401.headers
Section titled “post.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.404
Section titled “post.responses.404”404:
object
Description
Section titled “Description”Referral not found
post.responses.404.content?
Section titled “post.responses.404.content?”
optionalcontent?:undefined
post.responses.404.headers
Section titled “post.responses.404.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v1/referrals/{id}/process_ein_document
Section titled “/v1/referrals/{id}/process_ein_document”/v1/referrals/{id}/process_ein_document:
object
Defined in: src/onboarding/types.gen.ts:70
delete?
Section titled “delete?”
optionaldelete?:undefined
optionalget?:undefined
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
post:
object
Process a delayed EIN document after upload
Description
Section titled “Description”Processes a delayed EIN document after it has been uploaded.
This endpoint should be called after successfully uploading an IRS EIN Confirmation document (CP-575, CP-575 fax sheet, or 147C) using thestandard document upload flow (`/v1/referrals/{id}/document_upload` with `type: IRS_EIN_CONFIRMATION`).
The `document_id` should be the `id` returned from the document upload request.post.parameters
Section titled “post.parameters”parameters:
object
post.parameters.cookie?
Section titled “post.parameters.cookie?”
optionalcookie?:undefined
post.parameters.header?
Section titled “post.parameters.header?”
optionalheader?:undefined
post.parameters.path
Section titled “post.parameters.path”path:
object
post.parameters.path.id
Section titled “post.parameters.path.id”id:
string
post.parameters.query?
Section titled “post.parameters.query?”
optionalquery?:undefined
post.requestBody
Section titled “post.requestBody”requestBody:
object
post.requestBody.content
Section titled “post.requestBody.content”content:
object
post.requestBody.content.application/json
Section titled “post.requestBody.content.application/json”application/json:
object
post.requestBody.content.application/json.document_id
Section titled “post.requestBody.content.application/json.document_id”document_id:
string
Description
Section titled “Description”The document ID returned from the initial document creation request
post.responses
Section titled “post.responses”responses:
object
post.responses.200
Section titled “post.responses.200”200:
object
Description
Section titled “Description”Document processed successfully
post.responses.200.content?
Section titled “post.responses.200.content?”
optionalcontent?:undefined
post.responses.200.headers
Section titled “post.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.400
Section titled “post.responses.400”400:
object
Description
Section titled “Description”Document not uploaded or invalid
post.responses.400.content?
Section titled “post.responses.400.content?”
optionalcontent?:undefined
post.responses.400.headers
Section titled “post.responses.400.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.401
Section titled “post.responses.401”401:
object
Description
Section titled “Description”Unauthorized
post.responses.401.content?
Section titled “post.responses.401.content?”
optionalcontent?:undefined
post.responses.401.headers
Section titled “post.responses.401.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
post.responses.404
Section titled “post.responses.404”404:
object
Description
Section titled “Description”Referral not found
post.responses.404.content?
Section titled “post.responses.404.content?”
optionalcontent?:undefined
post.responses.404.headers
Section titled “post.responses.404.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined