Search
Introduction
Pagination
Metadata
Attributes Formats
Identifiers
External IDs
List of Prefixes
Events
Compliance Guard
Configuring Compliance Guard
Implementing Compliance Guard in your system
Locks
Sync calls
Errors
Frontend Integration
Frontend
get
Get bootstrap data
Authentication
Auth
post
Create a short-lived token
post
Exchange username and password for JWT token
put
Exchange current token for a new one
del
End login session, invalidating current login token.
post
Change password
get
Get all permissions for the requesting user
get
Get logged-in user's info.
post
Takes a user ID and returns a temporary token that can be exchanged for a real auth token.
post
Send one time code.
put
Replace user's auth based on configured company auth type
post
SAML callback endpoint
get
Redirect to the SAML login endpoint
get
Display Peach SP Metadata
get
Display IdP setup help
API Keys
get
Get all API keys associated with a company
post
Create an API key associated with a company
get
Get an API key associated with a company
del
Delete an API key associated with a company
Borrower Management
Borrowers
post
Create borrower
get
Get borrowers
get
Search borrowers
get
Get borrower by ID
put
Update borrower
Identity
get
Get primary identity
get
Get identities
post
Create identity
get
Get identity by ID
put
Update identity
del
Archive identity
Contact Information
post
Create contact
get
List contact for borrower
get
Get contact by ID
put
Update contact
del
Delete contact
post
Clone contact
Payment Instruments
post
Create payment instrument
get
Get payment instruments
get
Get payment instrument by ID
put
Update payment instrument
del
Delete payment instrument
post
Verify amounts of microdeposits
post
Create account link
put
Update account link
del
Delete account link
post
Refresh balance data
get
Get balance data
Consent
get
Get consents
put
Update consents
Documents
get
Get document descriptors
post
Create new document descriptor
get
Get document descriptor by ID
put
Update document descriptor
del
Delete document
post
Upload document content
get
Download document content
post
Convert document to the specified format
post
Digitally sign document
get
Get document upload links
post
Create document upload link
get
Get doc upload link by ID
post
Create new document via link
post
Upload document content via link
Legal Representation
post
Create representative
get
Get representatives
get
Get representative by ID
put
Update representative
Verifications
post
Start verification
get
Get verifications
get
Get verification by ID
post
Answer verification questions
Verification Types
get
Get questions
post
Create verification type
get
Get verification types
put
Update verification type
get
Get verification type by ID
Campaign Management
Campaign Overview
Campaigns
get
Get campaign runs
post
Create campaign
get
Get campaigns
get
Get campaign by ID
put
Update campaign
post
Run campaign
get
Get campaign runs
put
Update campaign run
get
Get campaign run
get
Download all files
Contact Exporters
post
Create contact exporter
get
List contact exporters
get
Get contact exporter by ID
put
Update contact exporter
del
Delete contact exporter
Bulk Senders
post
Create bulk sender
get
List bulk senders
get
Get bulk sender by ID
put
Update bulk sender
del
Delete bulk sender
Case Management
Cases
get
Get all cases
get
List active case escalations for a company
post
Create borrower case
get
Get borrower cases
get
Get borrower case by ID
put
Update case
post
Add association
del
Remove association
post
Mark a case as viewed
post
Escalate or de-escalate a case
get
List case escalations
get
List case escalation by ID
post
Snooze case
Case Types
post
Create type
get
Get case types
get
Get type by ID
put
Update type
post
Add association
del
Remove association
post
Create case type review tasks for ID
Smart Reviews
Key Dates
Collections
Supercases
post
Create supercase
get
List supercases
get
Get supercase members.csv template
get
Get supercase by ID
put
Update supercase
get
List populations
get
Get committed membership as CSV
get
Get draft population
post
Commit draft population
get
Get the draft population members
put
Set the draft population membership
post
Add to the draft population membership
get
Get membership as CSV
put
Set membership with CSV
post
Add to membership with CSV
get
Get population by ID
put
Update population
get
Get population membership
get
Get membership as CSV
get
Get private notes
post
Create private note
get
Get private note by ID
put
Update private note
get
Get global notes
post
Create global note
get
Get global note by ID
put
Update global note
get
Get the list of supercase documents
post
Associate documents with the supercase
put
Set the documents associated with the supercase
post
Update all subcases
post
Send a message to the borrowers on all subcases
post
Send a message to the borrowers on all subcases of the population
post
Create Do Not Interact instances on all subcases
post
Delete supercase related Do Not Interact instances on all subcases
get
List bulk operations on this supercase
get
Search bulk operations on this supercase
get
Get supercase bulk operation by ID
get
Get target populations for the supercase bulk operation
get
Get member bulk operation results by operation
get
Get the number of cases associated with the supercase
Do Not Interact
post
Create do not interact
get
Get case do not interacts
get
Get do not interact by ID
put
Update do not interact
del
Remove do not interact
get
Get all do not interacts
Do Not Interact Types
post
Create type
get
Get types
get
Get type by ID
put
Update type
Notification Types
post
Create type
get
Get types
get
Get type by ID
put
Update type
Notes
get
Get notes
post
Create note
get
Get note by ID
put
Update note
get
Get notes
post
Create note
get
Get note by ID
put
Update note
get
Get notes
post
Create note
get
Get note by ID
put
Update note
get
Get interaction notes for a person
Workflows
get
Get case workflow
put
Update workflow step status
put
Update workflow workitem status
Workflow Types
get
Get workflow types
post
Create workflow type
post
Export workflow, step and work item types.
post
Restore previously exported workflow, step and work item types.
get
Get workflow type by ID
put
Update workflow type
del
Delete workflow type
get
Get workflow step types
post
Create workflow step type
get
Get workflow step type
put
Update workflow step type
del
Delete workflow step type
get
Get work item types
post
Create work item type
get
Get work item type
put
Update work item type
del
Delete work item type
Tasks
get
List Terminated Tasks
get
Get Terminated Task by ID
post
Clone Terminated Task by ID
get
Get information on Twilio task queues
put
Update task type availability
get
Get task availability
get
List Taskrouter Workers
get
List Unterminated Tasks
del
Bulk Delete Unterminated Tasks
get
Read Unterminated Task by SID
del
Deletes Unterminated Task by SID
post
Abandon Unterminated Task by SID
Task-Worker Pairing Configs
get
List task-worker pairing configs
post
Create task-worker pairing config
post
Sync task-worker pairing configs to Twilio
get
Get task-worker pairing config
put
Update task-worker pairing config
del
Delete task-worker pairing config
Loans Management
Loans
get
Get loans
post
Create loan
get
Get borrower's loans
get
Get loan by ID
put
Update loan
get
Get loan lock status
post
Activate loan
post
Reimburse
post
Cancel loan
post
Close loan
post
Reopen a closed loan
get
Get loan credit limit
post
Update loan credit limit
post
Freeze loan
post
Unfreeze loan
post
Accelerate loan
post
Reverse accelerate
post
Charge-off loan
post
Reverse charge-off
post
Refresh loan
post
Migrate loan
Installment Advances
post
Create advance
get
Get advances
get
Get advance by ID
put
Update advance
Installment Refunds
post
Create refund
get
Get refunds
post
Cancel refund
post
Create refund v2
Line of Credit Draws
post
Create draw
get
Get draws
get
Get draw by ID
put
Update draw
post
Activate draw
get
Get draw credit limit
post
Update draw credit limit
post
Preview draw amortization
post
Amortize draw
post
Close draw
post
Reopen draw
post
Cancel draw
put
Update draw fees
Line of Credit Purchases
get
Get line of credit purchases
get
Get line of credit purchases timeline
post
Create purchase
get
Get draw purchases
get
Get draw purchases timeline
get
Get purchase by ID
put
Update purchase
post
Create purchase dispute
get
Get purchase disputes
get
Get draw purchase disputes
get
Get line of credit purchase disputes
get
Get purchase dispute by ID
put
Update purchase dispute
Line of Credit Migration
post
Create past periods data
put
Update past period data
del
Delete past period data
get
Get past period data
get
Get migration period LOC data
put
Update migration period LOC data
post
Create migration period LOC data
get
Get migration period draw data
put
Update migration period draw data
post
Create migration period draw data
post
Create past transaction
get
Get past transactions
put
Update past transaction
get
Get past transaction by ID
Expected Payments
get
Get loan expected payments
post
Change due dates schedule
get
Get draw expected payments
post
Defer single due date
post
Change loan terms
post
Change loan terms SCRA
post
Defer schedule
Obligations
get
Get loan obligations
get
Get draw obligations
get
Get loan obligation by ID
get
Get draw obligation by ID
Periods
get
Get loan periods
get
Get loan period by id
Payment Plans
post
Create payment plan
get
Get payment plans
get
Get payment plan by id
post
Cancel payment plan
Promise to Pay Plans
get
Get Promise to Pay Plans for a company
post
Create Promise to Pay Plan
get
Get Promise to Pay Plans for a Loan
get
Get Promise to Pay Plan
put
Cancel Promise to Pay Plan
put
Evaluate Promise to Pay Plan
put
Evaluate Promise to Pay Plan, does not require personId
Fees
get
Get fee types
put
Update origination fee
put
Update draw fee
get
Get fees
post
Charge dynamic fee
post
Cancel dynamic fees
post
Cancel dynamic fee
put
Update dynamic fee
Rates
post
Add loan rate
get
Get loan rates
get
Get loan effective rates
put
Update loan rate
del
Remove loan rate
post
Add draw rate
get
Get draw rates
get
Get draw effective rates
put
Update draw rate
del
Remove draw rate
Transactions
post
Create transaction
get
Get transactions
get
Get transaction by ID
put
Update transaction
post
Cancel transaction
post
Reverse transaction
post
Create transaction chargeback
get
Get transaction chargebacks
get
Get chargeback by ID
put
Update chargeback
post
Backdate transaction
Statements
get
Get statements
get
Get statement details
put
Update statement
post
Generate statement
Autopay
post
Create Autopay plan
get
Get Autopay plan
put
Update Autopay plan
del
Cancel Autopay plan
Balances
get
Get loan balances
get
Get loan interest
get
Get loan future balances
get
Get draw balances
get
Get draw future balances
Credit Reporting
post
Start credit reporting
put
Update reporting fields
get
Get credit reporting statuses
post
Delete from credit reporting
Loan Investors
get
Get loan investors
put
Update loan investors
Collection Agency
post
Update collection agency
get
Get collection agency
del
Unassign collection agency
Promo Programs
post
Create promo program
get
Get promo programs
get
Get promo program by ID
put
Update promo program
del
Cancel promo program
post
Create promo program for draw
get
Get promo program for draw by ID
put
Update promo program for draw
del
Cancel promo program for draw
post
Activate promo program
post
Activate promo program for draw
Card
post
Create card
get
Get cards
put
Update card
get
Get card
Loan Labels
get
Get loan labels
post
Create loan label
get
Get loan label by ID
put
Update loan label
del
Delete loan label
get
Get loans by loan labels
put
Add labels to loans
put
Remove labels from loans
Communicator & Interactions
Communicator
post
Send message
post
Receive message
post
Resend existing interaction
post
Render to download
post
Render to document
post
Render template preview for subject
post
Send free-form email
post
Preview free-form email
post
Send confirmation code for contact verification
get
List subject desciptors
get
Get subject descriptor
put
Update subject descriptor
Templates
Management
Content
get
List template descriptors
post
Create template descriptor
get
Get template descriptor
put
Update template descriptor
del
Delete template descriptor
get
List template versions for descriptor
get
List all template versions (Deprecated)
post
Create template version
get
List all template versions (v2)
get
Get template version
put
Update template version
del
Delete template version
put
Activate template version
post
Render template version preview
post
Render template version
get
List context vars for template version
get
Export all template descriptors and versions
post
Import exported template descriptors and versions
System Documents & UI
schema
autopayAgreement
schema
drawFundsDisclosure
System Sent Messages
schema
autopayAmountChanged
schema
autopayCanceledBySystem
schema
autopayEnabled
schema
autopayEnableReminder
schema
autopayPaymentCanceled
schema
autopayPaymentMethodUpdated
schema
autopayPaymentReminder
schema
autopayPaymentRescheduled
schema
cardExpiresReminder
schema
ceaseCommunicationAcknowledgement
schema
ceaseCommunicationRefuseToPay
schema
confirmationCode
schema
contactTakeover
schema
customX
schema
debtValidationNotice
schema
debtValidationNoticeArizona
schema
debtValidationNoticeAutomatic
schema
debtValidationNoticeNYCYonkers
schema
debtValidationNoticePuertoRico
schema
deceasedConfirmationOfPayoff
schema
deceasedNoticeToRepresentative
schema
deceasedNotificationUponDeath
schema
disputeOfDebtSubmitDocumentation
schema
disputeOfDebtConfirmed
schema
disputeOfDebtSubmitDocumentationReminder
schema
disputeOfDebtUnableToConfirm
schema
disputeOfDebtUnableToResolve
Interactions
post
Create interaction
get
Get borrower interactions
get
Get interaction by ID
put
Update interaction
del
Delete interaction
get
Get previous interactions
get
Download interaction recording
get
Download interaction voicemail
get
Get interaction call summaries
get
Get cases associated with an interaction
get
Get interactions
get
Get interaction by ID
get
Get previous interactions
get
Get interaction convo
post
Join interaction convo
post
Close interaction convo
post
Leave interaction convo
get
Download interaction recording
get
Download interaction voicemail
get
Get interaction call summaries
get
Get previous interactions
get
Get interaction call summaries
Compliance Guard
post
Can interact
Promo Programs Management
Promo Programs Type
post
Create promo program type
get
Get promo program types
get
Get promo program type by ID
put
Update promo program type
del
Cancel promo program type
Processor Management
Payment Processors
post
Create payment processor
get
Get payment processors
get
Get payment processor
put
Update payment processor
del
Delete payment processor
Card Issuers
post
Create card issuer
get
Get card issuers
get
Get card issuer by ID
put
Update card issuer
del
Delete card issuer
Funding Instruments
post
Create funding instrument
get
Get funding instruments
get
Get funding instrument by ID
put
Update funding instrument
Organization Management
Employees
post
Create employee
get
Get employees
put
Update employee
get
Get employee by ID
put
Add employee to team
del
Remove employee from team
Teams
post
Create team
get
Get teams
put
Update
get
Get team by ID
del
Delete team
Users
get
Get users
post
Create user
get
Get user
put
Update user
Capital Markets Management
Investors
get
Get loan investors
post
Create investor
get
Get investors
get
Get investor by ID
put
Update investor
Settlement Instruments
post
Create settlement instrument
get
Get settlement instruments
get
Get settlement instrument by ID
put
Update settlement instrument
Loan Tape Types
post
Create loan tape type
get
Get loan tape types
get
Get loan tape type by ID
put
Update loan tape type
del
Delete loan tape type
Loan Tapes
post
Create loan tape
get
Get loan tapes
get
Get loan tape by ID
put
Update loan tape
del
Delete loan tape
Merchants Management
Merchants
post
Create merchant
get
Get merchants
get
Get merchant by ID
put
Update merchant
Events and Webhooks Management
Events
get
Retrieve events
Webhooks
post
Create webhook subscription
get
Get webhooks
get
Get webhook subscription by ID
put
Update webhook subscription
del
Delete webhook subscription
post
Test a webhook with static payload.
Utilities
Loan Amortization
post
Amortize loan
Routing Numbers
get
Get routing number details
BIN Numbers
post
Get BIN details from card number
Index Rates
post
Add index interest rate
get
Get index interest rates
put
Update index interest rate
get
Get index interest rate by ID
del
Cancel index interest rate
Operations
get
Get operation status
Credit Agencies Management
Credit Agencies
post
Create credit agency
get
Get credit agencies
get
Get credit agency by ID
put
Update credit agency
Collection Agencies Management
Collection Agencies
post
Create collection agency
get
Get collection agencies
get
Get collection agency by ID
put
Update collection agency
del
Delete collection agency
Errors
Errors
schema
InvalidInput
schema
BadRequest
schema
InvalidJSON
schema
InvalidPublicId
schema
UnprocessableEntity
schema
Unauthorized
schema
Forbidden
schema
NotFound
schema
UrlNotDefined
schema
TemplateDisabled
schema
NoSuitableContact
schema
UndefinedTemplateVariable
schema
BadExternalServiceCredentials
schema
TemplateSyntax
schema
Duplicate
schema
ConfigMismatch
schema
CompanyConfigMismatch
schema
LoanLocked
schema
CardLocked
schema
InternalServerError
schema
ReadReplicaNotReady
Operations
Get operation status
Security
oauth2
or
bearerAuth
or
apiKeyHeader
Request
path Parameters
operationId
required
string
= 32 characters
Operation ID
Responses
200
Success
206
In progress
404
Not found
412
Operation failed
get
/operations/{operationId}
Try it
Response samples
200
206
404
412
application/json
Copy
{
"status"
:
0
,
"message"
:
"string"
}
➔ Next to
Credit Agencies