The team API lets you manage users, departments, locations, and cards.
Team API (1.0)
Download OpenAPI description
Overview
Languages
Servers
Production
https://api.brex.com
Staging (Note: This is not a sandbox. It will not work with customer tokens.)
https://api-staging.brex.com
Security
OAuth2(Required scopes:
legal_entities
legal_entities.readonly
)- Productionhttps://api.brex.com/v2/legal_entities
- Staging (Note: This is not a sandbox. It will not work with customer tokens.)https://api-staging.brex.com/v2/legal_entities
- curl
- JavaScript
- Node.js
- Python
- Ruby
- Java
curl -i -X GET \
https://api.brex.com/v2/legal_entities \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'listLegalEntities 200 response
Company business address (must be in the US; no PO box or virtual/forwarding addresses allowed).
Address line 2 (e.g., apartment, suite, unit, or building).
For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
The possible statuses for an entity's verification in Brex.
Enum"UNSUBMITTED""UNVERIFIED""IN_PROGRESS""VERIFIED""REJECTED"
Response
application/json
{ "next_cursor": "string", "items": [ { … } ] }
Security
OAuth2(Required scopes:
legal_entities
legal_entities.readonly
)- Productionhttps://api.brex.com/v2/legal_entities/{id}
- Staging (Note: This is not a sandbox. It will not work with customer tokens.)https://api-staging.brex.com/v2/legal_entities/{id}
- curl
- JavaScript
- Node.js
- Python
- Ruby
- Java
curl -i -X GET \
'https://api.brex.com/v2/legal_entities/{id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'getLegalEntity 200 response
Company business address (must be in the US; no PO box or virtual/forwarding addresses allowed).
For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
The possible statuses for an entity's verification in Brex.
Enum"UNSUBMITTED""UNVERIFIED""IN_PROGRESS""VERIFIED""REJECTED"
Response
application/json
{ "id": "string", "displayName": "string", "billingAddress": { "line1": "string", "line2": "string", "city": "string", "state": "string", "country": "string", "postal_code": "string", "phone_number": "string" }, "createdAt": "2019-08-24T14:15:22Z", "status": "UNSUBMITTED", "isDefault": true }