Referrals

Create a new document upload

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 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/v1/referrals/{id}/document_upload

Request

Base URL
https://api.brex.com
Auth
OAuth 2
Client credentials
Token URLhttps://accounts-api.brex.com/oauth2/default/v1/token
TypeScript
https://skmtc.dev/brex-com/apis/onboarding-api/docs/v1/referrals/:id/document_upload/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Request body

type'ARTICLES_OF_INCORPORATION' | 'IRS_EIN_CONFIRMATION' | 'IRS_EIN_APPLICATION' | 'CERTIFICATE_GOOD_STANDING' required

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

Response

Success

uristring required

This is a presigned S3 link that should be used to attach the document. The maximum size accepted for this document is 50 MB.

idstring required

Unique identifier for the document.

Example response

{
  "uri": "https://brex-documents.s3.amazonaws.com/upload/abc123?AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE&Expires=1234567890&Signature=example",
  "id": "prefdoc_a1b2c3d4e5"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.