---
title: OnboardingPaths
editUrl: false
head: []
template: doc
prev: false
next: false
sidebar:
  hidden: false
  attrs: {}
pagefind: true
draft: false
---

Defined in: [src/onboarding/types.gen.ts:2](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/types.gen.ts#L2)

## Properties

### /v1/referrals

> **/v1/referrals**: `object`

Defined in: [src/onboarding/types.gen.ts:3](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/types.gen.ts#L3)

#### delete?

> `optional` **delete?**: `undefined`

#### get

> **get**: `object`

List referrals

##### Description

Returns referrals created.
    *Note*: This doesn't include referrals that have expired.

##### get.parameters

> **parameters**: `object`

##### get.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### get.parameters.header?

> `optional` **header?**: `undefined`

##### get.parameters.path?

> `optional` **path?**: `undefined`

##### get.parameters.query?

> `optional` **query?**: `object`

##### get.parameters.query.cursor?

> `optional` **cursor?**: `string` \| `null`

##### get.requestBody?

> `optional` **requestBody?**: `undefined`

##### get.responses

> **responses**: `object`

##### get.responses.200

> **200**: `object`

###### Description

Success

##### get.responses.200.content

> **content**: `object`

##### get.responses.200.content.application/json

> **application/json**: `object`

##### get.responses.200.content.application/json.items

> **items**: `object`[]

##### get.responses.200.content.application/json.next\_cursor?

> `optional` **next\_cursor?**: `string` \| `null`

##### get.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.400

> **400**: `object`

###### Description

Invalid cursor

##### get.responses.400.content?

> `optional` **content?**: `undefined`

##### get.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.401

> **401**: `object`

###### Description

Unauthorized

##### get.responses.401.content?

> `optional` **content?**: `undefined`

##### get.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### head?

> `optional` **head?**: `undefined`

#### options?

> `optional` **options?**: `undefined`

#### parameters

> **parameters**: `object`

##### parameters.cookie?

> `optional` **cookie?**: `undefined`

##### parameters.header?

> `optional` **header?**: `undefined`

##### parameters.path?

> `optional` **path?**: `undefined`

##### parameters.query?

> `optional` **query?**: `undefined`

#### patch?

> `optional` **patch?**: `undefined`

#### post

> **post**: `object`

Creates a referral

##### 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

> **parameters**: `object`

##### post.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### post.parameters.header?

> `optional` **header?**: `undefined`

##### post.parameters.path?

> `optional` **path?**: `undefined`

##### post.parameters.query?

> `optional` **query?**: `undefined`

##### post.requestBody

> **requestBody**: `object`

##### post.requestBody.content

> **content**: `object`

##### post.requestBody.content.application/json

> **application/json**: `object`

##### post.requestBody.content.application/json.applicant

> **applicant**: `object`

##### post.requestBody.content.application/json.applicant.email

> **email**: `string`

Format: email

###### Description

Business email of the applying customer.

###### Example

```ts
jane.smith@example.com
```

##### post.requestBody.content.application/json.applicant.first\_name

> **first\_name**: `string`

###### Description

First name of the applying customer.

###### Example

```ts
Jane
```

##### post.requestBody.content.application/json.applicant.last\_name

> **last\_name**: `string`

###### Description

Last name of the applying customer.

###### Example

```ts
Smith
```

##### post.requestBody.content.application/json.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`

##### post.requestBody.content.application/json.contact\_preference?

> `optional` **contact\_preference?**: `"NO_OUTBOUND"` \| `"EMAIL_OUTBOUND"` \| `null`

##### post.requestBody.content.application/json.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
```

##### post.responses

> **responses**: `object`

##### post.responses.200

> **200**: `object`

###### Description

Success

##### post.responses.200.content

> **content**: `object`

##### post.responses.200.content.application/json

> **application/json**: `object`

##### post.responses.200.content.application/json.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.

##### post.responses.200.content.application/json.expires\_at

> **expires\_at**: `string`

Format: date-time

###### Description

The time at which this referral link expires.

##### post.responses.200.content.application/json.id

> **id**: `string`

###### Description

Unique identifier for the referral.

###### Example

```ts
a1b2c3d4e5f6g7
```

##### post.responses.200.content.application/json.products

> **products**: `object`[]

##### post.responses.200.content.application/json.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
```

##### post.responses.200.content.application/json.status

> **status**: `"ACTIVE"` \| `"EXPIRED"` \| `"CLOSED"` \| `"UNCLAIMED"`

##### post.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.401

> **401**: `object`

###### Description

Unauthorized

##### post.responses.401.content?

> `optional` **content?**: `undefined`

##### post.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### put?

> `optional` **put?**: `undefined`

#### trace?

> `optional` **trace?**: `undefined`

***

### /v1/referrals/\{id\}

> **/v1/referrals/\{id\}**: `object`

Defined in: [src/onboarding/types.gen.ts:28](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/types.gen.ts#L28)

#### delete?

> `optional` **delete?**: `undefined`

#### get

> **get**: `object`

Gets a referral by ID

##### Description

Returns a referral object by ID if it exists.

##### get.parameters

> **parameters**: `object`

##### get.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### get.parameters.header?

> `optional` **header?**: `undefined`

##### get.parameters.path

> **path**: `object`

##### get.parameters.path.id

> **id**: `string`

##### get.parameters.query?

> `optional` **query?**: `undefined`

##### get.requestBody?

> `optional` **requestBody?**: `undefined`

##### get.responses

> **responses**: `object`

##### get.responses.200

> **200**: `object`

###### Description

Success

##### get.responses.200.content

> **content**: `object`

##### get.responses.200.content.application/json

> **application/json**: `object`

##### get.responses.200.content.application/json.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.

##### get.responses.200.content.application/json.expires\_at

> **expires\_at**: `string`

Format: date-time

###### Description

The time at which this referral link expires.

##### get.responses.200.content.application/json.id

> **id**: `string`

###### Description

Unique identifier for the referral.

###### Example

```ts
a1b2c3d4e5f6g7
```

##### get.responses.200.content.application/json.products

> **products**: `object`[]

##### get.responses.200.content.application/json.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
```

##### get.responses.200.content.application/json.status

> **status**: `"ACTIVE"` \| `"EXPIRED"` \| `"CLOSED"` \| `"UNCLAIMED"`

##### get.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.401

> **401**: `object`

###### Description

Unauthorized

##### get.responses.401.content?

> `optional` **content?**: `undefined`

##### get.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### get.responses.404

> **404**: `object`

###### Description

Referral not found

##### get.responses.404.content?

> `optional` **content?**: `undefined`

##### get.responses.404.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### head?

> `optional` **head?**: `undefined`

#### options?

> `optional` **options?**: `undefined`

#### parameters

> **parameters**: `object`

##### parameters.cookie?

> `optional` **cookie?**: `undefined`

##### parameters.header?

> `optional` **header?**: `undefined`

##### parameters.path?

> `optional` **path?**: `undefined`

##### parameters.query?

> `optional` **query?**: `undefined`

#### patch?

> `optional` **patch?**: `undefined`

#### post?

> `optional` **post?**: `undefined`

#### put?

> `optional` **put?**: `undefined`

#### trace?

> `optional` **trace?**: `undefined`

***

### /v1/referrals/\{id\}/document\_upload

> **/v1/referrals/\{id\}/document\_upload**: `object`

Defined in: [src/onboarding/types.gen.ts:48](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/types.gen.ts#L48)

#### delete?

> `optional` **delete?**: `undefined`

#### get?

> `optional` **get?**: `undefined`

#### head?

> `optional` **head?**: `undefined`

#### options?

> `optional` **options?**: `undefined`

#### parameters

> **parameters**: `object`

##### parameters.cookie?

> `optional` **cookie?**: `undefined`

##### parameters.header?

> `optional` **header?**: `undefined`

##### parameters.path?

> `optional` **path?**: `undefined`

##### parameters.query?

> `optional` **query?**: `undefined`

#### patch?

> `optional` **patch?**: `undefined`

#### post

> **post**: `object`

Create a new document upload

##### 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

> **parameters**: `object`

##### post.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### post.parameters.header?

> `optional` **header?**: `undefined`

##### post.parameters.path

> **path**: `object`

##### post.parameters.path.id

> **id**: `string`

##### post.parameters.query?

> `optional` **query?**: `undefined`

##### post.requestBody

> **requestBody**: `object`

##### post.requestBody.content

> **content**: `object`

##### post.requestBody.content.application/json

> **application/json**: `object`

##### post.requestBody.content.application/json.type

> **type**: `"ARTICLES_OF_INCORPORATION"` \| `"IRS_EIN_CONFIRMATION"` \| `"IRS_EIN_APPLICATION"` \| `"CERTIFICATE_GOOD_STANDING"`

##### post.responses

> **responses**: `object`

##### post.responses.200

> **200**: `object`

###### Description

Success

##### post.responses.200.content

> **content**: `object`

##### post.responses.200.content.application/json

> **application/json**: `object`

##### post.responses.200.content.application/json.id

> **id**: `string`

###### Description

Unique identifier for the document.

###### Example

```ts
prefdoc_a1b2c3d4e5
```

##### post.responses.200.content.application/json.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
```

##### post.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.401

> **401**: `object`

###### Description

Unauthorized

##### post.responses.401.content?

> `optional` **content?**: `undefined`

##### post.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.404

> **404**: `object`

###### Description

Referral not found

##### post.responses.404.content?

> `optional` **content?**: `undefined`

##### post.responses.404.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### put?

> `optional` **put?**: `undefined`

#### trace?

> `optional` **trace?**: `undefined`

***

### /v1/referrals/\{id\}/process\_ein\_document

> **/v1/referrals/\{id\}/process\_ein\_document**: `object`

Defined in: [src/onboarding/types.gen.ts:70](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/onboarding/types.gen.ts#L70)

#### delete?

> `optional` **delete?**: `undefined`

#### get?

> `optional` **get?**: `undefined`

#### head?

> `optional` **head?**: `undefined`

#### options?

> `optional` **options?**: `undefined`

#### parameters

> **parameters**: `object`

##### parameters.cookie?

> `optional` **cookie?**: `undefined`

##### parameters.header?

> `optional` **header?**: `undefined`

##### parameters.path?

> `optional` **path?**: `undefined`

##### parameters.query?

> `optional` **query?**: `undefined`

#### patch?

> `optional` **patch?**: `undefined`

#### post

> **post**: `object`

Process a delayed EIN document after upload

##### 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 the
    standard 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

> **parameters**: `object`

##### post.parameters.cookie?

> `optional` **cookie?**: `undefined`

##### post.parameters.header?

> `optional` **header?**: `undefined`

##### post.parameters.path

> **path**: `object`

##### post.parameters.path.id

> **id**: `string`

##### post.parameters.query?

> `optional` **query?**: `undefined`

##### post.requestBody

> **requestBody**: `object`

##### post.requestBody.content

> **content**: `object`

##### post.requestBody.content.application/json

> **application/json**: `object`

##### post.requestBody.content.application/json.document\_id

> **document\_id**: `string`

###### Description

The document ID returned from the initial document creation request

##### post.responses

> **responses**: `object`

##### post.responses.200

> **200**: `object`

###### Description

Document processed successfully

##### post.responses.200.content?

> `optional` **content?**: `undefined`

##### post.responses.200.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.400

> **400**: `object`

###### Description

Document not uploaded or invalid

##### post.responses.400.content?

> `optional` **content?**: `undefined`

##### post.responses.400.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.401

> **401**: `object`

###### Description

Unauthorized

##### post.responses.401.content?

> `optional` **content?**: `undefined`

##### post.responses.401.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

##### post.responses.404

> **404**: `object`

###### Description

Referral not found

##### post.responses.404.content?

> `optional` **content?**: `undefined`

##### post.responses.404.headers

> **headers**: `object`

###### Index Signature

\[`name`: `string`\]: `unknown`

#### put?

> `optional` **put?**: `undefined`

#### trace?

> `optional` **trace?**: `undefined`