Jump to Content
API Reference
v1.0
Log In
API Reference
Log In
v1.0
API Reference
Overview
Search
All
Pages
Start typing to search…
JUMP TO
Freede Agency API
Overview
Authentication
Environments
Accounts
Search Accounts
post
Add Account Payment
post
Get Account
get
Update Consumer Account
put
Upload file for consumer account
post
Consumers
Update Opt-in status
put
Get consumer optins
get
Get consumer details
get
Deregister consumer
del
Update Consumer Information
put
Search consumers
post
Utilities
Get new API key
post
API Health
get
Update PEM
post
Generate QR Code for Invite reference code
get
Tasks
Submit Task Details
put
Close Task
del
Conversations
Get Conversation Transcript
get
Payments
Update payment status
put
Agency Incoming API
Overview
Request Verification
Accounts
Get account details
get
Consumers
Consumer submitted form
post
Create Consumer Payment Method
post
Update Payment Plan Payment Method
put
Update consumer demographics
put
Deregister consumer
del
Get Consumer Info
get
Get Consumer Accounts
get
Consumer Convenience Fee Lookup
post
Update consumer optins
put
Consumer conversation
post
Update consumer conversation
put
Send consumer conversation event
post
Get Consumer Stored Payment Methods
get
Delete Stored Payment Method
del
Update Consumer Payment Method
put
Registration
Register consumer
post
Intents
Agency confirmation of intent to communicate with consumer
post
Auth
Auth consumer
post
Payments
Account Payment
post
Get Account Payments
get
Update payment
put
Get Payment Plan Configuration
get
Get Payment Plans
get
Offers
Submit settlement offer
post
Powered by
Overview
API spec for agencies to call Freede.
Download OpenAPI v3 Spec
