{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Making Your First API Call","siteUrl":"https://docs.peachfinance.com","description":"API and product documentation for Peach Finance, a lending-as-a-service platform.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"making-your-first-api-call","__idx":0},"children":["Making Your First API Call"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This guide walks you through making your first API calls with Peach's platform, starting with creating a borrower and adding their contact details."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can also do this through the sandbox Admin Portal. This quickstart covers the API approach."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"before-you-start","__idx":1},"children":["Before You Start"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To execute the API calls in this guide, you'll need:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sandbox Environment Access"]},": ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://docs.google.com/forms/d/e/1FAIpQLSf-kJGjUDafsCC3OEvij3y5waoCjvSuSA4uCk3BKcvdpZgmVA/viewform"},"children":["Request access"]}," from Peach support if you haven't already"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Loan Type ID"]},": Available during onboarding or from your Peach account manager"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Testing Tool"]},": We recommend Postman for testing:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Download Postman from ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.postman.com/downloads/"},"children":["postman.com/downloads"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Import the Peach API collection using the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://app.getpostman.com/run-collection/23131454-99e27da9-79dd-4570-929a-72ce999de673?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D23131454-99e27da9-79dd-4570-929a-72ce999de673%26entityType%3Dcollection%26workspaceId%3Dca5f20b2-c9a1-4706-9785-3c05510737ff"},"children":["<img src=\"https://run.pstmn.io/button.svg\" alt=\"Run In Postman\" style=\"width: 128px; height: 32px;\">"]}," button"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Fork the collection to create your own copy"]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-1-create-a-borrower","__idx":2},"children":["Step 1: Create a Borrower"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["First, we'll create a borrower record. A borrower can represent either a person or business in the Peach system."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request","__idx":3},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST https://sandboxapi.peach.finance/api/people\nContent-Type: application/json\nX-API-KEY: <YOUR-API-KEY>\n\n{\n  \"status\": \"active\",\n  \"externalId\": \"BORROWER-123\",  // Optional: your system's ID\n  \"name\": {\n    \"firstName\": \"Elmer\",\n    \"middleName\": \"Fudd\",\n    \"lastName\": \"Jones\"\n  },\n  \"dateOfBirth\": \"1970-01-01\",\n  \"identity\": {\n    \"identityType\": \"SSN\",\n    \"value\": \"111111111\"\n  }\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response","__idx":4},"children":["Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"BO-1234-ABCD\",\n  \"status\": \"active\",\n  \"externalId\": \"BORROWER-123\",\n  \"name\": {\n    \"firstName\": \"Elmer\",\n    \"middleName\": \"Fudd\", \n    \"lastName\": \"Jones\"\n  },\n  \"dateOfBirth\": \"1970-01-01\",\n  \"identity\": {\n    \"identityType\": \"SSN\",\n    \"value\": \"111111111\"\n  },\n  \"createdAt\": \"2024-01-09T10:30:00Z\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Verify:"]}," Confirm the response includes an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," field and that ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["active"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Save the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," value from the response—we'll refer to it as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PERSON_ID"]}," in the next steps."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-2-add-home-address-contact-details","__idx":5},"children":["Step 2: Add Home Address Contact Details"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After creating the borrower, let's add their home address as a contact method."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-1","__idx":6},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST https://sandboxapi.peach.finance/api/people/{PERSON_ID}/contacts\nContent-Type: application/json\nX-API-KEY: <YOUR-API-KEY>\n\n{\n  \"contactType\": \"address\",\n  \"label\": \"home\",\n  \"affiliation\": \"self\",\n  \"status\": \"primary\",\n  \"address\": {\n    \"addressLine1\": \"1 Main St\",\n    \"addressLine2\": \"\",\n    \"city\": \"Houston\",\n    \"state\": \"TX\",\n    \"postalCode\": \"77002\",\n    \"country\": \"US\"\n  }\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response-1","__idx":7},"children":["Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"CT-456-DEF\",\n  \"contactType\": \"address\",\n  \"label\": \"home\",\n  \"affiliation\": \"self\",\n  \"status\": \"primary\",\n  \"address\": {\n    \"addressLine1\": \"1 Main St\",\n    \"addressLine2\": \"\",\n    \"city\": \"Houston\",\n    \"state\": \"TX\",\n    \"postalCode\": \"77002\",\n    \"country\": \"US\"\n  },\n  \"createdAt\": \"2024-01-09T10:35:00Z\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Verify:"]}," Run ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/people/{PERSON_ID}/contacts"]}," to confirm the home address appears with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["primary"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":8},"children":["Next Steps"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Now that you've created a borrower and added their contact information, you can:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Add additional contact methods (email, phone)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Create a user account for the borrower"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Create a loan for the borrower"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Enable autopay"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For detailed information about these and other operations, see:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-docs/api-public/#section/Introduction"},"children":["API Reference"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/getting-started/core-concepts"},"children":["Core Concepts"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/borrowers/"},"children":["Borrower Management"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/loan-lifecycle/"},"children":["Loan Management"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"additional-tips","__idx":9},"children":["Additional Tips"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Always store the Peach ID values returned in responses for future reference"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use meaningful external IDs to help map Peach records to your system"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Test thoroughly in sandbox before moving to production"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Contact Peach support if you need help with any API operations"]}]}]},"headings":[{"value":"Making Your First API Call","id":"making-your-first-api-call","depth":1},{"value":"Before You Start","id":"before-you-start","depth":2},{"value":"Step 1: Create a Borrower","id":"step-1-create-a-borrower","depth":2},{"value":"Request","id":"request","depth":3},{"value":"Response","id":"response","depth":3},{"value":"Step 2: Add Home Address Contact Details","id":"step-2-add-home-address-contact-details","depth":2},{"value":"Request","id":"request-1","depth":3},{"value":"Response","id":"response-1","depth":3},{"value":"Next Steps","id":"next-steps","depth":2},{"value":"Additional Tips","id":"additional-tips","depth":2}],"frontmatter":{"seo":{"title":"Making Your First API Call"}},"lastModified":"2026-05-21T20:50:35.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/getting-started/quickstart","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}