{"items":[{"type":"link","label":"Peach Finance API","link":"/api-docs/api-public","routeSlug":"/api-docs/api-public","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"Introduction","link":"/api-docs/api-public/section/introduction","routeSlug":"/api-docs/api-public/section/introduction","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"Versioning","link":"/api-docs/api-public/section/versioning","routeSlug":"/api-docs/api-public/section/versioning","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"Pagination","link":"/api-docs/api-public/section/pagination","routeSlug":"/api-docs/api-public/section/pagination","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"Metadata","link":"/api-docs/api-public/section/metadata","routeSlug":"/api-docs/api-public/section/metadata","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"Attributes Formats","link":"/api-docs/api-public/section/attributes-formats","routeSlug":"/api-docs/api-public/section/attributes-formats","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Identifiers","link":"/api-docs/api-public/section/identifiers","routeSlug":"/api-docs/api-public/section/identifiers","items":[{"type":"link","label":"External IDs","link":"/api-docs/api-public/section/identifiers/external-ids","routeSlug":"/api-docs/api-public/section/identifiers/external-ids","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"List of Prefixes","link":"/api-docs/api-public/section/identifiers/list-of-prefixes","routeSlug":"/api-docs/api-public/section/identifiers/list-of-prefixes","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"Events","link":"/api-docs/api-public/section/events","routeSlug":"/api-docs/api-public/section/events","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Compliance Guard","link":"/api-docs/api-public/section/compliance-guard","routeSlug":"/api-docs/api-public/section/compliance-guard","items":[{"type":"link","label":"Configuring Compliance Guard","link":"/api-docs/api-public/section/compliance-guard/configuring-compliance-guard","routeSlug":"/api-docs/api-public/section/compliance-guard/configuring-compliance-guard","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"Implementing Compliance Guard in your system","link":"/api-docs/api-public/section/compliance-guard/implementing-compliance-guard-in-your-system","routeSlug":"/api-docs/api-public/section/compliance-guard/implementing-compliance-guard-in-your-system","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"Locks","link":"/api-docs/api-public/section/locks","routeSlug":"/api-docs/api-public/section/locks","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"Sync calls","link":"/api-docs/api-public/section/sync-calls","routeSlug":"/api-docs/api-public/section/sync-calls","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"Errors","link":"/api-docs/api-public/section/errors","routeSlug":"/api-docs/api-public/section/errors","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"separator","label":"Frontend Integration","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Frontend","link":"/api-docs/api-public/frontend","routeSlug":"/api-docs/api-public/frontend","items":[{"label":"Get bootstrap data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/frontend/peach.security.handlers.bootstrap","routeSlug":"/api-docs/api-public/frontend/peach.security.handlers.bootstrap","metadata":{"seo":{"title":"Get bootstrap data","description":"Get pre-auth app metadata and settings."}},"httpPath":"/bootstrap","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"separator","label":"Authentication","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Auth","link":"/api-docs/api-public/auth","routeSlug":"/api-docs/api-public/auth","items":[{"label":"Takes a user ID and returns a temporary token that can be exchanged for a real auth token.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.exchange_token_create","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.exchange_token_create","metadata":{"seo":{"title":"Takes a user ID and returns a temporary token that can be exchanged for a real auth token.","description":"Takes a user ID and returns a temporary token that can be exchanged for a real auth token."}},"httpPath":"/auth/exchange-token","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Change password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.password_post","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.password_post","metadata":{"seo":{"title":"Change password","description":"Change password"}},"httpPath":"/auth/password","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get all permissions for the requesting user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.permissions_get","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.permissions_get","metadata":{"seo":{"title":"Get all permissions for the requesting user","description":"Get all permissions for the requesting user"}},"httpPath":"/auth/permissions","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"End login session, invalidating current login token.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.logout","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.logout","metadata":{"seo":{"title":"End login session, invalidating current login token.","description":"End login session, invalidating current login token."}},"httpPath":"/auth/token","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Exchange username and password for JWT token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.validate_and_send_token","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.validate_and_send_token","metadata":{"seo":{"title":"Exchange username and password for JWT token","description":"Exchange username and password for JWT token"}},"httpPath":"/auth/token","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Exchange current token for a new one","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.renew_jwt_token","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.renew_jwt_token","metadata":{"seo":{"title":"Exchange current token for a new one","description":"Exchange current token for a new one"}},"httpPath":"/auth/token","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create a short-lived token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.short_lived_token","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.short_lived_token","metadata":{"seo":{"title":"Create a short-lived token","description":"Create a short-lived token"}},"httpPath":"/auth/token/short-lived","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get logged-in user's info.\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.user_info_get","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.user_info_get","metadata":{"seo":{"title":"Get logged-in user's info.\n","description":"Get logged-in user's info.\n"}},"httpPath":"/auth/user","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"SAML callback endpoint\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.saml_sp_auth.idp_initiated","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.saml_sp_auth.idp_initiated","metadata":{"seo":{"title":"SAML callback endpoint\n","description":"SAML callback endpoint\n"}},"httpPath":"/companies/{companyId}/auth/saml/callback","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Display IdP setup help\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.saml_sp_auth.idp_setup_help","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.saml_sp_auth.idp_setup_help","metadata":{"seo":{"title":"Display IdP setup help\n","description":"Display IdP setup help\n"}},"httpPath":"/companies/{companyId}/auth/saml/help","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Redirect to the SAML login endpoint\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.saml_sp_auth.sp_initiated","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.saml_sp_auth.sp_initiated","metadata":{"seo":{"title":"Redirect to the SAML login endpoint\n","description":"Redirect to the SAML login endpoint\n"}},"httpPath":"/companies/{companyId}/auth/saml/login","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Display Peach SP Metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.saml_sp_auth.sp_metadata_xml","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.saml_sp_auth.sp_metadata_xml","metadata":{"seo":{"title":"Display Peach SP Metadata","description":"Peach acts as the service provider"}},"httpPath":"/companies/{companyId}/auth/saml/metadata.xml","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Send one time code.\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.send_one_time_code","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.send_one_time_code","metadata":{"seo":{"title":"Send one time code.\n","description":"Send a one time code to a phone number or email address. For phone numbers, the code can be sent via text or voice."}},"httpPath":"/companies/{companyId}/auth/send-one-time-code","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"End login session, invalidating current login token.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.compliance_logout","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.compliance_logout","metadata":{"seo":{"title":"End login session, invalidating current login token.","description":"End login session, invalidating current login token."}},"httpPath":"/compliance/auth/token","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Exchange username and password for JWT token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.compliance_validate_and_send_token","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.compliance_validate_and_send_token","metadata":{"seo":{"title":"Exchange username and password for JWT token","description":"Exchange username and password for JWT token"}},"httpPath":"/compliance/auth/token","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Exchange current token for a new one","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.compliance_renew_jwt_token","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.compliance_renew_jwt_token","metadata":{"seo":{"title":"Exchange current token for a new one","description":"Exchange current token for a new one"}},"httpPath":"/compliance/auth/token","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Replace user's auth based on configured company auth type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/auth/peach.security.handlers.user_auth_replace","routeSlug":"/api-docs/api-public/auth/peach.security.handlers.user_auth_replace","metadata":{"seo":{"title":"Replace user's auth based on configured company auth type","description":"Replace the user's authentication values from scratch. The authentication type is derived from the company config."}},"httpPath":"/users/{userId}/auth","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"API Keys","link":"/api-docs/api-public/api-keys","routeSlug":"/api-docs/api-public/api-keys","items":[{"label":"Get all API keys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/api-keys/peach.security.api_keys.handlers.company_api_keys_get_all","routeSlug":"/api-docs/api-public/api-keys/peach.security.api_keys.handlers.company_api_keys_get_all","metadata":{"seo":{"title":"Get all API keys","description":"Get all API keys"}},"httpPath":"/keys","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create an API key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/api-keys/peach.security.api_keys.handlers.company_api_key_create","routeSlug":"/api-docs/api-public/api-keys/peach.security.api_keys.handlers.company_api_key_create","metadata":{"seo":{"title":"Create an API key","description":"Create an API key"}},"httpPath":"/keys","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Delete an API key","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/api-keys/peach.security.api_keys.handlers.company_api_key_delete","routeSlug":"/api-docs/api-public/api-keys/peach.security.api_keys.handlers.company_api_key_delete","metadata":{"seo":{"title":"Delete an API key","description":"Delete an API key"}},"httpPath":"/keys/{keyId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get an API key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/api-keys/peach.security.api_keys.handlers.company_api_key_get","routeSlug":"/api-docs/api-public/api-keys/peach.security.api_keys.handlers.company_api_key_get","metadata":{"seo":{"title":"Get an API key","description":"Get an API key"}},"httpPath":"/keys/{keyId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update an API key","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/api-keys/peach.security.api_keys.handlers.company_api_key_update","routeSlug":"/api-docs/api-public/api-keys/peach.security.api_keys.handlers.company_api_key_update","metadata":{"seo":{"title":"Update an API key","description":"Update an API key"}},"httpPath":"/keys/{keyId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"separator","label":"Borrower Management","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Borrowers","link":"/api-docs/api-public/borrowers","routeSlug":"/api-docs/api-public/borrowers","items":[{"label":"Get borrowers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/borrowers/peach.people.handlers.borrowers_list","routeSlug":"/api-docs/api-public/borrowers/peach.people.handlers.borrowers_list","metadata":{"seo":{"title":"Get borrowers","description":"Get borrowers filtering with optional parameters."}},"httpPath":"/people","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create borrower","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/borrowers/peach.people.handlers.borrower_create","routeSlug":"/api-docs/api-public/borrowers/peach.people.handlers.borrower_create","metadata":{"seo":{"title":"Create borrower","description":"Create a new borrower."}},"httpPath":"/people","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Search borrowers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/borrowers/peach.people.handlers.borrower_search","routeSlug":"/api-docs/api-public/borrowers/peach.people.handlers.borrower_search","metadata":{"seo":{"title":"Search borrowers","description":"Search for borrowers. Returns same resourcesas <a href=\"/api-docs/api-public/borrowers/peach.people.handlers.borrowers_list\">/people</a>."}},"httpPath":"/people/search","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get borrower by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/borrowers/peach.people.handlers.borrower_get","routeSlug":"/api-docs/api-public/borrowers/peach.people.handlers.borrower_get","metadata":{"seo":{"title":"Get borrower by ID","description":"Get an existing borrower by ID."}},"httpPath":"/people/{personId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update borrower","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/borrowers/peach.people.handlers.borrower_update","routeSlug":"/api-docs/api-public/borrowers/peach.people.handlers.borrower_update","metadata":{"seo":{"title":"Update borrower","description":"Update an existing borrower."}},"httpPath":"/people/{personId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Identity","link":"/api-docs/api-public/identity","routeSlug":"/api-docs/api-public/identity","items":[{"label":"Get identities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/identity/peach.people.handlers.list_identities","routeSlug":"/api-docs/api-public/identity/peach.people.handlers.list_identities","metadata":{"seo":{"title":"Get identities","description":"Get identities"}},"httpPath":"/people/{personId}/identities","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create identity","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/identity/peach.people.handlers.create_identity","routeSlug":"/api-docs/api-public/identity/peach.people.handlers.create_identity","metadata":{"seo":{"title":"Create identity","description":"Create identity"}},"httpPath":"/people/{personId}/identities","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Archive identity","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/identity/peach.people.handlers.delete_identity","routeSlug":"/api-docs/api-public/identity/peach.people.handlers.delete_identity","metadata":{"seo":{"title":"Archive identity","description":"Primary identities cannot be archived."}},"httpPath":"/people/{personId}/identities/{personIdentityId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get identity by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/identity/peach.people.handlers.get_identity","routeSlug":"/api-docs/api-public/identity/peach.people.handlers.get_identity","metadata":{"seo":{"title":"Get identity by ID","description":"Get identity by ID"}},"httpPath":"/people/{personId}/identities/{personIdentityId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update identity","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/identity/peach.people.handlers.update_identity","routeSlug":"/api-docs/api-public/identity/peach.people.handlers.update_identity","metadata":{"seo":{"title":"Update identity","description":"For primary identities, the isArchived field cannot be changed."}},"httpPath":"/people/{personId}/identities/{personIdentityId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get primary identity","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/identity/peach.people.handlers.get_primary_identity","routeSlug":"/api-docs/api-public/identity/peach.people.handlers.get_primary_identity","metadata":{"seo":{"title":"Get primary identity","description":"Get primary identity"}},"httpPath":"/people/{personId}/identity","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Contact Information","link":"/api-docs/api-public/contact-information","routeSlug":"/api-docs/api-public/contact-information","items":[{"label":"List contact for borrower","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/contact-information/peach.people.contact.handlers.list_contacts_for_borrower","routeSlug":"/api-docs/api-public/contact-information/peach.people.contact.handlers.list_contacts_for_borrower","metadata":{"seo":{"title":"List contact for borrower","description":"List contacts for a borrower."}},"httpPath":"/people/{personId}/contacts","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/contact-information/peach.people.contact.handlers.create_contact_for_borrower","routeSlug":"/api-docs/api-public/contact-information/peach.people.contact.handlers.create_contact_for_borrower","metadata":{"seo":{"title":"Create contact","description":"Create contact for a borrower."}},"httpPath":"/people/{personId}/contacts","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Delete contact","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/contact-information/peach.people.contact.handlers.delete_contact","routeSlug":"/api-docs/api-public/contact-information/peach.people.contact.handlers.delete_contact","metadata":{"seo":{"title":"Delete contact","description":"Delete a borrower's contact."}},"httpPath":"/people/{personId}/contacts/{contactId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get contact by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/contact-information/peach.people.contact.handlers.get_contact_for_borrower","routeSlug":"/api-docs/api-public/contact-information/peach.people.contact.handlers.get_contact_for_borrower","metadata":{"seo":{"title":"Get contact by ID","description":"Get contact by ID"}},"httpPath":"/people/{personId}/contacts/{contactId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update contact","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/contact-information/peach.people.contact.handlers.update_contact_for_borrower","routeSlug":"/api-docs/api-public/contact-information/peach.people.contact.handlers.update_contact_for_borrower","metadata":{"seo":{"title":"Update contact","description":"Update contact of a borrower."}},"httpPath":"/people/{personId}/contacts/{contactId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Clone contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/contact-information/peach.people.contact.handlers.clone_contact","routeSlug":"/api-docs/api-public/contact-information/peach.people.contact.handlers.clone_contact","metadata":{"seo":{"title":"Clone contact","description":"Clones the borrower's contact information."}},"httpPath":"/people/{personId}/contacts/{contactId}/clone","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Payment Instruments","link":"/api-docs/api-public/payment-instruments","routeSlug":"/api-docs/api-public/payment-instruments","items":[{"label":"Get payment instruments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_get_all","routeSlug":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_get_all","metadata":{"seo":{"title":"Get payment instruments","description":"Get payment instruments"}},"httpPath":"/people/{personId}/payment-instruments","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create payment instrument","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_create","routeSlug":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_create","metadata":{"seo":{"title":"Create payment instrument","description":"Create a payment instrument."}},"httpPath":"/people/{personId}/payment-instruments","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Delete payment instrument","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_delete","routeSlug":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_delete","metadata":{"seo":{"title":"Delete payment instrument","description":"Delete payment instrument"}},"httpPath":"/people/{personId}/payment-instruments/{paymentInstrumentId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get payment instrument by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_get","routeSlug":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_get","metadata":{"seo":{"title":"Get payment instrument by ID","description":"Get payment instrument by ID"}},"httpPath":"/people/{personId}/payment-instruments/{paymentInstrumentId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update payment instrument","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_update","routeSlug":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_update","metadata":{"seo":{"title":"Update payment instrument","description":"Update payment instrument"}},"httpPath":"/people/{personId}/payment-instruments/{paymentInstrumentId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Delete account link","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.account_link_delete","routeSlug":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.account_link_delete","metadata":{"seo":{"title":"Delete account link","description":"Retrieve the data vendor link details for this payment instrument."}},"httpPath":"/people/{personId}/payment-instruments/{paymentInstrumentId}/account-link","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create account link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.account_link_post","routeSlug":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.account_link_post","metadata":{"seo":{"title":"Create account link","description":"Add a data vendor link for this payment instrument. If one is already present, it is replaced."}},"httpPath":"/people/{personId}/payment-instruments/{paymentInstrumentId}/account-link","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update account link","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.account_link_put","routeSlug":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.account_link_put","metadata":{"seo":{"title":"Update account link","description":"Update record keeping details about the account link. This can not be used to set up a new account link."}},"httpPath":"/people/{personId}/payment-instruments/{paymentInstrumentId}/account-link","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get balance data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.balances_get","routeSlug":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.balances_get","metadata":{"seo":{"title":"Get balance data","description":"Get stored balance data for the account associated with the payment instrument."}},"httpPath":"/people/{personId}/payment-instruments/{paymentInstrumentId}/balance","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Refresh balance data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.balances_post","routeSlug":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.balances_post","metadata":{"seo":{"title":"Refresh balance data","description":"Fetch updated balance data from the account link associated with this payment instrument."}},"httpPath":"/people/{personId}/payment-instruments/{paymentInstrumentId}/balance","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Verify amounts of microdeposits","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_verify","routeSlug":"/api-docs/api-public/payment-instruments/peach.payment_instruments.handlers.person_payment_instrument_verify","metadata":{"seo":{"title":"Verify amounts of microdeposits","description":"Verify amounts of microdeposits"}},"httpPath":"/people/{personId}/payment-instruments/{paymentInstrumentId}/verify","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Consent","link":"/api-docs/api-public/consent","routeSlug":"/api-docs/api-public/consent","items":[{"label":"Get consents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/consent/peach.people.handlers.consent_get","routeSlug":"/api-docs/api-public/consent/peach.people.handlers.consent_get","metadata":{"seo":{"title":"Get consents","description":"Get all consent associated with a borrower."}},"httpPath":"/people/{personId}/consents","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update consents","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/consent/peach.people.handlers.consent_update","routeSlug":"/api-docs/api-public/consent/peach.people.handlers.consent_update","metadata":{"seo":{"title":"Update consents","description":"Update the consents"}},"httpPath":"/people/{personId}/consents","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Documents","link":"/api-docs/api-public/documents","routeSlug":"/api-docs/api-public/documents","items":[{"label":"Create new document via link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/documents/peach.docustore.handlers.documents_via_links.create_document_via_link","routeSlug":"/api-docs/api-public/documents/peach.docustore.handlers.documents_via_links.create_document_via_link","metadata":{"seo":{"title":"Create new document via link","description":"Create new document via link"}},"httpPath":"/document-uploads/{documentUploadLinkKey}/documents","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Upload document content via link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/documents/peach.docustore.handlers.documents_via_links.upload_document_content_via_link","routeSlug":"/api-docs/api-public/documents/peach.docustore.handlers.documents_via_links.upload_document_content_via_link","metadata":{"seo":{"title":"Upload document content via link","description":"Upload document content via link"}},"httpPath":"/document-uploads/{documentUploadLinkKey}/documents/{documentDescriptorId}/content","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get document upload links","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/documents/peach.docustore.handlers.document_upload_links.get_document_upload_links","routeSlug":"/api-docs/api-public/documents/peach.docustore.handlers.document_upload_links.get_document_upload_links","metadata":{"seo":{"title":"Get document upload links","description":"Get document upload links"}},"httpPath":"/people/{personId}/document-upload-links","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create document upload link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/documents/peach.docustore.handlers.document_upload_links.create_document_upload_link","routeSlug":"/api-docs/api-public/documents/peach.docustore.handlers.document_upload_links.create_document_upload_link","metadata":{"seo":{"title":"Create document upload link","description":"Create document upload link"}},"httpPath":"/people/{personId}/document-upload-links","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get doc upload link by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/documents/peach.docustore.handlers.document_upload_links.get_document_upload_link","routeSlug":"/api-docs/api-public/documents/peach.docustore.handlers.document_upload_links.get_document_upload_link","metadata":{"seo":{"title":"Get doc upload link by ID","description":"Get doc upload link by ID"}},"httpPath":"/people/{personId}/document-upload-links/{documentUploadLinkId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get document descriptors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/documents/peach.docustore.handlers.list_person_documents","routeSlug":"/api-docs/api-public/documents/peach.docustore.handlers.list_person_documents","metadata":{"seo":{"title":"Get document descriptors","description":"Get document descriptors"}},"httpPath":"/people/{personId}/documents","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create new document descriptor","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/documents/peach.docustore.handlers.create_person_document","routeSlug":"/api-docs/api-public/documents/peach.docustore.handlers.create_person_document","metadata":{"seo":{"title":"Create new document descriptor","description":"Create new document descriptor"}},"httpPath":"/people/{personId}/documents","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Delete document","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/documents/peach.docustore.handlers.delete_document","routeSlug":"/api-docs/api-public/documents/peach.docustore.handlers.delete_document","metadata":{"seo":{"title":"Delete document","description":"Delete document"}},"httpPath":"/people/{personId}/documents/{documentDescriptorId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get document descriptor by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/documents/peach.docustore.handlers.get_person_document","routeSlug":"/api-docs/api-public/documents/peach.docustore.handlers.get_person_document","metadata":{"seo":{"title":"Get document descriptor by ID","description":"Get document descriptor by ID"}},"httpPath":"/people/{personId}/documents/{documentDescriptorId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update document descriptor","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/documents/peach.docustore.handlers.update_person_document","routeSlug":"/api-docs/api-public/documents/peach.docustore.handlers.update_person_document","metadata":{"seo":{"title":"Update document descriptor","description":"Update document descriptor"}},"httpPath":"/people/{personId}/documents/{documentDescriptorId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Download document content","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/documents/peach.docustore.handlers.download_person_document_content","routeSlug":"/api-docs/api-public/documents/peach.docustore.handlers.download_person_document_content","metadata":{"seo":{"title":"Download document content","description":"Download document content"}},"httpPath":"/people/{personId}/documents/{documentDescriptorId}/content","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Upload document content","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/documents/peach.docustore.handlers.upload_person_document_content","routeSlug":"/api-docs/api-public/documents/peach.docustore.handlers.upload_person_document_content","metadata":{"seo":{"title":"Upload document content","description":"Upload document content"}},"httpPath":"/people/{personId}/documents/{documentDescriptorId}/content","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Convert document to the specified format","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/documents/peach.docustore.handlers.convert_person_document","routeSlug":"/api-docs/api-public/documents/peach.docustore.handlers.convert_person_document","metadata":{"seo":{"title":"Convert document to the specified format","description":"Convert document to the specified format"}},"httpPath":"/people/{personId}/documents/{documentDescriptorId}/convert","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Digitally sign document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/documents/peach.docustore.handlers.sign_person_pdf_document","routeSlug":"/api-docs/api-public/documents/peach.docustore.handlers.sign_person_pdf_document","metadata":{"seo":{"title":"Digitally sign document","description":"Digitally sign document"}},"httpPath":"/people/{personId}/documents/{documentDescriptorId}/sign","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Legal Representation","link":"/api-docs/api-public/legal-representation","routeSlug":"/api-docs/api-public/legal-representation","items":[{"label":"Get representatives","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/legal-representation/peach.people.legal.handlers.legal_representative_get_all","routeSlug":"/api-docs/api-public/legal-representation/peach.people.legal.handlers.legal_representative_get_all","metadata":{"seo":{"title":"Get representatives","description":"Get representatives"}},"httpPath":"/people/{personId}/legal-representatives","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create representative","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/legal-representation/peach.people.legal.handlers.legal_representative_add","routeSlug":"/api-docs/api-public/legal-representation/peach.people.legal.handlers.legal_representative_add","metadata":{"seo":{"title":"Create representative","description":"Create representative"}},"httpPath":"/people/{personId}/legal-representatives","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get representative by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/legal-representation/peach.people.legal.handlers.legal_representative_get_by_id","routeSlug":"/api-docs/api-public/legal-representation/peach.people.legal.handlers.legal_representative_get_by_id","metadata":{"seo":{"title":"Get representative by ID","description":"Get representative by ID"}},"httpPath":"/people/{personId}/legal-representatives/{legalRepresentativeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update representative","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/legal-representation/peach.people.legal.handlers.legal_representative_update","routeSlug":"/api-docs/api-public/legal-representation/peach.people.legal.handlers.legal_representative_update","metadata":{"seo":{"title":"Update representative","description":"Update representative"}},"httpPath":"/people/{personId}/legal-representatives/{legalRepresentativeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Verifications","link":"/api-docs/api-public/verifications","routeSlug":"/api-docs/api-public/verifications","items":[{"label":"Get verifications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/verifications/peach.people.borrower_verification.handlers.borrower_verification_get_all","routeSlug":"/api-docs/api-public/verifications/peach.people.borrower_verification.handlers.borrower_verification_get_all","metadata":{"seo":{"title":"Get verifications","description":"Retrieve all verifications—optionally filtering. Note that unlike most Peach \"get all\" endpoints,the verifications get all endpoint returns items in a reverse chronological list, since almostall interesting verifications are those which happened in the recent past."}},"httpPath":"/people/{personId}/verifications","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Start verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/verifications/peach.people.borrower_verification.handlers.borrower_verification_create","routeSlug":"/api-docs/api-public/verifications/peach.people.borrower_verification.handlers.borrower_verification_create","metadata":{"seo":{"title":"Start verification","description":"Start a borrower verification session. Newly created verificationsinclude randomly selected questions about the borrower. The human must attemptto provide correct answers to these questions in order for the borrower verificationto be successful."}},"httpPath":"/people/{personId}/verifications","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get verification by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/verifications/peach.people.borrower_verification.handlers.borrower_verification_get","routeSlug":"/api-docs/api-public/verifications/peach.people.borrower_verification.handlers.borrower_verification_get","metadata":{"seo":{"title":"Get verification by ID","description":"Get verification by ID"}},"httpPath":"/people/{personId}/verifications/{verificationId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Answer verification questions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/verifications/peach.people.borrower_verification.handlers.borrower_verification_answer_attempt_create","routeSlug":"/api-docs/api-public/verifications/peach.people.borrower_verification.handlers.borrower_verification_answer_attempt_create","metadata":{"seo":{"title":"Answer verification questions","description":"Answer verification questions"}},"httpPath":"/people/{personId}/verifications/{verificationId}/attempts","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Verification Types","link":"/api-docs/api-public/verification-types","routeSlug":"/api-docs/api-public/verification-types","items":[{"label":"Get questions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/verification-types/peach.borrower_verification.handlers.borrower_verification_questions_get_all","routeSlug":"/api-docs/api-public/verification-types/peach.borrower_verification.handlers.borrower_verification_questions_get_all","metadata":{"seo":{"title":"Get questions","description":"Retrieve all the questions which are available for use with verification types—i.e., the question bank."}},"httpPath":"/verification-questions","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get verification types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/verification-types/peach.borrower_verification.handlers.borrower_verification_types_get_all","routeSlug":"/api-docs/api-public/verification-types/peach.borrower_verification.handlers.borrower_verification_types_get_all","metadata":{"seo":{"title":"Get verification types","description":"Get verification types"}},"httpPath":"/verification-types","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create verification type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/verification-types/peach.borrower_verification.handlers.borrower_verification_types_create","routeSlug":"/api-docs/api-public/verification-types/peach.borrower_verification.handlers.borrower_verification_types_create","metadata":{"seo":{"title":"Create verification type","description":"Create a new borrower verification type."}},"httpPath":"/verification-types","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get verification type by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/verification-types/peach.borrower_verification.handlers.borrower_verification_types_get_one","routeSlug":"/api-docs/api-public/verification-types/peach.borrower_verification.handlers.borrower_verification_types_get_one","metadata":{"seo":{"title":"Get verification type by ID","description":"Get verification type by ID"}},"httpPath":"/verification-types/{verificationTypeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update verification type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/verification-types/peach.borrower_verification.handlers.borrower_verification_types_update","routeSlug":"/api-docs/api-public/verification-types/peach.borrower_verification.handlers.borrower_verification_types_update","metadata":{"seo":{"title":"Update verification type","description":"Update verification type"}},"httpPath":"/verification-types/{verificationTypeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"separator","label":"Campaign Management","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Campaign Overview","link":"/api-docs/api-public/campaign-overview","routeSlug":"/api-docs/api-public/campaign-overview","items":[],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Campaigns","link":"/api-docs/api-public/campaigns","routeSlug":"/api-docs/api-public/campaigns","items":[{"label":"Get campaigns","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers.campaign_get_all","routeSlug":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers.campaign_get_all","metadata":{"seo":{"title":"Get campaigns","description":"Get a list of all campaigns."}},"httpPath":"/campaigns","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create campaign","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers.campaign_create","routeSlug":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers.campaign_create","metadata":{"seo":{"title":"Create campaign","description":"Create a new campaign by associating a Redash query that returns a single column containing borrower IDs labeled \"id\". The campaign can also be scheduled."}},"httpPath":"/campaigns","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get campaign by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers.campaign_get","routeSlug":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers.campaign_get","metadata":{"seo":{"title":"Get campaign by ID","description":"Get a campaign by ID."}},"httpPath":"/campaigns/{borrowerCampaignId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update campaign","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers.campaign_update","routeSlug":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers.campaign_update","metadata":{"seo":{"title":"Update campaign","description":"Update a campaign by ID."}},"httpPath":"/campaigns/{borrowerCampaignId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get campaign runs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers_runs.campaign_run_list","routeSlug":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers_runs.campaign_run_list","metadata":{"seo":{"title":"Get campaign runs","description":"Get a list of campaign runs."}},"httpPath":"/campaigns/{borrowerCampaignId}/runs","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Run campaign","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers_runs.campaign_run_create","routeSlug":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers_runs.campaign_run_create","metadata":{"seo":{"title":"Run campaign","description":"Start a new borrower campaign run and save results."}},"httpPath":"/campaigns/{borrowerCampaignId}/runs","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get campaign run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers_runs.campaign_run_read","routeSlug":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers_runs.campaign_run_read","metadata":{"seo":{"title":"Get campaign run","description":"Get campaign run data by ID."}},"httpPath":"/campaigns/{borrowerCampaignId}/runs/{borrowerCampaignRunId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update campaign run","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers_runs.campaign_run_update","routeSlug":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers_runs.campaign_run_update","metadata":{"seo":{"title":"Update campaign run","description":"Update campaign run data."}},"httpPath":"/campaigns/{borrowerCampaignId}/runs/{borrowerCampaignRunId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Download all files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers_runs.campaign_run_download","routeSlug":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers_runs.campaign_run_download","metadata":{"seo":{"title":"Download all files","description":"Download files generated by a campaign run."}},"httpPath":"/campaigns/{borrowerCampaignId}/runs/{borrowerCampaignRunId}/download","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get campaign runs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers_runs.internal_campaign_run_list","routeSlug":"/api-docs/api-public/campaigns/peach.people.campaigns.handlers_runs.internal_campaign_run_list","metadata":{"seo":{"title":"Get campaign runs","description":"Get a list of campaign runs."}},"httpPath":"/companies/{companyId}/campaigns/{borrowerCampaignId}/runs","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Contact Exporters","link":"/api-docs/api-public/contact-exporters","routeSlug":"/api-docs/api-public/contact-exporters","items":[{"label":"List contact exporters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_list","routeSlug":"/api-docs/api-public/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_list","metadata":{"seo":{"title":"List contact exporters","description":"Get a list of all contact exporters."}},"httpPath":"/campaign-workers/contact-exporters","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create contact exporter","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_create","routeSlug":"/api-docs/api-public/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_create","metadata":{"seo":{"title":"Create contact exporter","description":"Create a new Contact Exporter by defining the contact matching criteria and the exportable columns. Ifdesired, designate an SFTP setting and/or screen through Compliance Guard."}},"httpPath":"/campaign-workers/contact-exporters","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Delete contact exporter","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_delete","routeSlug":"/api-docs/api-public/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_delete","metadata":{"seo":{"title":"Delete contact exporter","description":"Delete a contact exporter by ID."}},"httpPath":"/campaign-workers/contact-exporters/{contactExporterId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get contact exporter by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_get_by_id","routeSlug":"/api-docs/api-public/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_get_by_id","metadata":{"seo":{"title":"Get contact exporter by ID","description":"Get a contact exporter by ID."}},"httpPath":"/campaign-workers/contact-exporters/{contactExporterId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update contact exporter","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_update","routeSlug":"/api-docs/api-public/contact-exporters/peach.people.contact_exporters.handlers.contact_exporter_update","metadata":{"seo":{"title":"Update contact exporter","description":"Update a contact exporter by ID."}},"httpPath":"/campaign-workers/contact-exporters/{contactExporterId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Bulk Senders","link":"/api-docs/api-public/bulk-senders","routeSlug":"/api-docs/api-public/bulk-senders","items":[{"label":"List bulk senders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_list","routeSlug":"/api-docs/api-public/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_list","metadata":{"seo":{"title":"List bulk senders","description":"Get a list of all bulk senders."}},"httpPath":"/campaign-workers/bulk-senders","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create bulk sender","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_create","routeSlug":"/api-docs/api-public/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_create","metadata":{"seo":{"title":"Create bulk sender","description":"Create a new bulk sender."}},"httpPath":"/campaign-workers/bulk-senders","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Delete bulk sender","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_delete","routeSlug":"/api-docs/api-public/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_delete","metadata":{"seo":{"title":"Delete bulk sender","description":"Delete a bulk sender by ID."}},"httpPath":"/campaign-workers/bulk-senders/{bulkSenderId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get bulk sender by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_get","routeSlug":"/api-docs/api-public/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_get","metadata":{"seo":{"title":"Get bulk sender by ID","description":"Get a bulk sender by ID."}},"httpPath":"/campaign-workers/bulk-senders/{bulkSenderId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update bulk sender","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_update","routeSlug":"/api-docs/api-public/bulk-senders/peach.people.campaigns.handlers_workers.bulk_sender_update","metadata":{"seo":{"title":"Update bulk sender","description":"Update the existing bulk sender"}},"httpPath":"/campaign-workers/bulk-senders/{bulkSenderId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"separator","label":"Case Management","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Cases","link":"/api-docs/api-public/cases","routeSlug":"/api-docs/api-public/cases","items":[{"label":"List active case escalations for a company","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cases/peach.cases.escalations.handlers.case_open_escalations_get_by_company","routeSlug":"/api-docs/api-public/cases/peach.cases.escalations.handlers.case_open_escalations_get_by_company","metadata":{"seo":{"title":"List active case escalations for a company","description":"List active case escalations for a company"}},"httpPath":"/active-escalations","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get all cases","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cases/peach.cases.handlers.list_cases_by_company","routeSlug":"/api-docs/api-public/cases/peach.cases.handlers.list_cases_by_company","metadata":{"seo":{"title":"Get all cases","description":"Get all cases. Returns only borrower-bound cases by default."}},"httpPath":"/cases","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get borrower cases","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cases/peach.cases.handlers.list_cases_by_borrower","routeSlug":"/api-docs/api-public/cases/peach.cases.handlers.list_cases_by_borrower","metadata":{"seo":{"title":"Get borrower cases","description":"Get all cases associated with a borrower."}},"httpPath":"/people/{personId}/cases","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create borrower case","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cases/peach.cases.handlers.create_case","routeSlug":"/api-docs/api-public/cases/peach.cases.handlers.create_case","metadata":{"seo":{"title":"Create borrower case","description":"Create a new case and associate it with a borrower using their ID."}},"httpPath":"/people/{personId}/cases","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Remove association","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cases/peach.cases.handlers.remove_case_association","routeSlug":"/api-docs/api-public/cases/peach.cases.handlers.remove_case_association","metadata":{"seo":{"title":"Remove association","description":"Remove association of an existing case, interaction, loan, or file objects from the case."}},"httpPath":"/people/{personId}/cases/{caseId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get borrower case by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cases/peach.cases.handlers.get_case_by_id","routeSlug":"/api-docs/api-public/cases/peach.cases.handlers.get_case_by_id","metadata":{"seo":{"title":"Get borrower case by ID","description":"Get borrower case by ID"}},"httpPath":"/people/{personId}/cases/{caseId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Add association","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cases/peach.cases.handlers.add_case_association","routeSlug":"/api-docs/api-public/cases/peach.cases.handlers.add_case_association","metadata":{"seo":{"title":"Add association","description":"Associate an existing case, interaction, loan, or file objects to the case.This way you can create comprehensive view of the case."}},"httpPath":"/people/{personId}/cases/{caseId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update case","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cases/peach.cases.handlers.update_case","routeSlug":"/api-docs/api-public/cases/peach.cases.handlers.update_case","metadata":{"seo":{"title":"Update case","description":"Update a case associated with a borrower."}},"httpPath":"/people/{personId}/cases/{caseId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"List case escalations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cases/peach.cases.escalations.handlers.case_escalations_get","routeSlug":"/api-docs/api-public/cases/peach.cases.escalations.handlers.case_escalations_get","metadata":{"seo":{"title":"List case escalations","description":"List case escalations"}},"httpPath":"/people/{personId}/cases/{caseId}/escalations","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Escalate or de-escalate a case","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cases/peach.cases.escalations.handlers.case_escalations_create","routeSlug":"/api-docs/api-public/cases/peach.cases.escalations.handlers.case_escalations_create","metadata":{"seo":{"title":"Escalate or de-escalate a case","description":"Escalate or de-escalate a case"}},"httpPath":"/people/{personId}/cases/{caseId}/escalations","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"List case escalation by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cases/peach.cases.escalations.handlers.case_escalation_get_by_id","routeSlug":"/api-docs/api-public/cases/peach.cases.escalations.handlers.case_escalation_get_by_id","metadata":{"seo":{"title":"List case escalation by ID","description":"List case escalations"}},"httpPath":"/people/{personId}/cases/{caseId}/escalations/{caseEscalationId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Snooze case","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cases/peach.cases.handlers.snooze_case","routeSlug":"/api-docs/api-public/cases/peach.cases.handlers.snooze_case","metadata":{"seo":{"title":"Snooze case","description":"Snooze the case or cancel the case snooze."}},"httpPath":"/people/{personId}/cases/{caseId}/snooze","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Mark a case as viewed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cases/peach.cases.handlers.view_case","routeSlug":"/api-docs/api-public/cases/peach.cases.handlers.view_case","metadata":{"seo":{"title":"Mark a case as viewed","description":"Mark a case as viewed by the current user"}},"httpPath":"/people/{personId}/cases/{caseId}/views","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Case Types","link":"/api-docs/api-public/case-types","routeSlug":"/api-docs/api-public/case-types","items":[{"label":"Get case types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/case-types/peach.cases.case_types.handlers.list_case_type","routeSlug":"/api-docs/api-public/case-types/peach.cases.case_types.handlers.list_case_type","metadata":{"seo":{"title":"Get case types","description":"Get case types"}},"httpPath":"/case-types","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/case-types/peach.cases.case_types.handlers.create_case_type","routeSlug":"/api-docs/api-public/case-types/peach.cases.case_types.handlers.create_case_type","metadata":{"seo":{"title":"Create type","description":"Create type"}},"httpPath":"/case-types","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get type by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/case-types/peach.cases.case_types.handlers.get_case_type_by_id","routeSlug":"/api-docs/api-public/case-types/peach.cases.case_types.handlers.get_case_type_by_id","metadata":{"seo":{"title":"Get type by ID","description":"Get type by ID"}},"httpPath":"/case-types/{caseTypeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/case-types/peach.cases.case_types.handlers.update_case_type","routeSlug":"/api-docs/api-public/case-types/peach.cases.case_types.handlers.update_case_type","metadata":{"seo":{"title":"Update type","description":"A PUT request is used to update an existing type configuration. While the type is in draft status requestscan move it to active. Setting the status to deprecated will immediately hide it from future GETall requests, and spawn a draft replica which can be edited and published in its place."}},"httpPath":"/case-types/{caseTypeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Remove association","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/case-types/peach.cases.case_types.handlers.case_type_remove_association","routeSlug":"/api-docs/api-public/case-types/peach.cases.case_types.handlers.case_type_remove_association","metadata":{"seo":{"title":"Remove association","description":"Remove association"}},"httpPath":"/case-types/{caseTypeId}/associations","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Add association","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/case-types/peach.cases.case_types.handlers.case_type_add_association","routeSlug":"/api-docs/api-public/case-types/peach.cases.case_types.handlers.case_type_add_association","metadata":{"seo":{"title":"Add association","description":"Add association"}},"httpPath":"/case-types/{caseTypeId}/associations","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create case type review tasks for ID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/case-types/peach.cases.case_types.handlers.create_smart_review_tasks","routeSlug":"/api-docs/api-public/case-types/peach.cases.case_types.handlers.create_smart_review_tasks","metadata":{"seo":{"title":"Create case type review tasks for ID","description":"Create case type review tasks for ID"}},"httpPath":"/case-types/{caseTypeId}/create-smart-review-tasks","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Smart Reviews","link":"/api-docs/api-public/smart-reviews","routeSlug":"/api-docs/api-public/smart-reviews","items":[{"type":"link","label":"Key Dates","link":"/api-docs/api-public/smart-reviews/key-dates","routeSlug":"/api-docs/api-public/smart-reviews/key-dates","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"Collections","link":"/api-docs/api-public/smart-reviews/collections","routeSlug":"/api-docs/api-public/smart-reviews/collections","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Supercases","link":"/api-docs/api-public/supercases","routeSlug":"/api-docs/api-public/supercases","items":[{"label":"List supercases","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_list","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_list","metadata":{"seo":{"title":"List supercases","description":"List supercases"}},"httpPath":"/supercases","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create supercase","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_create","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_create","metadata":{"seo":{"title":"Create supercase","description":"Creates a new supercase."}},"httpPath":"/supercases","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get supercase members.csv template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_members_template_csv","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_members_template_csv","metadata":{"seo":{"title":"Get supercase members.csv template","description":"Get supercase members.csv template"}},"httpPath":"/supercases/members-template.csv","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get supercase by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_get","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_get","metadata":{"seo":{"title":"Get supercase by ID","description":"Get supercase by ID"}},"httpPath":"/supercases/{supercaseId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update supercase","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_update","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_update","metadata":{"seo":{"title":"Update supercase","description":"Update supercase"}},"httpPath":"/supercases/{supercaseId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create Do Not Interact instances on all subcases","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_create_dni","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_create_dni","metadata":{"seo":{"title":"Create Do Not Interact instances on all subcases","description":"Create Do Not Interact instances on all subcases"}},"httpPath":"/supercases/{supercaseId}/bulk-create-do-not-interact","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Delete supercase related Do Not Interact instances on all subcases","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_delete_dni","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_delete_dni","metadata":{"seo":{"title":"Delete supercase related Do Not Interact instances on all subcases","description":"Delete supercase related Do Not Interact instances on all subcases"}},"httpPath":"/supercases/{supercaseId}/bulk-delete-do-not-interact","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"List bulk operations on this supercase","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_operation_list","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_operation_list","metadata":{"seo":{"title":"List bulk operations on this supercase","description":"List bulk operations on this supercase"}},"httpPath":"/supercases/{supercaseId}/bulk-operations","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Search bulk operations on this supercase","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_operation_search","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_operation_search","metadata":{"seo":{"title":"Search bulk operations on this supercase","description":"Search bulk operations on this supercase"}},"httpPath":"/supercases/{supercaseId}/bulk-operations/search","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get supercase bulk operation by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_operation_get","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_operation_get","metadata":{"seo":{"title":"Get supercase bulk operation by ID","description":"Get supercase bulk operation by ID"}},"httpPath":"/supercases/{supercaseId}/bulk-operations/{supercaseBulkOperationId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get member bulk operation results by operation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.get_member_bulk_operation_results_by_operation","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.get_member_bulk_operation_results_by_operation","metadata":{"seo":{"title":"Get member bulk operation results by operation","description":"Returns a list of member bulk operation results for the supercase bulk operation. Each member bulk operation result represents a member that was affected by the operation."}},"httpPath":"/supercases/{supercaseId}/bulk-operations/{supercaseBulkOperationId}/member-bulk-operation-results","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get target populations for the supercase bulk operation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.get_bulk_operation_target_populations","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.get_bulk_operation_target_populations","metadata":{"seo":{"title":"Get target populations for the supercase bulk operation","description":"Returns a list of target populations for the supercase bulk operation. Each target population represents a set of members that will be affected by the operation."}},"httpPath":"/supercases/{supercaseId}/bulk-operations/{supercaseBulkOperationId}/target-populations","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Send a message to the borrowers on all subcases","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_send_message","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_send_message","metadata":{"seo":{"title":"Send a message to the borrowers on all subcases","description":"Send a message to the borrowers on all subcases"}},"httpPath":"/supercases/{supercaseId}/bulk-send","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update all subcases","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_update","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_update","metadata":{"seo":{"title":"Update all subcases","description":"Update all subcases"}},"httpPath":"/supercases/{supercaseId}/bulk-update","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get the number of cases associated with the supercase","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_case_count","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.supercase_case_count","metadata":{"seo":{"title":"Get the number of cases associated with the supercase","description":"Get the number of cases associated with the supercase"}},"httpPath":"/supercases/{supercaseId}/case-count","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get the list of supercase documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.documents.get_supercase_documents","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.documents.get_supercase_documents","metadata":{"seo":{"title":"Get the list of supercase documents","description":"Get the list of supercase documents"}},"httpPath":"/supercases/{supercaseId}/documents","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Associate documents with the supercase","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.documents.add_supercase_documents","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.documents.add_supercase_documents","metadata":{"seo":{"title":"Associate documents with the supercase","description":"Associate documents with the supercase"}},"httpPath":"/supercases/{supercaseId}/documents","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Set the documents associated with the supercase","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.documents.set_supercase_documents","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.documents.set_supercase_documents","metadata":{"seo":{"title":"Set the documents associated with the supercase","description":"Set the documents associated with the supercase"}},"httpPath":"/supercases/{supercaseId}/documents","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get global notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.global_note_list","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.global_note_list","metadata":{"seo":{"title":"Get global notes","description":"Get global notes"}},"httpPath":"/supercases/{supercaseId}/global-notes","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create global note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.global_note_create","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.global_note_create","metadata":{"seo":{"title":"Create global note","description":"Create global note"}},"httpPath":"/supercases/{supercaseId}/global-notes","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get global note by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.global_note_get","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.global_note_get","metadata":{"seo":{"title":"Get global note by ID","description":"Get global note by ID"}},"httpPath":"/supercases/{supercaseId}/global-notes/{noteId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update global note","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.global_note_update","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.global_note_update","metadata":{"seo":{"title":"Update global note","description":"Update global note"}},"httpPath":"/supercases/{supercaseId}/global-notes/{noteId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get private notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.private_note_list","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.private_note_list","metadata":{"seo":{"title":"Get private notes","description":"Get private notes"}},"httpPath":"/supercases/{supercaseId}/notes","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create private note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.private_note_create","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.private_note_create","metadata":{"seo":{"title":"Create private note","description":"Create private note"}},"httpPath":"/supercases/{supercaseId}/notes","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get private note by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.private_note_get","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.private_note_get","metadata":{"seo":{"title":"Get private note by ID","description":"Get private note by ID"}},"httpPath":"/supercases/{supercaseId}/notes/{noteId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update private note","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.private_note_update","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.notes.private_note_update","metadata":{"seo":{"title":"Update private note","description":"Update private note"}},"httpPath":"/supercases/{supercaseId}/notes/{noteId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"List populations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.population_list","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.population_list","metadata":{"seo":{"title":"List populations","description":"List populations"}},"httpPath":"/supercases/{supercaseId}/populations","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get draft population","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_get","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_get","metadata":{"seo":{"title":"Get draft population","description":"Get draft population"}},"httpPath":"/supercases/{supercaseId}/populations/draft","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Commit draft population","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_commit","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_commit","metadata":{"seo":{"title":"Commit draft population","description":"Creates subcases for all members of the draft population and moves the population to the committed state."}},"httpPath":"/supercases/{supercaseId}/populations/draft/commit","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get the draft population members","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_list","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_list","metadata":{"seo":{"title":"Get the draft population members","description":"Get the draft population members"}},"httpPath":"/supercases/{supercaseId}/populations/draft/members","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Add to the draft population membership","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_add","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_add","metadata":{"seo":{"title":"Add to the draft population membership","description":"Add to the current population membership the members in this request."}},"httpPath":"/supercases/{supercaseId}/populations/draft/members","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Set the draft population membership","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_set","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_set","metadata":{"seo":{"title":"Set the draft population membership","description":"Set the draft population membership to the population in this request. (Removing all current members if they exist.)"}},"httpPath":"/supercases/{supercaseId}/populations/draft/members","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get membership as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_list_csv","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_list_csv","metadata":{"seo":{"title":"Get membership as CSV","description":"Get membership as CSV"}},"httpPath":"/supercases/{supercaseId}/populations/draft/members.csv","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Add to membership with CSV","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_add_csv","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_add_csv","metadata":{"seo":{"title":"Add to membership with CSV","description":"Add to the current population membership with the population in this request. Format is a CSV document."}},"httpPath":"/supercases/{supercaseId}/populations/draft/members.csv","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Set membership with CSV","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_set_csv","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_set_csv","metadata":{"seo":{"title":"Set membership with CSV","description":"Set the current population membership to the population in this request. (Removing all current members if they exist.) Format is a CSV document."}},"httpPath":"/supercases/{supercaseId}/populations/draft/members.csv","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get committed membership as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.committed_members_list_csv","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.committed_members_list_csv","metadata":{"seo":{"title":"Get committed membership as CSV","description":"Get committed membership as CSV"}},"httpPath":"/supercases/{supercaseId}/populations/members.csv","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get population by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.population_get","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.population_get","metadata":{"seo":{"title":"Get population by ID","description":"Get population by ID"}},"httpPath":"/supercases/{supercaseId}/populations/{populationId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update population","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.population_update","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.population_update","metadata":{"seo":{"title":"Update population","description":"Update the population."}},"httpPath":"/supercases/{supercaseId}/populations/{populationId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Send a message to the borrowers on all subcases of the population","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.population_bulk_send_message","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.population_bulk_send_message","metadata":{"seo":{"title":"Send a message to the borrowers on all subcases of the population","description":"Send a message to the borrowers on all subcases of the population"}},"httpPath":"/supercases/{supercaseId}/populations/{populationId}/bulk-send","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get population membership","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.population_members_list","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.population_members_list","metadata":{"seo":{"title":"Get population membership","description":"Get population membership"}},"httpPath":"/supercases/{supercaseId}/populations/{populationId}/members","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get membership as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/supercases/peach.supercases.handlers.population_members_list_csv","routeSlug":"/api-docs/api-public/supercases/peach.supercases.handlers.population_members_list_csv","metadata":{"seo":{"title":"Get membership as CSV","description":"Get membership as CSV"}},"httpPath":"/supercases/{supercaseId}/populations/{populationId}/members.csv","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Do Not Interact","link":"/api-docs/api-public/do-not-interact","routeSlug":"/api-docs/api-public/do-not-interact","items":[{"label":"Get case do not interacts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_get_all","routeSlug":"/api-docs/api-public/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_get_all","metadata":{"seo":{"title":"Get case do not interacts","description":"Get the all DoNoInteract instances associated with a case."}},"httpPath":"/people/{personId}/cases/{caseId}/do-not-interacts","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create do not interact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_create","routeSlug":"/api-docs/api-public/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_create","metadata":{"seo":{"title":"Create do not interact","description":"Create do not interact"}},"httpPath":"/people/{personId}/cases/{caseId}/do-not-interacts","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Remove do not interact","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_delete","routeSlug":"/api-docs/api-public/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_delete","metadata":{"seo":{"title":"Remove do not interact","description":"Update a DoNotInteract instance to have inactive status, and set the end date."}},"httpPath":"/people/{personId}/cases/{caseId}/do-not-interacts/{doNotInteractId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get do not interact by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_get_by_id","routeSlug":"/api-docs/api-public/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_get_by_id","metadata":{"seo":{"title":"Get do not interact by ID","description":"Get a single DoNotInteract object instance for the borrower using a unique ID."}},"httpPath":"/people/{personId}/cases/{caseId}/do-not-interacts/{doNotInteractId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update do not interact","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_update","routeSlug":"/api-docs/api-public/do-not-interact/peach.cases.events.handlers.do_not_interact.do_not_interact_update","metadata":{"seo":{"title":"Update do not interact","description":"Update a DoNotInteract instance with new information."}},"httpPath":"/people/{personId}/cases/{caseId}/do-not-interacts/{doNotInteractId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get all do not interacts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/do-not-interact/peach.people.do_not_interact.handlers.do_not_interact_get_all","routeSlug":"/api-docs/api-public/do-not-interact/peach.people.do_not_interact.handlers.do_not_interact_get_all","metadata":{"seo":{"title":"Get all do not interacts","description":"Get the all DoNoInteract instances associated with a borrower."}},"httpPath":"/people/{personId}/do-not-interacts","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Do Not Interact Types","link":"/api-docs/api-public/do-not-interact-types","routeSlug":"/api-docs/api-public/do-not-interact-types","items":[{"label":"Get types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/do-not-interact-types/peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_get_all","routeSlug":"/api-docs/api-public/do-not-interact-types/peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_get_all","metadata":{"seo":{"title":"Get types","description":"Get types"}},"httpPath":"/do-not-interact-types","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/do-not-interact-types/peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_create","routeSlug":"/api-docs/api-public/do-not-interact-types/peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_create","metadata":{"seo":{"title":"Create type","description":"Create type"}},"httpPath":"/do-not-interact-types","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get type by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/do-not-interact-types/peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_get_by_id","routeSlug":"/api-docs/api-public/do-not-interact-types/peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_get_by_id","metadata":{"seo":{"title":"Get type by ID","description":"Get type by ID"}},"httpPath":"/do-not-interact-types/{doNotInteractTypeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/do-not-interact-types/peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_update","routeSlug":"/api-docs/api-public/do-not-interact-types/peach.cases.events.handlers.do_not_interact_type.do_not_interact_type_update","metadata":{"seo":{"title":"Update type","description":"Change the triggering conditions and settings of a draft type, or update the status of an activetype to deprecated. Doing the later will create a new draft version of the configuration unlessexplicitly told not to."}},"httpPath":"/do-not-interact-types/{doNotInteractTypeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Notification Types","link":"/api-docs/api-public/notification-types","routeSlug":"/api-docs/api-public/notification-types","items":[{"label":"Get types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notification-types/peach.cases.events.handlers.notifications.notification_type_get_all","routeSlug":"/api-docs/api-public/notification-types/peach.cases.events.handlers.notifications.notification_type_get_all","metadata":{"seo":{"title":"Get types","description":"Get types"}},"httpPath":"/notification-types","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notification-types/peach.cases.events.handlers.notifications.notification_type_create","routeSlug":"/api-docs/api-public/notification-types/peach.cases.events.handlers.notifications.notification_type_create","metadata":{"seo":{"title":"Create type","description":"Create a new type configuration for triggering notifications."}},"httpPath":"/notification-types","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get type by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notification-types/peach.cases.events.handlers.notifications.notification_type_get_by_id","routeSlug":"/api-docs/api-public/notification-types/peach.cases.events.handlers.notifications.notification_type_get_by_id","metadata":{"seo":{"title":"Get type by ID","description":"Get type by ID"}},"httpPath":"/notification-types/{notificationTypeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notification-types/peach.cases.events.handlers.notifications.notification_type_update","routeSlug":"/api-docs/api-public/notification-types/peach.cases.events.handlers.notifications.notification_type_update","metadata":{"seo":{"title":"Update type","description":"Change the triggering conditions and settings of a draft type, or update the status of an activetype to deprecated."}},"httpPath":"/notification-types/{notificationTypeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Notes","link":"/api-docs/api-public/notes","routeSlug":"/api-docs/api-public/notes","items":[{"label":"Get notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notes/peach.notes.handlers.list_interaction_notes","routeSlug":"/api-docs/api-public/notes/peach.notes.handlers.list_interaction_notes","metadata":{"seo":{"title":"Get notes","description":"Get notes"}},"httpPath":"/interactions/{interactionId}/notes","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notes/peach.notes.handlers.create_interaction_note","routeSlug":"/api-docs/api-public/notes/peach.notes.handlers.create_interaction_note","metadata":{"seo":{"title":"Create note","description":"Create note"}},"httpPath":"/interactions/{interactionId}/notes","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get note by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notes/peach.notes.handlers.get_interaction_note","routeSlug":"/api-docs/api-public/notes/peach.notes.handlers.get_interaction_note","metadata":{"seo":{"title":"Get note by ID","description":"Get note by ID"}},"httpPath":"/interactions/{interactionId}/notes/{noteId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update note","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notes/peach.notes.handlers.update_interaction_note","routeSlug":"/api-docs/api-public/notes/peach.notes.handlers.update_interaction_note","metadata":{"seo":{"title":"Update note","description":"Update note"}},"httpPath":"/interactions/{interactionId}/notes/{noteId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notes/peach.notes.handlers.list_case_notes","routeSlug":"/api-docs/api-public/notes/peach.notes.handlers.list_case_notes","metadata":{"seo":{"title":"Get notes","description":"Get notes"}},"httpPath":"/people/{personId}/cases/{caseId}/notes","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notes/peach.notes.handlers.create_case_note","routeSlug":"/api-docs/api-public/notes/peach.notes.handlers.create_case_note","metadata":{"seo":{"title":"Create note","description":"Create note"}},"httpPath":"/people/{personId}/cases/{caseId}/notes","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get note by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notes/peach.notes.handlers.get_case_note","routeSlug":"/api-docs/api-public/notes/peach.notes.handlers.get_case_note","metadata":{"seo":{"title":"Get note by ID","description":"Get note by ID"}},"httpPath":"/people/{personId}/cases/{caseId}/notes/{noteId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update note","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notes/peach.notes.handlers.update_case_note","routeSlug":"/api-docs/api-public/notes/peach.notes.handlers.update_case_note","metadata":{"seo":{"title":"Update note","description":"Update note"}},"httpPath":"/people/{personId}/cases/{caseId}/notes/{noteId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get interaction notes for a person","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notes/peach.notes.handlers.list_borrower_interaction_notes","routeSlug":"/api-docs/api-public/notes/peach.notes.handlers.list_borrower_interaction_notes","metadata":{"seo":{"title":"Get interaction notes for a person","description":"Get interaction notes for a person"}},"httpPath":"/people/{personId}/interaction-notes","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notes/peach.notes.handlers.list_borrower_notes","routeSlug":"/api-docs/api-public/notes/peach.notes.handlers.list_borrower_notes","metadata":{"seo":{"title":"Get notes","description":"Get notes"}},"httpPath":"/people/{personId}/notes","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notes/peach.notes.handlers.create_borrower_note","routeSlug":"/api-docs/api-public/notes/peach.notes.handlers.create_borrower_note","metadata":{"seo":{"title":"Create note","description":"Create note"}},"httpPath":"/people/{personId}/notes","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get note by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notes/peach.notes.handlers.get_borrower_note","routeSlug":"/api-docs/api-public/notes/peach.notes.handlers.get_borrower_note","metadata":{"seo":{"title":"Get note by ID","description":"Get note by ID"}},"httpPath":"/people/{personId}/notes/{noteId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update note","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/notes/peach.notes.handlers.update_borrower_note","routeSlug":"/api-docs/api-public/notes/peach.notes.handlers.update_borrower_note","metadata":{"seo":{"title":"Update note","description":"Update note"}},"httpPath":"/people/{personId}/notes/{noteId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Workflows","link":"/api-docs/api-public/workflows","routeSlug":"/api-docs/api-public/workflows","items":[{"label":"Get case workflow","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflows/peach.workflows.handlers.get_case_workflow","routeSlug":"/api-docs/api-public/workflows/peach.workflows.handlers.get_case_workflow","metadata":{"seo":{"title":"Get case workflow","description":"Get case workflow"}},"httpPath":"/companies/{companyId}/people/{personId}/cases/{caseId}/workflow","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update workflow step status","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflows/peach.workflows.handlers.update_workflow_step","routeSlug":"/api-docs/api-public/workflows/peach.workflows.handlers.update_workflow_step","metadata":{"seo":{"title":"Update workflow step status","description":"Update workflow step status"}},"httpPath":"/companies/{companyId}/people/{personId}/cases/{caseId}/workflow/steps/{workflowStepId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update workflow workitem status","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflows/peach.workflows.handlers.update_workflow_workitem","routeSlug":"/api-docs/api-public/workflows/peach.workflows.handlers.update_workflow_workitem","metadata":{"seo":{"title":"Update workflow workitem status","description":"Update workflow workitem status"}},"httpPath":"/companies/{companyId}/people/{personId}/cases/{caseId}/workflow/steps/{workflowStepId}/workitems/{workflowWorkitemId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Workflow Types","link":"/api-docs/api-public/workflow-types","routeSlug":"/api-docs/api-public/workflow-types","items":[{"label":"Get workflow step types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.get_workflow_step_types","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.get_workflow_step_types","metadata":{"seo":{"title":"Get workflow step types","description":"Get workflow step types"}},"httpPath":"/companies/{companyId}/workflow-step-types","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create workflow step type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.create_workflow_step_type","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.create_workflow_step_type","metadata":{"seo":{"title":"Create workflow step type","description":"Create workflow step type"}},"httpPath":"/companies/{companyId}/workflow-step-types","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Delete workflow step type","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.delete_workflow_step_type","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.delete_workflow_step_type","metadata":{"seo":{"title":"Delete workflow step type","description":"Delete workflow step type"}},"httpPath":"/companies/{companyId}/workflow-step-types/{workflowStepTypeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get workflow step type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.get_workflow_step_type_by_id","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.get_workflow_step_type_by_id","metadata":{"seo":{"title":"Get workflow step type","description":"Get workflow step type"}},"httpPath":"/companies/{companyId}/workflow-step-types/{workflowStepTypeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update workflow step type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.update_workflow_step_type","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.update_workflow_step_type","metadata":{"seo":{"title":"Update workflow step type","description":"Update workflow step type"}},"httpPath":"/companies/{companyId}/workflow-step-types/{workflowStepTypeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get workflow types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.get_workflow_types","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.get_workflow_types","metadata":{"seo":{"title":"Get workflow types","description":"Get workflow types"}},"httpPath":"/companies/{companyId}/workflow-types","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create workflow type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.create_workflow_type","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.create_workflow_type","metadata":{"seo":{"title":"Create workflow type","description":"Create workflow type"}},"httpPath":"/companies/{companyId}/workflow-types","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Export workflow, step and work item types.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.export_workflow_types","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.export_workflow_types","metadata":{"seo":{"title":"Export workflow, step and work item types.","description":"Export workflow, step and work item types."}},"httpPath":"/companies/{companyId}/workflow-types/export","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Restore previously exported workflow, step and work item types.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.import_workflow_types","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.import_workflow_types","metadata":{"seo":{"title":"Restore previously exported workflow, step and work item types.","description":"Restore previously exported workflow, step and work item types."}},"httpPath":"/companies/{companyId}/workflow-types/import","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Delete workflow type","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.delete_workflow_type","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.delete_workflow_type","metadata":{"seo":{"title":"Delete workflow type","description":"Delete workflow type"}},"httpPath":"/companies/{companyId}/workflow-types/{workflowTypeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get workflow type by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.get_workflow_type_by_id","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.get_workflow_type_by_id","metadata":{"seo":{"title":"Get workflow type by ID","description":"Get workflow type by ID"}},"httpPath":"/companies/{companyId}/workflow-types/{workflowTypeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update workflow type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.update_workflow_type","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.update_workflow_type","metadata":{"seo":{"title":"Update workflow type","description":"Update workflow type"}},"httpPath":"/companies/{companyId}/workflow-types/{workflowTypeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get work item types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.get_workitem_types","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.get_workitem_types","metadata":{"seo":{"title":"Get work item types","description":"Get work item types"}},"httpPath":"/companies/{companyId}/workflow-workitem-types","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create work item type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.create_workitem_type","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.create_workitem_type","metadata":{"seo":{"title":"Create work item type","description":"Create work item type"}},"httpPath":"/companies/{companyId}/workflow-workitem-types","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Delete work item type","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.delete_workitem_type","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.delete_workitem_type","metadata":{"seo":{"title":"Delete work item type","description":"Delete work item type"}},"httpPath":"/companies/{companyId}/workflow-workitem-types/{workflowWorkitemTypeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get work item type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.get_workitem_type_by_id","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.get_workitem_type_by_id","metadata":{"seo":{"title":"Get work item type","description":"Get work item type"}},"httpPath":"/companies/{companyId}/workflow-workitem-types/{workflowWorkitemTypeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update work item type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/workflow-types/peach.workflows.handlers.update_workitem_type","routeSlug":"/api-docs/api-public/workflow-types/peach.workflows.handlers.update_workitem_type","metadata":{"seo":{"title":"Update work item type","description":"Update work item type"}},"httpPath":"/companies/{companyId}/workflow-workitem-types/{workflowWorkitemTypeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Tasks","link":"/api-docs/api-public/tasks","routeSlug":"/api-docs/api-public/tasks","items":[{"label":"Get information on Twilio task queues","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.get_all_queues","routeSlug":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.get_all_queues","metadata":{"seo":{"title":"Get information on Twilio task queues","description":"Get information on task queues such as friendly name and task statistics."}},"httpPath":"/companies/{companyId}/twilio-queues","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"List Terminated Tasks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers_task_history.task_history_list","routeSlug":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers_task_history.task_history_list","metadata":{"seo":{"title":"List Terminated Tasks","description":"List Terminated Tasks"}},"httpPath":"/companies/{companyId}/twilio-terminated-tasks","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get Terminated Task by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers_task_history.task_history_get","routeSlug":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers_task_history.task_history_get","metadata":{"seo":{"title":"Get Terminated Task by ID","description":"Get Terminated Task by ID"}},"httpPath":"/companies/{companyId}/twilio-terminated-tasks/{taskHistoryId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Clone Terminated Task by ID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers_task_history.task_history_clone","routeSlug":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers_task_history.task_history_clone","metadata":{"seo":{"title":"Clone Terminated Task by ID","description":"Clone Terminated Task by ID"}},"httpPath":"/companies/{companyId}/twilio-terminated-tasks/{taskHistoryId}/clone","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Bulk Delete Unterminated Tasks","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.delete_unterminated_tasks","routeSlug":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.delete_unterminated_tasks","metadata":{"seo":{"title":"Bulk Delete Unterminated Tasks","description":"Bulk delete unterminated tasks from Twilio API. (this proxy's Twilio'sTask API)."}},"httpPath":"/companies/{companyId}/twilio-unterminated-tasks","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"List Unterminated Tasks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.list_unterminated_tasks","routeSlug":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.list_unterminated_tasks","metadata":{"seo":{"title":"List Unterminated Tasks","description":"Reads unterminated task from Twilio API. (This essentially proxies Twilio'sTask API)."}},"httpPath":"/companies/{companyId}/twilio-unterminated-tasks","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Deletes Unterminated Task by SID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.delete_unterminated_task","routeSlug":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.delete_unterminated_task","metadata":{"seo":{"title":"Deletes Unterminated Task by SID","description":"Delete the unterminated task from Twilio API (this proxy's Twilio'sTask API)."}},"httpPath":"/companies/{companyId}/twilio-unterminated-tasks/{taskSid}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Read Unterminated Task by SID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.read_unterminated_task","routeSlug":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.read_unterminated_task","metadata":{"seo":{"title":"Read Unterminated Task by SID","description":"Read's the specified unterminated task from Twilio API (this proxy's Twilio'sTask API)."}},"httpPath":"/companies/{companyId}/twilio-unterminated-tasks/{taskSid}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Abandon Unterminated Task by SID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.abandon_accepted_task","routeSlug":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.abandon_accepted_task","metadata":{"seo":{"title":"Abandon Unterminated Task by SID","description":"Abandon an unterminated, accepted task. i.e., Mark the task as \"Unable to Complete\"and create a duplicate task."}},"httpPath":"/companies/{companyId}/twilio-unterminated-tasks/{taskSid}/abandon","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"List Taskrouter Workers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers_workers.list_workers","routeSlug":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers_workers.list_workers","metadata":{"seo":{"title":"List Taskrouter Workers","description":"List all Taskrouter Workers."}},"httpPath":"/companies/{companyId}/twilio-workers","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get task availability","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.get_tasktype_availability","routeSlug":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.get_tasktype_availability","metadata":{"seo":{"title":"Get task availability","description":"Get task availability"}},"httpPath":"/twilio/tasktype-availability","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update task type availability","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.update_tasktype_availability","routeSlug":"/api-docs/api-public/tasks/peach.twilio.taskrouter.handlers.update_tasktype_availability","metadata":{"seo":{"title":"Update task type availability","description":"Update task type availability"}},"httpPath":"/twilio/tasktype-availability","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Task-Worker Pairing Configs","link":"/api-docs/api-public/task-worker-pairing-configs","routeSlug":"/api-docs/api-public/task-worker-pairing-configs","items":[{"label":"List task-worker pairing configs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_list","routeSlug":"/api-docs/api-public/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_list","metadata":{"seo":{"title":"List task-worker pairing configs","description":"List the task-worker pairing configs for a company."}},"httpPath":"/companies/{companyId}/task-worker-pairing-configs","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create task-worker pairing config\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_create","routeSlug":"/api-docs/api-public/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_create","metadata":{"seo":{"title":"Create task-worker pairing config\n","description":"Create a new task-worker pairing config."}},"httpPath":"/companies/{companyId}/task-worker-pairing-configs","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Sync task-worker pairing configs to Twilio","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_sync","routeSlug":"/api-docs/api-public/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_sync","metadata":{"seo":{"title":"Sync task-worker pairing configs to Twilio","description":"Perform synchronization of task-worker pairing config to Twilio."}},"httpPath":"/companies/{companyId}/task-worker-pairing-configs/sync","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Delete task-worker pairing config","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_delete","routeSlug":"/api-docs/api-public/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_delete","metadata":{"seo":{"title":"Delete task-worker pairing config","description":"Delete a task-worker pairing config."}},"httpPath":"/companies/{companyId}/task-worker-pairing-configs/{taskWorkerPairingConfigId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get task-worker pairing config","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_get","routeSlug":"/api-docs/api-public/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_get","metadata":{"seo":{"title":"Get task-worker pairing config","description":"Get task-worker pairing config"}},"httpPath":"/companies/{companyId}/task-worker-pairing-configs/{taskWorkerPairingConfigId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update task-worker pairing config","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_update","routeSlug":"/api-docs/api-public/task-worker-pairing-configs/peach.twilio.taskrouter.handlers_task_worker_pairing_configs.task_worker_pairing_config_update","metadata":{"seo":{"title":"Update task-worker pairing config","description":"Update a task-worker pairing config."}},"httpPath":"/companies/{companyId}/task-worker-pairing-configs/{taskWorkerPairingConfigId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"separator","label":"Loans Management","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Loans","link":"/api-docs/api-public/loans","routeSlug":"/api-docs/api-public/loans","items":[{"label":"Get loans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.loans.handlers.loans_get_by_company","routeSlug":"/api-docs/api-public/loans/peach.loans.handlers.loans_get_by_company","metadata":{"seo":{"title":"Get loans","description":"Get all loans associated with a company."}},"httpPath":"/loans","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get borrower's loans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loans_get","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loans_get","metadata":{"seo":{"title":"Get borrower's loans","description":"Get borrower's loans"}},"httpPath":"/people/{personId}/loans","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loans_add","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loans_add","metadata":{"seo":{"title":"Create loan","description":"Add a new loan."}},"httpPath":"/people/{personId}/loans","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get loan by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_get","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_get","metadata":{"seo":{"title":"Get loan by ID","description":"Get loan by ID"}},"httpPath":"/people/{personId}/loans/{loanId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update loan","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_update","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_update","metadata":{"seo":{"title":"Update loan","description":"Update loan"}},"httpPath":"/people/{personId}/loans/{loanId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Accelerate loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_accelerate","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_accelerate","metadata":{"seo":{"title":"Accelerate loan","description":"The accelerate endpoint will change the status of an active loan to accelerated,and trigger any acceleration-related logic and accounting treatment."}},"httpPath":"/people/{personId}/loans/{loanId}/accelerate","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Activate loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_activate","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_activate","metadata":{"seo":{"title":"Activate loan","description":"Activate loan"}},"httpPath":"/people/{personId}/loans/{loanId}/activate","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Cancel loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_cancel","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_cancel","metadata":{"seo":{"title":"Cancel loan","description":"The cancel loan endpoint will change the status of a loan to canceled, andtrigger any cancellation-related logic, such as removing a loan from active monitoringand handling the accounting treatment for canceled loans."}},"httpPath":"/people/{personId}/loans/{loanId}/cancel","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Charge-off loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_charge_off","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_charge_off","metadata":{"seo":{"title":"Charge-off loan","description":"The charge-off endpoint will change the status of a loan to chargedOff, and trigger anycharge-off-related logic and accounting treatment."}},"httpPath":"/people/{personId}/loans/{loanId}/charge-off","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Close loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_close","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_close","metadata":{"seo":{"title":"Close loan","description":"Closing a loan"}},"httpPath":"/people/{personId}/loans/{loanId}/close","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get loan credit limit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_get_credit_limit","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_get_credit_limit","metadata":{"seo":{"title":"Get loan credit limit","description":"Get loan credit limit"}},"httpPath":"/people/{personId}/loans/{loanId}/credit-limit","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update loan credit limit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_update_credit_limit","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_update_credit_limit","metadata":{"seo":{"title":"Update loan credit limit","description":"Update loan credit limit"}},"httpPath":"/people/{personId}/loans/{loanId}/credit-limit","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Freeze loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_freeze","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_freeze","metadata":{"seo":{"title":"Freeze loan","description":"Freeze loan will change the status of an active loan to frozen effective as of thecurrent date. The loan will remain in a frozen status until the Unfreeze endpoint iscalled."}},"httpPath":"/people/{personId}/loans/{loanId}/freeze","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get loan lock status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.get_lock_status","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.get_lock_status","metadata":{"seo":{"title":"Get loan lock status","description":"Get loan lock status"}},"httpPath":"/people/{personId}/loans/{loanId}/lock-status","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Migrate loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.loans.migration.handlers.loan_migrate","routeSlug":"/api-docs/api-public/loans/peach.loans.migration.handlers.loan_migrate","metadata":{"seo":{"title":"Migrate loan","description":"Migrate loan"}},"httpPath":"/people/{personId}/loans/{loanId}/migrate","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Refresh loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_refresh","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_refresh","metadata":{"seo":{"title":"Refresh loan","description":"In the case that a loan is out of sync, the refresh endpoint will make sure thatobligations, expected payments, and interest accrual is brought into sync."}},"httpPath":"/people/{personId}/loans/{loanId}/refresh","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Reimburse","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_reimburse","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_reimburse","metadata":{"seo":{"title":"Reimburse","description":"The reimburse endpoint should be used when the lender owes money to a borrower on a given loan.The endpoint will execute a reimbursement according to the specified reimbursementAmount. If the reimbursementAmount is greater than the amount owed to the borrower, the system will not process the reimbursement and return an error. Funds are reimbursed to a specified payment instrument. The endpoint will update the ledger and create a new transaction."}},"httpPath":"/people/{personId}/loans/{loanId}/reimburse","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Reopen a closed loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_reopen","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_reopen","metadata":{"seo":{"title":"Reopen a closed loan","description":"Reopen a closed line of credit. This will allow new draws to be added. By default, draws in paidOff status willnot be reopened, and a line of credit that has transitioned to paidOff status cannot be reopened. Set force totrue to also reopen the line and all of its draws when they are paidOff (e.g. for a post-closure balancecorrection). No special permission is required beyond loan:reopen."}},"httpPath":"/people/{personId}/loans/{loanId}/reopen","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Reverse accelerate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_accelerate_reverse","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_accelerate_reverse","metadata":{"seo":{"title":"Reverse accelerate","description":"A loan must be in accelerated status to be reversed."}},"httpPath":"/people/{personId}/loans/{loanId}/reverse-accelerate","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Reverse charge-off","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_charge_off_reverse","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_charge_off_reverse","metadata":{"seo":{"title":"Reverse charge-off","description":"A loan must be in chargedOff status to be reversed."}},"httpPath":"/people/{personId}/loans/{loanId}/reverse-charge-off","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Unfreeze loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_unfreeze","routeSlug":"/api-docs/api-public/loans/peach.people.loans.handlers.loan_unfreeze","metadata":{"seo":{"title":"Unfreeze loan","description":"The Unfreeze endpoint will change the status of a frozen loan back to active, accelerated or chargedOff."}},"httpPath":"/people/{personId}/loans/{loanId}/unfreeze","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Installment Advances","link":"/api-docs/api-public/installment-advances","routeSlug":"/api-docs/api-public/installment-advances","items":[{"label":"Get advances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/installment-advances/peach.people.loans.installment_advances.handlers.get_loan_advances","routeSlug":"/api-docs/api-public/installment-advances/peach.people.loans.installment_advances.handlers.get_loan_advances","metadata":{"seo":{"title":"Get advances","description":"Returns an installment loan's advances"}},"httpPath":"/people/{personId}/loans/{loanId}/advances","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create advance","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/installment-advances/peach.people.loans.installment_advances.handlers.create_loan_advance","routeSlug":"/api-docs/api-public/installment-advances/peach.people.loans.installment_advances.handlers.create_loan_advance","metadata":{"seo":{"title":"Create advance","description":"Create advance"}},"httpPath":"/people/{personId}/loans/{loanId}/advances","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get advance by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/installment-advances/peach.people.loans.installment_advances.handlers.get_loan_advance","routeSlug":"/api-docs/api-public/installment-advances/peach.people.loans.installment_advances.handlers.get_loan_advance","metadata":{"seo":{"title":"Get advance by ID","description":"Returns an installment loan advance"}},"httpPath":"/people/{personId}/loans/{loanId}/advances/{advanceId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update advance","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/installment-advances/peach.people.loans.installment_advances.handlers.update_loan_advance","routeSlug":"/api-docs/api-public/installment-advances/peach.people.loans.installment_advances.handlers.update_loan_advance","metadata":{"seo":{"title":"Update advance","description":"Update advance"}},"httpPath":"/people/{personId}/loans/{loanId}/advances/{advanceId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Installment Refunds","link":"/api-docs/api-public/installment-refunds","routeSlug":"/api-docs/api-public/installment-refunds","items":[{"label":"Get refunds","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/installment-refunds/peach.people.loans.handlers.loan_refunds_get","routeSlug":"/api-docs/api-public/installment-refunds/peach.people.loans.handlers.loan_refunds_get","metadata":{"seo":{"title":"Get refunds","description":"Returns a list of all prior refunds for the loan, as well as the remaining eligible refund amount."}},"httpPath":"/people/{personId}/loans/{loanId}/refunds","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/installment-refunds/peach.people.loans.handlers.loan_refunds_post","routeSlug":"/api-docs/api-public/installment-refunds/peach.people.loans.handlers.loan_refunds_post","metadata":{"seo":{"title":"Create refund","description":"The refund endpoint will execute a full or partial refund according to the refundAmount specified.A full refund is equal to the amountFinancedAtOrigination. An atFaultParty must also be specified,in order to trigger the corresponding accounting entries related to billing for the refund."}},"httpPath":"/people/{personId}/loans/{loanId}/refunds","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create refund v2","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/installment-refunds/peach.people.loans.handlers.loan_refunds_v2_post","routeSlug":"/api-docs/api-public/installment-refunds/peach.people.loans.handlers.loan_refunds_v2_post","metadata":{"seo":{"title":"Create refund v2","description":"The refund endpoint will execute a full or partial refund according to the refundAmount specified.The total of all refunds cannot exceed the amountFinanced (or principalAmount)  passed at origination."}},"httpPath":"/people/{personId}/loans/{loanId}/refunds-v2","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Cancel refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/installment-refunds/peach.people.loans.handlers.loan_refunds_cancel","routeSlug":"/api-docs/api-public/installment-refunds/peach.people.loans.handlers.loan_refunds_cancel","metadata":{"seo":{"title":"Cancel refund","description":"Cancel a refund."}},"httpPath":"/people/{personId}/loans/{loanId}/refunds/{loanRefundId}/cancel","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Line of Credit Draws","link":"/api-docs/api-public/line-of-credit-draws","routeSlug":"/api-docs/api-public/line-of-credit-draws","items":[{"label":"Preview draw amortization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.preview_draw_amortize","routeSlug":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.preview_draw_amortize","metadata":{"seo":{"title":"Preview draw amortization","description":"This endpoint is used for previewing draw amortization. The draw must have non-due principal to be amortized."}},"httpPath":"/people/{personId}/loans/{loanId}/amortize-preview","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get draws","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.loan_draws_get","routeSlug":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.loan_draws_get","metadata":{"seo":{"title":"Get draws","description":"Get draws"}},"httpPath":"/people/{personId}/loans/{loanId}/draws","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create draw","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.loan_draws_post","routeSlug":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.loan_draws_post","metadata":{"seo":{"title":"Create draw","description":"Create draw"}},"httpPath":"/people/{personId}/loans/{loanId}/draws","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get draw by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.loan_draw_get","routeSlug":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.loan_draw_get","metadata":{"seo":{"title":"Get draw by ID","description":"Get draw by ID"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update draw","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_update","routeSlug":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_update","metadata":{"seo":{"title":"Update draw","description":"Update draw"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Activate draw","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_activate","routeSlug":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_activate","metadata":{"seo":{"title":"Activate draw","description":"Activate draw"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/activate","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Amortize draw","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.loan_draw_amortize","routeSlug":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.loan_draw_amortize","metadata":{"seo":{"title":"Amortize draw","description":"This endpoint is used for draw amortization. The draw must have non-due principal to be reamortized."}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/amortize","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Cancel draw","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_cancel","routeSlug":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_cancel","metadata":{"seo":{"title":"Cancel draw","description":"The cancel loan endpoint will change the status of a draw to canceled, andtrigger any cancellation-related logic."}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/cancel","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Close draw","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_close","routeSlug":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_close","metadata":{"seo":{"title":"Close draw","description":"Closing a draw means that the draw can no longer accept new purchases. The draw will automatically transitionto paidOff status once all of the following conditions are met:"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/close","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get draw credit limit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_get_credit_limit","routeSlug":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_get_credit_limit","metadata":{"seo":{"title":"Get draw credit limit","description":"Get draw credit limit"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/credit-limit","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update draw credit limit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_update_credit_limit","routeSlug":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_update_credit_limit","metadata":{"seo":{"title":"Update draw credit limit","description":"Update draw credit limit"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/credit-limit","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update draw fees","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.fees.handlers.draw_dynamic_fees_at_origination_update","routeSlug":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.fees.handlers.draw_dynamic_fees_at_origination_update","metadata":{"seo":{"title":"Update draw fees","description":"Allows lenders to add or remove dynamic fees from a draw going forward. This does not affect balances or fees in the past."}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/dynamic-fees","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update draw min pay calculation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_min_payment_calculation_post","routeSlug":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_min_payment_calculation_post","metadata":{"seo":{"title":"Update draw min pay calculation","description":"Update draw min pay calculation"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/min-payment-calculation","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Reopen draw","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_reopen","routeSlug":"/api-docs/api-public/line-of-credit-draws/peach.people.loans.draws.handlers.draw_reopen","metadata":{"seo":{"title":"Reopen draw","description":"Reopen a closed draw. This will allow new purchases to be added to the draw. By default, a draw in paidOffstatus cannot be reopened. Set force to true to reopen a paidOff draw (e.g. for a post-closure balancecorrection); its parent line of credit is also reopened if needed, but sibling draws are left untouched. Nospecial permission is required beyond loan:reopen."}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/reopen","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Line of Credit Purchases","link":"/api-docs/api-public/line-of-credit-purchases","routeSlug":"/api-docs/api-public/line-of-credit-purchases","items":[{"label":"Get line of credit purchase disputes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_disputes_list_for_loc","routeSlug":"/api-docs/api-public/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_disputes_list_for_loc","metadata":{"seo":{"title":"Get line of credit purchase disputes","description":"Get line of credit purchase disputes"}},"httpPath":"/people/{personId}/loans/{loanId}/disputes","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get draw purchase disputes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_disputes_list_for_draw","routeSlug":"/api-docs/api-public/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_disputes_list_for_draw","metadata":{"seo":{"title":"Get draw purchase disputes","description":"Get draw purchase disputes"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/disputes","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get draw purchases","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchases_get","routeSlug":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchases_get","metadata":{"seo":{"title":"Get draw purchases","description":"Get draw purchases"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create purchase","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchases_create","routeSlug":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchases_create","metadata":{"seo":{"title":"Create purchase","description":"Create purchase"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get draw purchases timeline","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchases_timeline_get","routeSlug":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchases_timeline_get","metadata":{"seo":{"title":"Get draw purchases timeline","description":"Get draw purchases timeline is designed to provide a sequential ordering of purchases using specific purchase timestamps passed to Peach as part of the query parameters. To generate the timeline, Peach \"inserts\" purchases using the first available timestamp provided in the query parameters. For example, if effectiveAt and authorizedAt are provided in that order, Peach will"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases-timeline","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get purchase by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchase_get_one","routeSlug":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchase_get_one","metadata":{"seo":{"title":"Get purchase by ID","description":"Get purchase by ID"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update purchase","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchase_update","routeSlug":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.draw_purchase_update","metadata":{"seo":{"title":"Update purchase","description":"Update purchase"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get purchase disputes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_disputes_list_for_purchase","routeSlug":"/api-docs/api-public/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_disputes_list_for_purchase","metadata":{"seo":{"title":"Get purchase disputes","description":"Get purchase disputes"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}/disputes","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create purchase dispute","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_dispute_create","routeSlug":"/api-docs/api-public/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_dispute_create","metadata":{"seo":{"title":"Create purchase dispute","description":"Creates a new purchase dispute. Purchases in authorized status may not be disputed. They must firstbe written to the ledger by changing the status of the purchase or creating a new purchase object inpending or settled status. Once one of those steps have been taken, the purchase may be disputed."}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}/disputes","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get purchase dispute by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_dispute_get","routeSlug":"/api-docs/api-public/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_dispute_get","metadata":{"seo":{"title":"Get purchase dispute by ID","description":"Get purchase dispute by ID"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}/disputes/{purchaseDisputeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update purchase dispute","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_dispute_update","routeSlug":"/api-docs/api-public/line-of-credit-purchases/peach.loans.purchase_disputes.handlers.purchase_dispute_update","metadata":{"seo":{"title":"Update purchase dispute","description":"Update purchase dispute"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/purchases/{purchaseId}/disputes/{purchaseDisputeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get line of credit purchases","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.loan_purchases_get","routeSlug":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.loan_purchases_get","metadata":{"seo":{"title":"Get line of credit purchases","description":"Get line of credit purchases"}},"httpPath":"/people/{personId}/loans/{loanId}/purchases","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get line of credit purchases timeline","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.loan_purchases_timeline_get","routeSlug":"/api-docs/api-public/line-of-credit-purchases/peach.people.loans.purchases.handlers.loan_purchases_timeline_get","metadata":{"seo":{"title":"Get line of credit purchases timeline","description":"Get line of credit purchases timeline is designed to provide a sequential ordering of purchases using specific purchase timestamps passed to Peach as part of the query parameters. To generate the timeline, Peach \"inserts\" purchases using the first available timestamp provided in the query parameters. For example, if effectiveAt and authorizedAt are provided in that order, Peach will"}},"httpPath":"/people/{personId}/loans/{loanId}/purchases-timeline","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Line of Credit Migration","link":"/api-docs/api-public/line-of-credit-migration","routeSlug":"/api-docs/api-public/line-of-credit-migration","items":[{"label":"Get migration period draw data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_draw_get","routeSlug":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_draw_get","metadata":{"seo":{"title":"Get migration period draw data","description":"Get migration period draw data"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/migration/period","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create migration period draw data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_draw_create","routeSlug":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_draw_create","metadata":{"seo":{"title":"Create migration period draw data","description":"This endpoint allows you to pass additional details about draws in preparation for migration."}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/migration/period","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update migration period draw data","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_draw_update","routeSlug":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_draw_update","metadata":{"seo":{"title":"Update migration period draw data","description":"Update migration period draw data"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/migration/period","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Delete past period data","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_periods.handlers.past_periods_data_delete","routeSlug":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_periods.handlers.past_periods_data_delete","metadata":{"seo":{"title":"Delete past period data","description":"Deletes past period in preparation for migration."}},"httpPath":"/people/{personId}/loans/{loanId}/migration/past-periods","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get past period data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_periods.handlers.past_periods_data_list","routeSlug":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_periods.handlers.past_periods_data_list","metadata":{"seo":{"title":"Get past period data","description":"Get past period in preparation for migration."}},"httpPath":"/people/{personId}/loans/{loanId}/migration/past-periods","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create past periods data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_periods.handlers.past_periods_data_create","routeSlug":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_periods.handlers.past_periods_data_create","metadata":{"seo":{"title":"Create past periods data","description":"Creates past periods in preparation for migration."}},"httpPath":"/people/{personId}/loans/{loanId}/migration/past-periods","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update past period data","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_periods.handlers.past_periods_data_update","routeSlug":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_periods.handlers.past_periods_data_update","metadata":{"seo":{"title":"Update past period data","description":"Updates past period in preparation for migration."}},"httpPath":"/people/{personId}/loans/{loanId}/migration/past-periods","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get past transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_transactions.handlers.past_transaction_data_get_all","routeSlug":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_transactions.handlers.past_transaction_data_get_all","metadata":{"seo":{"title":"Get past transactions","description":"Get past transactions"}},"httpPath":"/people/{personId}/loans/{loanId}/migration/past-transaction","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create past transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_transactions.handlers.past_transaction_data_create","routeSlug":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_transactions.handlers.past_transaction_data_create","metadata":{"seo":{"title":"Create past transaction","description":"Creates past transaction in preparation for line of credit migration."}},"httpPath":"/people/{personId}/loans/{loanId}/migration/past-transaction","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get past transaction by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_transactions.handlers.past_transaction_data_get_one","routeSlug":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_transactions.handlers.past_transaction_data_get_one","metadata":{"seo":{"title":"Get past transaction by ID","description":"Get past transaction by ID"}},"httpPath":"/people/{personId}/loans/{loanId}/migration/past-transaction/{transactionId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update past transaction","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_transactions.handlers.past_transaction_data_update","routeSlug":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.past_transactions.handlers.past_transaction_data_update","metadata":{"seo":{"title":"Update past transaction","description":"Update past transaction in preparation for line of credit migration."}},"httpPath":"/people/{personId}/loans/{loanId}/migration/past-transaction/{transactionId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get migration period LOC data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_loc_get","routeSlug":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_loc_get","metadata":{"seo":{"title":"Get migration period LOC data","description":"Get migration period LOC data"}},"httpPath":"/people/{personId}/loans/{loanId}/migration/period","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create migration period LOC data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_loc_create","routeSlug":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_loc_create","metadata":{"seo":{"title":"Create migration period LOC data","description":"This endpoint allows you to pass additional details about the line in preparation for migration."}},"httpPath":"/people/{personId}/loans/{loanId}/migration/period","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update migration period LOC data","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_loc_update","routeSlug":"/api-docs/api-public/line-of-credit-migration/peach.loans.migration.migration_period.handlers.migration_period_loc_update","metadata":{"seo":{"title":"Update migration period LOC data","description":"Update migration period LOC data"}},"httpPath":"/people/{personId}/loans/{loanId}/migration/period","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Expected Payments","link":"/api-docs/api-public/expected-payments","routeSlug":"/api-docs/api-public/expected-payments","items":[{"label":"Defer installment single due date","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.loan_due_date_defer","routeSlug":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.loan_due_date_defer","metadata":{"seo":{"title":"Defer installment single due date","description":"Defer single due date takes the amount in a selected due date and defers the amount to another due date in the future. The deferral amount can be moved to an existing due date or alternatively, to a new due date added after the last existing due date. These two options are mutually exclusive."}},"httpPath":"/people/{personId}/loans/{loanId}/defer-due-date","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Defer installment schedule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.loan_schedule_defer","routeSlug":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.loan_schedule_defer","metadata":{"seo":{"title":"Defer installment schedule","description":"Defer schedule allows lenders to shift the entire expected payments schedule. There are two use cases:"}},"httpPath":"/people/{personId}/loans/{loanId}/defer-schedule","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get draw expected payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.draw_expected_payments_get","routeSlug":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.draw_expected_payments_get","metadata":{"seo":{"title":"Get draw expected payments","description":"Get draw expected payments"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/expected-payments","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Defer remaining balances for a draw","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.defer_remaining_draw_balances","routeSlug":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.defer_remaining_draw_balances","metadata":{"seo":{"title":"Defer remaining balances for a draw","description":"Defer draw single or multiple due dates. The selected due dates to defer can only be due dates for which the statement was already generated. Past due dates should always have statements. Upcoming due date can only be selected if the statement was already generated."}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/expected-payments/defer-remaining-balances","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get loan expected payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.loan_expected_payments_get","routeSlug":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.loan_expected_payments_get","metadata":{"seo":{"title":"Get loan expected payments","description":"Get loan expected payments"}},"httpPath":"/people/{personId}/loans/{loanId}/expected-payments","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Change due dates schedule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.loan_change_due_dates_schedule_post","routeSlug":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.loan_change_due_dates_schedule_post","metadata":{"seo":{"title":"Change due dates schedule","description":"Change due date allows the customer to change the frequency of a loan and/or the specific day(s) thatdue dates will fall on. This is not supported for loans with periodCalculationType=statementDate."}},"httpPath":"/people/{personId}/loans/{loanId}/expected-payments","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Defer remaining balances for all active draws","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.defer_remaining_loc_balances","routeSlug":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.defer_remaining_loc_balances","metadata":{"seo":{"title":"Defer remaining balances for all active draws","description":"Defer line of credit single or multiple due dates. The system will defer amounts across the line of credit and all draws. The selected due dates to defer can only be due dates for which the statement was already generated. Past due dates should always have statements. Upcoming due date can only be selected if the statement was already generated."}},"httpPath":"/people/{personId}/loans/{loanId}/expected-payments/defer-remaining-balances","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Change installment loan terms","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.loan_change_terms","routeSlug":"/api-docs/api-public/expected-payments/peach.people.loans.expected_payments.handlers.loan_change_terms","metadata":{"seo":{"title":"Change installment loan terms","description":"Change loan terms creates a customer payment plan for the borrower. There are several options:"}},"httpPath":"/people/{personId}/loans/{loanId}/payment-plan","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Obligations","link":"/api-docs/api-public/obligations","routeSlug":"/api-docs/api-public/obligations","items":[{"label":"Get draw obligations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/obligations/peach.obligations.handlers.draw_obligations_get_all","routeSlug":"/api-docs/api-public/obligations/peach.obligations.handlers.draw_obligations_get_all","metadata":{"seo":{"title":"Get draw obligations","description":"Get draw obligations"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/obligations","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get draw obligation by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/obligations/peach.obligations.handlers.draw_obligation_get_by_id","routeSlug":"/api-docs/api-public/obligations/peach.obligations.handlers.draw_obligation_get_by_id","metadata":{"seo":{"title":"Get draw obligation by ID","description":"Get draw obligation by ID"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/obligations/{obligationId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get loan obligations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/obligations/peach.obligations.handlers.obligations_get_all","routeSlug":"/api-docs/api-public/obligations/peach.obligations.handlers.obligations_get_all","metadata":{"seo":{"title":"Get loan obligations","description":"Get loan obligations"}},"httpPath":"/people/{personId}/loans/{loanId}/obligations","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get loan obligation by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/obligations/peach.obligations.handlers.obligation_get_by_id","routeSlug":"/api-docs/api-public/obligations/peach.obligations.handlers.obligation_get_by_id","metadata":{"seo":{"title":"Get loan obligation by ID","description":"Get loan obligation by ID"}},"httpPath":"/people/{personId}/loans/{loanId}/obligations/{obligationId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Periods","link":"/api-docs/api-public/periods","routeSlug":"/api-docs/api-public/periods","items":[{"label":"Get loan periods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/periods/peach.people.loans.handlers.get_loan_periods","routeSlug":"/api-docs/api-public/periods/peach.people.loans.handlers.get_loan_periods","metadata":{"seo":{"title":"Get loan periods","description":"Returns loan's payment periods."}},"httpPath":"/people/{personId}/loans/{loanId}/periods","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get loan period by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/periods/peach.people.loans.handlers.get_loan_period_by_id","routeSlug":"/api-docs/api-public/periods/peach.people.loans.handlers.get_loan_period_by_id","metadata":{"seo":{"title":"Get loan period by id","description":"Returns a single loan period"}},"httpPath":"/people/{personId}/loans/{loanId}/periods/{loanPeriodId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Payment Plans","link":"/api-docs/api-public/payment-plans","routeSlug":"/api-docs/api-public/payment-plans","items":[{"label":"Get payment plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-plans/peach.people.loans.handlers.loan_custom_payment_plan_get","routeSlug":"/api-docs/api-public/payment-plans/peach.people.loans.handlers.loan_custom_payment_plan_get","metadata":{"seo":{"title":"Get payment plans","description":"Returns all payment plans associated with a loan."}},"httpPath":"/people/{personId}/loans/{loanId}/custom-payment-plans","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create payment plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-plans/peach.people.loans.expected_payments.handlers.loan_custom_payment_plan_create","routeSlug":"/api-docs/api-public/payment-plans/peach.people.loans.expected_payments.handlers.loan_custom_payment_plan_create","metadata":{"seo":{"title":"Create payment plan","description":"Creates a custom payment plan for the borrower. numberOfPeriods is required. If paymentPlanType=fixedAmountAndFees,then the amount is required."}},"httpPath":"/people/{personId}/loans/{loanId}/custom-payment-plans","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get payment plan by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-plans/peach.people.loans.handlers.loan_custom_payment_plan_get_by_id","routeSlug":"/api-docs/api-public/payment-plans/peach.people.loans.handlers.loan_custom_payment_plan_get_by_id","metadata":{"seo":{"title":"Get payment plan by id","description":"Return a single payment plan."}},"httpPath":"/people/{personId}/loans/{loanId}/custom-payment-plans/{paymentPlanId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Cancel payment plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-plans/peach.people.loans.handlers.loan_custom_payment_plan_cancel","routeSlug":"/api-docs/api-public/payment-plans/peach.people.loans.handlers.loan_custom_payment_plan_cancel","metadata":{"seo":{"title":"Cancel payment plan","description":"Use this endpoint to cancel a payment plan. Any existing payment plan must be canceled prior to creating a new payment plan. After canceling a payment plan, Peach's system will revert the loan schedule (from the current period onwards) to the previous recurring payment amount and frequency prior to creating the payment plan."}},"httpPath":"/people/{personId}/loans/{loanId}/custom-payment-plans/{paymentPlanId}/cancel","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"SCRA","link":"/api-docs/api-public/scra","routeSlug":"/api-docs/api-public/scra","items":[{"label":"Delete line of credit loan terms SCRA","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/scra/peach.people.loans.expected_payments.handlers.loc_change_terms_scra_delete","routeSlug":"/api-docs/api-public/scra/peach.people.loans.expected_payments.handlers.loc_change_terms_scra_delete","metadata":{"seo":{"title":"Delete line of credit loan terms SCRA","description":"Removes a single SCRA interest rate (interestType=AbsoluteScra) on a line of credit loan."}},"httpPath":"/people/{personId}/loans/{loanId}/loc-payment-plan-scra","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create line of credit loan terms SCRA","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/scra/peach.people.loans.expected_payments.handlers.loc_change_terms_scra_create","routeSlug":"/api-docs/api-public/scra/peach.people.loans.expected_payments.handlers.loc_change_terms_scra_create","metadata":{"seo":{"title":"Create line of credit loan terms SCRA","description":"Creates SCRA (Servicemembers Civil Relief Act) terms for a line of credit loan."}},"httpPath":"/people/{personId}/loans/{loanId}/loc-payment-plan-scra","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Change line of credit loan terms SCRA","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/scra/peach.people.loans.expected_payments.handlers.loc_change_terms_scra_update","routeSlug":"/api-docs/api-public/scra/peach.people.loans.expected_payments.handlers.loc_change_terms_scra_update","metadata":{"seo":{"title":"Change line of credit loan terms SCRA","description":"Modifies the start date or end date of a single SCRA interest rate (interestType=AbsoluteScra)on a line of credit loan."}},"httpPath":"/people/{personId}/loans/{loanId}/loc-payment-plan-scra","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Delete installment loan terms SCRA","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/scra/peach.people.loans.expected_payments.handlers.loan_change_terms_scra_delete","routeSlug":"/api-docs/api-public/scra/peach.people.loans.expected_payments.handlers.loan_change_terms_scra_delete","metadata":{"seo":{"title":"Delete installment loan terms SCRA","description":"This endpoint is used for removing a single SCRA interest rate (interestType=AbsoluteScra) on a loan. Only applicable to installment loans."}},"httpPath":"/people/{personId}/loans/{loanId}/payment-plan-scra","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create installment loan terms SCRA","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/scra/peach.people.loans.expected_payments.handlers.loan_change_terms_scra_create","routeSlug":"/api-docs/api-public/scra/peach.people.loans.expected_payments.handlers.loan_change_terms_scra_create","metadata":{"seo":{"title":"Create installment loan terms SCRA","description":"Creates a customer payment plan for the borrower in accordance with SCRA regulations. Only applicable to installment loans."}},"httpPath":"/people/{personId}/loans/{loanId}/payment-plan-scra","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Change installment loan terms SCRA","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/scra/peach.people.loans.expected_payments.handlers.loan_change_terms_scra_update","routeSlug":"/api-docs/api-public/scra/peach.people.loans.expected_payments.handlers.loan_change_terms_scra_update","metadata":{"seo":{"title":"Change installment loan terms SCRA","description":"This endpoint is used for modifying the start date or end date of a single SCRA interest rate (interestType=AbsoluteScra).Only applicable to installment loans."}},"httpPath":"/people/{personId}/loans/{loanId}/payment-plan-scra","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Promise to Pay Plans","link":"/api-docs/api-public/promise-to-pay-plans","routeSlug":"/api-docs/api-public/promise-to-pay-plans","items":[{"label":"Evaluate Promise to Pay Plan, does not require personId","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.internal_evaluate_promise_to_pay_plan","routeSlug":"/api-docs/api-public/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.internal_evaluate_promise_to_pay_plan","metadata":{"seo":{"title":"Evaluate Promise to Pay Plan, does not require personId","description":"Evaluates a Promise to Pay Plan and updates the status and isOverdue of the Promise to Pay Plan."}},"httpPath":"/companies/{companyId}/loans/{loanId}/promise-to-pay-plans/{promiseToPayPlanId}/evaluate","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get Promise to Pay Plans for a Loan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.get_promise_to_pay_plans_by_loan","routeSlug":"/api-docs/api-public/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.get_promise_to_pay_plans_by_loan","metadata":{"seo":{"title":"Get Promise to Pay Plans for a Loan","description":"Returns Promise to Pay Plans for a given Loan."}},"httpPath":"/people/{personId}/loans/{loanId}/promise-to-pay-plans","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create Promise to Pay Plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.create_promise_to_pay_plan","routeSlug":"/api-docs/api-public/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.create_promise_to_pay_plan","metadata":{"seo":{"title":"Create Promise to Pay Plan","description":"Creates a new Promise to Pay Plan."}},"httpPath":"/people/{personId}/loans/{loanId}/promise-to-pay-plans","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get Promise to Pay Plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.get_promise_to_pay_plan","routeSlug":"/api-docs/api-public/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.get_promise_to_pay_plan","metadata":{"seo":{"title":"Get Promise to Pay Plan","description":"Returns a Promise to Pay Plan for a given Loan."}},"httpPath":"/people/{personId}/loans/{loanId}/promise-to-pay-plans/{promiseToPayPlanId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Cancel Promise to Pay Plan","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.cancel_promise_to_pay_plan","routeSlug":"/api-docs/api-public/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.cancel_promise_to_pay_plan","metadata":{"seo":{"title":"Cancel Promise to Pay Plan","description":"Cancels a Promise to Pay Plan."}},"httpPath":"/people/{personId}/loans/{loanId}/promise-to-pay-plans/{promiseToPayPlanId}/cancel","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Evaluate Promise to Pay Plan","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.evaluate_promise_to_pay_plan","routeSlug":"/api-docs/api-public/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.evaluate_promise_to_pay_plan","metadata":{"seo":{"title":"Evaluate Promise to Pay Plan","description":"Evaluates a Promise to Pay Plan and updates the status and isOverdue of the Promise to Pay Plan."}},"httpPath":"/people/{personId}/loans/{loanId}/promise-to-pay-plans/{promiseToPayPlanId}/evaluate","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get Promise to Pay Plans for a company","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.get_promise_to_pay_plans_by_company","routeSlug":"/api-docs/api-public/promise-to-pay-plans/peach.loans.promise_to_pays.handlers.get_promise_to_pay_plans_by_company","metadata":{"seo":{"title":"Get Promise to Pay Plans for a company","description":"Returns Promise to Pay Plans for a given company."}},"httpPath":"/promise-to-pay-plans","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Fees","link":"/api-docs/api-public/fees","routeSlug":"/api-docs/api-public/fees","items":[{"label":"Get fee types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/fees/peach.people.loans.fees.handlers.fee_types_get","routeSlug":"/api-docs/api-public/fees/peach.people.loans.fees.handlers.fee_types_get","metadata":{"seo":{"title":"Get fee types","description":"Get fee types"}},"httpPath":"/loan-types/{loanTypeId}/fee-types","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Cancel dynamic fees","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/fees/peach.people.loans.fees.handlers.fees_cancel","routeSlug":"/api-docs/api-public/fees/peach.people.loans.fees.handlers.fees_cancel","metadata":{"seo":{"title":"Cancel dynamic fees","description":"Cancel dynamic fees"}},"httpPath":"/people/{personId}/loans/{loanId}/cancel-fees","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update draw fee","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/fees/peach.people.loans.handlers.update_draw_fee","routeSlug":"/api-docs/api-public/fees/peach.people.loans.handlers.update_draw_fee","metadata":{"seo":{"title":"Update draw fee","description":"This endpoint allows lenders to change the draw fee amount. The system will update the draw fee amount and replay the loan from the draw activation date."}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/fees/draw","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get fees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/fees/peach.people.loans.fees.handlers.fees_get","routeSlug":"/api-docs/api-public/fees/peach.people.loans.fees.handlers.fees_get","metadata":{"seo":{"title":"Get fees","description":"Get fees"}},"httpPath":"/people/{personId}/loans/{loanId}/fees","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Charge dynamic fee","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/fees/peach.people.loans.fees.handlers.fees_post","routeSlug":"/api-docs/api-public/fees/peach.people.loans.fees.handlers.fees_post","metadata":{"seo":{"title":"Charge dynamic fee","description":"Charge dynamic fee"}},"httpPath":"/people/{personId}/loans/{loanId}/fees","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update origination fee","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/fees/peach.people.loans.handlers.update_origination_fee","routeSlug":"/api-docs/api-public/fees/peach.people.loans.handlers.update_origination_fee","metadata":{"seo":{"title":"Update origination fee","description":"This endpoint allows lenders to change the origination fee amount. The system will update the origination fee amount and replay the loan from the activation date."}},"httpPath":"/people/{personId}/loans/{loanId}/fees/origination","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update dynamic fee","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/fees/peach.people.loans.fees.handlers.dynamic_fee_update","routeSlug":"/api-docs/api-public/fees/peach.people.loans.fees.handlers.dynamic_fee_update","metadata":{"seo":{"title":"Update dynamic fee","description":"Update dynamic fee"}},"httpPath":"/people/{personId}/loans/{loanId}/fees/{loanFeeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Cancel dynamic fee","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/fees/peach.people.loans.fees.handlers.fees_cancel_one","routeSlug":"/api-docs/api-public/fees/peach.people.loans.fees.handlers.fees_cancel_one","metadata":{"seo":{"title":"Cancel dynamic fee","description":"Cancel dynamic fee"}},"httpPath":"/people/{personId}/loans/{loanId}/fees/{loanFeeId}/cancel","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Rates","link":"/api-docs/api-public/rates","routeSlug":"/api-docs/api-public/rates","items":[{"label":"Get draw effective rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rates/peach.people.loans.handlers.draw_effective_rates_get","routeSlug":"/api-docs/api-public/rates/peach.people.loans.handlers.draw_effective_rates_get","metadata":{"seo":{"title":"Get draw effective rates","description":"This endpoint returns rates details of a draw for a given date(s).Interest rates:If two or more interest rates are active on the same date (aka overlap), the Peach system selects the lowest rate (also called effective rate) to accrue interest.Promo rates:If two or more promo rates are active on the same date (aka overlap), the Peach system sums up the rates as \"effective\" promo rate."}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/effective-rates","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get draw rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rates/peach.people.loans.handlers.draw_rates_get","routeSlug":"/api-docs/api-public/rates/peach.people.loans.handlers.draw_rates_get","metadata":{"seo":{"title":"Get draw rates","description":"Get draw rates"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/rates","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Add draw rate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rates/peach.people.loans.handlers.draw_rates_add","routeSlug":"/api-docs/api-public/rates/peach.people.loans.handlers.draw_rates_add","metadata":{"seo":{"title":"Add draw rate","description":"This endpoint is used for adding rates. A draw can have multiple rates. If two or more interestRate overlap on the same datewe use the lowest value. If two or more promoRate overlap on the same date, we take the sum of the promo rates for the givenday, and cap this rate at the maximum interest rate for the given day (to avoid accruing negative interest)."}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/rates","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Remove draw rate","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rates/peach.people.loans.handlers.draw_rates_delete","routeSlug":"/api-docs/api-public/rates/peach.people.loans.handlers.draw_rates_delete","metadata":{"seo":{"title":"Remove draw rate","description":"This endpoint is used for removing a single interest or promo rate. The deletion of aninterest rate cannot lead to a gap in the loan where there is no reference rate."}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/rates/{rateId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update draw rate","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rates/peach.people.loans.handlers.draw_rates_update","routeSlug":"/api-docs/api-public/rates/peach.people.loans.handlers.draw_rates_update","metadata":{"seo":{"title":"Update draw rate","description":"This endpoint is used for updating a single interest or promo rate (don't pass both in the same call). The updating of aninterest rate cannot lead to a gap in the loan where there is no reference interest rate."}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/rates/{rateId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get loan effective rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rates/peach.people.loans.handlers.loan_effective_rates_get","routeSlug":"/api-docs/api-public/rates/peach.people.loans.handlers.loan_effective_rates_get","metadata":{"seo":{"title":"Get loan effective rates","description":"This endpoint returns rates details of a loan for given date(s)."}},"httpPath":"/people/{personId}/loans/{loanId}/effective-rates","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get loan rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rates/peach.people.loans.handlers.loan_rates_get","routeSlug":"/api-docs/api-public/rates/peach.people.loans.handlers.loan_rates_get","metadata":{"seo":{"title":"Get loan rates","description":"Get loan rates"}},"httpPath":"/people/{personId}/loans/{loanId}/rates","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Add loan rate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rates/peach.people.loans.handlers.loan_rates_add","routeSlug":"/api-docs/api-public/rates/peach.people.loans.handlers.loan_rates_add","metadata":{"seo":{"title":"Add loan rate","description":"This endpoint is used for adding rates. A loan can have multiple rates. If two or more interestRateoverlap on the same date we use the lowest value. If two or more promoRate overlap on the same date, wetake the sum of the promo rates for the given day, and cap this rate at the maximum interest rate for thegiven day (to avoid accruing negative interest)."}},"httpPath":"/people/{personId}/loans/{loanId}/rates","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Remove loan rate","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rates/peach.people.loans.handlers.loan_rates_delete","routeSlug":"/api-docs/api-public/rates/peach.people.loans.handlers.loan_rates_delete","metadata":{"seo":{"title":"Remove loan rate","description":"This endpoint is used for removing a single interest or promo rate. The deletion of aninterest rate cannot lead to a gap in the loan where there is no reference rate."}},"httpPath":"/people/{personId}/loans/{loanId}/rates/{rateId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update loan rate","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rates/peach.people.loans.handlers.loan_rates_update","routeSlug":"/api-docs/api-public/rates/peach.people.loans.handlers.loan_rates_update","metadata":{"seo":{"title":"Update loan rate","description":"This endpoint is used for updating a single interest or promo rate. (don't pass both in the same call). The updating of aninterest rate cannot lead to a gap in the loan where there is no reference interest rate."}},"httpPath":"/people/{personId}/loans/{loanId}/rates/{rateId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Rate Caps","link":"/api-docs/api-public/rate-caps","routeSlug":"/api-docs/api-public/rate-caps","items":[{"label":"Get draw rate caps","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.draw_rate_caps_get","routeSlug":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.draw_rate_caps_get","metadata":{"seo":{"title":"Get draw rate caps","description":"Get draw rate caps"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/rate-caps","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Add draw rate cap","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.draw_rate_cap_add","routeSlug":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.draw_rate_cap_add","metadata":{"seo":{"title":"Add draw rate cap","description":"This endpoint is used for adding rate caps to a draw. If two ormore rate caps overlap on the same date, we will use the lowest value.This defines the maximum interest rate that can accrue on a drawto ensure interest accrual never exceeds the cap. You can define thestartDate and endDate for each rate cap."}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/rate-caps","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Delete draw rate cap","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.draw_rate_cap_delete","routeSlug":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.draw_rate_cap_delete","metadata":{"seo":{"title":"Delete draw rate cap","description":"This endpoint is used for removing a single rate cap on a draw."}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/rate-caps/{rateCapId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update draw rate cap","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.draw_rate_cap_update","routeSlug":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.draw_rate_cap_update","metadata":{"seo":{"title":"Update draw rate cap","description":"This endpoint is used for updating a single rate cap on a draw."}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/rate-caps/{rateCapId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get loan rate caps","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.loan_rate_caps_get","routeSlug":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.loan_rate_caps_get","metadata":{"seo":{"title":"Get loan rate caps","description":"Get loan rate caps"}},"httpPath":"/people/{personId}/loans/{loanId}/rate-caps","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Add loan rate cap","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.loan_rate_cap_add","routeSlug":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.loan_rate_cap_add","metadata":{"seo":{"title":"Add loan rate cap","description":"This endpoint is used for adding rate caps to a loan. If two ormore rate caps overlap on the same date, we will use the lowest value.This defines the maximum interest rate that can accrue on a loanto ensure interest accrual never exceeds the cap. You can define thestartDate and endDate for each rate cap."}},"httpPath":"/people/{personId}/loans/{loanId}/rate-caps","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Delete loan rate cap","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.loan_rate_cap_delete","routeSlug":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.loan_rate_cap_delete","metadata":{"seo":{"title":"Delete loan rate cap","description":"This endpoint is used for removing a single rate cap on a loan."}},"httpPath":"/people/{personId}/loans/{loanId}/rate-caps/{rateCapId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update loan rate cap","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.loan_rate_cap_update","routeSlug":"/api-docs/api-public/rate-caps/peach.loans.rate_caps.handlers.loan_rate_cap_update","metadata":{"seo":{"title":"Update loan rate cap","description":"This endpoint is used for updating a single rate cap on a loan."}},"httpPath":"/people/{personId}/loans/{loanId}/rate-caps/{rateCapId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Transactions","link":"/api-docs/api-public/transactions","routeSlug":"/api-docs/api-public/transactions","items":[{"label":"Get transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/transactions/peach.transactions.handlers.loan_transactions_get_all","routeSlug":"/api-docs/api-public/transactions/peach.transactions.handlers.loan_transactions_get_all","metadata":{"seo":{"title":"Get transactions","description":"Get transactions"}},"httpPath":"/people/{personId}/loans/{loanId}/transactions","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/transactions/peach.transactions.handlers.transactions_create","routeSlug":"/api-docs/api-public/transactions/peach.transactions.handlers.transactions_create","metadata":{"seo":{"title":"Create transaction","description":"Create a transaction. Permissions required depend on the object type passed:"}},"httpPath":"/people/{personId}/loans/{loanId}/transactions","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Fail multiple transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/transactions/peach.transactions.handlers.transactions_fail_multiple","routeSlug":"/api-docs/api-public/transactions/peach.transactions.handlers.transactions_fail_multiple","metadata":{"seo":{"title":"Fail multiple transactions","description":"This endpoint allows you to fail multiple transactions in one call. The system will mark applicable transactions asfailed and replay the loan once (starting from the earliest effective date of the provided transactions)."}},"httpPath":"/people/{personId}/loans/{loanId}/transactions/fail","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get transaction by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/transactions/peach.transactions.handlers.transactions_get_by_id","routeSlug":"/api-docs/api-public/transactions/peach.transactions.handlers.transactions_get_by_id","metadata":{"seo":{"title":"Get transaction by ID","description":"Get transaction by ID"}},"httpPath":"/people/{personId}/loans/{loanId}/transactions/{transactionId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update transaction","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/transactions/peach.transactions.handlers.transactions_update","routeSlug":"/api-docs/api-public/transactions/peach.transactions.handlers.transactions_update","metadata":{"seo":{"title":"Update transaction","description":"Update transaction"}},"httpPath":"/people/{personId}/loans/{loanId}/transactions/{transactionId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Backdate transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/transactions/peach.transactions.handlers.transaction_backdate","routeSlug":"/api-docs/api-public/transactions/peach.transactions.handlers.transaction_backdate","metadata":{"seo":{"title":"Backdate transaction","description":"Backdate a transaction. Can only be applied to transactions with status=succeeded or status=pending. Can be applied to payments or service credits."}},"httpPath":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/backdate","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Cancel transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/transactions/peach.transactions.handlers.transaction_cancel","routeSlug":"/api-docs/api-public/transactions/peach.transactions.handlers.transaction_cancel","metadata":{"seo":{"title":"Cancel transaction","description":"Cancel transaction"}},"httpPath":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/cancel","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get transaction chargebacks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/transactions/peach.transactions.chargebacks.handlers.get_chargebacks","routeSlug":"/api-docs/api-public/transactions/peach.transactions.chargebacks.handlers.get_chargebacks","metadata":{"seo":{"title":"Get transaction chargebacks","description":"Get transaction chargebacks"}},"httpPath":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/chargebacks","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create transaction chargeback","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/transactions/peach.transactions.chargebacks.handlers.transaction_chargeback","routeSlug":"/api-docs/api-public/transactions/peach.transactions.chargebacks.handlers.transaction_chargeback","metadata":{"seo":{"title":"Create transaction chargeback","description":"In some cases a borrower might chargeback/dispute a payment that they made in the past. Only transactions in succeeded status can be charged back."}},"httpPath":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/chargebacks","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get chargeback by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/transactions/peach.transactions.chargebacks.handlers.get_chargeback_by_id","routeSlug":"/api-docs/api-public/transactions/peach.transactions.chargebacks.handlers.get_chargeback_by_id","metadata":{"seo":{"title":"Get chargeback by ID","description":"Get chargeback by ID"}},"httpPath":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/chargebacks/{chargebackId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update chargeback","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/transactions/peach.transactions.chargebacks.handlers.update_chargeback","routeSlug":"/api-docs/api-public/transactions/peach.transactions.chargebacks.handlers.update_chargeback","metadata":{"seo":{"title":"Update chargeback","description":"Update chargeback"}},"httpPath":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/chargebacks/{chargebackId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Reverse transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/transactions/peach.transactions.handlers.transaction_reverse","routeSlug":"/api-docs/api-public/transactions/peach.transactions.handlers.transaction_reverse","metadata":{"seo":{"title":"Reverse transaction","description":"Reverse transaction"}},"httpPath":"/people/{personId}/loans/{loanId}/transactions/{transactionId}/reverse","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Statements","link":"/api-docs/api-public/statements","routeSlug":"/api-docs/api-public/statements","items":[{"label":"Generate statement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/statements/peach.statements.handlers.generate_statement","routeSlug":"/api-docs/api-public/statements/peach.statements.handlers.generate_statement","metadata":{"seo":{"title":"Generate statement","description":"Generates a statement, and if one already exists, replaces the older one as the active one.If sync=true is passed, the server will try to wait up to 20 seconds for the statementcreation to finish. If it finishes in time, it will return the statement object.Otherwise, it will return nothing."}},"httpPath":"/people/{personId}/loans/{loanId}/periods/{periodId}/generate-statement","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get statements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/statements/peach.statements.handlers.get_statements","routeSlug":"/api-docs/api-public/statements/peach.statements.handlers.get_statements","metadata":{"seo":{"title":"Get statements","description":"Get statements"}},"httpPath":"/people/{personId}/loans/{loanId}/statements","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update statement","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/statements/peach.statements.handlers.update_statement","routeSlug":"/api-docs/api-public/statements/peach.statements.handlers.update_statement","metadata":{"seo":{"title":"Update statement","description":"Update statement"}},"httpPath":"/people/{personId}/loans/{loanId}/statements/{statementId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get statement details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/statements/peach.statements.handlers.get_statement_details","routeSlug":"/api-docs/api-public/statements/peach.statements.handlers.get_statement_details","metadata":{"seo":{"title":"Get statement details","description":"Get statement details"}},"httpPath":"/people/{personId}/loans/{loanId}/statements/{statementId}/details","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Autopay","link":"/api-docs/api-public/autopay","routeSlug":"/api-docs/api-public/autopay","items":[{"label":"Cancel Autopay plan","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/autopay/peach.people.loans.autopay.handlers.loan_autopay_delete","routeSlug":"/api-docs/api-public/autopay/peach.people.loans.autopay.handlers.loan_autopay_delete","metadata":{"seo":{"title":"Cancel Autopay plan","description":"Cancel Autopay plan"}},"httpPath":"/people/{personId}/loans/{loanId}/autopay","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get Autopay plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/autopay/peach.people.loans.autopay.handlers.loan_autopay_get","routeSlug":"/api-docs/api-public/autopay/peach.people.loans.autopay.handlers.loan_autopay_get","metadata":{"seo":{"title":"Get Autopay plan","description":"Get Autopay plan"}},"httpPath":"/people/{personId}/loans/{loanId}/autopay","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create Autopay plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/autopay/peach.people.loans.autopay.handlers.loan_autopay_post","routeSlug":"/api-docs/api-public/autopay/peach.people.loans.autopay.handlers.loan_autopay_post","metadata":{"seo":{"title":"Create Autopay plan","description":"Create Autopay plan"}},"httpPath":"/people/{personId}/loans/{loanId}/autopay","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update Autopay plan","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/autopay/peach.people.loans.autopay.handlers.loan_autopay_put","routeSlug":"/api-docs/api-public/autopay/peach.people.loans.autopay.handlers.loan_autopay_put","metadata":{"seo":{"title":"Update Autopay plan","description":"Update Autopay plan"}},"httpPath":"/people/{personId}/loans/{loanId}/autopay","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Balances","link":"/api-docs/api-public/balances","routeSlug":"/api-docs/api-public/balances","items":[{"label":"Get loan balances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/balances/peach.people.loans.balances.handlers.loan_balances_get","routeSlug":"/api-docs/api-public/balances/peach.people.loans.balances.handlers.loan_balances_get","metadata":{"seo":{"title":"Get loan balances","description":"Get loan balances"}},"httpPath":"/people/{personId}/loans/{loanId}/balances","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get draw balances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/balances/peach.people.loans.balances.handlers.draw_balances_get","routeSlug":"/api-docs/api-public/balances/peach.people.loans.balances.handlers.draw_balances_get","metadata":{"seo":{"title":"Get draw balances","description":"Get draw balances"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/balances","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get draw future balances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/balances/peach.people.loans.balances.handlers.draw_future_balances_get","routeSlug":"/api-docs/api-public/balances/peach.people.loans.balances.handlers.draw_future_balances_get","metadata":{"seo":{"title":"Get draw future balances","description":"Get draw future balances"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/future-balances","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get loan future balances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/balances/peach.people.loans.balances.handlers.loan_future_balances_get","routeSlug":"/api-docs/api-public/balances/peach.people.loans.balances.handlers.loan_future_balances_get","metadata":{"seo":{"title":"Get loan future balances","description":"Get loan future balances"}},"httpPath":"/people/{personId}/loans/{loanId}/future-balances","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get loan interest","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/balances/peach.people.loans.handlers.loan_interest_get","routeSlug":"/api-docs/api-public/balances/peach.people.loans.handlers.loan_interest_get","metadata":{"seo":{"title":"Get loan interest","description":"Get loan interest"}},"httpPath":"/people/{personId}/loans/{loanId}/interest","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Credit Reporting","link":"/api-docs/api-public/credit-reporting","routeSlug":"/api-docs/api-public/credit-reporting","items":[{"label":"Get credit reporting statuses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/credit-reporting/peach.credit_reporting.handlers.credit_reporting_statuses_list","routeSlug":"/api-docs/api-public/credit-reporting/peach.credit_reporting.handlers.credit_reporting_statuses_list","metadata":{"seo":{"title":"Get credit reporting statuses","description":"Get credit reporting statuses"}},"httpPath":"/people/{personId}/loans/{loanId}/credit-reporting","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Start credit reporting","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/credit-reporting/peach.credit_reporting.handlers.credit_reporting_status_create","routeSlug":"/api-docs/api-public/credit-reporting/peach.credit_reporting.handlers.credit_reporting_status_create","metadata":{"seo":{"title":"Start credit reporting","description":"Sets the starting date to begin reporting credit history for the loan."}},"httpPath":"/people/{personId}/loans/{loanId}/credit-reporting","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update reporting fields","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/credit-reporting/peach.credit_reporting.handlers.credit_reporting_fields_update","routeSlug":"/api-docs/api-public/credit-reporting/peach.credit_reporting.handlers.credit_reporting_fields_update","metadata":{"seo":{"title":"Update reporting fields","description":"Sets loan-level credit reporting fields"}},"httpPath":"/people/{personId}/loans/{loanId}/credit-reporting","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Delete from credit reporting","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/credit-reporting/peach.credit_reporting.handlers.credit_reporting_status_delete","routeSlug":"/api-docs/api-public/credit-reporting/peach.credit_reporting.handlers.credit_reporting_status_delete","metadata":{"seo":{"title":"Delete from credit reporting","description":"Delete from credit reporting"}},"httpPath":"/people/{personId}/loans/{loanId}/credit-reporting/{creditAgencyId}/delete","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Loan Investors","link":"/api-docs/api-public/loansinvestors","routeSlug":"/api-docs/api-public/loansinvestors","items":[{"label":"Get loan investors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loansinvestors/peach.people.loans.handlers.loan_investors_get_all","routeSlug":"/api-docs/api-public/loansinvestors/peach.people.loans.handlers.loan_investors_get_all","metadata":{"seo":{"title":"Get loan investors","description":"Get loan investors"}},"httpPath":"/people/{personId}/loans/{loanId}/investors","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update loan investors","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loansinvestors/peach.people.loans.handlers.loan_investors_update","routeSlug":"/api-docs/api-public/loansinvestors/peach.people.loans.handlers.loan_investors_update","metadata":{"seo":{"title":"Update loan investors","description":"Update loan investors"}},"httpPath":"/people/{personId}/loans/{loanId}/investors","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Loan Collection Agencies","link":"/api-docs/api-public/loan-collection-agencies","routeSlug":"/api-docs/api-public/loan-collection-agencies","items":[{"label":"Unassign loan collection agency","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-collection-agencies/peach.collections.handlers.collection_agency_loan_details_unassign","routeSlug":"/api-docs/api-public/loan-collection-agencies/peach.collections.handlers.collection_agency_loan_details_unassign","metadata":{"seo":{"title":"Unassign loan collection agency","description":"This endpoint is used to \"unassign\" a loan from a collection agency. To keep the servicedBy value on the loan to debtCollectionAgency,just pass that value to this endpoint and the servicedBy will remain the same, while still clearing the collection agency assignment fields for the loan."}},"httpPath":"/people/{personId}/loans/{loanId}/collection-agency","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get loan collection agency","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-collection-agencies/peach.collections.handlers.collection_agency_loan_details_get","routeSlug":"/api-docs/api-public/loan-collection-agencies/peach.collections.handlers.collection_agency_loan_details_get","metadata":{"seo":{"title":"Get loan collection agency","description":"Get loan collection agency"}},"httpPath":"/people/{personId}/loans/{loanId}/collection-agency","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update loan collection agency","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-collection-agencies/peach.collections.handlers.collection_agency_loan_details_update","routeSlug":"/api-docs/api-public/loan-collection-agencies/peach.collections.handlers.collection_agency_loan_details_update","metadata":{"seo":{"title":"Update loan collection agency","description":"This end point allows lenders to assign a loan to a debt collection agency.When a loan is assigned to a debt collection agency, the system will set servicedBy=debtCollectionAgency.Once the loan is assigned, Peach system can only accept \"external\" transactions to update the loan balance (isExternal=true)."}},"httpPath":"/people/{personId}/loans/{loanId}/collection-agency","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Promo Programs","link":"/api-docs/api-public/promo-programs","routeSlug":"/api-docs/api-public/promo-programs","items":[{"label":"Create promo program for draw","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_add","routeSlug":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_add","metadata":{"seo":{"title":"Create promo program for draw","description":"Create promo program for draw"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/promo-programs","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Cancel promo program for draw","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_delete","routeSlug":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_delete","metadata":{"seo":{"title":"Cancel promo program for draw","description":"Cancel promo program for draw"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/promo-programs/{promoProgramId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get promo program for draw by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_get","routeSlug":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_get","metadata":{"seo":{"title":"Get promo program for draw by ID","description":"Get promo program for draw by ID"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/promo-programs/{promoProgramId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update promo program for draw","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_update","routeSlug":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_update","metadata":{"seo":{"title":"Update promo program for draw","description":"There a few restrictions on what can be updated.promoTypeId cannot be updated.If status=pending - any attribute except for status can beupdated.To activate use the Activate promo program endpoint.If status=active - promoType, status, promoDurationDaysand promoStartDate cannot be updated.If status=canceled -  promoType, promoDurationDays andpromoStartDate cannot be updated.If status=exercised - no attributes can be updated."}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/promo-programs/{promoProgramId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Activate promo program for draw","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_activate","routeSlug":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_draw_activate","metadata":{"seo":{"title":"Activate promo program for draw","description":"Activate promo program for draw"}},"httpPath":"/people/{personId}/loans/{loanId}/draws/{drawId}/promo-programs/{promoProgramId}/activate","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get promo programs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_get_all","routeSlug":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_get_all","metadata":{"seo":{"title":"Get promo programs","description":"Get promo programs"}},"httpPath":"/people/{personId}/loans/{loanId}/promo-programs","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create promo program","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_add","routeSlug":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_add","metadata":{"seo":{"title":"Create promo program","description":"Create promo program"}},"httpPath":"/people/{personId}/loans/{loanId}/promo-programs","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Cancel promo program","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_delete","routeSlug":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_delete","metadata":{"seo":{"title":"Cancel promo program","description":"Cancel promo program"}},"httpPath":"/people/{personId}/loans/{loanId}/promo-programs/{promoProgramId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get promo program by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_get","routeSlug":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_get","metadata":{"seo":{"title":"Get promo program by ID","description":"Get promo program by ID"}},"httpPath":"/people/{personId}/loans/{loanId}/promo-programs/{promoProgramId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update promo program","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_update","routeSlug":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_update","metadata":{"seo":{"title":"Update promo program","description":"There a few restrictions on what can be updated.promoTypeId cannot be updated.If status=pending - any attribute except for status can beupdated.To activate use the Activate promo program endpoint.If status=active - promoType, status, promoDurationDaysand promoStartDate cannot be updated.If status=canceled -  promoType, promoDurationDays andpromoStartDate cannot be updated.If status=exercised - no attributes can be updated."}},"httpPath":"/people/{personId}/loans/{loanId}/promo-programs/{promoProgramId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Activate promo program","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_activate","routeSlug":"/api-docs/api-public/promo-programs/peach.promo_programs.handlers.promo_program.promo_programs_activate","metadata":{"seo":{"title":"Activate promo program","description":"Activate promo program"}},"httpPath":"/people/{personId}/loans/{loanId}/promo-programs/{promoProgramId}/activate","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Cards","link":"/api-docs/api-public/cards","routeSlug":"/api-docs/api-public/cards","items":[{"label":"Get cards","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cards/peach.card_issuers.handlers.cards_list","routeSlug":"/api-docs/api-public/cards/peach.card_issuers.handlers.cards_list","metadata":{"seo":{"title":"Get cards","description":"Get cards"}},"httpPath":"/people/{personId}/loans/{loanId}/cards","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cards/peach.card_issuers.handlers.card_create","routeSlug":"/api-docs/api-public/cards/peach.card_issuers.handlers.card_create","metadata":{"seo":{"title":"Create card","description":"The card details."}},"httpPath":"/people/{personId}/loans/{loanId}/cards","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get card","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cards/peach.card_issuers.handlers.card_get","routeSlug":"/api-docs/api-public/cards/peach.card_issuers.handlers.card_get","metadata":{"seo":{"title":"Get card","description":"Get card"}},"httpPath":"/people/{personId}/loans/{loanId}/cards/{cardId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update card","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/cards/peach.card_issuers.handlers.card_update","routeSlug":"/api-docs/api-public/cards/peach.card_issuers.handlers.card_update","metadata":{"seo":{"title":"Update card","description":"The card details."}},"httpPath":"/people/{personId}/loans/{loanId}/cards/{cardId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Loan Labels","link":"/api-docs/api-public/loan-labels","routeSlug":"/api-docs/api-public/loan-labels","items":[{"label":"Get loan labels","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_labels_list","routeSlug":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_labels_list","metadata":{"seo":{"title":"Get loan labels","description":"Get loan labels"}},"httpPath":"/companies/{companyId}/loan-labels","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create loan label","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_label_create","routeSlug":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_label_create","metadata":{"seo":{"title":"Create loan label","description":"Creates a new loan label."}},"httpPath":"/companies/{companyId}/loan-labels","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get loans by loan labels","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_labels_get_loans","routeSlug":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_labels_get_loans","metadata":{"seo":{"title":"Get loans by loan labels","description":"Get loans by loan labels"}},"httpPath":"/companies/{companyId}/loan-labels/{loanLabelIds}/loans","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Add labels to loans","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_labels_add_loans","routeSlug":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_labels_add_loans","metadata":{"seo":{"title":"Add labels to loans","description":"Adds loans to the specified labels."}},"httpPath":"/companies/{companyId}/loan-labels/{loanLabelIds}/loans","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Remove labels from loans","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_labels_remove_loans","routeSlug":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_labels_remove_loans","metadata":{"seo":{"title":"Remove labels from loans","description":"Remove loans from the specified labels."}},"httpPath":"/companies/{companyId}/loan-labels/{loanLabelIds}/loans/remove","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Delete loan label","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_label_delete","routeSlug":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_label_delete","metadata":{"seo":{"title":"Delete loan label","description":"Delete loan label"}},"httpPath":"/companies/{companyId}/loan-labels/{loanLabelId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get loan label by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_label_get","routeSlug":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_label_get","metadata":{"seo":{"title":"Get loan label by ID","description":"Get loan label by ID"}},"httpPath":"/companies/{companyId}/loan-labels/{loanLabelId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update loan label","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_label_update","routeSlug":"/api-docs/api-public/loan-labels/peach.loans.labels.handlers.loan_label_update","metadata":{"seo":{"title":"Update loan label","description":"Updates a loan label."}},"httpPath":"/companies/{companyId}/loan-labels/{loanLabelId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"separator","label":"Communicator & Interactions","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Communicator","link":"/api-docs/api-public/communicator","routeSlug":"/api-docs/api-public/communicator","items":[{"label":"Render template preview for subject","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/communicator/peach.communicator.handlers.preview","routeSlug":"/api-docs/api-public/communicator/peach.communicator.handlers.preview","metadata":{"seo":{"title":"Render template preview for subject","description":"Render the template and return as a JSON response."}},"httpPath":"/communicator/preview","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Preview free-form email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/communicator/peach.communicator.handlers.preview_free_form_email","routeSlug":"/api-docs/api-public/communicator/peach.communicator.handlers.preview_free_form_email","metadata":{"seo":{"title":"Preview free-form email","description":"Render a template for \"free-form\" emails and return is as JSON."}},"httpPath":"/communicator/preview-free-form-email","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Receive message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/communicator/peach.communicator.handlers.handle_receive","routeSlug":"/api-docs/api-public/communicator/peach.communicator.handlers.handle_receive","metadata":{"seo":{"title":"Receive message","description":"Receive a message."}},"httpPath":"/communicator/receive","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Render to download","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/communicator/peach.communicator.handlers.render","routeSlug":"/api-docs/api-public/communicator/peach.communicator.handlers.render","metadata":{"seo":{"title":"Render to download","description":"Render a file (text, html or pdf) from template and download it."}},"httpPath":"/communicator/render","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Render to document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/communicator/peach.communicator.handlers.render_to_document","routeSlug":"/api-docs/api-public/communicator/peach.communicator.handlers.render_to_document","metadata":{"seo":{"title":"Render to document","description":"Render a file (text, html or pdf) from template and write it to a document descriptor."}},"httpPath":"/communicator/render-to-document","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Resend existing interaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/communicator/peach.communicator.handlers.resend","routeSlug":"/api-docs/api-public/communicator/peach.communicator.handlers.resend","metadata":{"seo":{"title":"Resend existing interaction","description":"Copy the fields from an existing interaction into a new interaction and queue that new interaction for sending."}},"httpPath":"/communicator/resend","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Send message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/communicator/peach.communicator.handlers.handle_send","routeSlug":"/api-docs/api-public/communicator/peach.communicator.handlers.handle_send","metadata":{"seo":{"title":"Send message","description":"Send a message and save it as a new interaction."}},"httpPath":"/communicator/send","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Send confirmation code for contact verification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/communicator/peach.communicator.confirmation_codes.handlers.send_confirmation_code","routeSlug":"/api-docs/api-public/communicator/peach.communicator.confirmation_codes.handlers.send_confirmation_code","metadata":{"seo":{"title":"Send confirmation code for contact verification","description":"Send a verification code to an email or phone number."}},"httpPath":"/communicator/send-confirmation-code","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Send free-form email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/communicator/peach.communicator.handlers.send_free_form_email","routeSlug":"/api-docs/api-public/communicator/peach.communicator.handlers.send_free_form_email","metadata":{"seo":{"title":"Send free-form email","description":"Sends an email with the freeFormBranded template."}},"httpPath":"/communicator/send-free-form-email","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"List subject desciptors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/communicator/peach.communicator.handlers.subject_descriptors_list","routeSlug":"/api-docs/api-public/communicator/peach.communicator.handlers.subject_descriptors_list","metadata":{"seo":{"title":"List subject desciptors","description":"List all the currently available Interaction Subject descriptors."}},"httpPath":"/communicator/subjects","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get subject descriptor","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/communicator/peach.communicator.handlers.subject_descriptor_get_by_subject","routeSlug":"/api-docs/api-public/communicator/peach.communicator.handlers.subject_descriptor_get_by_subject","metadata":{"seo":{"title":"Get subject descriptor","description":"Get the descriptor for a specific Interaction Subject."}},"httpPath":"/communicator/subjects/{subject}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update subject descriptor","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/communicator/peach.communicator.handlers.subject_descriptor_update","routeSlug":"/api-docs/api-public/communicator/peach.communicator.handlers.subject_descriptor_update","metadata":{"seo":{"title":"Update subject descriptor","description":"Update the descriptor for a specific Interaction Subject."}},"httpPath":"/communicator/subjects/{subject}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Templates","link":"/api-docs/api-public/templates","routeSlug":"/api-docs/api-public/templates","items":[{"type":"link","label":"Management","link":"/api-docs/api-public/templates/management","routeSlug":"/api-docs/api-public/templates/management","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"Content","link":"/api-docs/api-public/templates/content","routeSlug":"/api-docs/api-public/templates/content","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"Syntax","link":"/api-docs/api-public/templates/syntax","routeSlug":"/api-docs/api-public/templates/syntax","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"Rendering Context","link":"/api-docs/api-public/templates/rendering-context","routeSlug":"/api-docs/api-public/templates/rendering-context","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"List template descriptors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.list_template_descriptors","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.list_template_descriptors","metadata":{"seo":{"title":"List template descriptors","description":"List template descriptors"}},"httpPath":"/communicator/templatedescriptors","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create template descriptor","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.create_template_descriptor","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.create_template_descriptor","metadata":{"seo":{"title":"Create template descriptor","description":"Create template descriptor"}},"httpPath":"/communicator/templatedescriptors","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Delete template descriptor","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.delete_template_descriptor","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.delete_template_descriptor","metadata":{"seo":{"title":"Delete template descriptor","description":"Delete template descriptor"}},"httpPath":"/communicator/templatedescriptors/{descriptorId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get template descriptor","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.get_template_descriptor","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.get_template_descriptor","metadata":{"seo":{"title":"Get template descriptor","description":"Get template descriptor"}},"httpPath":"/communicator/templatedescriptors/{descriptorId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update template descriptor","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.update_template_descriptor","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.update_template_descriptor","metadata":{"seo":{"title":"Update template descriptor","description":"Update template descriptor"}},"httpPath":"/communicator/templatedescriptors/{descriptorId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"List template versions for descriptor","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.list_template_versions_by_descriptor","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.list_template_versions_by_descriptor","metadata":{"seo":{"title":"List template versions for descriptor","description":"List all template versions for the given template descriptor."}},"httpPath":"/communicator/templatedescriptors/{descriptorId}/templates","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"List all template versions (Deprecated)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.list_template_versions","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.list_template_versions","metadata":{"seo":{"title":"List all template versions (Deprecated)","description":"List all template versions."}},"httpPath":"/communicator/templates","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create template version","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.create_template_version","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.create_template_version","metadata":{"seo":{"title":"Create template version","description":"Create a new template versions."}},"httpPath":"/communicator/templates","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Export all template descriptors and versions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.export_templates","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.export_templates","metadata":{"seo":{"title":"Export all template descriptors and versions","description":"Export all template descriptors and template versions for a company. The export is in JSON format. It can be used with the import endpoint to restore templates."}},"httpPath":"/communicator/templates/export","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Import exported template descriptors and versions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.import_templates","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.import_templates","metadata":{"seo":{"title":"Import exported template descriptors and versions","description":"Import exported template descriptors and template versions for a company. The exporteddata should come from the /communicator/templates/export endpoint."}},"httpPath":"/communicator/templates/import","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get template version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.get_template_version","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.get_template_version","metadata":{"seo":{"title":"Get template version","description":"Get template version"}},"httpPath":"/communicator/templates/{templateVersionId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update template version","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.update_template_version","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.update_template_version","metadata":{"seo":{"title":"Update template version","description":"Update template version"}},"httpPath":"/communicator/templates/{templateVersionId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Activate template version","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.activate_template_version","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.activate_template_version","metadata":{"seo":{"title":"Activate template version","description":"Set's the given template version as active."}},"httpPath":"/communicator/templates/{templateVersionId}/activate","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Render template version preview","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.preview_template_version","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.preview_template_version","metadata":{"seo":{"title":"Render template version preview","description":"Render the template contents of the given Template Versionusing the given context."}},"httpPath":"/communicator/templates/{templateVersionId}/preview","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Render template version","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.render_template_version","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.render_template_version","metadata":{"seo":{"title":"Render template version","description":"Render a file (text, html or pdf) from this Template Version and download it."}},"httpPath":"/communicator/templates/{templateVersionId}/render","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"List context vars for template version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.get_template_vars","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.get_template_vars","metadata":{"seo":{"title":"List context vars for template version","description":"List all context variables used in the given template version."}},"httpPath":"/communicator/templates/{templateVersionId}/vars","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"List all template versions (v2)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.list_template_versions_modern","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.list_template_versions_modern","metadata":{"seo":{"title":"List all template versions (v2)","description":"List all Templates Versions for all Template Descriptors."}},"httpPath":"/v2/communicator/templates","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Delete template version (no longer supported)","deprecated":true,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/templates/peach.communicator.handlers.delete_template_version","routeSlug":"/api-docs/api-public/templates/peach.communicator.handlers.delete_template_version","metadata":{"seo":{"title":"Delete template version (no longer supported)","description":"Deleting template versions is not allowed. Template versions are historical records. This endpoint is retained for backwards compatibility but responds with a 400 error."}},"httpPath":"/communicator/templates/{templateVersionId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"System Documents & UI","link":"/api-docs/api-public/system-documents-and-ui","routeSlug":"/api-docs/api-public/system-documents-and-ui","items":[{"type":"link","label":"Available Context Variables","link":"/api-docs/api-public/system-documents-and-ui/available-context-variables","routeSlug":"/api-docs/api-public/system-documents-and-ui/available-context-variables","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"autopayAgreement","link":"/api-docs/api-public/system-documents-and-ui/availabletemplatecontextsubjectautopayagreement","routeSlug":"/api-docs/api-public/system-documents-and-ui/availabletemplatecontextsubjectautopayagreement","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"drawFundsDisclosure","link":"/api-docs/api-public/system-documents-and-ui/availabletemplatecontextsubjectdrawfundsdisclosure","routeSlug":"/api-docs/api-public/system-documents-and-ui/availabletemplatecontextsubjectdrawfundsdisclosure","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"System Sent Messages","link":"/api-docs/api-public/system-sent-messages","routeSlug":"/api-docs/api-public/system-sent-messages","items":[{"type":"link","label":"Automatically Calculated Context Vars","link":"/api-docs/api-public/system-sent-messages/automatically-calculated-context-vars","routeSlug":"/api-docs/api-public/system-sent-messages/automatically-calculated-context-vars","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"Customization","link":"/api-docs/api-public/system-sent-messages/customization","routeSlug":"/api-docs/api-public/system-sent-messages/customization","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"autopayAmountChanged","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopayamountchanged","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopayamountchanged","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"autopayCanceledBySystem","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopaycanceledbysystem","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopaycanceledbysystem","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"autopayEnabled","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopayenabled","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopayenabled","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"autopayEnableReminder","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopayenablereminder","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopayenablereminder","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"autopayPaymentCanceled","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopaypaymentcanceled","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopaypaymentcanceled","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"autopayPaymentMethodUpdated","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopaypaymentmethodupdated","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopaypaymentmethodupdated","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"autopayPaymentReminder","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopaypaymentreminder","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopaypaymentreminder","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"autopayPaymentRescheduled","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopaypaymentrescheduled","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectautopaypaymentrescheduled","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"cardExpiresReminder","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectcardexpiresreminder","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectcardexpiresreminder","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"ceaseCommunicationAcknowledgement","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectceasecommunicationacknowledgement","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectceasecommunicationacknowledgement","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"ceaseCommunicationRefuseToPay","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectceaserefusetopay","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectceaserefusetopay","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"confirmationCode","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectconfirmationcode","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectconfirmationcode","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"contactTakeover","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectcontacttakeover","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectcontacttakeover","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"customX","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectcustomx","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectcustomx","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"debtValidationNotice","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdebtvalidationnotice","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdebtvalidationnotice","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"debtValidationNoticeArizona","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdebtvalidationnoticearizona","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdebtvalidationnoticearizona","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"debtValidationNoticeAutomatic","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdebtvalidationnoticeautomatic","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdebtvalidationnoticeautomatic","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"debtValidationNoticeNYCYonkers","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdebtvalidationnoticenycyonkers","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdebtvalidationnoticenycyonkers","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"debtValidationNoticePuertoRico","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdebtvalidationnoticepuertorico","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdebtvalidationnoticepuertorico","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"deceasedConfirmationOfPayoff","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdeceasedconfirmationofpayoff","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdeceasedconfirmationofpayoff","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"deceasedNoticeToRepresentative","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdeceasednoticetorepresentative","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdeceasednoticetorepresentative","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"deceasedNotificationUponDeath","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdeceasednotificationupondeath","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdeceasednotificationupondeath","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"disputeOfDebtConfirmed","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdisputeofdebtconfirmed","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdisputeofdebtconfirmed","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"disputeOfDebtSubmitDocumentation","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdisputeofdebtsubmitdocumentation","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdisputeofdebtsubmitdocumentation","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"disputeOfDebtSubmitDocumentationReminder","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdisputeofdebtsubmitdocumentationreminder","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdisputeofdebtsubmitdocumentationreminder","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"disputeOfDebtUnableToConfirm","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdisputeofdebtunabletoconfirm","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdisputeofdebtunabletoconfirm","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"disputeOfDebtUnableToResolve","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdisputeofdebtunabletoresolve","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectdisputeofdebtunabletoresolve","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"electronicConsentOptOut","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectelectronicconsentoptout","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectelectronicconsentoptout","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"failedSettlementInvestor","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectfailedsettlementinvestor","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectfailedsettlementinvestor","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"freeFormBranded","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectfreeformbranded","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectfreeformbranded","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"futurepayCanceledf","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectfuturepaycanceled","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectfuturepaycanceled","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"futurepayPaymentDueReminder","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectfuturepaypaymentduereminder","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectfuturepaypaymentduereminder","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"identityTheftIncompleteDocumentation","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectidentitytheftincompletedocumentation","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectidentitytheftincompletedocumentation","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"identityTheftNotValidated","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectidentitytheftnotvalidated","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectidentitytheftnotvalidated","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"identityTheftSubmitDocumentation","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectidentitytheftsubmitdocumentation","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectidentitytheftsubmitdocumentation","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"identityTheftSubmitDocumentationFirstReminder","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectidentitytheftsubmitdocumentationfirstreminder","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectidentitytheftsubmitdocumentationfirstreminder","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"identityTheftSubmitDocumentationSecondReminder","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectidentitytheftsubmitdocumentationsecondreminder","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectidentitytheftsubmitdocumentationsecondreminder","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"link","label":"identityTheftValidated","link":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectidentitytheftvalidated","routeSlug":"/api-docs/api-public/system-sent-messages/availabletemplatecontextsubjectidentitytheftvalidated","httpVerb":"schema","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Interactions","link":"/api-docs/api-public/interactions","routeSlug":"/api-docs/api-public/interactions","items":[{"label":"Get interaction call summaries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.ai.call_transcription.handlers.internal_unbound_interaction_call_summary_results_get_by_interaction","routeSlug":"/api-docs/api-public/interactions/peach.ai.call_transcription.handlers.internal_unbound_interaction_call_summary_results_get_by_interaction","metadata":{"seo":{"title":"Get interaction call summaries","description":"Get interaction call summaries"}},"httpPath":"/companies/{companyId}/interactions/{interactionId}/call-transcripts/summaries","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get previous interactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.internal_unbound_get_many_previous_interactions","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.internal_unbound_get_many_previous_interactions","metadata":{"seo":{"title":"Get previous interactions","description":"For this interaction, get all the previous interactions linked to itvia the previousInteractionId field."}},"httpPath":"/companies/{companyId}/interactions/{interactionId}/previous","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get interactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.unbound_interaction_get_all","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.unbound_interaction_get_all","metadata":{"seo":{"title":"Get interactions","description":"Get interactions"}},"httpPath":"/interactions","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get interaction by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.unbound_interaction_get_by_id","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.unbound_interaction_get_by_id","metadata":{"seo":{"title":"Get interaction by ID","description":"Get interaction by ID"}},"httpPath":"/interactions/{interactionId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get interaction call summaries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.ai.call_transcription.handlers.unbound_interaction_call_summary_results_get_by_interaction","routeSlug":"/api-docs/api-public/interactions/peach.ai.call_transcription.handlers.unbound_interaction_call_summary_results_get_by_interaction","metadata":{"seo":{"title":"Get interaction call summaries","description":"Get interaction call summaries"}},"httpPath":"/interactions/{interactionId}/call-transcripts/summaries","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get interaction convo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.twilio.convo.handlers_api.interaction_convo_get","routeSlug":"/api-docs/api-public/interactions/peach.twilio.convo.handlers_api.interaction_convo_get","metadata":{"seo":{"title":"Get interaction convo","description":"Get interaction convo"}},"httpPath":"/interactions/{interactionId}/convo","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Close interaction convo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.twilio.convo.handlers_api.interaction_convo_close","routeSlug":"/api-docs/api-public/interactions/peach.twilio.convo.handlers_api.interaction_convo_close","metadata":{"seo":{"title":"Close interaction convo","description":"Close interaction convo"}},"httpPath":"/interactions/{interactionId}/convo/close","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Join interaction convo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.twilio.convo.handlers_api.interaction_convo_join","routeSlug":"/api-docs/api-public/interactions/peach.twilio.convo.handlers_api.interaction_convo_join","metadata":{"seo":{"title":"Join interaction convo","description":"Add the user making the request to the conversation associated with this interaction."}},"httpPath":"/interactions/{interactionId}/convo/join","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Leave interaction convo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.twilio.convo.handlers_api.interaction_convo_leave","routeSlug":"/api-docs/api-public/interactions/peach.twilio.convo.handlers_api.interaction_convo_leave","metadata":{"seo":{"title":"Leave interaction convo","description":"Leave interaction convo"}},"httpPath":"/interactions/{interactionId}/convo/leave","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get previous interactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.unbound_get_many_previous_interactions","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.unbound_get_many_previous_interactions","metadata":{"seo":{"title":"Get previous interactions","description":"For this interaction, get all the previous interactions linked to itvia the previousInteractionId field."}},"httpPath":"/interactions/{interactionId}/previous","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Download interaction recording","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.unbound_interaction_download_recording","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.unbound_interaction_download_recording","metadata":{"seo":{"title":"Download interaction recording","description":"Download interaction recording"}},"httpPath":"/interactions/{interactionId}/recording-content","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Download interaction voicemail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.unbound_interaction_download_voicemail","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.unbound_interaction_download_voicemail","metadata":{"seo":{"title":"Download interaction voicemail","description":"Download interaction voicemail"}},"httpPath":"/interactions/{interactionId}/voicemail-content","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get borrower interactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.interaction_get_all","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.interaction_get_all","metadata":{"seo":{"title":"Get borrower interactions","description":"Get borrower interactions"}},"httpPath":"/people/{personId}/interactions","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create interaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.interaction_add","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.interaction_add","metadata":{"seo":{"title":"Create interaction","description":"Creating interactions tracks the history of communication between lenders/servicers and borrowers."}},"httpPath":"/people/{personId}/interactions","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Delete interaction","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.interaction_delete","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.interaction_delete","metadata":{"seo":{"title":"Delete interaction","description":"Delete an interaction. Only external interactions (interactions created by lenders via API) can be deleted."}},"httpPath":"/people/{personId}/interactions/{interactionId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get interaction by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.interaction_get_by_id","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.interaction_get_by_id","metadata":{"seo":{"title":"Get interaction by ID","description":"Get interaction by ID"}},"httpPath":"/people/{personId}/interactions/{interactionId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update interaction","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.interaction_update","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.interaction_update","metadata":{"seo":{"title":"Update interaction","description":"Update interaction"}},"httpPath":"/people/{personId}/interactions/{interactionId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get interaction call summaries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.ai.call_transcription.handlers.call_summary_results_get_by_interaction","routeSlug":"/api-docs/api-public/interactions/peach.ai.call_transcription.handlers.call_summary_results_get_by_interaction","metadata":{"seo":{"title":"Get interaction call summaries","description":"Get interaction call summaries"}},"httpPath":"/people/{personId}/interactions/{interactionId}/call-transcripts/summaries","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get cases associated with an interaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.get_interaction_cases","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.get_interaction_cases","metadata":{"seo":{"title":"Get cases associated with an interaction","description":"Get cases associated with an interaction"}},"httpPath":"/people/{personId}/interactions/{interactionId}/cases","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get previous interactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.get_many_previous_interactions","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.get_many_previous_interactions","metadata":{"seo":{"title":"Get previous interactions","description":"For this interaction, get all the previous interactions linked to itvia the previousInteractionId field."}},"httpPath":"/people/{personId}/interactions/{interactionId}/previous","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Download interaction recording","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.interaction_download_recording","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.interaction_download_recording","metadata":{"seo":{"title":"Download interaction recording","description":"Download interaction recording"}},"httpPath":"/people/{personId}/interactions/{interactionId}/recording-content","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Download interaction voicemail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/interactions/peach.people.interaction.handlers.interaction_download_voicemail","routeSlug":"/api-docs/api-public/interactions/peach.people.interaction.handlers.interaction_download_voicemail","metadata":{"seo":{"title":"Download interaction voicemail","description":"Download interaction voicemail"}},"httpPath":"/people/{personId}/interactions/{interactionId}/voicemail-content","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Compliance Guard","link":"/api-docs/api-public/compliance-guard","routeSlug":"/api-docs/api-public/compliance-guard","items":[{"label":"Can interact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/compliance-guard/peach.people.handlers.can_interact","routeSlug":"/api-docs/api-public/compliance-guard/peach.people.handlers.can_interact","metadata":{"seo":{"title":"Can interact","description":"Returns whether or not a communication is allowed with a borrower."}},"httpPath":"/people/{personId}/can-interact","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"separator","label":"Promo Programs Management","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Promo Programs Type","link":"/api-docs/api-public/promo-programs-type","routeSlug":"/api-docs/api-public/promo-programs-type","items":[{"label":"Get promo program types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_get_all","routeSlug":"/api-docs/api-public/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_get_all","metadata":{"seo":{"title":"Get promo program types","description":"Get promo program types"}},"httpPath":"/companies/{companyId}/promo-program-types","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create promo program type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_add","routeSlug":"/api-docs/api-public/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_add","metadata":{"seo":{"title":"Create promo program type","description":"Create promo program type"}},"httpPath":"/companies/{companyId}/promo-program-types","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Cancel promo program type","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_delete","routeSlug":"/api-docs/api-public/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_delete","metadata":{"seo":{"title":"Cancel promo program type","description":"Cancel promo program type"}},"httpPath":"/companies/{companyId}/promo-program-types/{promoProgramTypeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get promo program type by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_get","routeSlug":"/api-docs/api-public/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_get","metadata":{"seo":{"title":"Get promo program type by ID","description":"Get promo program type by ID"}},"httpPath":"/companies/{companyId}/promo-program-types/{promoProgramTypeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update promo program type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_update","routeSlug":"/api-docs/api-public/promo-programs-type/peach.promo_programs.handlers.promo_program_type.internal_promo_program_types_update","metadata":{"seo":{"title":"Update promo program type","description":"Update promo program type"}},"httpPath":"/companies/{companyId}/promo-program-types/{promoProgramTypeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"separator","label":"Processor Management","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Payment Processors","link":"/api-docs/api-public/payment-processors","routeSlug":"/api-docs/api-public/payment-processors","items":[{"label":"Get payment processors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-processors/peach.payment_processors.handlers.get_payment_processors","routeSlug":"/api-docs/api-public/payment-processors/peach.payment_processors.handlers.get_payment_processors","metadata":{"seo":{"title":"Get payment processors","description":"Get payment processors"}},"httpPath":"/payment-processors","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create payment processor","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-processors/peach.payment_processors.handlers.create_payment_processor","routeSlug":"/api-docs/api-public/payment-processors/peach.payment_processors.handlers.create_payment_processor","metadata":{"seo":{"title":"Create payment processor","description":"Create payment processor"}},"httpPath":"/payment-processors","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Delete payment processor","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-processors/peach.payment_processors.handlers.delete_payment_processor","routeSlug":"/api-docs/api-public/payment-processors/peach.payment_processors.handlers.delete_payment_processor","metadata":{"seo":{"title":"Delete payment processor","description":"Delete payment processor"}},"httpPath":"/payment-processors/{paymentProcessorId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get payment processor","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-processors/peach.payment_processors.handlers.get_one_payment_processor","routeSlug":"/api-docs/api-public/payment-processors/peach.payment_processors.handlers.get_one_payment_processor","metadata":{"seo":{"title":"Get payment processor","description":"Get payment processor"}},"httpPath":"/payment-processors/{paymentProcessorId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update payment processor","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/payment-processors/peach.payment_processors.handlers.update_payment_processor","routeSlug":"/api-docs/api-public/payment-processors/peach.payment_processors.handlers.update_payment_processor","metadata":{"seo":{"title":"Update payment processor","description":"Update payment processor"}},"httpPath":"/payment-processors/{paymentProcessorId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Card Issuers","link":"/api-docs/api-public/card-issuers","routeSlug":"/api-docs/api-public/card-issuers","items":[{"label":"Get card issuers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/card-issuers/peach.card_issuers.handlers.card_issuers_list","routeSlug":"/api-docs/api-public/card-issuers/peach.card_issuers.handlers.card_issuers_list","metadata":{"seo":{"title":"Get card issuers","description":"Get card issuers"}},"httpPath":"/card-issuers","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create card issuer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/card-issuers/peach.card_issuers.handlers.card_issuer_create","routeSlug":"/api-docs/api-public/card-issuers/peach.card_issuers.handlers.card_issuer_create","metadata":{"seo":{"title":"Create card issuer","description":"Creates a new card issuer."}},"httpPath":"/card-issuers","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Delete card issuer","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/card-issuers/peach.card_issuers.handlers.card_issuer_delete","routeSlug":"/api-docs/api-public/card-issuers/peach.card_issuers.handlers.card_issuer_delete","metadata":{"seo":{"title":"Delete card issuer","description":"Delete card issuer"}},"httpPath":"/card-issuers/{cardIssuerId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get card issuer by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/card-issuers/peach.card_issuers.handlers.card_issuer_get","routeSlug":"/api-docs/api-public/card-issuers/peach.card_issuers.handlers.card_issuer_get","metadata":{"seo":{"title":"Get card issuer by ID","description":"Get card issuer by ID"}},"httpPath":"/card-issuers/{cardIssuerId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update card issuer","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/card-issuers/peach.card_issuers.handlers.card_issuer_update","routeSlug":"/api-docs/api-public/card-issuers/peach.card_issuers.handlers.card_issuer_update","metadata":{"seo":{"title":"Update card issuer","description":"Update card issuer"}},"httpPath":"/card-issuers/{cardIssuerId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Funding Instruments","link":"/api-docs/api-public/funding-instruments","routeSlug":"/api-docs/api-public/funding-instruments","items":[{"label":"Get funding instruments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/funding-instruments/peach.payment_instruments.handlers.funding_instrument_get_all","routeSlug":"/api-docs/api-public/funding-instruments/peach.payment_instruments.handlers.funding_instrument_get_all","metadata":{"seo":{"title":"Get funding instruments","description":"Get funding instruments"}},"httpPath":"/companies/{companyId}/payment-processors/{paymentProcessorId}/funding-instruments","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create funding instrument","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/funding-instruments/peach.payment_instruments.handlers.funding_instrument_create","routeSlug":"/api-docs/api-public/funding-instruments/peach.payment_instruments.handlers.funding_instrument_create","metadata":{"seo":{"title":"Create funding instrument","description":"Create funding instrument"}},"httpPath":"/companies/{companyId}/payment-processors/{paymentProcessorId}/funding-instruments","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get funding instrument by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/funding-instruments/peach.payment_instruments.handlers.funding_instrument_get","routeSlug":"/api-docs/api-public/funding-instruments/peach.payment_instruments.handlers.funding_instrument_get","metadata":{"seo":{"title":"Get funding instrument by ID","description":"Get funding instrument by ID"}},"httpPath":"/companies/{companyId}/payment-processors/{paymentProcessorId}/funding-instruments/{fundingInstrumentId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update funding instrument","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/funding-instruments/peach.payment_instruments.handlers.funding_instrument_update","routeSlug":"/api-docs/api-public/funding-instruments/peach.payment_instruments.handlers.funding_instrument_update","metadata":{"seo":{"title":"Update funding instrument","description":"Update funding instrument"}},"httpPath":"/companies/{companyId}/payment-processors/{paymentProcessorId}/funding-instruments/{fundingInstrumentId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"separator","label":"Organization Management","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Employees","link":"/api-docs/api-public/employees","routeSlug":"/api-docs/api-public/employees","items":[{"label":"Get employees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/employees/peach.employees.handlers.employees.employees_get","routeSlug":"/api-docs/api-public/employees/peach.employees.handlers.employees.employees_get","metadata":{"seo":{"title":"Get employees","description":"Get employees"}},"httpPath":"/employees","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create employee","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/employees/peach.employees.handlers.employees.employee_create","routeSlug":"/api-docs/api-public/employees/peach.employees.handlers.employees.employee_create","metadata":{"seo":{"title":"Create employee","description":"Create a new employee for a company."}},"httpPath":"/employees","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get employee by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/employees/peach.employees.handlers.employees.employee_get_by_id","routeSlug":"/api-docs/api-public/employees/peach.employees.handlers.employees.employee_get_by_id","metadata":{"seo":{"title":"Get employee by ID","description":"Get employee by ID"}},"httpPath":"/employees/{employeeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update employee","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/employees/peach.employees.handlers.employees.employee_update","routeSlug":"/api-docs/api-public/employees/peach.employees.handlers.employees.employee_update","metadata":{"seo":{"title":"Update employee","description":"Update an employee"}},"httpPath":"/employees/{employeeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get email signature","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/employees/peach.employees.handlers.email_signature.employee_email_signature_get","routeSlug":"/api-docs/api-public/employees/peach.employees.handlers.email_signature.employee_email_signature_get","metadata":{"seo":{"title":"Get email signature","description":"Get the employee's email signature"}},"httpPath":"/employees/{employeeId}/email-signature","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update email signature","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/employees/peach.employees.handlers.email_signature.employee_email_signature_set","routeSlug":"/api-docs/api-public/employees/peach.employees.handlers.email_signature.employee_email_signature_set","metadata":{"seo":{"title":"Update email signature","description":"Update the employee's email signature"}},"httpPath":"/employees/{employeeId}/email-signature","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Remove employee from team","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/employees/peach.employees.handlers.employees.employee_remove_from_team","routeSlug":"/api-docs/api-public/employees/peach.employees.handlers.employees.employee_remove_from_team","metadata":{"seo":{"title":"Remove employee from team","description":"Remove an employee from a team"}},"httpPath":"/employees/{employeeId}/teams/{teamId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Add employee to team","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/employees/peach.employees.handlers.employees.employee_add_to_team","routeSlug":"/api-docs/api-public/employees/peach.employees.handlers.employees.employee_add_to_team","metadata":{"seo":{"title":"Add employee to team","description":"Add employee to a team"}},"httpPath":"/employees/{employeeId}/teams/{teamId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Teams","link":"/api-docs/api-public/teams","routeSlug":"/api-docs/api-public/teams","items":[{"label":"Get teams","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/teams/peach.employees.handlers.teams.teams_get","routeSlug":"/api-docs/api-public/teams/peach.employees.handlers.teams.teams_get","metadata":{"seo":{"title":"Get teams","description":"Get all teams in a company"}},"httpPath":"/teams","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create team","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/teams/peach.employees.handlers.teams.teams_create","routeSlug":"/api-docs/api-public/teams/peach.employees.handlers.teams.teams_create","metadata":{"seo":{"title":"Create team","description":"Create a new team"}},"httpPath":"/teams","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Delete team","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/teams/peach.employees.handlers.teams.team_delete","routeSlug":"/api-docs/api-public/teams/peach.employees.handlers.teams.team_delete","metadata":{"seo":{"title":"Delete team","description":"Delete team"}},"httpPath":"/teams/{teamId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get team by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/teams/peach.employees.handlers.teams.team_get","routeSlug":"/api-docs/api-public/teams/peach.employees.handlers.teams.team_get","metadata":{"seo":{"title":"Get team by ID","description":"Get team by ID"}},"httpPath":"/teams/{teamId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/teams/peach.employees.handlers.teams.team_update","routeSlug":"/api-docs/api-public/teams/peach.employees.handlers.teams.team_update","metadata":{"seo":{"title":"Update","description":"Update team"}},"httpPath":"/teams/{teamId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Users","link":"/api-docs/api-public/users","routeSlug":"/api-docs/api-public/users","items":[{"label":"Get users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/users/peach.users.handlers.users_get","routeSlug":"/api-docs/api-public/users/peach.users.handlers.users_get","metadata":{"seo":{"title":"Get users","description":"Get users"}},"httpPath":"/users","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create user\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/users/peach.users.handlers.user_create","routeSlug":"/api-docs/api-public/users/peach.users.handlers.user_create","metadata":{"seo":{"title":"Create user\n","description":"Creates a user."}},"httpPath":"/users","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/users/peach.users.handlers.user_get","routeSlug":"/api-docs/api-public/users/peach.users.handlers.user_get","metadata":{"seo":{"title":"Get user","description":"Get user"}},"httpPath":"/users/{userId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/users/peach.users.handlers.user_update","routeSlug":"/api-docs/api-public/users/peach.users.handlers.user_update","metadata":{"seo":{"title":"Update user","description":"Update user"}},"httpPath":"/users/{userId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Roles","link":"/api-docs/api-public/roles","routeSlug":"/api-docs/api-public/roles","items":[{"label":"Get user's current permissions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/roles/peach.users.handlers.user_get_permissions","routeSlug":"/api-docs/api-public/roles/peach.users.handlers.user_get_permissions","metadata":{"seo":{"title":"Get user's current permissions","description":"Given"}},"httpPath":"/users/{userId}/permissions","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get user roles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/roles/peach.roles.handlers.user_role_get","routeSlug":"/api-docs/api-public/roles/peach.roles.handlers.user_role_get","metadata":{"seo":{"title":"Get user roles","description":"Get user roles"}},"httpPath":"/users/{userId}/roles","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Remove role from user","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/roles/peach.roles.handlers.user_role_delete","routeSlug":"/api-docs/api-public/roles/peach.roles.handlers.user_role_delete","metadata":{"seo":{"title":"Remove role from user","description":"Remove role from user"}},"httpPath":"/users/{userId}/roles/{roleId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Add role to user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/roles/peach.roles.handlers.user_role_update","routeSlug":"/api-docs/api-public/roles/peach.roles.handlers.user_role_update","metadata":{"seo":{"title":"Add role to user","description":"Add role to user"}},"httpPath":"/users/{userId}/roles/{roleId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"separator","label":"Capital Markets Management","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Investors","link":"/api-docs/api-public/investors","routeSlug":"/api-docs/api-public/investors","items":[{"label":"Get investors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/investors/peach.payment_instruments.handlers.investor_get_all","routeSlug":"/api-docs/api-public/investors/peach.payment_instruments.handlers.investor_get_all","metadata":{"seo":{"title":"Get investors","description":"Get all investors under the given company."}},"httpPath":"/companies/{companyId}/investors","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create investor","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/investors/peach.payment_instruments.handlers.investor_create","routeSlug":"/api-docs/api-public/investors/peach.payment_instruments.handlers.investor_create","metadata":{"seo":{"title":"Create investor","description":"Create an investor under the umbrella of the given company."}},"httpPath":"/companies/{companyId}/investors","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get investor by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/investors/peach.payment_instruments.handlers.investor_get","routeSlug":"/api-docs/api-public/investors/peach.payment_instruments.handlers.investor_get","metadata":{"seo":{"title":"Get investor by ID","description":"Get investor by ID"}},"httpPath":"/companies/{companyId}/investors/{investorId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update investor","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/investors/peach.payment_instruments.handlers.investor_update","routeSlug":"/api-docs/api-public/investors/peach.payment_instruments.handlers.investor_update","metadata":{"seo":{"title":"Update investor","description":"Update investor"}},"httpPath":"/companies/{companyId}/investors/{investorId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get loan investors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/investors/peach.people.loans.handlers.internal_loan_investors_get_all","routeSlug":"/api-docs/api-public/investors/peach.people.loans.handlers.internal_loan_investors_get_all","metadata":{"seo":{"title":"Get loan investors","description":"Get loan investors"}},"httpPath":"/companies/{companyId}/people/{personId}/loans/{loanId}/investors","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Settlement Instruments","link":"/api-docs/api-public/settlement-instruments","routeSlug":"/api-docs/api-public/settlement-instruments","items":[{"label":"Get settlement instruments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/settlement-instruments/peach.payment_instruments.handlers.settlement_instrument_get_all","routeSlug":"/api-docs/api-public/settlement-instruments/peach.payment_instruments.handlers.settlement_instrument_get_all","metadata":{"seo":{"title":"Get settlement instruments","description":"Returns all settlement instruments registered for an investor. These are the bank accounts the Peach payment processor will wire investor settlement proceeds to."}},"httpPath":"/companies/{companyId}/investors/{investorId}/settlement-instruments","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create settlement instrument","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/settlement-instruments/peach.payment_instruments.handlers.settlement_instrument_create","routeSlug":"/api-docs/api-public/settlement-instruments/peach.payment_instruments.handlers.settlement_instrument_create","metadata":{"seo":{"title":"Create settlement instrument","description":"Registers a bank account as a settlement instrument for an investor. The Peach payment processor will use this account to wire the investor's share of collected borrower payments as part of automated daily investor settlement."}},"httpPath":"/companies/{companyId}/investors/{investorId}/settlement-instruments","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get settlement instrument by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/settlement-instruments/peach.payment_instruments.handlers.settlement_instrument_get","routeSlug":"/api-docs/api-public/settlement-instruments/peach.payment_instruments.handlers.settlement_instrument_get","metadata":{"seo":{"title":"Get settlement instrument by ID","description":"Get settlement instrument by ID"}},"httpPath":"/companies/{companyId}/investors/{investorId}/settlement-instruments/{settlementInstrumentId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update settlement instrument","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/settlement-instruments/peach.payment_instruments.handlers.settlement_instrument_update","routeSlug":"/api-docs/api-public/settlement-instruments/peach.payment_instruments.handlers.settlement_instrument_update","metadata":{"seo":{"title":"Update settlement instrument","description":"Update settlement instrument"}},"httpPath":"/companies/{companyId}/investors/{investorId}/settlement-instruments/{settlementInstrumentId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Loan Tape Types","link":"/api-docs/api-public/loan-tape-types","routeSlug":"/api-docs/api-public/loan-tape-types","items":[{"label":"Get loan tape types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-tape-types/peach.loans.tape.handlers.loan_tape_types_list","routeSlug":"/api-docs/api-public/loan-tape-types/peach.loans.tape.handlers.loan_tape_types_list","metadata":{"seo":{"title":"Get loan tape types","description":"Get loan tape types"}},"httpPath":"/companies/{companyId}/loan-tape-types","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create loan tape type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-tape-types/peach.loans.tape.handlers.loan_tape_type_create","routeSlug":"/api-docs/api-public/loan-tape-types/peach.loans.tape.handlers.loan_tape_type_create","metadata":{"seo":{"title":"Create loan tape type","description":"Creates a new loan tape type."}},"httpPath":"/companies/{companyId}/loan-tape-types","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Delete loan tape type","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-tape-types/peach.loans.tape.handlers.loan_tape_type_delete","routeSlug":"/api-docs/api-public/loan-tape-types/peach.loans.tape.handlers.loan_tape_type_delete","metadata":{"seo":{"title":"Delete loan tape type","description":"Delete loan tape type"}},"httpPath":"/companies/{companyId}/loan-tape-types/{loanTapeTypeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get loan tape type by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-tape-types/peach.loans.tape.handlers.loan_tape_type_get","routeSlug":"/api-docs/api-public/loan-tape-types/peach.loans.tape.handlers.loan_tape_type_get","metadata":{"seo":{"title":"Get loan tape type by ID","description":"Get loan tape type by ID"}},"httpPath":"/companies/{companyId}/loan-tape-types/{loanTapeTypeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update loan tape type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-tape-types/peach.loans.tape.handlers.loan_tape_type_update","routeSlug":"/api-docs/api-public/loan-tape-types/peach.loans.tape.handlers.loan_tape_type_update","metadata":{"seo":{"title":"Update loan tape type","description":"Update loan tape type"}},"httpPath":"/companies/{companyId}/loan-tape-types/{loanTapeTypeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Loan Tapes","link":"/api-docs/api-public/loan-tapes","routeSlug":"/api-docs/api-public/loan-tapes","items":[{"label":"Get loan tapes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-tapes/peach.loans.tape.handlers.loan_tapes_list","routeSlug":"/api-docs/api-public/loan-tapes/peach.loans.tape.handlers.loan_tapes_list","metadata":{"seo":{"title":"Get loan tapes","description":"Get loan tapes"}},"httpPath":"/companies/{companyId}/loan-tapes","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create loan tape","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-tapes/peach.loans.tape.handlers.loan_tape_create","routeSlug":"/api-docs/api-public/loan-tapes/peach.loans.tape.handlers.loan_tape_create","metadata":{"seo":{"title":"Create loan tape","description":"Creates a new loan tape."}},"httpPath":"/companies/{companyId}/loan-tapes","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Generate Loan Tapes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-tapes/peach.loans.tape.handlers.loan_tapes_generate","routeSlug":"/api-docs/api-public/loan-tapes/peach.loans.tape.handlers.loan_tapes_generate","metadata":{"seo":{"title":"Generate Loan Tapes","description":"Generate Loan Tapes"}},"httpPath":"/companies/{companyId}/loan-tapes/generate","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Delete loan tape","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-tapes/peach.loans.tape.handlers.loan_tape_delete","routeSlug":"/api-docs/api-public/loan-tapes/peach.loans.tape.handlers.loan_tape_delete","metadata":{"seo":{"title":"Delete loan tape","description":"Delete loan tape"}},"httpPath":"/companies/{companyId}/loan-tapes/{loanTapeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get loan tape by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-tapes/peach.loans.tape.handlers.loan_tape_get","routeSlug":"/api-docs/api-public/loan-tapes/peach.loans.tape.handlers.loan_tape_get","metadata":{"seo":{"title":"Get loan tape by ID","description":"Get loan tape by ID"}},"httpPath":"/companies/{companyId}/loan-tapes/{loanTapeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update loan tape","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-tapes/peach.loans.tape.handlers.loan_tape_update","routeSlug":"/api-docs/api-public/loan-tapes/peach.loans.tape.handlers.loan_tape_update","metadata":{"seo":{"title":"Update loan tape","description":"Update loan tape"}},"httpPath":"/companies/{companyId}/loan-tapes/{loanTapeId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get loan tape records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-tapes/peach.loans.tape.handlers.loan_tape_records_list","routeSlug":"/api-docs/api-public/loan-tapes/peach.loans.tape.handlers.loan_tape_records_list","metadata":{"seo":{"title":"Get loan tape records","description":"Records are sorted by createdAt descending"}},"httpPath":"/companies/{companyId}/loan-tapes/{loanTapeId}/records","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"separator","label":"Merchants Management","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Merchants","link":"/api-docs/api-public/merchants","routeSlug":"/api-docs/api-public/merchants","items":[{"label":"Get merchants","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/merchants/peach.merchants.handlers.merchants_list","routeSlug":"/api-docs/api-public/merchants/peach.merchants.handlers.merchants_list","metadata":{"seo":{"title":"Get merchants","description":"Get merchants"}},"httpPath":"/companies/{companyId}/merchants","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create merchant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/merchants/peach.merchants.handlers.merchant_create","routeSlug":"/api-docs/api-public/merchants/peach.merchants.handlers.merchant_create","metadata":{"seo":{"title":"Create merchant","description":"Creates a new merchant."}},"httpPath":"/companies/{companyId}/merchants","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get merchant by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/merchants/peach.merchants.handlers.merchant_get","routeSlug":"/api-docs/api-public/merchants/peach.merchants.handlers.merchant_get","metadata":{"seo":{"title":"Get merchant by ID","description":"Get merchant by ID"}},"httpPath":"/companies/{companyId}/merchants/{merchantId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update merchant","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/merchants/peach.merchants.handlers.merchant_update","routeSlug":"/api-docs/api-public/merchants/peach.merchants.handlers.merchant_update","metadata":{"seo":{"title":"Update merchant","description":"Update merchant"}},"httpPath":"/companies/{companyId}/merchants/{merchantId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"separator","label":"Events and Webhooks Management","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Events","link":"/api-docs/api-public/events","routeSlug":"/api-docs/api-public/events","items":[{"label":"Retrieve events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/events/peach.events.handlers.get_events","routeSlug":"/api-docs/api-public/events/peach.events.handlers.get_events","metadata":{"seo":{"title":"Retrieve events","description":"Retrieve events"}},"httpPath":"/events","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Webhooks","link":"/api-docs/api-public/webhooks","routeSlug":"/api-docs/api-public/webhooks","items":[{"label":"Get webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/webhooks/peach.webhooks.handlers.webhooks_list","routeSlug":"/api-docs/api-public/webhooks/peach.webhooks.handlers.webhooks_list","metadata":{"seo":{"title":"Get webhooks","description":"Get webhooks"}},"httpPath":"/webhooks","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create webhook subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/webhooks/peach.webhooks.handlers.webhook_create","routeSlug":"/api-docs/api-public/webhooks/peach.webhooks.handlers.webhook_create","metadata":{"seo":{"title":"Create webhook subscription","description":"Creates a new webhook subscription."}},"httpPath":"/webhooks","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Delete webhook subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/webhooks/peach.webhooks.handlers.webhook_delete","routeSlug":"/api-docs/api-public/webhooks/peach.webhooks.handlers.webhook_delete","metadata":{"seo":{"title":"Delete webhook subscription","description":"Delete webhook subscription"}},"httpPath":"/webhooks/{webhookSubscriptionId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get webhook subscription by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/webhooks/peach.webhooks.handlers.webhook_get","routeSlug":"/api-docs/api-public/webhooks/peach.webhooks.handlers.webhook_get","metadata":{"seo":{"title":"Get webhook subscription by ID","description":"Get webhook subscription by ID"}},"httpPath":"/webhooks/{webhookSubscriptionId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update webhook subscription","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/webhooks/peach.webhooks.handlers.webhook_update","routeSlug":"/api-docs/api-public/webhooks/peach.webhooks.handlers.webhook_update","metadata":{"seo":{"title":"Update webhook subscription","description":"Update webhook subscription"}},"httpPath":"/webhooks/{webhookSubscriptionId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Test a webhook with static payload.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/webhooks/peach.webhooks.handlers.webhook_ping","routeSlug":"/api-docs/api-public/webhooks/peach.webhooks.handlers.webhook_ping","metadata":{"seo":{"title":"Test a webhook with static payload.","description":"Test a webhook with static payload."}},"httpPath":"/webhooks/{webhookSubscriptionId}/ping","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"separator","label":"Utilities","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Loan Amortization","link":"/api-docs/api-public/loan-amortization","routeSlug":"/api-docs/api-public/loan-amortization","items":[{"label":"Amortize loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-amortization/peach.loans.handlers.amortization_get","routeSlug":"/api-docs/api-public/loan-amortization/peach.loans.handlers.amortization_get","metadata":{"seo":{"title":"Amortize loan","description":"This utility generates an amortization schedule for an installment loan or line of credit draw.The atOrigination field is where you specify various loan or draw-specific inputs such as thestart date, amount to be financed, and duration."}},"httpPath":"/amortize","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Amortize loan combinations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/loan-amortization/peach.loans.handlers.amortization_combinations","routeSlug":"/api-docs/api-public/loan-amortization/peach.loans.handlers.amortization_combinations","metadata":{"seo":{"title":"Amortize loan combinations","description":"NOTE: This endpoint does not support recurring dynamic fees. Origination fees and other dynamic non-recurring fees are supported."}},"httpPath":"/amortize-combinations","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Routing Numbers","link":"/api-docs/api-public/routing-numbers","routeSlug":"/api-docs/api-public/routing-numbers","items":[{"label":"Get routing number details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/routing-numbers/peach.routing_numbers.handlers.get_routing_number","routeSlug":"/api-docs/api-public/routing-numbers/peach.routing_numbers.handlers.get_routing_number","metadata":{"seo":{"title":"Get routing number details","description":"Get routing number details"}},"httpPath":"/routing-numbers/{routingNumber}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"BIN Numbers","link":"/api-docs/api-public/bin-numbers","routeSlug":"/api-docs/api-public/bin-numbers","items":[{"label":"Get BIN details from card number","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/bin-numbers/peach.bin_numbers.handlers.get_bin_number","routeSlug":"/api-docs/api-public/bin-numbers/peach.bin_numbers.handlers.get_bin_number","metadata":{"seo":{"title":"Get BIN details from card number","description":"Get BIN details from card number"}},"httpPath":"/bin-numbers","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Index Rates","link":"/api-docs/api-public/index-rates","routeSlug":"/api-docs/api-public/index-rates","items":[{"label":"Get index interest rates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_get_all","routeSlug":"/api-docs/api-public/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_get_all","metadata":{"seo":{"title":"Get index interest rates","description":"Get index interest rates"}},"httpPath":"/loan-types/{loanTypeId}/index-rates","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Add index interest rate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_add","routeSlug":"/api-docs/api-public/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_add","metadata":{"seo":{"title":"Add index interest rate","description":"Add index interest rate"}},"httpPath":"/loan-types/{loanTypeId}/index-rates","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Cancel index interest rate","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_delete","routeSlug":"/api-docs/api-public/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_delete","metadata":{"seo":{"title":"Cancel index interest rate","description":"Cancel index interest rate"}},"httpPath":"/loan-types/{loanTypeId}/index-rates/{indexRateId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get index interest rate by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_get","routeSlug":"/api-docs/api-public/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_get","metadata":{"seo":{"title":"Get index interest rate by ID","description":"Get index interest rate by ID"}},"httpPath":"/loan-types/{loanTypeId}/index-rates/{indexRateId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update index interest rate","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_update","routeSlug":"/api-docs/api-public/index-rates/peach.loan_configuration.handlers.loan_type_index_rate_update","metadata":{"seo":{"title":"Update index interest rate","description":"This endpoint is used for updating index interest rates."}},"httpPath":"/loan-types/{loanTypeId}/index-rates/{indexRateId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Operations","link":"/api-docs/api-public/operations","routeSlug":"/api-docs/api-public/operations","items":[{"label":"Get operation status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/operations/peach.operation_status.handlers.operation_status_get","routeSlug":"/api-docs/api-public/operations/peach.operation_status.handlers.operation_status_get","metadata":{"seo":{"title":"Get operation status","description":"Get operation status"}},"httpPath":"/operations/{operationId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"separator","label":"Credit Agencies Management","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Credit Agencies","link":"/api-docs/api-public/credit-agencies","routeSlug":"/api-docs/api-public/credit-agencies","items":[{"label":"Get credit agencies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/credit-agencies/peach.credit_reporting.handlers.credit_agencies_list","routeSlug":"/api-docs/api-public/credit-agencies/peach.credit_reporting.handlers.credit_agencies_list","metadata":{"seo":{"title":"Get credit agencies","description":"Get credit agencies"}},"httpPath":"/companies/{companyId}/credit-agencies","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create credit agency","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/credit-agencies/peach.credit_reporting.handlers.credit_agency_create","routeSlug":"/api-docs/api-public/credit-agencies/peach.credit_reporting.handlers.credit_agency_create","metadata":{"seo":{"title":"Create credit agency","description":"Creates a new credit agency."}},"httpPath":"/companies/{companyId}/credit-agencies","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get credit agency by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/credit-agencies/peach.credit_reporting.handlers.credit_agency_get","routeSlug":"/api-docs/api-public/credit-agencies/peach.credit_reporting.handlers.credit_agency_get","metadata":{"seo":{"title":"Get credit agency by ID","description":"Get credit agency by ID"}},"httpPath":"/companies/{companyId}/credit-agencies/{creditAgencyId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update credit agency","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/credit-agencies/peach.credit_reporting.handlers.credit_agency_update","routeSlug":"/api-docs/api-public/credit-agencies/peach.credit_reporting.handlers.credit_agency_update","metadata":{"seo":{"title":"Update credit agency","description":"Update credit agency"}},"httpPath":"/companies/{companyId}/credit-agencies/{creditAgencyId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Regenerate SSH key pair for credit agency","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/credit-agencies/peach.credit_reporting.handlers.credit_agency_regenerate_ssh_keys","routeSlug":"/api-docs/api-public/credit-agencies/peach.credit_reporting.handlers.credit_agency_regenerate_ssh_keys","metadata":{"seo":{"title":"Regenerate SSH key pair for credit agency","description":"Generates a new RSA SSH key pair for the credit agency and returns the updated object.The new sftpSSHPeachPublicKey must be added to the SFTP server's authorized_keys file —the old public key will no longer work after this call."}},"httpPath":"/companies/{companyId}/credit-agencies/{creditAgencyId}/regenerate-ssh-keys","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"separator","label":"Collection Agencies Management","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Collection Agencies","link":"/api-docs/api-public/collection-agencies","routeSlug":"/api-docs/api-public/collection-agencies","items":[{"label":"Get collection agencies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/collection-agencies/peach.collections.handlers.collection_agencies_list","routeSlug":"/api-docs/api-public/collection-agencies/peach.collections.handlers.collection_agencies_list","metadata":{"seo":{"title":"Get collection agencies","description":"Get collection agencies"}},"httpPath":"/companies/{companyId}/collection-agencies","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Create collection agency","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/collection-agencies/peach.collections.handlers.collection_agency_create","routeSlug":"/api-docs/api-public/collection-agencies/peach.collections.handlers.collection_agency_create","metadata":{"seo":{"title":"Create collection agency","description":"Creates a new collection agency. This is useful when a lender assigns a charged off loan to a third party debt collection agency.The Peach Borrower Portal will display the collection agency information to the borrower. The lender can continue to use Peach as the systemof record / ledger for charged off loans. The lender can post any payments collected by the collection agency as isExternal=true transaction.The Peach system will waterfall the payments and update loan balances."}},"httpPath":"/companies/{companyId}/collection-agencies","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Delete collection agency","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/collection-agencies/peach.collections.handlers.collection_agency_delete","routeSlug":"/api-docs/api-public/collection-agencies/peach.collections.handlers.collection_agency_delete","metadata":{"seo":{"title":"Delete collection agency","description":"Sets isArchived = true on the agency"}},"httpPath":"/companies/{companyId}/collection-agencies/{collectionAgencyId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Get collection agency by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/collection-agencies/peach.collections.handlers.collection_agency_get","routeSlug":"/api-docs/api-public/collection-agencies/peach.collections.handlers.collection_agency_get","metadata":{"seo":{"title":"Get collection agency by ID","description":"Get collection agency by ID"}},"httpPath":"/companies/{companyId}/collection-agencies/{collectionAgencyId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"label":"Update collection agency","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-docs/api-public/collection-agencies/peach.collections.handlers.collection_agency_update","routeSlug":"/api-docs/api-public/collection-agencies/peach.collections.handlers.collection_agency_update","metadata":{"seo":{"title":"Update collection agency","description":"Update collection agency"}},"httpPath":"/companies/{companyId}/collection-agencies/{collectionAgencyId}","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"separator","label":"Errors","version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"},{"type":"group","label":"Errors","link":"/api-docs/api-public/errors","routeSlug":"/api-docs/api-public/errors","items":[],"version":"2025-03-26","isDefault":true,"versionFolderId":"a00ed449"}]}