{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Borrower Quickstart Guide","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":"borrower-quickstart-guide","__idx":0},"children":["Borrower Quickstart Guide"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This guide walks you through creating and setting up a borrower in the Peach platform. We'll follow a sample borrower, James Smith, through the essential setup process."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can also do this through the sandbox Agent Portal. This"," ","quickstart covers the API approach."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":1},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before starting this guide, ensure you have:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A Peach account with API access"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Your API key"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Basic familiarity with REST APIs"]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note"]},": The following examples use commonly used fields, but for full details, including additional data and parameters, refer to the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/api-docs/api-public"},"children":["API Reference"]},"."]}]},{"$$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, let's create a borrower and provide the borrower data."]},{"$$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 /api/people\nX-API-KEY: \nContent-Type: application/json\n\n{\n \"borrowerType\": \"person\",\n \"externalId\": \"BORROWER-12345\",\n \"status\": \"active\",\n \"name\": {\n \"firstName\": \"James\",\n \"lastName\": \"Smith\"\n },\n \"dateOfBirth\": \"1990-01-01\",\n \"identity\": {\n \"identityType\": \"SSN\",\n \"value\": \"123-45-6789\"\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 \"status\": 200,\n \"data\": {\n \"createdAt\": \"2024-12-03T18:16:08.286549+00:00\",\n \"updatedAt\": \"2024-12-03T18:16:08.816137+00:00\",\n \"deletedAt\": null,\n \"id\": \"BO-1212-ABAB\",\n \"object\": \"person\",\n \"externalId\": \"BORROWER-12345\",\n \"companyId\": \"CP-3434-EF12\",\n \"status\": \"active\",\n \"statusUpdatedAt\": null,\n \"borrowerType\": \"person\",\n \"identities\": [\n {\n \"createdAt\": \"2024-12-03T18:16:08.819842+00:00\",\n \"updatedAt\": \"2024-12-03T18:16:08.819850+00:00\",\n \"deletedAt\": null,\n \"id\": \"BI-RGMP-9RZB\",\n \"object\": \"identity\",\n \"identityType\": \"SSN\",\n \"valid\": true,\n \"value\": \"ct7klq70kahc73d6mel0\",\n \"isPrimary\": true,\n \"isArchived\": false,\n \"issueDate\": null,\n \"expirationDate\": null,\n \"issuingCountry\": \"\",\n \"customIdentityTypeName\": null\n }\n ],\n \"monitorStartDate\": \"2024-12-03\",\n \"collectionsIntensity\": \"normal\",\n \"commPreferences\": {\n \"sendRemindersWhenCurrent\": true,\n \"statementDeliveryChannels\": []\n },\n \"displayId\": \"BO-1212-ABAB\",\n \"user\": null,\n \"metaData\": null,\n \"dateOfBirth\": \"1990-01-01\",\n \"name\": {\n \"createdAt\": \"2024-12-03T18:16:08.296616+00:00\",\n \"updatedAt\": \"2024-12-03T18:16:08.296626+00:00\",\n \"deletedAt\": null,\n \"id\": \"BN-T678-EO6J\",\n \"object\": \"name\",\n \"status\": \"active\",\n \"prefix\": null,\n \"firstName\": \"James\",\n \"middleName\": null,\n \"lastName\": \"Smith\",\n \"maidenLastName\": null,\n \"suffix\": null,\n \"preferredFirstName\": null,\n \"effectiveAt\": null,\n \"originalValue\": {},\n \"source\": \"lender\",\n \"current\": true\n }\n },\n \"message\": \"Created person 269470\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Verify:"]}," Confirm the response includes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," object and that ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["active"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Take note of the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BO-1212-ABAB"]},") as you'll need it for subsequent requests."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-2-add-contact-information","__idx":5},"children":["Step 2: Add Contact Information"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Next, let's add James' contact details. We'll add his home address, email, and phone number."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"add-home-address","__idx":6},"children":["Add Home Address"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /api/people/{personId}/contacts\nX-API-KEY: \nContent-Type: application/json\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":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Verify:"]}," Run ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/people/{personId}/contacts"]}," to confirm the home address appears."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"add-email-address","__idx":7},"children":["Add Email Address"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /api/people/{personId}/contacts\nX-API-KEY: \nContent-Type: application/json\n\n{\n \"contactType\": \"email\",\n \"label\": \"personal\",\n \"affiliation\": \"self\",\n \"status\": \"primary\",\n \"value\": \"elmer.jones@example.com\",\n \"valid\": true,\n \"verified\": true\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Verify:"]}," Run ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/people/{personId}/contacts"]}," to confirm the email contact was created."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," Since we previously sent James a verification code in a external system we can mark this email"," ","address as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["verified=true"]},". The same goes for his phone number."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"add-phone-number","__idx":8},"children":["Add Phone Number"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /api/people/{personId}/contacts\nX-API-KEY: \nContent-Type: application/json\n\n{\n \"contactType\": \"phone\",\n \"label\": \"mobile\",\n \"affiliation\": \"self\",\n \"status\": \"primary\",\n \"value\": \"+14155551234\",\n \"valid\": true,\n \"verified\": true,\n \"receiveTextMessages\": true\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Verify:"]}," Run ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/people/{personId}/contacts"]}," to confirm the phone contact was created."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-3-set-up-payment-instrument","__idx":9},"children":["Step 3: Set Up Payment Instrument"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Now let's add James' bank account as a payment instrument."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /api/people/{personId}/payment-instruments\nX-API-KEY: \nContent-Type: application/json\n\n{\n \"status\": \"active\",\n \"verified\": false,\n \"nickname\": \"Personal Checking\",\n \"instrumentType\": \"bankAccount\",\n \"accountNumber\": \"1232323\",\n \"routingNumber\": \"021313103\",\n \"accountType\": \"checking\",\n \"accountHolderType\": \"personal\",\n \"accountHolderName\": \"James Smith\"\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Verify:"]}," Run ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/people/{personId}/payment-instruments"]}," to confirm the bank account was added."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-4-create-user-account","__idx":10},"children":["Step 4: Create User Account"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Finally, let's create a user account so James can access the Borrower Portal."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /api/companies/{companyId}/users\nX-API-KEY: \nContent-Type: application/json\n\n{\n \"userType\": \"borrower\",\n \"authType\": {\n \"email\": \"james.smith@example.com\"\n },\n \"roles\": [\n \"ROLE-BORROWER-DEFAULT\"\n ],\n \"associatedPersonId\": \"BO-1212-ABAB\"\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Verify:"]}," Confirm the response includes a user ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," and that ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userType"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["borrower"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," You need to have configured a role previously to reference it here. Contact Peach support"," ","if you don't know which roles you should reference."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":11},"children":["Next steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/borrowers/contact-information"},"children":["Contact Information"]}]}," — Add additional emails and phone numbers to the borrower record."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/borrowers/identities"},"children":["Identities"]}]}," — Attach identity documents like SSN or driver's license."]}]}]},"headings":[{"value":"Borrower Quickstart Guide","id":"borrower-quickstart-guide","depth":1},{"value":"Prerequisites","id":"prerequisites","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 Contact Information","id":"step-2-add-contact-information","depth":2},{"value":"Add Home Address","id":"add-home-address","depth":3},{"value":"Add Email Address","id":"add-email-address","depth":3},{"value":"Add Phone Number","id":"add-phone-number","depth":3},{"value":"Step 3: Set Up Payment Instrument","id":"step-3-set-up-payment-instrument","depth":2},{"value":"Step 4: Create User Account","id":"step-4-create-user-account","depth":2},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"seo":{"title":"Borrower Quickstart Guide"}},"lastModified":"2026-05-01T14:33:55.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/borrowers/quickstart","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}