--- title: OnboardingComponents editUrl: false head: [] template: doc prev: false next: false sidebar: hidden: false attrs: {} pagefind: true draft: false --- Defined in: [src/onboarding/types.gen.ts:97](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/types.gen.ts#L97) ## Properties ### headers > **headers**: `never` Defined in: [src/onboarding/types.gen.ts:414](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/types.gen.ts#L414) *** ### parameters > **parameters**: `never` Defined in: [src/onboarding/types.gen.ts:412](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/types.gen.ts#L412) *** ### pathItems > **pathItems**: `never` Defined in: [src/onboarding/types.gen.ts:415](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/types.gen.ts#L415) *** ### requestBodies > **requestBodies**: `never` Defined in: [src/onboarding/types.gen.ts:413](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/types.gen.ts#L413) *** ### responses > **responses**: `never` Defined in: [src/onboarding/types.gen.ts:411](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/types.gen.ts#L411) *** ### schemas > **schemas**: `object` Defined in: [src/onboarding/types.gen.ts:98](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/types.gen.ts#L98) #### Account > **Account**: `object` ##### 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 > **created\_at**: `string` Format: date-time ##### Account.id > **id**: `string` ###### Description Brex Cash management account ID. ##### Account.instructions? > `optional` **instructions?**: \{ `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 > **Address**: `object` ##### Description Company business address (must be in the US; no PO box or virtual/forwarding addresses allowed). ##### Address.city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ##### Address.country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ##### Address.line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ##### Address.line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ##### Address.phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ##### Address.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ##### Address.state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. #### Applicant > **Applicant**: `object` ##### Description Required information about the referred prospect. ##### Applicant.email > **email**: `string` Format: email ###### Description Business email of the applying customer. ###### Example ```ts jane.smith@example.com ``` ##### Applicant.first\_name > **first\_name**: `string` ###### Description First name of the applying customer. ###### Example ```ts Jane ``` ##### Applicant.last\_name > **last\_name**: `string` ###### Description Last name of the applying customer. ###### Example ```ts Smith ``` #### Application > **Application**: `object` ##### Application.status > **status**: `"ACTIVE"` \| `"PROCESSING"` \| `"REJECTED"` \| `"NO_ACCOUNT"` \| `"NOT_SUBMITTED"` \| `"INFORMATION_PENDING"` \| `"MANUAL_REVIEW"` \| `"CLOSED"` #### ApplicationStatus > **ApplicationStatus**: `"ACTIVE"` \| `"PROCESSING"` \| `"REJECTED"` \| `"NO_ACCOUNT"` \| `"NOT_SUBMITTED"` \| `"INFORMATION_PENDING"` \| `"MANUAL_REVIEW"` \| `"CLOSED"` ##### 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 > **BeneficialOwner**: `object` ##### Description Federal law requires us to collect information for anyone who owns 25% or more of the company. ##### BeneficialOwner.address? > `optional` **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 ###### 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`; \} ###### city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ###### country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ###### line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ###### line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ###### postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ###### state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ##### BeneficialOwner.company\_relationship? > `optional` **company\_relationship?**: `"OTHER"` \| `"FOUNDER"` \| `"EXECUTIVE"` \| `"SENIOR_LEADERSHIP"` \| `null` ##### BeneficialOwner.date\_of\_birth? > `optional` **date\_of\_birth?**: `string` \| `null` Format: date ###### Description Date of birth. ##### BeneficialOwner.identity\_document? > `optional` **identity\_document?**: \{ `country`: `string`; `number`: `string`; `type`: `"SSN"` \| `"PASSPORT"`; \} \| `null` ###### Union Members ###### Type Literal \{ `country`: `string`; `number`: `string`; `type`: `"SSN"` \| `"PASSPORT"`; \} ###### country > **country**: `string` ###### Description Country where the identity document was issued. ###### number > **number**: `string` ###### Description US SSN or passport number. ###### type > **type**: `"SSN"` \| `"PASSPORT"` *** `null` ##### BeneficialOwner.legal\_name > **legal\_name**: `string` ###### Description Legal full name. ##### BeneficialOwner.ownership\_percentage? > `optional` **ownership\_percentage?**: `number` \| `null` Format: int32 ###### Description Ownership percentage (25-100). Only populated for individuals with ownership stakes (25% or more). ###### Example ```ts 25 ``` ##### BeneficialOwner.prong > **prong**: `"OWNERSHIP"` \| `"CONTROL"` \| `"BOTH"` #### Business > **Business**: `object` ##### 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 the registration address. For instance, for international companies where their operational address may be different than where the company was incorporated. ##### Business.activity\_description? > `optional` **activity\_description?**: `string` \| `null` ###### Description Brief description of the business activity. ###### Example ```ts Software as a Service platform for project management ``` ##### Business.address? > `optional` **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 ###### 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`; \} ###### city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ###### country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ###### line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ###### line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ###### postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ###### state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ##### Business.alternate\_address? > `optional` **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` ###### Union Members ###### 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`; \} ###### city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ###### country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ###### line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ###### line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ###### postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ###### state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ##### Business.beneficial\_owners? > `optional` **beneficial\_owners?**: `object`[] \| `null` ###### Description List of beneficial owners of the company ##### Business.employer\_identification\_number? > `optional` **employer\_identification\_number?**: `string` \| `null` ###### Description Company Employer Identification Number(EIN). ###### Example ```ts 123456789 ``` ##### Business.incorporation\_state? > `optional` **incorporation\_state?**: `string` \| `null` ###### Description State of incorporation (US state abbreviation). ###### Example ```ts CA ``` ##### Business.incorporation\_type? > `optional` **incorporation\_type?**: `"C_CORP"` \| `"S_CORP"` \| `"B_CORP"` \| `"LLC"` \| `"LLP"` \| `"SOLE_PROP"` \| `"ORG_501C3"` \| `"LP"` \| `null` ##### Business.incorporation\_year? > `optional` **incorporation\_year?**: `number` \| `null` Format: int32 ###### Description Year of incorporation (YYYY format). ###### Example ```ts 2023 ``` ##### Business.legal\_name? > `optional` **legal\_name?**: `string` \| `null` ###### Description Company legal name. ###### Example ```ts Acme Corporation ``` ##### Business.website\_url? > `optional` **website\_url?**: `string` \| `null` ###### Description Business website (or link to ecommerce store for sellers). ###### Example ```ts https://www.acmecorp.com ``` #### Cash > **Cash**: `object` ##### Description Available if customer applied for Brex Cash. ##### Cash.accounts? > `optional` **accounts?**: `object`[] \| `null` ##### Cash.application > **application**: `object` ##### Cash.application.status > **status**: `"ACTIVE"` \| `"PROCESSING"` \| `"REJECTED"` \| `"NO_ACCOUNT"` \| `"NOT_SUBMITTED"` \| `"INFORMATION_PENDING"` \| `"MANUAL_REVIEW"` \| `"CLOSED"` #### CompanyRelationship > **CompanyRelationship**: `"OTHER"` \| `"FOUNDER"` \| `"EXECUTIVE"` \| `"SENIOR_LEADERSHIP"` ##### Description Relationship of this beneficial owner for this company. #### ContactPreference > **ContactPreference**: `"NO_OUTBOUND"` \| `"EMAIL_OUTBOUND"` ##### 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 > **CreateDocumentRequest**: `object` ##### Description Request for creating new document upload URL. ##### CreateDocumentRequest.type > **type**: `"ARTICLES_OF_INCORPORATION"` \| `"IRS_EIN_CONFIRMATION"` \| `"IRS_EIN_APPLICATION"` \| `"CERTIFICATE_GOOD_STANDING"` #### CreateReferralRequest > **CreateReferralRequest**: `object` ##### Description Submit a new referral to Brex for onboarding. ##### CreateReferralRequest.applicant > **applicant**: `object` ##### CreateReferralRequest.applicant.email > **email**: `string` Format: email ###### Description Business email of the applying customer. ###### Example ```ts jane.smith@example.com ``` ##### CreateReferralRequest.applicant.first\_name > **first\_name**: `string` ###### Description First name of the applying customer. ###### Example ```ts Jane ``` ##### CreateReferralRequest.applicant.last\_name > **last\_name**: `string` ###### Description Last name of the applying customer. ###### Example ```ts Smith ``` ##### CreateReferralRequest.business? > `optional` **business?**: \{ `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 ###### 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? > `optional` **activity\_description?**: `string` \| `null` ###### Description Brief description of the business activity. ###### Example ```ts Software as a Service platform for project management ``` ###### address? > `optional` **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 ###### 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`; \} ###### city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ###### country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ###### line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ###### line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ###### postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ###### state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ###### alternate\_address? > `optional` **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` ###### Union Members ###### 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`; \} ###### city? > `optional` **city?**: `string` \| `null` ###### Description City, district, suburb, town, or village. ###### country? > `optional` **country?**: `string` \| `null` ###### Description Two-letter country code (ISO 3166-1 alpha-2). ###### line1? > `optional` **line1?**: `string` \| `null` ###### Description Address line 1, no PO Box. ###### line2? > `optional` **line2?**: `string` \| `null` ###### Description Address line 2 (e.g., apartment, suite, unit, or building). ###### phone\_number? > `optional` **phone\_number?**: `string` \| `null` ###### Description Phone number. ###### postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description ZIP or postal code. ###### state? > `optional` **state?**: `string` \| `null` ###### Description For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region. *** `null` ###### beneficial\_owners? > `optional` **beneficial\_owners?**: `object`[] \| `null` ###### Description List of beneficial owners of the company ###### employer\_identification\_number? > `optional` **employer\_identification\_number?**: `string` \| `null` ###### Description Company Employer Identification Number(EIN). ###### Example ```ts 123456789 ``` ###### incorporation\_state? > `optional` **incorporation\_state?**: `string` \| `null` ###### Description State of incorporation (US state abbreviation). ###### Example ```ts CA ``` ###### incorporation\_type? > `optional` **incorporation\_type?**: `"C_CORP"` \| `"S_CORP"` \| `"B_CORP"` \| `"LLC"` \| `"LLP"` \| `"SOLE_PROP"` \| `"ORG_501C3"` \| `"LP"` \| `null` ###### incorporation\_year? > `optional` **incorporation\_year?**: `number` \| `null` Format: int32 ###### Description Year of incorporation (YYYY format). ###### Example ```ts 2023 ``` ###### legal\_name? > `optional` **legal\_name?**: `string` \| `null` ###### Description Company legal name. ###### Example ```ts Acme Corporation ``` ###### website\_url? > `optional` **website\_url?**: `string` \| `null` ###### Description Business website (or link to ecommerce store for sellers). ###### Example ```ts https://www.acmecorp.com ``` *** `null` ##### CreateReferralRequest.contact\_preference? > `optional` **contact\_preference?**: `"NO_OUTBOUND"` \| `"EMAIL_OUTBOUND"` \| `null` ##### CreateReferralRequest.referral\_code > **referral\_code**: `string` ###### Description Referral code that attributes credit to you if the prospect signs up for a Brex account. ###### Example ```ts partner_abc123 ``` #### Document > **Document**: `object` ##### Document.id > **id**: `string` ###### Description Unique identifier for the document. ###### Example ```ts prefdoc_a1b2c3d4e5 ``` ##### Document.uri > **uri**: `string` ###### 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 ```ts https://brex-documents.s3.amazonaws.com/upload/abc123?AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE&Expires=1234567890&Signature=example ``` #### DocumentType > **DocumentType**: `"ARTICLES_OF_INCORPORATION"` \| `"IRS_EIN_CONFIRMATION"` \| `"IRS_EIN_APPLICATION"` \| `"CERTIFICATE_GOOD_STANDING"` ##### 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 > **DomesticInstruction**: `object` ##### Description Domestic ACH/wire instructions. ##### DomesticInstruction.account\_type > **account\_type**: `string` ##### DomesticInstruction.bank\_account\_number > **bank\_account\_number**: `string` ##### DomesticInstruction.bank\_address > **bank\_address**: `string` ##### DomesticInstruction.bank\_name > **bank\_name**: `string` ##### DomesticInstruction.bank\_routing\_number > **bank\_routing\_number**: `string` ##### DomesticInstruction.beneficiary\_address > **beneficiary\_address**: `string` ##### DomesticInstruction.beneficiary\_name > **beneficiary\_name**: `string` #### IdentityDocument > **IdentityDocument**: `object` ##### Description Document identifying the owner. ##### IdentityDocument.country > **country**: `string` ###### Description Country where the identity document was issued. ##### IdentityDocument.number > **number**: `string` ###### Description US SSN or passport number. ##### IdentityDocument.type > **type**: `"SSN"` \| `"PASSPORT"` #### IdentityDocumentType > **IdentityDocumentType**: `"SSN"` \| `"PASSPORT"` ##### Description Either a US SSN or US/international passport. #### IncorporationType > **IncorporationType**: `"C_CORP"` \| `"S_CORP"` \| `"B_CORP"` \| `"LLC"` \| `"LLP"` \| `"SOLE_PROP"` \| `"ORG_501C3"` \| `"LP"` ##### Description Incorporation type of the company referred. #### Instruction > **Instruction**: `object` ##### Description Domestic and international ACH/wire instructions. ##### Instruction.domestic > **domestic**: `object` ##### Instruction.domestic.account\_type > **account\_type**: `string` ##### Instruction.domestic.bank\_account\_number > **bank\_account\_number**: `string` ##### Instruction.domestic.bank\_address > **bank\_address**: `string` ##### Instruction.domestic.bank\_name > **bank\_name**: `string` ##### Instruction.domestic.bank\_routing\_number > **bank\_routing\_number**: `string` ##### Instruction.domestic.beneficiary\_address > **beneficiary\_address**: `string` ##### Instruction.domestic.beneficiary\_name > **beneficiary\_name**: `string` ##### Instruction.international > **international**: `object` ##### Instruction.international.account\_type > **account\_type**: `string` ##### Instruction.international.bank\_address > **bank\_address**: `string` ##### Instruction.international.bank\_name > **bank\_name**: `string` ##### Instruction.international.beneficiary\_address > **beneficiary\_address**: `string` ##### Instruction.international.beneficiary\_name > **beneficiary\_name**: `string` ##### Instruction.international.special\_instructions > **special\_instructions**: `string` ##### Instruction.international.swift\_account\_number > **swift\_account\_number**: `string` ##### Instruction.international.swift\_bank\_number > **swift\_bank\_number**: `string` #### InternationalInstruction > **InternationalInstruction**: `object` ##### Description International wire instructions. ##### InternationalInstruction.account\_type > **account\_type**: `string` ##### InternationalInstruction.bank\_address > **bank\_address**: `string` ##### InternationalInstruction.bank\_name > **bank\_name**: `string` ##### InternationalInstruction.beneficiary\_address > **beneficiary\_address**: `string` ##### InternationalInstruction.beneficiary\_name > **beneficiary\_name**: `string` ##### InternationalInstruction.special\_instructions > **special\_instructions**: `string` ##### InternationalInstruction.swift\_account\_number > **swift\_account\_number**: `string` ##### InternationalInstruction.swift\_bank\_number > **swift\_bank\_number**: `string` #### ProcessDelayedEINDocumentRequest > **ProcessDelayedEINDocumentRequest**: `object` ##### Description Request for processing a delayed EIN document ##### ProcessDelayedEINDocumentRequest.document\_id > **document\_id**: `string` ###### Description The document ID returned from the initial document creation request #### Product > **Product**: `object` ##### Description Array of Brex products that the customer has applied for. This is a gated feature available to select clients only. ##### Product.cash > **cash**: `object` ##### Product.cash.accounts? > `optional` **accounts?**: `object`[] \| `null` ##### Product.cash.application > **application**: `object` ##### Product.cash.application.status > **status**: `"ACTIVE"` \| `"PROCESSING"` \| `"REJECTED"` \| `"NO_ACCOUNT"` \| `"NOT_SUBMITTED"` \| `"INFORMATION_PENDING"` \| `"MANUAL_REVIEW"` \| `"CLOSED"` #### Prong > **Prong**: `"OWNERSHIP"` \| `"CONTROL"` \| `"BOTH"` ##### 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 or indirectly, through any contract, arrangement, understanding, relationship or otherwise, owns 25 percent or more of the equity interests of a legal entity customer. If a trust owns directly or indirectly, through any contract, arrangement, understanding, relationship or otherwise, 25 percent or more of the equity interests of a legal entity customer, the beneficial owner is the trustee. Under the `BOTH` prong, the beneficial owner represents both. #### Referral > **Referral**: `object` ##### Referral.customer\_email? > `optional` **customer\_email?**: `string` \| `null` Format: email ###### Description Customer's email address registered for the Brex application. This field is available only if there's a signup completed. ##### Referral.expires\_at > **expires\_at**: `string` Format: date-time ###### Description The time at which this referral link expires. ##### Referral.id > **id**: `string` ###### Description Unique identifier for the referral. ###### Example ```ts a1b2c3d4e5f6g7 ``` ##### Referral.products > **products**: `object`[] ##### Referral.referral\_signup\_url > **referral\_signup\_url**: `string` ###### 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 ```ts https://brex.com/signup?pref_token=a1b2c3d4e5f6g7 ``` ##### Referral.status > **status**: `"ACTIVE"` \| `"EXPIRED"` \| `"CLOSED"` \| `"UNCLAIMED"` #### ReferralPage > **ReferralPage**: `object` ##### ReferralPage.items > **items**: `object`[] ##### ReferralPage.next\_cursor? > `optional` **next\_cursor?**: `string` \| `null` #### ReferralStatus > **ReferralStatus**: `"ACTIVE"` \| `"EXPIRED"` \| `"CLOSED"` \| `"UNCLAIMED"` ##### Description Status of the referral. `UNCLAIMED` or `EXPIRED` unless the customer completes signup. Customers are attributed once `ACTIVE` until the account is `CLOSED`.