Onboarding API

Number of APIs: 5

Onboarding APIs

Onboarding APIs allows partners to refer their customers to Brex to streamline the process of creating new accounts for these customers. By submitting information for referrals, it removes the need for customers to enter in this information again.

Authentication via OAuth + OpenID Connect

Brex API authentication is fully compliant with OpenID Connect, an extension on top of OAuth2.

For more details on the OpenID Connect protocol see the spec here. The well-known configuration can be found at the following urls:

Production: https://accounts.brex.com/.well-known/openid-configuration

Staging: https://accounts.staging.brexapps.com/.well-known/openid-configuration

Scopes

You will need to request the following scopes to access the API:

• openid
• offline_access
• https://onboarding.brexapis.com/referrals

Contact Support: Name: Admin Email: partner-inquiries@brex.com

1. v1/referrals-{id} - Gets a referral by ID

GET {{api_url}}/v1/referrals/:id

---

2. v1/referrals-{id} - Attach document to referral

POST {{api_url}}/v1/referrals/:id/document_upload

---

3. v1/referrals - List referrals

GET {{api_url}}/v1/referrals

---

4. v1/referrals - Creates a referral

POST {{api_url}}/v1/referrals

---

5. S3 Document Upload

PUT {{document_upload_url}}

---