Agreements
Overview
Retrieve agreements and manage consent records. Agreements enables developers to list and retrieve agreements, download agreement documents, and work with the consent responses individuals have recorded across WEX platforms. It includes operations for agreements, agreement files, and consent records. Use this resource to present the right agreements to consumers, show them the document they are agreeing to, and keep an accurate record of their consent.
Why use the API?
- Modernization: It provides a standardized, clear, and modern RESTful endpoint, making it easier to integrate with current systems.
- Integration: It allows you to easily consume and integrate agreement and consent data, powering your own consumer-facing experiences.
- Growth & Innovation: Using our API, you can improve your own products and create a smoother consent experience for your customers and consumers.
What can the API do?
The Agreements API allows you to perform functions related to:
- Agreements and guides
- Agreement files (PDF or HTML)
- Consent records for an individual
Key Features
- Returns a paginated list of agreements, filtered by custodian, administrator, document type, active status, and whether a file is attached. Use
page(zero-based, default 0) andpage_size(1 to 100, default 20). - Returns a single agreement by ID, including its name, document type (agreement or guide), active status, effective date, current definition, and files.
- Returns the file for an agreement as base64-encoded content with its MIME type and size in bytes, so you can display or store the document.
- Lists all consent records for an individual, with optional filters by custodian or agreement.
- Includes the owning custodian on agreement results when you request admin properties.
Agreements API Operations
The Agreements API includes the following operations. Select the API Reference tab to find functional information about each one.
- Get Agreement Responses
- Get Agreements Agreement
- Get Agreements Agreements
- Get Agreements Agreement File
- Create Agreement Response
- Agreements Attach Agreement File
Was this section helpful?