{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"API keys","siteUrl":"https://docs.peachfinance.com","description":"API and product documentation for Peach Finance, a lending-as-a-service platform."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"api-keys","__idx":0},"children":["API keys"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API keys authenticate requests to the Peach API on behalf of your company. The Admin Portal provides a read-only view of your API keys and their version history, so you can verify which keys are active and track version changes over time."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Availability:"]}," All clients"," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required permissions:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["company.keys:list"]}," (to view)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," API keys are read-only in the Admin Portal. To create, update, or delete API keys, use the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://docs.peachfinance.com/api-docs/"},"children":["Peach API"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"view-api-keys","__idx":1},"children":["View API keys"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["From the Admin Portal sidebar, select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Keys"]},". The list displays all API keys for your company."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Column"},"children":["Column"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["ID"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The API key identifier."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A description of the key's purpose, if one was provided at creation."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Version"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The API version this key uses (format: YYYY-MM-DD). Select to open version history."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["User"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The user account associated with this key."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The API key value."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Last updated"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The date and time the key was last modified."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether the key is Active or Inactive."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Status"]}," filter to show only ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Active"]}," or ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Inactive"]}," keys. Select the column management icon to show, hide, or reorder columns. The list displays 50 keys per page."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"view-version-history","__idx":2},"children":["View version history"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each API key tracks its version changes over time. To view the history:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["From the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Keys"]}," list, select the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Version"]}," link for a key."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The version history dialog opens, showing a table of all version changes."]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Column"},"children":["Column"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Updated at"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The date and time of the version change."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Old version"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The previous API version (YYYY-MM-DD)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["New version"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The updated API version (YYYY-MM-DD)."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["By default, the dialog shows the four most recent changes. Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Show all version history"]}," to see the full list."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"about-api-versions","__idx":3},"children":["About API versions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API versions are date-based (YYYY-MM-DD) and determine which version of the Peach API a key interacts with. When Peach releases API changes, keys continue using their assigned version until explicitly upgraded."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-pages","__idx":4},"children":["Related pages"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/servicing-operations/admin-portal/admin-portal-overview"},"children":["Admin Portal overview"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://docs.peachfinance.com/api-docs/"},"children":["Peach API documentation"]}]}]}]},"headings":[{"value":"API keys","id":"api-keys","depth":1},{"value":"View API keys","id":"view-api-keys","depth":2},{"value":"View version history","id":"view-version-history","depth":2},{"value":"About API versions","id":"about-api-versions","depth":2},{"value":"Related pages","id":"related-pages","depth":2}],"frontmatter":{"seo":{"title":"API keys"}},"lastModified":"2026-09-11T22:55:40.333Z","pagePropGetterError":{"message":"","name":""}},"slug":"/servicing-operations/admin-portal/admin-portal-api-keys","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}