OnboardingComponents
Defined in: src/onboarding/types.gen.ts:97
Properties
Section titled “Properties”headers
Section titled “headers”headers:
never
Defined in: src/onboarding/types.gen.ts:414
parameters
Section titled “parameters”parameters:
never
Defined in: src/onboarding/types.gen.ts:412
pathItems
Section titled “pathItems”pathItems:
never
Defined in: src/onboarding/types.gen.ts:415
requestBodies
Section titled “requestBodies”requestBodies:
never
Defined in: src/onboarding/types.gen.ts:413
responses
Section titled “responses”responses:
never
Defined in: src/onboarding/types.gen.ts:411
schemas
Section titled “schemas”schemas:
object
Defined in: src/onboarding/types.gen.ts:98
Account
Section titled “Account”Account:
object
Description
Section titled “Description”If the application status is ACTIVE, array of bank cash management accounts (note there is currently only one account per customer).
Account.created_at
Section titled “Account.created_at”created_at:
string
Format: date-time
Account.id
Section titled “Account.id”id:
string
Description
Section titled “Description”Brex Cash management account ID.
Account.instructions?
Section titled “Account.instructions?”
optionalinstructions?: {domestic: {account_type:string;bank_account_number:string;bank_address:string;bank_name:string;bank_routing_number:string;beneficiary_address:string;beneficiary_name:string; };international: {account_type:string;bank_address:string;bank_name:string;beneficiary_address:string;beneficiary_name:string;special_instructions:string;swift_account_number:string;swift_bank_number:string; }; } |null
Address
Section titled “Address”Address:
object
Description
Section titled “Description”Company business address (must be in the US; no PO box or virtual/forwarding addresses allowed).
Address.city?
Section titled “Address.city?”
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
Address.country?
Section titled “Address.country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
Address.line1?
Section titled “Address.line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
Address.line2?
Section titled “Address.line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
Address.phone_number?
Section titled “Address.phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
Address.postal_code?
Section titled “Address.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
Address.state?
Section titled “Address.state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
Applicant
Section titled “Applicant”Applicant:
object
Description
Section titled “Description”Required information about the referred prospect.
Applicant.email
Section titled “Applicant.email”email:
string
Format: email
Description
Section titled “Description”Business email of the applying customer.
Example
Section titled “Example”jane.smith@example.comApplicant.first_name
Section titled “Applicant.first_name”first_name:
string
Description
Section titled “Description”First name of the applying customer.
Example
Section titled “Example”JaneApplicant.last_name
Section titled “Applicant.last_name”last_name:
string
Description
Section titled “Description”Last name of the applying customer.
Example
Section titled “Example”SmithApplication
Section titled “Application”Application:
object
Application.status
Section titled “Application.status”status:
"ACTIVE"|"PROCESSING"|"REJECTED"|"NO_ACCOUNT"|"NOT_SUBMITTED"|"INFORMATION_PENDING"|"MANUAL_REVIEW"|"CLOSED"
ApplicationStatus
Section titled “ApplicationStatus”ApplicationStatus:
"ACTIVE"|"PROCESSING"|"REJECTED"|"NO_ACCOUNT"|"NOT_SUBMITTED"|"INFORMATION_PENDING"|"MANUAL_REVIEW"|"CLOSED"
Description
Section titled “Description”Application status of a product.
`NO_ACCOUNT` - There is no active application, and the product account is not provisioned.
`ACTIVE` - The application is approved, and the product account is provisioned.
`NOT_SUBMITTED` - The application is started but not yet submitted.
`INFORMATION_PENDING` - The application is submitted and additional information is requested.
`MANUAL_REVIEW` - The application is under manual review.
`PROCESSING` - The application is submitted and is under review.
`REJECTED` - The application is rejected.
`CLOSED` - The product account is closed.BeneficialOwner
Section titled “BeneficialOwner”BeneficialOwner:
object
Description
Section titled “Description”Federal law requires us to collect information for anyone who owns 25% or more of the company.
BeneficialOwner.address?
Section titled “BeneficialOwner.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
BeneficialOwner.company_relationship?
Section titled “BeneficialOwner.company_relationship?”
optionalcompany_relationship?:"OTHER"|"FOUNDER"|"EXECUTIVE"|"SENIOR_LEADERSHIP"|null
BeneficialOwner.date_of_birth?
Section titled “BeneficialOwner.date_of_birth?”
optionaldate_of_birth?:string|null
Format: date
Description
Section titled “Description”Date of birth.
BeneficialOwner.identity_document?
Section titled “BeneficialOwner.identity_document?”
optionalidentity_document?: {country:string;number:string;type:"SSN"|"PASSPORT"; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ country: string; number: string; type: "SSN" | "PASSPORT"; }
country
Section titled “country”country:
string
Description
Section titled “Description”Country where the identity document was issued.
number
Section titled “number”number:
string
Description
Section titled “Description”US SSN or passport number.
type:
"SSN"|"PASSPORT"
null
BeneficialOwner.legal_name
Section titled “BeneficialOwner.legal_name”legal_name:
string
Description
Section titled “Description”Legal full name.
BeneficialOwner.ownership_percentage?
Section titled “BeneficialOwner.ownership_percentage?”
optionalownership_percentage?:number|null
Format: int32
Description
Section titled “Description”Ownership percentage (25-100). Only populated for individuals with ownership stakes (25% or more).
Example
Section titled “Example”25BeneficialOwner.prong
Section titled “BeneficialOwner.prong”prong:
"OWNERSHIP"|"CONTROL"|"BOTH"
Business
Section titled “Business”Business:
object
Description
Section titled “Description”Information about the business the application is for.
You can optionally set the `alternate_address`, if the business has an additional address which is different from theregistration address. For instance, for international companies where their operational address may be differentthan where the company was incorporated.Business.activity_description?
Section titled “Business.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 managementBusiness.address?
Section titled “Business.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
Business.alternate_address?
Section titled “Business.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
Business.beneficial_owners?
Section titled “Business.beneficial_owners?”
optionalbeneficial_owners?:object[] |null
Description
Section titled “Description”List of beneficial owners of the company
Business.employer_identification_number?
Section titled “Business.employer_identification_number?”
optionalemployer_identification_number?:string|null
Description
Section titled “Description”Company Employer Identification Number(EIN).
Example
Section titled “Example”123456789Business.incorporation_state?
Section titled “Business.incorporation_state?”
optionalincorporation_state?:string|null
Description
Section titled “Description”State of incorporation (US state abbreviation).
Example
Section titled “Example”CABusiness.incorporation_type?
Section titled “Business.incorporation_type?”
optionalincorporation_type?:"C_CORP"|"S_CORP"|"B_CORP"|"LLC"|"LLP"|"SOLE_PROP"|"ORG_501C3"|"LP"|null
Business.incorporation_year?
Section titled “Business.incorporation_year?”
optionalincorporation_year?:number|null
Format: int32
Description
Section titled “Description”Year of incorporation (YYYY format).
Example
Section titled “Example”2023Business.legal_name?
Section titled “Business.legal_name?”
optionallegal_name?:string|null
Description
Section titled “Description”Company legal name.
Example
Section titled “Example”Acme CorporationBusiness.website_url?
Section titled “Business.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.comCash:
object
Description
Section titled “Description”Available if customer applied for Brex Cash.
Cash.accounts?
Section titled “Cash.accounts?”
optionalaccounts?:object[] |null
Cash.application
Section titled “Cash.application”application:
object
Cash.application.status
Section titled “Cash.application.status”status:
"ACTIVE"|"PROCESSING"|"REJECTED"|"NO_ACCOUNT"|"NOT_SUBMITTED"|"INFORMATION_PENDING"|"MANUAL_REVIEW"|"CLOSED"
CompanyRelationship
Section titled “CompanyRelationship”CompanyRelationship:
"OTHER"|"FOUNDER"|"EXECUTIVE"|"SENIOR_LEADERSHIP"
Description
Section titled “Description”Relationship of this beneficial owner for this company.
ContactPreference
Section titled “ContactPreference”ContactPreference:
"NO_OUTBOUND"|"EMAIL_OUTBOUND"
Description
Section titled “Description”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.
CreateDocumentRequest
Section titled “CreateDocumentRequest”CreateDocumentRequest:
object
Description
Section titled “Description”Request for creating new document upload URL.
CreateDocumentRequest.type
Section titled “CreateDocumentRequest.type”type:
"ARTICLES_OF_INCORPORATION"|"IRS_EIN_CONFIRMATION"|"IRS_EIN_APPLICATION"|"CERTIFICATE_GOOD_STANDING"
CreateReferralRequest
Section titled “CreateReferralRequest”CreateReferralRequest:
object
Description
Section titled “Description”Submit a new referral to Brex for onboarding.
CreateReferralRequest.applicant
Section titled “CreateReferralRequest.applicant”applicant:
object
CreateReferralRequest.applicant.email
Section titled “CreateReferralRequest.applicant.email”email:
string
Format: email
Description
Section titled “Description”Business email of the applying customer.
Example
Section titled “Example”jane.smith@example.comCreateReferralRequest.applicant.first_name
Section titled “CreateReferralRequest.applicant.first_name”first_name:
string
Description
Section titled “Description”First name of the applying customer.
Example
Section titled “Example”JaneCreateReferralRequest.applicant.last_name
Section titled “CreateReferralRequest.applicant.last_name”last_name:
string
Description
Section titled “Description”Last name of the applying customer.
Example
Section titled “Example”SmithCreateReferralRequest.business?
Section titled “CreateReferralRequest.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
CreateReferralRequest.contact_preference?
Section titled “CreateReferralRequest.contact_preference?”
optionalcontact_preference?:"NO_OUTBOUND"|"EMAIL_OUTBOUND"|null
CreateReferralRequest.referral_code
Section titled “CreateReferralRequest.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_abc123Document
Section titled “Document”Document:
object
Document.id
Section titled “Document.id”id:
string
Description
Section titled “Description”Unique identifier for the document.
Example
Section titled “Example”prefdoc_a1b2c3d4e5Document.uri
Section titled “Document.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=exampleDocumentType
Section titled “DocumentType”DocumentType:
"ARTICLES_OF_INCORPORATION"|"IRS_EIN_CONFIRMATION"|"IRS_EIN_APPLICATION"|"CERTIFICATE_GOOD_STANDING"
Description
Section titled “Description”Type of document being submitted. Allowable types: - ARTICLES_OF_INCORPORATION - IRS_EIN_CONFIRMATION (IRS CP 575, CP 575 fax sheet, or 147C form) - IRS_EIN_APPLICATION (IRS SS4 form) - CERTIFICATE_GOOD_STANDING
DomesticInstruction
Section titled “DomesticInstruction”DomesticInstruction:
object
Description
Section titled “Description”Domestic ACH/wire instructions.
DomesticInstruction.account_type
Section titled “DomesticInstruction.account_type”account_type:
string
DomesticInstruction.bank_account_number
Section titled “DomesticInstruction.bank_account_number”bank_account_number:
string
DomesticInstruction.bank_address
Section titled “DomesticInstruction.bank_address”bank_address:
string
DomesticInstruction.bank_name
Section titled “DomesticInstruction.bank_name”bank_name:
string
DomesticInstruction.bank_routing_number
Section titled “DomesticInstruction.bank_routing_number”bank_routing_number:
string
DomesticInstruction.beneficiary_address
Section titled “DomesticInstruction.beneficiary_address”beneficiary_address:
string
DomesticInstruction.beneficiary_name
Section titled “DomesticInstruction.beneficiary_name”beneficiary_name:
string
IdentityDocument
Section titled “IdentityDocument”IdentityDocument:
object
Description
Section titled “Description”Document identifying the owner.
IdentityDocument.country
Section titled “IdentityDocument.country”country:
string
Description
Section titled “Description”Country where the identity document was issued.
IdentityDocument.number
Section titled “IdentityDocument.number”number:
string
Description
Section titled “Description”US SSN or passport number.
IdentityDocument.type
Section titled “IdentityDocument.type”type:
"SSN"|"PASSPORT"
IdentityDocumentType
Section titled “IdentityDocumentType”IdentityDocumentType:
"SSN"|"PASSPORT"
Description
Section titled “Description”Either a US SSN or US/international passport.
IncorporationType
Section titled “IncorporationType”IncorporationType:
"C_CORP"|"S_CORP"|"B_CORP"|"LLC"|"LLP"|"SOLE_PROP"|"ORG_501C3"|"LP"
Description
Section titled “Description”Incorporation type of the company referred.
Instruction
Section titled “Instruction”Instruction:
object
Description
Section titled “Description”Domestic and international ACH/wire instructions.
Instruction.domestic
Section titled “Instruction.domestic”domestic:
object
Instruction.domestic.account_type
Section titled “Instruction.domestic.account_type”account_type:
string
Instruction.domestic.bank_account_number
Section titled “Instruction.domestic.bank_account_number”bank_account_number:
string
Instruction.domestic.bank_address
Section titled “Instruction.domestic.bank_address”bank_address:
string
Instruction.domestic.bank_name
Section titled “Instruction.domestic.bank_name”bank_name:
string
Instruction.domestic.bank_routing_number
Section titled “Instruction.domestic.bank_routing_number”bank_routing_number:
string
Instruction.domestic.beneficiary_address
Section titled “Instruction.domestic.beneficiary_address”beneficiary_address:
string
Instruction.domestic.beneficiary_name
Section titled “Instruction.domestic.beneficiary_name”beneficiary_name:
string
Instruction.international
Section titled “Instruction.international”international:
object
Instruction.international.account_type
Section titled “Instruction.international.account_type”account_type:
string
Instruction.international.bank_address
Section titled “Instruction.international.bank_address”bank_address:
string
Instruction.international.bank_name
Section titled “Instruction.international.bank_name”bank_name:
string
Instruction.international.beneficiary_address
Section titled “Instruction.international.beneficiary_address”beneficiary_address:
string
Instruction.international.beneficiary_name
Section titled “Instruction.international.beneficiary_name”beneficiary_name:
string
Instruction.international.special_instructions
Section titled “Instruction.international.special_instructions”special_instructions:
string
Instruction.international.swift_account_number
Section titled “Instruction.international.swift_account_number”swift_account_number:
string
Instruction.international.swift_bank_number
Section titled “Instruction.international.swift_bank_number”swift_bank_number:
string
InternationalInstruction
Section titled “InternationalInstruction”InternationalInstruction:
object
Description
Section titled “Description”International wire instructions.
InternationalInstruction.account_type
Section titled “InternationalInstruction.account_type”account_type:
string
InternationalInstruction.bank_address
Section titled “InternationalInstruction.bank_address”bank_address:
string
InternationalInstruction.bank_name
Section titled “InternationalInstruction.bank_name”bank_name:
string
InternationalInstruction.beneficiary_address
Section titled “InternationalInstruction.beneficiary_address”beneficiary_address:
string
InternationalInstruction.beneficiary_name
Section titled “InternationalInstruction.beneficiary_name”beneficiary_name:
string
InternationalInstruction.special_instructions
Section titled “InternationalInstruction.special_instructions”special_instructions:
string
InternationalInstruction.swift_account_number
Section titled “InternationalInstruction.swift_account_number”swift_account_number:
string
InternationalInstruction.swift_bank_number
Section titled “InternationalInstruction.swift_bank_number”swift_bank_number:
string
ProcessDelayedEINDocumentRequest
Section titled “ProcessDelayedEINDocumentRequest”ProcessDelayedEINDocumentRequest:
object
Description
Section titled “Description”Request for processing a delayed EIN document
ProcessDelayedEINDocumentRequest.document_id
Section titled “ProcessDelayedEINDocumentRequest.document_id”document_id:
string
Description
Section titled “Description”The document ID returned from the initial document creation request
Product
Section titled “Product”Product:
object
Description
Section titled “Description”Array of Brex products that the customer has applied for. This is a gated feature available to select clients only.
Product.cash
Section titled “Product.cash”cash:
object
Product.cash.accounts?
Section titled “Product.cash.accounts?”
optionalaccounts?:object[] |null
Product.cash.application
Section titled “Product.cash.application”application:
object
Product.cash.application.status
Section titled “Product.cash.application.status”status:
"ACTIVE"|"PROCESSING"|"REJECTED"|"NO_ACCOUNT"|"NOT_SUBMITTED"|"INFORMATION_PENDING"|"MANUAL_REVIEW"|"CLOSED"
Prong:
"OWNERSHIP"|"CONTROL"|"BOTH"
Description
Section titled “Description”When using CONTROL prong, the beneficial owner is a single individual with
significant responsibility to control, manage, or direct a legal entity customer. This includes, an
executive officer or senior manager (Chief Executive Officer, Chief Financial Officer, Chief
Operating Officer, President), or any other individual who regularly performs similar
functions.
Under the `OWNERSHIP` prong, a beneficial owner is each individual, if any, who, directly orindirectly, through any contract, arrangement, understanding, relationship or otherwise, owns25 percent or more of the equity interests of a legal entity customer. If a trust owns directlyor indirectly, through any contract, arrangement, understanding, relationship or otherwise, 25percent or more of the equity interests of a legal entity customer, the beneficial owner is thetrustee.
Under the `BOTH` prong, the beneficial owner represents both.Referral
Section titled “Referral”Referral:
object
Referral.customer_email?
Section titled “Referral.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.
Referral.expires_at
Section titled “Referral.expires_at”expires_at:
string
Format: date-time
Description
Section titled “Description”The time at which this referral link expires.
Referral.id
Section titled “Referral.id”id:
string
Description
Section titled “Description”Unique identifier for the referral.
Example
Section titled “Example”a1b2c3d4e5f6g7Referral.products
Section titled “Referral.products”products:
object[]
Referral.referral_signup_url
Section titled “Referral.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=a1b2c3d4e5f6g7Referral.status
Section titled “Referral.status”status:
"ACTIVE"|"EXPIRED"|"CLOSED"|"UNCLAIMED"
ReferralPage
Section titled “ReferralPage”ReferralPage:
object
ReferralPage.items
Section titled “ReferralPage.items”items:
object[]
ReferralPage.next_cursor?
Section titled “ReferralPage.next_cursor?”
optionalnext_cursor?:string|null
ReferralStatus
Section titled “ReferralStatus”ReferralStatus:
"ACTIVE"|"EXPIRED"|"CLOSED"|"UNCLAIMED"
Description
Section titled “Description”Status of the referral. UNCLAIMED or EXPIRED unless the customer completes signup. Customers are attributed once ACTIVE until the account is CLOSED.