{"info":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","description":"\n
Authentication
\n

For the PPDocs API we will use an API key for authentication. The key will need to be supplied in the header similar to the preconfigured options included in this documentation collection. The key name must be \"X-Api-Key\" and the server will provide a message if no key is provided. If you added the header and receive a message saying no key was provided it is recommended that you check the spelling of the header. For the sandbox the value of the \"X-Api-Key\" can be anything so long as it is not null or whitespace. For the production you will have an API key that is unique to each user and all users should take appropriate measures to ensure their API key remains secure.

\n

The sandbox environment is a copy of the production environment that you can use to test your integration. It will not contain any real data. It is meant to be used to test your integration and to ensure that it is working properly before you begin using the production environment.

\n

The production environment is the real environment that you will be using to integrate with the PPDocs API. It will contain real data and will be used to process real transactions. It is important that you test your integration in the sandbox environment before you begin using the production environment.

\n

Contact Support:\n Name: PPDocs\n Email: support@ppdocs.com

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"16492808","collectionId":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","publishedId":"2s9YsQ9AAy","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-01-16T22:44:35.000Z"},"item":[{"name":"Account","item":[{"name":"Get Account","id":"51bf85f1-2ea4-4203-a5fb-a4b076d63740","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/Account","description":"

This endpoint will return the current user's account information.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Account"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"0bfdb6ff-4e2f-485e-b46e-7ac66af0dd72","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":"//api/v1/Account"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"accountId\": \"\",\n \"adminYn\": \"\",\n \"autoArchiveDays\": \"\",\n \"branch\": {\n \"branchId\": \"\",\n \"city\": \"\",\n \"client\": {\n \"clientId\": \"\",\n \"name\": \"\",\n \"url\": \"\"\n },\n \"clientId\": \"\",\n \"contact\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"state\": \"\",\n \"street1\": \"\",\n \"zip\": \"\",\n \"street2\": \"\",\n \"ext\": \"\",\n \"originationSystem\": \"\"\n },\n \"branchId\": \"\",\n \"city\": \"\",\n \"company\": \"\",\n \"dateTimeRegistered\": \"\",\n \"email\": \"\",\n \"emailFormat\": \"Mobile\",\n \"environment\": \"\",\n \"firstName\": \"\",\n \"fullAddress\": \"\",\n \"fullName\": \"\",\n \"lastName\": \"\",\n \"lastUpdated\": \"\",\n \"phone\": \"\",\n \"state\": \"\",\n \"street1\": \"\",\n \"webhooks\": [\n {\n \"eventNotification\": \"PackageSignedEvent\",\n \"id\": \"\",\n \"webhookUrl\": \"\"\n },\n {\n \"eventNotification\": \"OrderStatusChangedEvent\",\n \"id\": \"\",\n \"webhookUrl\": \"\"\n }\n ],\n \"zip\": \"\",\n \"street2\": \"\",\n \"ext\": \"\",\n \"lastConnect\": \"\",\n \"lastKnownIp\": \"\",\n \"dateTimeLastOrdered\": \"\",\n \"calculatorSubscriptionExpDate\": \"\"\n}"}],"_postman_id":"51bf85f1-2ea4-4203-a5fb-a4b076d63740"},{"name":"Update Account","id":"df7c5357-bfc1-4c6f-977d-808e8f963c06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"autoArchiveDays\": \"\",\n \"city\": \"\",\n \"company\": \"\",\n \"email\": \"\",\n \"emailFormat\": \"Mobile\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": \"\",\n \"receiveNewsletterEmails\": \"\",\n \"receiveReleaseNoteEmails\": \"\",\n \"state\": \"\",\n \"street1\": \"\",\n \"zip\": \"\",\n \"street2\": \"\",\n \"ext\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/v1/Account","description":"

This endpoint will update the current user's account information with the AccountUpdateRequest object that is provided with the request.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Account"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"eb4d146b-a2e6-436c-81fc-f9696a785106","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"autoArchiveDays\": \"\",\n \"city\": \"\",\n \"company\": \"\",\n \"email\": \"\",\n \"emailFormat\": \"Mobile\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"phone\": \"\",\n \"receiveNewsletterEmails\": \"\",\n \"receiveReleaseNoteEmails\": \"\",\n \"state\": \"\",\n \"street1\": \"\",\n \"zip\": \"\",\n \"street2\": \"\",\n \"ext\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/v1/Account"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"accountId\": \"\",\n \"adminYn\": \"\",\n \"autoArchiveDays\": \"\",\n \"branch\": {\n \"branchId\": \"\",\n \"city\": \"\",\n \"client\": {\n \"clientId\": \"\",\n \"name\": \"\",\n \"url\": \"\"\n },\n \"clientId\": \"\",\n \"contact\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone\": \"\",\n \"state\": \"\",\n \"street1\": \"\",\n \"zip\": \"\",\n \"street2\": \"\",\n \"ext\": \"\",\n \"originationSystem\": \"\"\n },\n \"branchId\": \"\",\n \"city\": \"\",\n \"company\": \"\",\n \"dateTimeRegistered\": \"\",\n \"email\": \"\",\n \"emailFormat\": \"Mobile\",\n \"environment\": \"\",\n \"firstName\": \"\",\n \"fullAddress\": \"\",\n \"fullName\": \"\",\n \"lastName\": \"\",\n \"lastUpdated\": \"\",\n \"phone\": \"\",\n \"state\": \"\",\n \"street1\": \"\",\n \"webhooks\": [\n {\n \"eventNotification\": \"PackageSignedEvent\",\n \"id\": \"\",\n \"webhookUrl\": \"\"\n },\n {\n \"eventNotification\": \"OrderStatusChangedEvent\",\n \"id\": \"\",\n \"webhookUrl\": \"\"\n }\n ],\n \"zip\": \"\",\n \"street2\": \"\",\n \"ext\": \"\",\n \"lastConnect\": \"\",\n \"lastKnownIp\": \"\",\n \"dateTimeLastOrdered\": \"\",\n \"calculatorSubscriptionExpDate\": \"\"\n}"}],"_postman_id":"df7c5357-bfc1-4c6f-977d-808e8f963c06"},{"name":"Create Web Hook","id":"7172a475-01a2-42c4-b25e-c460216a5377","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"eventNotification\": \"PackageDeliveredEvent\",\n \"webhookUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/v1/Account/WebHooks","description":"

Endpoint to create a webhook alert.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Account","WebHooks"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"e04180be-4d4c-4635-ba43-b58d3b8e30b1","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"eventNotification\": \"PackageDeliveredEvent\",\n \"webhookUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/v1/Account/WebHooks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"eventNotification\": \"LoanSubmittedEvent\",\n \"id\": \"\",\n \"webhookUrl\": \"\"\n}"},{"id":"41f3413d-80f8-4b62-b3d5-5dce11dfeb88","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"eventNotification\": \"PackageDeliveredEvent\",\n \"webhookUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/v1/Account/WebHooks"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}"},{"id":"9a214c8f-f819-4e0a-866a-55f25d4011aa","name":"Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"eventNotification\": \"PackageDeliveredEvent\",\n \"webhookUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/v1/Account/WebHooks"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}"}],"_postman_id":"7172a475-01a2-42c4-b25e-c460216a5377"},{"name":"Update Web Hook","id":"39db4f18-4b00-4760-8adb-ebc67517b243","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"eventNotification\": \"LoanRedrawEvent\",\n \"id\": \"\",\n \"webhookUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/v1/Account/WebHooks/:id","description":"

Endpoint to update one of your webhook alerts.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Account","WebHooks",":id"],"host":["/"],"query":[],"variable":[{"id":"cdff4f83-290e-4df5-b486-ad9a14ff6060","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"c86d883c-f0bb-408e-a47e-16083f8d665d","name":"No Content","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"eventNotification\": \"LoanRedrawEvent\",\n \"id\": \"\",\n \"webhookUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//api/v1/Account/WebHooks/:id","host":["/"],"path":["api","v1","Account","WebHooks",":id"],"variable":[{"key":"id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"c6efadce-acb8-4a2a-9a9a-1d7d57e53bb1","name":"Bad Request","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"eventNotification\": \"LoanRedrawEvent\",\n \"id\": \"\",\n \"webhookUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//api/v1/Account/WebHooks/:id","host":["/"],"path":["api","v1","Account","WebHooks",":id"],"variable":[{"key":"id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}"},{"id":"4fd0720a-c2e6-4919-9836-047dd5e6f740","name":"Not Found","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"eventNotification\": \"LoanRedrawEvent\",\n \"id\": \"\",\n \"webhookUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//api/v1/Account/WebHooks/:id","host":["/"],"path":["api","v1","Account","WebHooks",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}"},{"id":"cf2616d4-b5c1-4101-95ce-67925dc3b7db","name":"Error","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"eventNotification\": \"LoanRedrawEvent\",\n \"id\": \"\",\n \"webhookUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//api/v1/Account/WebHooks/:id","host":["/"],"path":["api","v1","Account","WebHooks",":id"],"variable":[{"key":"id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}"}],"_postman_id":"39db4f18-4b00-4760-8adb-ebc67517b243"},{"name":"Delete Web Hook","id":"18a1f7d5-e762-4a3e-81f1-759deed0d550","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/Account/WebHooks/:id","description":"

Endpoint to delete a webhook alert.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Account","WebHooks",":id"],"host":["/"],"query":[],"variable":[{"id":"5e745d39-031b-4214-8194-bbc5d9357960","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"ed8a8b99-9054-4f47-9a18-de23068a2176","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/Account/WebHooks/:id","host":["/"],"path":["api","v1","Account","WebHooks",":id"],"variable":[{"key":"id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"c267744d-7ba0-4fa3-b489-af60162a2098","name":"Bad Request","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/Account/WebHooks/:id","host":["/"],"path":["api","v1","Account","WebHooks",":id"],"variable":[{"key":"id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}"},{"id":"87249f56-bb06-4110-ab5d-5a5ad45442be","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/Account/WebHooks/:id","host":["/"],"path":["api","v1","Account","WebHooks",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}"},{"id":"edcc1b52-a9f8-49b1-b7a4-97ec12c9039d","name":"Error","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/Account/WebHooks/:id","host":["/"],"path":["api","v1","Account","WebHooks",":id"],"variable":[{"key":"id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}"}],"_postman_id":"18a1f7d5-e762-4a3e-81f1-759deed0d550"}],"id":"5aa5a1e1-c66b-4042-b2df-92a635f72db0","description":"

This API is meant for retrieving and updating account information.

\n","_postman_id":"5aa5a1e1-c66b-4042-b2df-92a635f72db0","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}}},{"name":"Investors","item":[{"name":"Get Investor","id":"07166e98-af84-4bc4-ba5f-42af02e27d22","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/Investors/:investorId","description":"

This endpoint will return the investor information for the investorId provided in the request.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Investors",":investorId"],"host":["/"],"query":[],"variable":[{"id":"add24181-e90c-43ae-a201-35f8daf44de2","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"investorId"}]}},"response":[{"id":"faa288d3-008f-4ffd-8550-88656ce434b1","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/Investors/:investorId","host":["/"],"path":["api","v1","Investors",":investorId"],"variable":[{"key":"investorId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"city\": \"\",\n \"company\": \"\",\n \"contact\": \"\",\n \"defaultProgramId\": \"\",\n \"investorId\": \"\",\n \"phone\": \"\",\n \"state\": \"\",\n \"street1\": \"\",\n \"zip\": \"\",\n \"street2\": \"\",\n \"ext\": \"\",\n \"fax\": \"\"\n}"},{"id":"73e0243c-cb02-44a3-bf6e-ba1bffc4edba","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/Investors/:investorId","host":["/"],"path":["api","v1","Investors",":investorId"],"variable":[{"key":"investorId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}"},{"id":"22203031-a163-4aab-a6da-38af9df59477","name":"Error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/Investors/:investorId","host":["/"],"path":["api","v1","Investors",":investorId"],"variable":[{"key":"investorId"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}"}],"_postman_id":"07166e98-af84-4bc4-ba5f-42af02e27d22"},{"name":"Get Investors","id":"3002a004-4f44-4fc5-9dd1-23f960a7e433","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/Investors","description":"

This endpoint will return a list of all investors.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Investors"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"1c4b22d1-4158-41a4-a741-b73e8207e428","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":"//api/v1/Investors"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"city\": \"\",\n \"company\": \"\",\n \"contact\": \"\",\n \"defaultProgramId\": \"\",\n \"investorId\": \"\",\n \"phone\": \"\",\n \"state\": \"\",\n \"street1\": \"\",\n \"zip\": \"\",\n \"street2\": \"\",\n \"ext\": \"\",\n \"fax\": \"\",\n \"tags\": \"\"\n },\n {\n \"city\": \"\",\n \"company\": \"\",\n \"contact\": \"\",\n \"defaultProgramId\": \"\",\n \"investorId\": \"\",\n \"phone\": \"\",\n \"state\": \"\",\n \"street1\": \"\",\n \"zip\": \"\",\n \"street2\": \"\",\n \"ext\": \"\",\n \"fax\": \"\",\n \"tags\": \"\"\n }\n]"}],"_postman_id":"3002a004-4f44-4fc5-9dd1-23f960a7e433"}],"id":"0150b257-0dad-42a3-bc77-dfadd097a557","description":"

This API facilitates the retrieval of investor information and can be used to retrieve a specific or all investors. InvestorId is needed to create a loan.

\n","_postman_id":"0150b257-0dad-42a3-bc77-dfadd097a557","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}}},{"name":"Invoices","item":[{"name":"Get Invoice","id":"87d8227f-fa4d-46a0-aa81-a0846a82dce3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/Invoices/:invoiceNumber?includeDownloadUrl=","description":"

This endpoint will return the invoice information for the invoice number provided. Query with IncludeDownloadUrl=true to include the temporary url in the response. For the sandbox you can use either '11-11-11111' or '22-22-22222' to query for sample data.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Invoices",":invoiceNumber"],"host":["/"],"query":[{"key":"includeDownloadUrl","value":""}],"variable":[{"id":"592462ec-ec17-41fe-b8d4-fe6647fe30b9","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"invoiceNumber"}]}},"response":[{"id":"1580134e-ded2-4d9c-a07a-26a8eec8812e","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/Invoices/:invoiceNumber?includeDownloadUrl=","host":["/"],"path":["api","v1","Invoices",":invoiceNumber"],"query":[{"key":"includeDownloadUrl","value":""}],"variable":[{"key":"invoiceNumber"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"attachments\": [\n {\n \"attachDate\": \"\",\n \"attachmentId\": \"\",\n \"fileName\": \"\",\n \"size\": \"\",\n \"downloadUrl\": \"\"\n },\n {\n \"attachDate\": \"\",\n \"attachmentId\": \"\",\n \"fileName\": \"\",\n \"size\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"city\": \"\",\n \"company\": \"\",\n \"contact\": \"\",\n \"description\": \"\",\n \"due\": \"\",\n \"email\": \"\",\n \"invoiceAmount\": \"\",\n \"invoiceDate\": \"\",\n \"invoiceNumber\": \"\",\n \"invoiceTo\": \"\",\n \"invoiceType\": \"LegalReview\",\n \"orders\": [\n {\n \"description\": \"\",\n \"orderNumber\": \"\",\n \"orderType\": \"eSign\",\n \"recVia\": \"\",\n \"status\": \"\",\n \"submittedBy\": \"\",\n \"timeModified\": \"\",\n \"timeNeeded\": \"\",\n \"timeReceived\": \"\",\n \"totalFee\": \"\",\n \"clientInvoiceNumber\": \"\",\n \"checkerId\": \"\",\n \"operatorId\": \"\",\n \"fulfillerId\": \"\",\n \"timeReleased\": \"\",\n \"relVia\": \"\"\n },\n {\n \"description\": \"\",\n \"orderNumber\": \"\",\n \"orderType\": \"ExpressDocs\",\n \"recVia\": \"\",\n \"status\": \"\",\n \"submittedBy\": \"\",\n \"timeModified\": \"\",\n \"timeNeeded\": \"\",\n \"timeReceived\": \"\",\n \"totalFee\": \"\",\n \"clientInvoiceNumber\": \"\",\n \"checkerId\": \"\",\n \"operatorId\": \"\",\n \"fulfillerId\": \"\",\n \"timeReleased\": \"\",\n \"relVia\": \"\"\n }\n ],\n \"paid\": \"\",\n \"payments\": [\n {\n \"amount\": \"\",\n \"paymentDate\": \"\",\n \"paymentId\": \"\",\n \"reference\": \"\",\n \"status\": \"\",\n \"invoiceNumber\": \"\"\n },\n {\n \"amount\": \"\",\n \"paymentDate\": \"\",\n \"paymentId\": \"\",\n \"reference\": \"\",\n \"status\": \"\",\n \"invoiceNumber\": \"\"\n }\n ],\n \"phone\": \"\",\n \"relatedInvoices\": [\n {\n \"city\": \"\",\n \"company\": \"\",\n \"contact\": \"\",\n \"description\": \"\",\n \"due\": \"\",\n \"email\": \"\",\n \"invoiceAmount\": \"\",\n \"invoiceDate\": \"\",\n \"invoiceNumber\": \"\",\n \"invoiceTo\": \"\",\n \"invoiceType\": \"Fulfillment\",\n \"paid\": \"\",\n \"phone\": \"\",\n \"state\": \"\",\n \"status\": \"Due\",\n \"street1\": \"\",\n \"timeModified\": \"\",\n \"zip\": \"\",\n \"street2\": \"\",\n \"ext\": \"\"\n },\n {\n \"city\": \"\",\n \"company\": \"\",\n \"contact\": \"\",\n \"description\": \"\",\n \"due\": \"\",\n \"email\": \"\",\n \"invoiceAmount\": \"\",\n \"invoiceDate\": \"\",\n \"invoiceNumber\": \"\",\n \"invoiceTo\": \"\",\n \"invoiceType\": \"PPDocs\",\n \"paid\": \"\",\n \"phone\": \"\",\n \"state\": \"\",\n \"status\": \"Followup\",\n \"street1\": \"\",\n \"timeModified\": \"\",\n \"zip\": \"\",\n \"street2\": \"\",\n \"ext\": \"\"\n }\n ],\n \"state\": \"\",\n \"status\": \"Followup\",\n \"street1\": \"\",\n \"timeModified\": \"\",\n \"zip\": \"\",\n \"street2\": \"\",\n \"ext\": \"\",\n \"downloadUrl\": \"\"\n}"}],"_postman_id":"87d8227f-fa4d-46a0-aa81-a0846a82dce3"}],"id":"677b8d2e-f878-44fc-af12-8ebd69dee6ad","description":"

This API is meant for retrieving and updating invoice information.

\n","_postman_id":"677b8d2e-f878-44fc-af12-8ebd69dee6ad","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}}},{"name":"LenderSetups","item":[{"name":"Get Lender Setup List","id":"e02a140d-d9b5-40aa-8e01-c81fca257d46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/LenderSetups","description":"

Returns the a list of lender setups available to use on your loan orders

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","LenderSetups"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"607037b0-689b-4e9c-b593-cf14ea621c3a","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":"//api/v1/LenderSetups"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"account\": {\n \"accountId\": \"\",\n \"branchId\": \"\",\n \"city\": \"\",\n \"company\": \"\",\n \"dateTimeRegistered\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"fullName\": \"\",\n \"lastName\": \"\",\n \"lastUpdated\": \"\",\n \"phone\": \"\",\n \"state\": \"\",\n \"street1\": \"\",\n \"zip\": \"\",\n \"street2\": \"\",\n \"ext\": \"\",\n \"lastConnect\": \"\",\n \"lastKnownIp\": \"\"\n },\n \"accountId\": \"\",\n \"canDelete\": \"\",\n \"canEdit\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"timeModified\": \"\",\n \"timeLastUsed\": \"\",\n \"sharedBy\": \"\",\n \"sharedTo\": \"\"\n },\n {\n \"account\": {\n \"accountId\": \"\",\n \"branchId\": \"\",\n \"city\": \"\",\n \"company\": \"\",\n \"dateTimeRegistered\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"fullName\": \"\",\n \"lastName\": \"\",\n \"lastUpdated\": \"\",\n \"phone\": \"\",\n \"state\": \"\",\n \"street1\": \"\",\n \"zip\": \"\",\n \"street2\": \"\",\n \"ext\": \"\",\n \"lastConnect\": \"\",\n \"lastKnownIp\": \"\"\n },\n \"accountId\": \"\",\n \"canDelete\": \"\",\n \"canEdit\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"timeModified\": \"\",\n \"timeLastUsed\": \"\",\n \"sharedBy\": \"\",\n \"sharedTo\": \"\"\n }\n]"}],"_postman_id":"e02a140d-d9b5-40aa-8e01-c81fca257d46"},{"name":"Get Lender Setup","id":"80074cff-3df2-4b10-b3fb-77c5f9e9d812","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/LenderSetups/:id","description":"

Returns the a list of lender setups available to use on your loan orders

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","LenderSetups",":id"],"host":["/"],"query":[],"variable":[{"id":"4ec064b3-56d6-41c0-be81-4c636c0557ba","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"e9248b82-7328-49cb-a181-c430eded9b0f","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/LenderSetups/:id","host":["/"],"path":["api","v1","LenderSetups",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"account\": {\n \"accountId\": \"\",\n \"branchId\": \"\",\n \"city\": \"\",\n \"company\": \"\",\n \"dateTimeRegistered\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"fullName\": \"\",\n \"lastName\": \"\",\n \"lastUpdated\": \"\",\n \"phone\": \"\",\n \"state\": \"\",\n \"street1\": \"\",\n \"zip\": \"\",\n \"street2\": \"\",\n \"ext\": \"\",\n \"lastConnect\": \"\",\n \"lastKnownIp\": \"\"\n },\n \"accountId\": \"\",\n \"appraisalType\": \"\",\n \"canEdit\": \"\",\n \"fhaRenewalMethod\": \"\",\n \"fnmaAutomaticUnderwritingYN\": \"\",\n \"freddieMacAutomaticUnderwritingYN\": \"\",\n \"fulfillmentServiceYN\": \"\",\n \"id\": \"\",\n \"isOwner\": \"\",\n \"lateChargeMax\": \"\",\n \"lateChargeMin\": \"\",\n \"leConfirmReceipt\": \"\",\n \"name\": \"\",\n \"partialPayment\": \"\",\n \"prepaidInterestDatesYN\": \"\",\n \"prepaymentPenaltyMaxAmount\": \"\",\n \"prepaymentPenaltyYN\": \"\",\n \"prepayTerm\": \"\",\n \"printOptions\": \"\",\n \"propertyValuationMethodType\": \"\",\n \"ruralCreditorYN\": \"\",\n \"shareType\": \"SharedWithClient\",\n \"showURLAFieldsYN\": \"\",\n \"smallCreditorYN\": \"\",\n \"surveyType\": \"\",\n \"timeModified\": \"\",\n \"trackFeesYN\": \"\",\n \"ucdEnabledYN\": \"\",\n \"whichAppraisalType\": \"\",\n \"whichLegal\": \"\",\n \"timeLastUsed\": \"\",\n \"sharedBy\": \"\",\n \"sharedTo\": \"\",\n \"mersOrgID\": \"\",\n \"lei\": \"\",\n \"barcodeValue\": \"\",\n \"invoiceTo\": \"\",\n \"virPackBarcodeOriginationCode\": \"\",\n \"vaIdentificationNumber\": \"\"\n}"},{"id":"89ef56ac-4110-476f-b97a-31366ae63e73","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/LenderSetups/:id","host":["/"],"path":["api","v1","LenderSetups",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}"},{"id":"45b511ff-eb2f-4775-8ad5-fd7ffd30e8de","name":"Error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/LenderSetups/:id","host":["/"],"path":["api","v1","LenderSetups",":id"],"variable":[{"key":"id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}"}],"_postman_id":"80074cff-3df2-4b10-b3fb-77c5f9e9d812"}],"id":"33868cc3-fc8d-4ff5-8f1f-af22c2973085","description":"

This API is meant for retrieving and updating lender setups information.

\n","_postman_id":"33868cc3-fc8d-4ff5-8f1f-af22c2973085","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}}},{"name":"LoanPrograms","item":[{"name":"Get Loan Programs","id":"18461da5-dc8b-466f-a4cb-7ba0d3f9b98d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/LoanPrograms","description":"

Returns a list of programs available under this account. To change this list, please setup your account at your account page.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","LoanPrograms"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"43b8a9da-a038-4254-9ccc-10c915b95b04","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":"//api/v1/LoanPrograms"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"name\": \"\",\n \"plans\": [\n {\n \"favorite\": \"\",\n \"isArm\": \"\",\n \"name\": \"\",\n \"planId\": \"\",\n \"programId\": \"\",\n \"rateType\": \"Adjustable\",\n \"visible\": \"\",\n \"planNumber\": \"\",\n \"note\": \"\",\n \"addendum\": \"\",\n \"rider\": \"\",\n \"tag\": \"\",\n \"convertable\": \"\",\n \"conversionFee\": \"\",\n \"conversionNotes\": \"\",\n \"periodsToFirstPaymentChange\": \"\",\n \"periodsBetweenPaymentChanges\": \"\",\n \"periodsToFirstChange\": \"\",\n \"periodsBetweenChanges\": \"\",\n \"lifeCap\": \"\",\n \"periodicCap\": \"\",\n \"firstRateCapUp\": \"\",\n \"firstRateCapDn\": \"\",\n \"indexBasedOnPetName\": \"\"\n },\n {\n \"favorite\": \"\",\n \"isArm\": \"\",\n \"name\": \"\",\n \"planId\": \"\",\n \"programId\": \"\",\n \"rateType\": \"Adjustable\",\n \"visible\": \"\",\n \"planNumber\": \"\",\n \"note\": \"\",\n \"addendum\": \"\",\n \"rider\": \"\",\n \"tag\": \"\",\n \"convertable\": \"\",\n \"conversionFee\": \"\",\n \"conversionNotes\": \"\",\n \"periodsToFirstPaymentChange\": \"\",\n \"periodsBetweenPaymentChanges\": \"\",\n \"periodsToFirstChange\": \"\",\n \"periodsBetweenChanges\": \"\",\n \"lifeCap\": \"\",\n \"periodicCap\": \"\",\n \"firstRateCapUp\": \"\",\n \"firstRateCapDn\": \"\",\n \"indexBasedOnPetName\": \"\"\n }\n ],\n \"programId\": \"\"\n },\n {\n \"name\": \"\",\n \"plans\": [\n {\n \"favorite\": \"\",\n \"isArm\": \"\",\n \"name\": \"\",\n \"planId\": \"\",\n \"programId\": \"\",\n \"rateType\": \"Adjustable\",\n \"visible\": \"\",\n \"planNumber\": \"\",\n \"note\": \"\",\n \"addendum\": \"\",\n \"rider\": \"\",\n \"tag\": \"\",\n \"convertable\": \"\",\n \"conversionFee\": \"\",\n \"conversionNotes\": \"\",\n \"periodsToFirstPaymentChange\": \"\",\n \"periodsBetweenPaymentChanges\": \"\",\n \"periodsToFirstChange\": \"\",\n \"periodsBetweenChanges\": \"\",\n \"lifeCap\": \"\",\n \"periodicCap\": \"\",\n \"firstRateCapUp\": \"\",\n \"firstRateCapDn\": \"\",\n \"indexBasedOnPetName\": \"\"\n },\n {\n \"favorite\": \"\",\n \"isArm\": \"\",\n \"name\": \"\",\n \"planId\": \"\",\n \"programId\": \"\",\n \"rateType\": \"Variable\",\n \"visible\": \"\",\n \"planNumber\": \"\",\n \"note\": \"\",\n \"addendum\": \"\",\n \"rider\": \"\",\n \"tag\": \"\",\n \"convertable\": \"\",\n \"conversionFee\": \"\",\n \"conversionNotes\": \"\",\n \"periodsToFirstPaymentChange\": \"\",\n \"periodsBetweenPaymentChanges\": \"\",\n \"periodsToFirstChange\": \"\",\n \"periodsBetweenChanges\": \"\",\n \"lifeCap\": \"\",\n \"periodicCap\": \"\",\n \"firstRateCapUp\": \"\",\n \"firstRateCapDn\": \"\",\n \"indexBasedOnPetName\": \"\"\n }\n ],\n \"programId\": \"\"\n }\n]"}],"_postman_id":"18461da5-dc8b-466f-a4cb-7ba0d3f9b98d"},{"name":"Get Loan Program","id":"9dcdcfc9-9fff-45e6-8404-f8900fc49ee0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/LoanPrograms/:programId","description":"

Returns the loan program and all available plans within the given program.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","LoanPrograms",":programId"],"host":["/"],"query":[],"variable":[{"id":"87433e16-52a7-4a3e-afb6-4849afde29c8","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"programId"}]}},"response":[{"id":"dd5a1677-55d2-4680-a7cc-b00f1400989e","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/LoanPrograms/:programId","host":["/"],"path":["api","v1","LoanPrograms",":programId"],"variable":[{"key":"programId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"\",\n \"plans\": [\n {\n \"favorite\": \"\",\n \"isArm\": \"\",\n \"name\": \"\",\n \"planId\": \"\",\n \"programId\": \"\",\n \"rateType\": \"Adjustable\",\n \"visible\": \"\",\n \"planNumber\": \"\",\n \"note\": \"\",\n \"addendum\": \"\",\n \"rider\": \"\",\n \"tag\": \"\",\n \"convertable\": \"\",\n \"conversionFee\": \"\",\n \"conversionNotes\": \"\",\n \"periodsToFirstPaymentChange\": \"\",\n \"periodsBetweenPaymentChanges\": \"\",\n \"periodsToFirstChange\": \"\",\n \"periodsBetweenChanges\": \"\",\n \"lifeCap\": \"\",\n \"periodicCap\": \"\",\n \"firstRateCapUp\": \"\",\n \"firstRateCapDn\": \"\",\n \"indexBasedOnPetName\": \"\"\n },\n {\n \"favorite\": \"\",\n \"isArm\": \"\",\n \"name\": \"\",\n \"planId\": \"\",\n \"programId\": \"\",\n \"rateType\": \"Adjustable\",\n \"visible\": \"\",\n \"planNumber\": \"\",\n \"note\": \"\",\n \"addendum\": \"\",\n \"rider\": \"\",\n \"tag\": \"\",\n \"convertable\": \"\",\n \"conversionFee\": \"\",\n \"conversionNotes\": \"\",\n \"periodsToFirstPaymentChange\": \"\",\n \"periodsBetweenPaymentChanges\": \"\",\n \"periodsToFirstChange\": \"\",\n \"periodsBetweenChanges\": \"\",\n \"lifeCap\": \"\",\n \"periodicCap\": \"\",\n \"firstRateCapUp\": \"\",\n \"firstRateCapDn\": \"\",\n \"indexBasedOnPetName\": \"\"\n }\n ],\n \"programId\": \"\"\n}"},{"id":"61810b5f-c795-4265-8b73-729a915e4b7d","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/LoanPrograms/:programId","host":["/"],"path":["api","v1","LoanPrograms",":programId"],"variable":[{"key":"programId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}"},{"id":"5d81dd5c-27d6-4f58-bf47-16c8035bb39d","name":"Error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/LoanPrograms/:programId","host":["/"],"path":["api","v1","LoanPrograms",":programId"],"variable":[{"key":"programId"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}"}],"_postman_id":"9dcdcfc9-9fff-45e6-8404-f8900fc49ee0"},{"name":"Get Loan Plan","id":"ee3f0353-b27e-47ba-b962-ac72d9abd840","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/LoanPrograms/:loanPlanId/LoanPlan","description":"

Returns information about a given loan plan.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","LoanPrograms",":loanPlanId","LoanPlan"],"host":["/"],"query":[],"variable":[{"id":"ed215eb3-3723-49a9-873d-960befba725a","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"loanPlanId"}]}},"response":[{"id":"d87f21c1-7ff2-4172-8e10-ace7c45d46a9","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/LoanPrograms/:loanPlanId/LoanPlan","host":["/"],"path":["api","v1","LoanPrograms",":loanPlanId","LoanPlan"],"variable":[{"key":"loanPlanId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"indexId\": \"\",\n \"isArm\": \"\",\n \"isCustomPlan\": \"\",\n \"planId\": \"\",\n \"planName\": \"\",\n \"planNumber\": \"\",\n \"programId\": \"\",\n \"rateType\": \"Fixed\",\n \"planUrl\": \"\",\n \"note\": \"\",\n \"adden\": \"\",\n \"rider\": \"\",\n \"indexURL\": \"\",\n \"indexBasedOnPetName\": \"\",\n \"indexBasedOn\": \"\",\n \"publishInfo\": \"\",\n \"convertable\": \"\",\n \"conversionNotes\": \"\",\n \"conversionFee\": \"\",\n \"margin\": \"\",\n \"isInitialTeaser\": \"\",\n \"firstRateCapUp\": \"\",\n \"firstRateCapDn\": \"\",\n \"periodicCap\": \"\",\n \"lifeCap\": \"\",\n \"periodsToFirstChange\": \"\",\n \"periodsBetweenChanges\": \"\",\n \"periodsToFirstPaymentChange\": \"\",\n \"periodsBetweenPaymentChanges\": \"\",\n \"rateChangeFrequency\": \"\",\n \"rateChangeFrequencyPeriod\": \"\",\n \"paymentChangeFrequency\": \"\",\n \"paymentChangeFrequencyPeriod\": \"\",\n \"minFirstRate\": \"\",\n \"minLifeRate\": \"\",\n \"maxFirstRate\": \"\",\n \"maxLifeRate\": \"\",\n \"rounding\": \"\",\n \"roundingFactor\": \"\",\n \"prepaymentPenalty\": \"\",\n \"prepayPenaltyTerm\": \"\",\n \"prepayPenaltyInfo\": \"\",\n \"assumable\": \"\",\n \"computationModeChoices\": \"\",\n \"loanAdvanceChoices\": \"\",\n \"accrualMethodChoices\": \"\",\n \"paymentTypeChoices\": \"\",\n \"paymentsPerYearChoices\": \"\",\n \"interimInterestTypeChoices\": \"\",\n \"oddDayChoices\": \"\",\n \"rateRoundingChoices\": \"\",\n \"rateRoundingFactorChoices\": \"\",\n \"state\": \"\",\n \"lien\": \"\",\n \"lt\": \"\",\n \"lp\": \"\",\n \"calculationMethod\": \"\",\n \"computationMode\": \"\",\n \"paymentType\": \"\",\n \"loanTerm\": \"\",\n \"amortTerm\": \"\",\n \"interestOnlyTerm\": \"\",\n \"paymentsPerYear\": \"\",\n \"accrualMethod\": \"\",\n \"loanAdvance\": \"\",\n \"isNegAm\": \"\",\n \"interestOnlyAddendum\": \"\",\n \"interimInterestType\": \"\",\n \"negAPmtGrowth\": \"\",\n \"negAMoPmtGrowth\": \"\",\n \"negACap\": \"\",\n \"negARecastFrequency\": \"\",\n \"prepayment\": \"\",\n \"refund\": \"\",\n \"oddDays\": \"\",\n \"gracePeriod\": \"\",\n \"lateCharge\": \"\",\n \"lateChargeMin\": \"\",\n \"lateChargeMax\": \"\",\n \"lateChargePenalty\": \"\",\n \"demand\": \"\",\n \"homeImprovement\": \"\",\n \"planNotes\": \"\",\n \"defaultLienPosition\": \"\",\n \"defaultLoanType\": \"\",\n \"defaultLoanPurpose\": \"\",\n \"defaultInterestOnlyTerm\": \"\",\n \"defaultPaymentsPerYear\": \"\"\n}"},{"id":"c8e0abc6-f2a3-40a5-b226-aec133c1cc14","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/LoanPrograms/:loanPlanId/LoanPlan","host":["/"],"path":["api","v1","LoanPrograms",":loanPlanId","LoanPlan"],"variable":[{"key":"loanPlanId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}"},{"id":"a68dc894-8591-4bb8-b71c-86811a2a4485","name":"Error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/LoanPrograms/:loanPlanId/LoanPlan","host":["/"],"path":["api","v1","LoanPrograms",":loanPlanId","LoanPlan"],"variable":[{"key":"loanPlanId"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}"}],"_postman_id":"ee3f0353-b27e-47ba-b962-ac72d9abd840"},{"name":"Get Loan Plans","id":"c7efc613-5214-4ee9-bbba-c8f2f3c421bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/LoanPrograms/Plans?LoanPlanId=&ProgramId=&RateType=Fixed&State=GA&LienPosition=Unknown&LoanType=RHS&LoanPurpose=OneTime&OrderForm=HLCDSC&Package=Master&Service=Direct&SettlementMethod=TRID&PageNumber=&PageSize=&SortDirection=&SortBy=","description":"

This endpoint will return the loan plan information for all loan plans. This is a large request and will be paginated. The request object associated with this call should be included in the query string of the request and the various fields of the object will refine the search parameters.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","LoanPrograms","Plans"],"host":["/"],"query":[{"key":"LoanPlanId","value":""},{"key":"ProgramId","value":""},{"key":"RateType","value":"Fixed"},{"key":"State","value":"GA"},{"key":"LienPosition","value":"Unknown"},{"key":"LoanType","value":"RHS"},{"key":"LoanPurpose","value":"OneTime"},{"key":"OrderForm","value":"HLCDSC"},{"key":"Package","value":"Master"},{"key":"Service","value":"Direct"},{"key":"SettlementMethod","value":"TRID"},{"key":"PageNumber","value":""},{"key":"PageSize","value":""},{"key":"SortDirection","value":""},{"key":"SortBy","value":""}],"variable":[]}},"response":[{"id":"50427246-af5a-46aa-a898-b5144fe502ee","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/LoanPrograms/Plans?LoanPlanId=&ProgramId=&RateType=Fixed&State=GA&LienPosition=Unknown&LoanType=RHS&LoanPurpose=OneTime&OrderForm=HLCDSC&Package=Master&Service=Direct&SettlementMethod=TRID&PageNumber=&PageSize=&SortDirection=&SortBy=","host":["/"],"path":["api","v1","LoanPrograms","Plans"],"query":[{"key":"LoanPlanId","value":""},{"key":"ProgramId","value":""},{"key":"RateType","value":"Fixed"},{"key":"State","value":"GA"},{"key":"LienPosition","value":"Unknown"},{"key":"LoanType","value":"RHS"},{"key":"LoanPurpose","value":"OneTime"},{"key":"OrderForm","value":"HLCDSC"},{"key":"Package","value":"Master"},{"key":"Service","value":"Direct"},{"key":"SettlementMethod","value":"TRID"},{"key":"PageNumber","value":""},{"key":"PageSize","value":""},{"key":"SortDirection","value":""},{"key":"SortBy","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"currentPage\": \"\",\n \"hasNextPage\": \"\",\n \"hasPreviousPage\": \"\",\n \"items\": [\n {\n \"favorite\": \"\",\n \"isArm\": \"\",\n \"name\": \"\",\n \"planId\": \"\",\n \"programId\": \"\",\n \"rateType\": \"Fixed\",\n \"visible\": \"\",\n \"planNumber\": \"\",\n \"note\": \"\",\n \"addendum\": \"\",\n \"rider\": \"\",\n \"tag\": \"\",\n \"convertable\": \"\",\n \"conversionFee\": \"\",\n \"conversionNotes\": \"\",\n \"periodsToFirstPaymentChange\": \"\",\n \"periodsBetweenPaymentChanges\": \"\",\n \"periodsToFirstChange\": \"\",\n \"periodsBetweenChanges\": \"\",\n \"lifeCap\": \"\",\n \"periodicCap\": \"\",\n \"firstRateCapUp\": \"\",\n \"firstRateCapDn\": \"\",\n \"indexBasedOnPetName\": \"\"\n },\n {\n \"favorite\": \"\",\n \"isArm\": \"\",\n \"name\": \"\",\n \"planId\": \"\",\n \"programId\": \"\",\n \"rateType\": \"Adjustable\",\n \"visible\": \"\",\n \"planNumber\": \"\",\n \"note\": \"\",\n \"addendum\": \"\",\n \"rider\": \"\",\n \"tag\": \"\",\n \"convertable\": \"\",\n \"conversionFee\": \"\",\n \"conversionNotes\": \"\",\n \"periodsToFirstPaymentChange\": \"\",\n \"periodsBetweenPaymentChanges\": \"\",\n \"periodsToFirstChange\": \"\",\n \"periodsBetweenChanges\": \"\",\n \"lifeCap\": \"\",\n \"periodicCap\": \"\",\n \"firstRateCapUp\": \"\",\n \"firstRateCapDn\": \"\",\n \"indexBasedOnPetName\": \"\"\n }\n ],\n \"totalItems\": \"\",\n \"totalPages\": \"\"\n}"}],"_postman_id":"c7efc613-5214-4ee9-bbba-c8f2f3c421bd"}],"id":"8a05610d-4a66-4703-9294-68c634ce1165","description":"

This API provides access to information on our various loan programs and plans. When searching for all plans the response will be paginated as it is quite large.

\n","_postman_id":"8a05610d-4a66-4703-9294-68c634ce1165","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}}},{"name":"Loans","item":[{"name":"Get Loan","id":"ea5384c4-3357-4172-b707-206339aae440","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/Loans/:loanId","description":"

Use this endpoint to get details on a specific loan.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Loans",":loanId"],"host":["/"],"query":[],"variable":[{"id":"b1d87555-a36c-4c86-b7c1-3bc8f4893d20","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"loanId"}]}},"response":[{"id":"46747a99-51f3-4e70-9a11-375493023863","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/Loans/:loanId","host":["/"],"path":["api","v1","Loans",":loanId"],"variable":[{"key":"loanId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"apr\": \"\",\n \"archived\": \"\",\n \"baseLoanAmount\": \"\",\n \"borrower\": \"\",\n \"closingCosts\": \"\",\n \"editorUrl\": \"\",\n \"gfNumber\": \"\",\n \"lenderName\": \"\",\n \"lien\": \"Unknown\",\n \"loanId\": \"\",\n \"loanNumber\": \"\",\n \"loanPurpose\": \"Purchase\",\n \"loanType\": \"Agricultural\",\n \"orderForm\": {\n \"category\": \"\",\n \"description\": \"\",\n \"displaySequence\": \"\",\n \"isVisible\": \"\",\n \"name\": \"\",\n \"orderFormId\": \"\",\n \"services\": [\n {\n \"availability\": \"NotAvailable\",\n \"category\": \"DirectDocs\",\n \"description\": \"\",\n \"packageType\": \"\",\n \"serviceId\": \"\",\n \"serviceType\": \"\",\n \"fee\": \"\"\n },\n {\n \"availability\": \"RequireSetup\",\n \"category\": \"Review\",\n \"description\": \"\",\n \"packageType\": \"\",\n \"serviceId\": \"\",\n \"serviceType\": \"\",\n \"fee\": \"\"\n }\n ],\n \"lastUsed\": \"\"\n },\n \"orderFormId\": \"\",\n \"productPrice\": \"\",\n \"propertyAddress\": {\n \"fullAddress\": \"\",\n \"street1\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"county\": \"\"\n },\n \"pState\": \"\",\n \"recentEvents\": [\n {\n \"byName\": \"\",\n \"notes\": \"\",\n \"noteType\": \"TechnicalLog\",\n \"timeStamp\": \"\"\n },\n {\n \"byName\": \"\",\n \"notes\": \"\",\n \"noteType\": \"Note\",\n \"timeStamp\": \"\"\n }\n ],\n \"recentNotes\": [\n {\n \"byName\": \"\",\n \"notes\": \"\",\n \"noteType\": \"BorrowerNameChange\",\n \"timeStamp\": \"\"\n },\n {\n \"byName\": \"\",\n \"notes\": \"\",\n \"noteType\": \"Note\",\n \"timeStamp\": \"\"\n }\n ],\n \"serviceId\": \"\",\n \"serviceType\": \"\",\n \"timeCreated\": \"\",\n \"timeModified\": \"\",\n \"losLoanId\": \"\",\n \"loanPlanId\": \"\",\n \"orderNumber\": \"\",\n \"orderStatus\": \"\",\n \"seller\": \"\",\n \"investorId\": \"\",\n \"investorLoanNumber\": \"\",\n \"profileId\": \"\",\n \"lenderSetupId\": \"\",\n \"dataSource\": \"\",\n \"closingDate\": \"\",\n \"fundingDate\": \"\",\n \"rateExpDate\": \"\",\n \"assignedToInvestor\": \"\",\n \"armyn\": \"\",\n \"balloonYn\": \"\",\n \"interestRate\": \"\",\n \"occupancyType\": \"SecondHome\",\n \"statementType\": \"RESPA\",\n \"order\": {\n \"description\": \"\",\n \"orderNumber\": \"\",\n \"orderType\": \"Review\",\n \"recVia\": \"\",\n \"status\": \"\",\n \"submittedBy\": \"\",\n \"timeModified\": \"\",\n \"timeNeeded\": \"\",\n \"timeReceived\": \"\",\n \"totalFee\": \"\",\n \"clientInvoiceNumber\": \"\",\n \"checkerId\": \"\",\n \"operatorId\": \"\",\n \"fulfillerId\": \"\",\n \"timeReleased\": \"\",\n \"relVia\": \"\"\n },\n \"lockInfo\": {\n \"lockedBy\": \"\",\n \"lockedWith\": \"\",\n \"lockTime\": \"\"\n }\n}"}],"_postman_id":"ea5384c4-3357-4172-b707-206339aae440"},{"name":"Update Loan","id":"96d70459-535e-45fc-9301-6e21951b5fd1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"acknowledgements\": [\n \"\",\n \"\"\n ],\n \"correlationId\": \"\",\n \"loanNumber\": \"\",\n \"profileId\": \"\",\n \"lenderSetupId\": \"\",\n \"propertyState\": \"\",\n \"orderFormId\": \"\",\n \"productId\": \"\",\n \"serviceId\": \"\",\n \"investorId\": \"\",\n \"loanPlanId\": \"\",\n \"redrawInstructions\": \"\",\n \"script\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/v1/Loans/:loanId","description":"

Use this endpoint to update a loan that has been created.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Loans",":loanId"],"host":["/"],"query":[],"variable":[{"id":"b5d13fce-243c-433a-adcb-32d519e7a80a","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"loanId"}]}},"response":[{"id":"7074beb8-204e-4b30-8312-d3280b568a71","name":"Bad Request","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"acknowledgements\": [\n \"\",\n \"\"\n ],\n \"correlationId\": \"\",\n \"loanNumber\": \"\",\n \"profileId\": \"\",\n \"lenderSetupId\": \"\",\n \"propertyState\": \"\",\n \"orderFormId\": \"\",\n \"productId\": \"\",\n \"serviceId\": \"\",\n \"investorId\": \"\",\n \"loanPlanId\": \"\",\n \"redrawInstructions\": \"\",\n \"script\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//api/v1/Loans/:loanId","host":["/"],"path":["api","v1","Loans",":loanId"],"variable":[{"key":"loanId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}"}],"_postman_id":"96d70459-535e-45fc-9301-6e21951b5fd1"},{"name":"Delete Loan","id":"b74105b9-220d-44fa-8f3f-b028916b5ef4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/Loans/:loanId","description":"

This endpoint is used to delete an existing loan. Once a loan has been submitted to us it cannot be deleted.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Loans",":loanId"],"host":["/"],"query":[],"variable":[{"id":"1a483648-8c08-48a6-be5f-09666be3e6bc","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"loanId"}]}},"response":[{"id":"5d21ba2d-a6c3-498f-97ab-1e132e70154e","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/Loans/:loanId","host":["/"],"path":["api","v1","Loans",":loanId"],"variable":[{"key":"loanId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"6c34bbea-eb7b-45fa-8a4c-c58ab5c8fd6c","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/Loans/:loanId","host":["/"],"path":["api","v1","Loans",":loanId"],"variable":[{"key":"loanId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}"}],"_postman_id":"b74105b9-220d-44fa-8f3f-b028916b5ef4"},{"name":"Get Loan List","id":"f8621966-262c-48bd-902b-997e2560d104","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/Loans?LoanId=&OrderNumber=&OrderStatus=Hold&InvestorId=&Borrower=&Seller=&LenderName=&LoanNumber=&GFNumber=&CreatedBefore=&CreatedAfter=&ModifiedBefore=&ModifiedAfter=&ClosingDateBefore=&ClosingDateAfter=&LoanPlanId=&PropertyStreetAddress=&PropertyState=GA&PropertyZip=&PageNumber=&PageSize=&SortDirection=&SortBy=","description":"

Use this to search for details on many loans. This is a paginated request as mentioned in the general info section. The request object will be in the query string and is used to narrow down the search criteria.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Loans"],"host":["/"],"query":[{"key":"LoanId","value":""},{"key":"OrderNumber","value":""},{"key":"OrderStatus","value":"Hold"},{"key":"InvestorId","value":""},{"key":"Borrower","value":""},{"key":"Seller","value":""},{"key":"LenderName","value":""},{"key":"LoanNumber","value":""},{"key":"GFNumber","value":""},{"key":"CreatedBefore","value":""},{"key":"CreatedAfter","value":""},{"key":"ModifiedBefore","value":""},{"key":"ModifiedAfter","value":""},{"key":"ClosingDateBefore","value":""},{"key":"ClosingDateAfter","value":""},{"key":"LoanPlanId","value":""},{"key":"PropertyStreetAddress","value":""},{"key":"PropertyState","value":"GA"},{"key":"PropertyZip","value":""},{"key":"PageNumber","value":""},{"key":"PageSize","value":""},{"key":"SortDirection","value":""},{"key":"SortBy","value":""}],"variable":[]}},"response":[{"id":"a34bd681-bef1-4812-ad89-2d6366fa8acc","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/Loans?LoanId=&OrderNumber=&OrderStatus=Hold&InvestorId=&Borrower=&Seller=&LenderName=&LoanNumber=&GFNumber=&CreatedBefore=&CreatedAfter=&ModifiedBefore=&ModifiedAfter=&ClosingDateBefore=&ClosingDateAfter=&LoanPlanId=&PropertyStreetAddress=&PropertyState=GA&PropertyZip=&PageNumber=&PageSize=&SortDirection=&SortBy=","host":["/"],"path":["api","v1","Loans"],"query":[{"key":"LoanId","value":""},{"key":"OrderNumber","value":""},{"key":"OrderStatus","value":"Hold"},{"key":"InvestorId","value":""},{"key":"Borrower","value":""},{"key":"Seller","value":""},{"key":"LenderName","value":""},{"key":"LoanNumber","value":""},{"key":"GFNumber","value":""},{"key":"CreatedBefore","value":""},{"key":"CreatedAfter","value":""},{"key":"ModifiedBefore","value":""},{"key":"ModifiedAfter","value":""},{"key":"ClosingDateBefore","value":""},{"key":"ClosingDateAfter","value":""},{"key":"LoanPlanId","value":""},{"key":"PropertyStreetAddress","value":""},{"key":"PropertyState","value":"GA"},{"key":"PropertyZip","value":""},{"key":"PageNumber","value":""},{"key":"PageSize","value":""},{"key":"SortDirection","value":""},{"key":"SortBy","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"currentPage\": \"\",\n \"hasNextPage\": \"\",\n \"hasPreviousPage\": \"\",\n \"items\": [\n {\n \"archived\": \"\",\n \"borrower\": \"\",\n \"gfNumber\": \"\",\n \"lenderName\": \"\",\n \"lien\": \"First\",\n \"loanId\": \"\",\n \"loanNumber\": \"\",\n \"loanPurpose\": \"Development\",\n \"loanType\": \"Conventional\",\n \"orderFormId\": \"\",\n \"orderFormName\": \"\",\n \"propertyAddress\": {\n \"fullAddress\": \"\",\n \"street1\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"county\": \"\"\n },\n \"serviceDescription\": \"\",\n \"serviceId\": \"\",\n \"timeCreated\": \"\",\n \"timeModified\": \"\",\n \"losLoanId\": \"\",\n \"planId\": \"\",\n \"orderNumber\": \"\",\n \"orderStatus\": \"Receiving\",\n \"seller\": \"\",\n \"occupancyType\": \"NA\",\n \"statementType\": \"NonRESPA\",\n \"investorId\": \"\",\n \"investorLoanNumber\": \"\",\n \"closingDate\": \"\"\n },\n {\n \"archived\": \"\",\n \"borrower\": \"\",\n \"gfNumber\": \"\",\n \"lenderName\": \"\",\n \"lien\": \"First\",\n \"loanId\": \"\",\n \"loanNumber\": \"\",\n \"loanPurpose\": \"HomeImprovement\",\n \"loanType\": \"RHS\",\n \"orderFormId\": \"\",\n \"orderFormName\": \"\",\n \"propertyAddress\": {\n \"fullAddress\": \"\",\n \"street1\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"county\": \"\"\n },\n \"serviceDescription\": \"\",\n \"serviceId\": \"\",\n \"timeCreated\": \"\",\n \"timeModified\": \"\",\n \"losLoanId\": \"\",\n \"planId\": \"\",\n \"orderNumber\": \"\",\n \"orderStatus\": \"Processing\",\n \"seller\": \"\",\n \"occupancyType\": \"SecondHome\",\n \"statementType\": \"NonRESPA\",\n \"investorId\": \"\",\n \"investorLoanNumber\": \"\",\n \"closingDate\": \"\"\n }\n ],\n \"totalItems\": \"\",\n \"totalPages\": \"\"\n}"}],"_postman_id":"f8621966-262c-48bd-902b-997e2560d104"},{"name":"Create","id":"f5b09c07-cb5d-4c4a-bf38-9be42e27d064","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"correlationId\": \"\",\n \"loanNumber\": \"\",\n \"templateId\": \"\",\n \"profileId\": \"\",\n \"lenderSetupId\": \"\",\n \"propertyState\": \"\",\n \"orderFormId\": \"\",\n \"serviceId\": \"\",\n \"investorId\": \"\",\n \"loanPlanId\": \"\",\n \"script\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/v1/Loans","description":"

This is one of the endpoints that can be used in the initial creation of a loan. The LoanId returned in the response is what you shall use in other endpoints to fetch or mutate a given loan. The LoanId is a GUID value.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Loans"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"6075f650-524c-4a42-806f-14beba86f369","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"correlationId\": \"\",\n \"loanNumber\": \"\",\n \"templateId\": \"\",\n \"profileId\": \"\",\n \"lenderSetupId\": \"\",\n \"propertyState\": \"\",\n \"orderFormId\": \"\",\n \"serviceId\": \"\",\n \"investorId\": \"\",\n \"loanPlanId\": \"\",\n \"script\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/v1/Loans"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"apr\": \"\",\n \"archived\": \"\",\n \"baseLoanAmount\": \"\",\n \"borrower\": \"\",\n \"closingCosts\": \"\",\n \"editorUrl\": \"\",\n \"gfNumber\": \"\",\n \"lenderName\": \"\",\n \"lien\": \"Unknown\",\n \"loanId\": \"\",\n \"loanNumber\": \"\",\n \"loanPurpose\": \"Purchase\",\n \"loanType\": \"Agricultural\",\n \"orderForm\": {\n \"category\": \"\",\n \"description\": \"\",\n \"displaySequence\": \"\",\n \"isVisible\": \"\",\n \"name\": \"\",\n \"orderFormId\": \"\",\n \"services\": [\n {\n \"availability\": \"NotAvailable\",\n \"category\": \"DirectDocs\",\n \"description\": \"\",\n \"packageType\": \"\",\n \"serviceId\": \"\",\n \"serviceType\": \"\",\n \"fee\": \"\"\n },\n {\n \"availability\": \"RequireSetup\",\n \"category\": \"Review\",\n \"description\": \"\",\n \"packageType\": \"\",\n \"serviceId\": \"\",\n \"serviceType\": \"\",\n \"fee\": \"\"\n }\n ],\n \"lastUsed\": \"\"\n },\n \"orderFormId\": \"\",\n \"productPrice\": \"\",\n \"propertyAddress\": {\n \"fullAddress\": \"\",\n \"street1\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"county\": \"\"\n },\n \"pState\": \"\",\n \"recentEvents\": [\n {\n \"byName\": \"\",\n \"notes\": \"\",\n \"noteType\": \"TechnicalLog\",\n \"timeStamp\": \"\"\n },\n {\n \"byName\": \"\",\n \"notes\": \"\",\n \"noteType\": \"Note\",\n \"timeStamp\": \"\"\n }\n ],\n \"recentNotes\": [\n {\n \"byName\": \"\",\n \"notes\": \"\",\n \"noteType\": \"BorrowerNameChange\",\n \"timeStamp\": \"\"\n },\n {\n \"byName\": \"\",\n \"notes\": \"\",\n \"noteType\": \"Note\",\n \"timeStamp\": \"\"\n }\n ],\n \"serviceId\": \"\",\n \"serviceType\": \"\",\n \"timeCreated\": \"\",\n \"timeModified\": \"\",\n \"losLoanId\": \"\",\n \"loanPlanId\": \"\",\n \"orderNumber\": \"\",\n \"orderStatus\": \"\",\n \"seller\": \"\",\n \"investorId\": \"\",\n \"investorLoanNumber\": \"\",\n \"profileId\": \"\",\n \"lenderSetupId\": \"\",\n \"dataSource\": \"\",\n \"closingDate\": \"\",\n \"fundingDate\": \"\",\n \"rateExpDate\": \"\",\n \"assignedToInvestor\": \"\",\n \"armyn\": \"\",\n \"balloonYn\": \"\",\n \"interestRate\": \"\",\n \"occupancyType\": \"SecondHome\",\n \"statementType\": \"RESPA\",\n \"order\": {\n \"description\": \"\",\n \"orderNumber\": \"\",\n \"orderType\": \"Review\",\n \"recVia\": \"\",\n \"status\": \"\",\n \"submittedBy\": \"\",\n \"timeModified\": \"\",\n \"timeNeeded\": \"\",\n \"timeReceived\": \"\",\n \"totalFee\": \"\",\n \"clientInvoiceNumber\": \"\",\n \"checkerId\": \"\",\n \"operatorId\": \"\",\n \"fulfillerId\": \"\",\n \"timeReleased\": \"\",\n \"relVia\": \"\"\n },\n \"lockInfo\": {\n \"lockedBy\": \"\",\n \"lockedWith\": \"\",\n \"lockTime\": \"\"\n }\n}"}],"_postman_id":"f5b09c07-cb5d-4c4a-bf38-9be42e27d064"},{"name":"Get Audits","id":"34e8c79d-5edd-445c-9e81-bdb21f499aed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/Loans/:loanId/Audits","description":"

This will a list of audit findings on this loan

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Loans",":loanId","Audits"],"host":["/"],"query":[],"variable":[{"id":"b2540295-abc9-4a05-841e-7c990cab155c","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"loanId"}]}},"response":[{"id":"80669957-ee81-49ea-aca9-0acfad2fb997","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/Loans/:loanId/Audits","host":["/"],"path":["api","v1","Loans",":loanId","Audits"],"variable":[{"key":"loanId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"auditId\": \"\",\n \"category\": \"RegX\",\n \"details\": \"\",\n \"exceptionLevel\": \"Passed\",\n \"title\": \"\",\n \"acknowledgement\": {\n \"by\": \"\",\n \"byName\": \"\",\n \"timeStamp\": \"\"\n }\n },\n {\n \"auditId\": \"\",\n \"category\": \"HighCost\",\n \"details\": \"\",\n \"exceptionLevel\": \"Dismissable\",\n \"title\": \"\",\n \"acknowledgement\": {\n \"by\": \"\",\n \"byName\": \"\",\n \"timeStamp\": \"\"\n }\n }\n]"}],"_postman_id":"34e8c79d-5edd-445c-9e81-bdb21f499aed"},{"name":"Get Loan Packages","id":"53405e67-de1c-4346-83e1-1b6baaa44183","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/Loans/:loanId/Packages","description":"

This will a list of packages for this loan

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Loans",":loanId","Packages"],"host":["/"],"query":[],"variable":[{"id":"3e8e8684-9039-409f-9576-a9740697a08e","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"loanId"}]}},"response":[{"id":"8324424e-bdc8-4974-b459-e3b16d0796e2","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/Loans/:loanId/Packages","host":["/"],"path":["api","v1","Loans",":loanId","Packages"],"variable":[{"key":"loanId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"description\": \"\",\n \"packageId\": \"\",\n \"packageSize\": \"\",\n \"timeCreated\": \"\",\n \"loanId\": \"\"\n },\n {\n \"description\": \"\",\n \"packageId\": \"\",\n \"packageSize\": \"\",\n \"timeCreated\": \"\",\n \"loanId\": \"\"\n }\n]"}],"_postman_id":"53405e67-de1c-4346-83e1-1b6baaa44183"},{"name":"Get Snapshots","id":"4dab7542-776f-4099-8581-93d7d5634563","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/Loans/:loanId/Snapshots","description":"

This will a list of packages for this loan

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Loans",":loanId","Snapshots"],"host":["/"],"query":[],"variable":[{"id":"5773b06d-f172-47b9-a42a-8ebd838985cd","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"loanId"}]}},"response":[{"id":"cac980ae-9639-4a55-ab59-2f026b775d2e","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/Loans/:loanId/Snapshots","host":["/"],"path":["api","v1","Loans",":loanId","Snapshots"],"variable":[{"key":"loanId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"description\": \"\",\n \"id\": \"\",\n \"timeCreated\": \"\",\n \"createdBy\": \"\"\n },\n {\n \"description\": \"\",\n \"id\": \"\",\n \"timeCreated\": \"\",\n \"createdBy\": \"\"\n }\n]"}],"_postman_id":"4dab7542-776f-4099-8581-93d7d5634563"},{"name":"Get Order Forms","id":"2eecf8de-f3a4-4f74-ab26-a4b399e6a078","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/Loans/:loanId/OrderForms?orderFormId=","description":"

This will provide the various order forms that can be used with a given loan.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Loans",":loanId","OrderForms"],"host":["/"],"query":[{"key":"orderFormId","value":""}],"variable":[{"id":"8f541abb-bb2f-4235-a132-91eab0238e40","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"loanId"}]}},"response":[{"id":"93bf4bf2-382e-4126-a38e-ec79e9271988","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/Loans/:loanId/OrderForms?orderFormId=","host":["/"],"path":["api","v1","Loans",":loanId","OrderForms"],"query":[{"key":"orderFormId","value":""}],"variable":[{"key":"loanId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"category\": \"\",\n \"description\": \"\",\n \"displaySequence\": \"\",\n \"isVisible\": \"\",\n \"name\": \"\",\n \"orderFormId\": \"\",\n \"services\": [\n {\n \"availability\": \"Call\",\n \"category\": \"Unknown\",\n \"description\": \"\",\n \"packageType\": \"\",\n \"serviceId\": \"\",\n \"serviceType\": \"\",\n \"fee\": \"\"\n },\n {\n \"availability\": \"Available\",\n \"category\": \"FullServiceDocPrep\",\n \"description\": \"\",\n \"packageType\": \"\",\n \"serviceId\": \"\",\n \"serviceType\": \"\",\n \"fee\": \"\"\n }\n ],\n \"lastUsed\": \"\"\n },\n {\n \"category\": \"\",\n \"description\": \"\",\n \"displaySequence\": \"\",\n \"isVisible\": \"\",\n \"name\": \"\",\n \"orderFormId\": \"\",\n \"services\": [\n {\n \"availability\": \"Disabled\",\n \"category\": \"FullServiceDocPrep\",\n \"description\": \"\",\n \"packageType\": \"\",\n \"serviceId\": \"\",\n \"serviceType\": \"\",\n \"fee\": \"\"\n },\n {\n \"availability\": \"Discontinued\",\n \"category\": \"FulfillmentService\",\n \"description\": \"\",\n \"packageType\": \"\",\n \"serviceId\": \"\",\n \"serviceType\": \"\",\n \"fee\": \"\"\n }\n ],\n \"lastUsed\": \"\"\n }\n]"}],"_postman_id":"2eecf8de-f3a4-4f74-ab26-a4b399e6a078"},{"name":"Get Programs","id":"bacd56f7-947c-4fdd-8d5a-01448534f6de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/Loans/:loanId/Programs","description":"

This endpoint will returns loan programs that can be applied to a given loan.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Loans",":loanId","Programs"],"host":["/"],"query":[],"variable":[{"id":"e45c4c5e-d38c-4934-9894-b2199f9766b5","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"loanId"}]}},"response":[{"id":"e8fe385a-74a9-409e-bf4c-a2321f7c86b5","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/Loans/:loanId/Programs","host":["/"],"path":["api","v1","Loans",":loanId","Programs"],"variable":[{"key":"loanId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"name\": \"\",\n \"plans\": [\n {\n \"favorite\": \"\",\n \"isArm\": \"\",\n \"name\": \"\",\n \"planId\": \"\",\n \"programId\": \"\",\n \"rateType\": \"Adjustable\",\n \"visible\": \"\",\n \"planNumber\": \"\",\n \"note\": \"\",\n \"addendum\": \"\",\n \"rider\": \"\",\n \"tag\": \"\",\n \"convertable\": \"\",\n \"conversionFee\": \"\",\n \"conversionNotes\": \"\",\n \"periodsToFirstPaymentChange\": \"\",\n \"periodsBetweenPaymentChanges\": \"\",\n \"periodsToFirstChange\": \"\",\n \"periodsBetweenChanges\": \"\",\n \"lifeCap\": \"\",\n \"periodicCap\": \"\",\n \"firstRateCapUp\": \"\",\n \"firstRateCapDn\": \"\",\n \"indexBasedOnPetName\": \"\"\n },\n {\n \"favorite\": \"\",\n \"isArm\": \"\",\n \"name\": \"\",\n \"planId\": \"\",\n \"programId\": \"\",\n \"rateType\": \"Adjustable\",\n \"visible\": \"\",\n \"planNumber\": \"\",\n \"note\": \"\",\n \"addendum\": \"\",\n \"rider\": \"\",\n \"tag\": \"\",\n \"convertable\": \"\",\n \"conversionFee\": \"\",\n \"conversionNotes\": \"\",\n \"periodsToFirstPaymentChange\": \"\",\n \"periodsBetweenPaymentChanges\": \"\",\n \"periodsToFirstChange\": \"\",\n \"periodsBetweenChanges\": \"\",\n \"lifeCap\": \"\",\n \"periodicCap\": \"\",\n \"firstRateCapUp\": \"\",\n \"firstRateCapDn\": \"\",\n \"indexBasedOnPetName\": \"\"\n }\n ],\n \"programId\": \"\"\n },\n {\n \"name\": \"\",\n \"plans\": [\n {\n \"favorite\": \"\",\n \"isArm\": \"\",\n \"name\": \"\",\n \"planId\": \"\",\n \"programId\": \"\",\n \"rateType\": \"Adjustable\",\n \"visible\": \"\",\n \"planNumber\": \"\",\n \"note\": \"\",\n \"addendum\": \"\",\n \"rider\": \"\",\n \"tag\": \"\",\n \"convertable\": \"\",\n \"conversionFee\": \"\",\n \"conversionNotes\": \"\",\n \"periodsToFirstPaymentChange\": \"\",\n \"periodsBetweenPaymentChanges\": \"\",\n \"periodsToFirstChange\": \"\",\n \"periodsBetweenChanges\": \"\",\n \"lifeCap\": \"\",\n \"periodicCap\": \"\",\n \"firstRateCapUp\": \"\",\n \"firstRateCapDn\": \"\",\n \"indexBasedOnPetName\": \"\"\n },\n {\n \"favorite\": \"\",\n \"isArm\": \"\",\n \"name\": \"\",\n \"planId\": \"\",\n \"programId\": \"\",\n \"rateType\": \"Variable\",\n \"visible\": \"\",\n \"planNumber\": \"\",\n \"note\": \"\",\n \"addendum\": \"\",\n \"rider\": \"\",\n \"tag\": \"\",\n \"convertable\": \"\",\n \"conversionFee\": \"\",\n \"conversionNotes\": \"\",\n \"periodsToFirstPaymentChange\": \"\",\n \"periodsBetweenPaymentChanges\": \"\",\n \"periodsToFirstChange\": \"\",\n \"periodsBetweenChanges\": \"\",\n \"lifeCap\": \"\",\n \"periodicCap\": \"\",\n \"firstRateCapUp\": \"\",\n \"firstRateCapDn\": \"\",\n \"indexBasedOnPetName\": \"\"\n }\n ],\n \"programId\": \"\"\n }\n]"}],"_postman_id":"bacd56f7-947c-4fdd-8d5a-01448534f6de"},{"name":"Get Service Options","id":"8d04a7a6-cac0-4f69-b038-f0c82705f63d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/Loans/:loanId/ServiceOptions","description":"

This endpoint returns the services that are available to a given loan.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Loans",":loanId","ServiceOptions"],"host":["/"],"query":[],"variable":[{"id":"f98763da-f135-4cd0-b209-8ac0162c1e5b","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"loanId"}]}},"response":[{"id":"2056f35a-1dad-4c02-a148-102820d14f07","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/Loans/:loanId/ServiceOptions","host":["/"],"path":["api","v1","Loans",":loanId","ServiceOptions"],"variable":[{"key":"loanId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"availability\": \"Discontinued\",\n \"category\": \"eSign\",\n \"description\": \"\",\n \"packageType\": \"\",\n \"serviceId\": \"\",\n \"serviceType\": \"\",\n \"fee\": \"\"\n },\n {\n \"availability\": \"RequireSetup\",\n \"category\": \"DirectDocs\",\n \"description\": \"\",\n \"packageType\": \"\",\n \"serviceId\": \"\",\n \"serviceType\": \"\",\n \"fee\": \"\"\n }\n]"}],"_postman_id":"8d04a7a6-cac0-4f69-b038-f0c82705f63d"},{"name":"Create With Xml","id":"bcf4c844-7a08-4bb7-bbd6-a408d32ed59a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"CorrelationId","value":"","type":"text"},{"key":"LoanNumber","value":"","type":"text"},{"key":"TemplateId","value":"","type":"text"},{"key":"ProfileId","value":"","type":"text"},{"key":"LenderSetupId","value":"","type":"text"},{"key":"PropertyState","value":"","type":"text"},{"key":"OrderFormId","value":"","type":"text"},{"key":"ServiceId","value":"","type":"text"},{"key":"InvestorId","value":"","type":"text"},{"key":"LoanPlanId","value":"","type":"text"},{"key":"Script","value":"","type":"text"},{"key":"File","value":"","type":"text"}]},"url":"//api/v1/Loans/XML","description":"

This is one of the endpoints that can be used in the initial creation of a loan.\nThis endpoint consumes multipart/form-data with one property that is an XML file. All fields are nullable in the request as it is possible for you to complete the API process by either submitting the XML file with all other fields null, provide the individual fields while not providing the XML file, or you can do a combination of both.\nHow this endpoint works is it will read and apply all data consumed in the XML file and then it will consume the other fields. Essentially the create process allows you to submit all data by XML and then you can use the other fields to change a specific data point. The LoanId returned in the response is what you shall use in other endpoints to fetch or mutate a given loan. The LoanId is a GUID value.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Loans","XML"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"c2ce6c0f-c085-47fe-8514-4a0c6d7f4437","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"formdata","formdata":[{"key":"CorrelationId","value":"","type":"text"},{"key":"LoanNumber","value":"","type":"text"},{"key":"TemplateId","value":"","type":"text"},{"key":"ProfileId","value":"","type":"text"},{"key":"LenderSetupId","value":"","type":"text"},{"key":"PropertyState","value":"","type":"text"},{"key":"OrderFormId","value":"","type":"text"},{"key":"ServiceId","value":"","type":"text"},{"key":"InvestorId","value":"","type":"text"},{"key":"LoanPlanId","value":"","type":"text"},{"key":"Script","value":"","type":"text"},{"key":"File","value":"","type":"text"}]},"url":"//api/v1/Loans/XML"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"apr\": \"\",\n \"archived\": \"\",\n \"baseLoanAmount\": \"\",\n \"borrower\": \"\",\n \"closingCosts\": \"\",\n \"editorUrl\": \"\",\n \"gfNumber\": \"\",\n \"lenderName\": \"\",\n \"lien\": \"Unknown\",\n \"loanId\": \"\",\n \"loanNumber\": \"\",\n \"loanPurpose\": \"Purchase\",\n \"loanType\": \"Agricultural\",\n \"orderForm\": {\n \"category\": \"\",\n \"description\": \"\",\n \"displaySequence\": \"\",\n \"isVisible\": \"\",\n \"name\": \"\",\n \"orderFormId\": \"\",\n \"services\": [\n {\n \"availability\": \"NotAvailable\",\n \"category\": \"DirectDocs\",\n \"description\": \"\",\n \"packageType\": \"\",\n \"serviceId\": \"\",\n \"serviceType\": \"\",\n \"fee\": \"\"\n },\n {\n \"availability\": \"RequireSetup\",\n \"category\": \"Review\",\n \"description\": \"\",\n \"packageType\": \"\",\n \"serviceId\": \"\",\n \"serviceType\": \"\",\n \"fee\": \"\"\n }\n ],\n \"lastUsed\": \"\"\n },\n \"orderFormId\": \"\",\n \"productPrice\": \"\",\n \"propertyAddress\": {\n \"fullAddress\": \"\",\n \"street1\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"county\": \"\"\n },\n \"pState\": \"\",\n \"recentEvents\": [\n {\n \"byName\": \"\",\n \"notes\": \"\",\n \"noteType\": \"TechnicalLog\",\n \"timeStamp\": \"\"\n },\n {\n \"byName\": \"\",\n \"notes\": \"\",\n \"noteType\": \"Note\",\n \"timeStamp\": \"\"\n }\n ],\n \"recentNotes\": [\n {\n \"byName\": \"\",\n \"notes\": \"\",\n \"noteType\": \"BorrowerNameChange\",\n \"timeStamp\": \"\"\n },\n {\n \"byName\": \"\",\n \"notes\": \"\",\n \"noteType\": \"Note\",\n \"timeStamp\": \"\"\n }\n ],\n \"serviceId\": \"\",\n \"serviceType\": \"\",\n \"timeCreated\": \"\",\n \"timeModified\": \"\",\n \"losLoanId\": \"\",\n \"loanPlanId\": \"\",\n \"orderNumber\": \"\",\n \"orderStatus\": \"\",\n \"seller\": \"\",\n \"investorId\": \"\",\n \"investorLoanNumber\": \"\",\n \"profileId\": \"\",\n \"lenderSetupId\": \"\",\n \"dataSource\": \"\",\n \"closingDate\": \"\",\n \"fundingDate\": \"\",\n \"rateExpDate\": \"\",\n \"assignedToInvestor\": \"\",\n \"armyn\": \"\",\n \"balloonYn\": \"\",\n \"interestRate\": \"\",\n \"occupancyType\": \"SecondHome\",\n \"statementType\": \"RESPA\",\n \"order\": {\n \"description\": \"\",\n \"orderNumber\": \"\",\n \"orderType\": \"Review\",\n \"recVia\": \"\",\n \"status\": \"\",\n \"submittedBy\": \"\",\n \"timeModified\": \"\",\n \"timeNeeded\": \"\",\n \"timeReceived\": \"\",\n \"totalFee\": \"\",\n \"clientInvoiceNumber\": \"\",\n \"checkerId\": \"\",\n \"operatorId\": \"\",\n \"fulfillerId\": \"\",\n \"timeReleased\": \"\",\n \"relVia\": \"\"\n },\n \"lockInfo\": {\n \"lockedBy\": \"\",\n \"lockedWith\": \"\",\n \"lockTime\": \"\"\n }\n}"}],"_postman_id":"bcf4c844-7a08-4bb7-bbd6-a408d32ed59a"},{"name":"Submit Loan","id":"25515926-b29f-4d97-9552-3132e69f640b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"dueInHours\": \"\",\n \"services\": [\n {\n \"billingMethod\": \"NoPreference\",\n \"serviceId\": \"\",\n \"deliveries\": [\n {\n \"destination\": \"\",\n \"packageType\": \"Misc\"\n },\n {\n \"destination\": \"\",\n \"packageType\": \"Modification\"\n }\n ],\n \"eSigns\": [\n {\n \"destination\": \"\",\n \"packageType\": \"Legal\"\n },\n {\n \"destination\": \"\",\n \"packageType\": \"Full\"\n }\n ]\n },\n {\n \"billingMethod\": \"NoPreference\",\n \"serviceId\": \"\",\n \"deliveries\": [\n {\n \"destination\": \"\",\n \"packageType\": \"Master\"\n },\n {\n \"destination\": \"\",\n \"packageType\": \"Modification\"\n }\n ],\n \"eSigns\": [\n {\n \"destination\": \"\",\n \"packageType\": \"Assumption\"\n },\n {\n \"destination\": \"\",\n \"packageType\": \"LegalTIL\"\n }\n ]\n }\n ],\n \"correlationId\": \"\",\n \"comments\": \"\",\n \"billTo\": \"\",\n \"billingAddress\": {\n \"city\": \"\",\n \"company\": \"\",\n \"contact\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"state\": \"\",\n \"street1\": \"\",\n \"zip\": \"\",\n \"street2\": \"\",\n \"ext\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/v1/Loans/:loanId/Submit","description":"

This endpoint is used to finalize the details of any loan that had been created with us so that we may begin working on it. Further edits can be made in the future but the Redraw endpoint will first need to be hit so that the loan can be updated and then submitted again.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Loans",":loanId","Submit"],"host":["/"],"query":[],"variable":[{"id":"6261ff37-e29d-4a79-9465-3aabf620a72a","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"loanId"}]}},"response":[{"id":"7376dcc0-35b1-46f7-91e2-360e686db8fa","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"dueInHours\": \"\",\n \"services\": [\n {\n \"billingMethod\": \"NoPreference\",\n \"serviceId\": \"\",\n \"deliveries\": [\n {\n \"destination\": \"\",\n \"packageType\": \"Misc\"\n },\n {\n \"destination\": \"\",\n \"packageType\": \"Modification\"\n }\n ],\n \"eSigns\": [\n {\n \"destination\": \"\",\n \"packageType\": \"Legal\"\n },\n {\n \"destination\": \"\",\n \"packageType\": \"Full\"\n }\n ]\n },\n {\n \"billingMethod\": \"NoPreference\",\n \"serviceId\": \"\",\n \"deliveries\": [\n {\n \"destination\": \"\",\n \"packageType\": \"Master\"\n },\n {\n \"destination\": \"\",\n \"packageType\": \"Modification\"\n }\n ],\n \"eSigns\": [\n {\n \"destination\": \"\",\n \"packageType\": \"Assumption\"\n },\n {\n \"destination\": \"\",\n \"packageType\": \"LegalTIL\"\n }\n ]\n }\n ],\n \"correlationId\": \"\",\n \"comments\": \"\",\n \"billTo\": \"\",\n \"billingAddress\": {\n \"city\": \"\",\n \"company\": \"\",\n \"contact\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"state\": \"\",\n \"street1\": \"\",\n \"zip\": \"\",\n \"street2\": \"\",\n \"ext\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//api/v1/Loans/:loanId/Submit","host":["/"],"path":["api","v1","Loans",":loanId","Submit"],"variable":[{"key":"loanId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"apr\": \"\",\n \"archived\": \"\",\n \"baseLoanAmount\": \"\",\n \"borrower\": \"\",\n \"closingCosts\": \"\",\n \"editorUrl\": \"\",\n \"gfNumber\": \"\",\n \"lenderName\": \"\",\n \"lien\": \"Unknown\",\n \"loanId\": \"\",\n \"loanNumber\": \"\",\n \"loanPurpose\": \"Purchase\",\n \"loanType\": \"Agricultural\",\n \"orderForm\": {\n \"category\": \"\",\n \"description\": \"\",\n \"displaySequence\": \"\",\n \"isVisible\": \"\",\n \"name\": \"\",\n \"orderFormId\": \"\",\n \"services\": [\n {\n \"availability\": \"NotAvailable\",\n \"category\": \"DirectDocs\",\n \"description\": \"\",\n \"packageType\": \"\",\n \"serviceId\": \"\",\n \"serviceType\": \"\",\n \"fee\": \"\"\n },\n {\n \"availability\": \"RequireSetup\",\n \"category\": \"Review\",\n \"description\": \"\",\n \"packageType\": \"\",\n \"serviceId\": \"\",\n \"serviceType\": \"\",\n \"fee\": \"\"\n }\n ],\n \"lastUsed\": \"\"\n },\n \"orderFormId\": \"\",\n \"productPrice\": \"\",\n \"propertyAddress\": {\n \"fullAddress\": \"\",\n \"street1\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"county\": \"\"\n },\n \"pState\": \"\",\n \"recentEvents\": [\n {\n \"byName\": \"\",\n \"notes\": \"\",\n \"noteType\": \"TechnicalLog\",\n \"timeStamp\": \"\"\n },\n {\n \"byName\": \"\",\n \"notes\": \"\",\n \"noteType\": \"Note\",\n \"timeStamp\": \"\"\n }\n ],\n \"recentNotes\": [\n {\n \"byName\": \"\",\n \"notes\": \"\",\n \"noteType\": \"BorrowerNameChange\",\n \"timeStamp\": \"\"\n },\n {\n \"byName\": \"\",\n \"notes\": \"\",\n \"noteType\": \"Note\",\n \"timeStamp\": \"\"\n }\n ],\n \"serviceId\": \"\",\n \"serviceType\": \"\",\n \"timeCreated\": \"\",\n \"timeModified\": \"\",\n \"losLoanId\": \"\",\n \"loanPlanId\": \"\",\n \"orderNumber\": \"\",\n \"orderStatus\": \"\",\n \"seller\": \"\",\n \"investorId\": \"\",\n \"investorLoanNumber\": \"\",\n \"profileId\": \"\",\n \"lenderSetupId\": \"\",\n \"dataSource\": \"\",\n \"closingDate\": \"\",\n \"fundingDate\": \"\",\n \"rateExpDate\": \"\",\n \"assignedToInvestor\": \"\",\n \"armyn\": \"\",\n \"balloonYn\": \"\",\n \"interestRate\": \"\",\n \"occupancyType\": \"SecondHome\",\n \"statementType\": \"RESPA\",\n \"order\": {\n \"description\": \"\",\n \"orderNumber\": \"\",\n \"orderType\": \"Review\",\n \"recVia\": \"\",\n \"status\": \"\",\n \"submittedBy\": \"\",\n \"timeModified\": \"\",\n \"timeNeeded\": \"\",\n \"timeReceived\": \"\",\n \"totalFee\": \"\",\n \"clientInvoiceNumber\": \"\",\n \"checkerId\": \"\",\n \"operatorId\": \"\",\n \"fulfillerId\": \"\",\n \"timeReleased\": \"\",\n \"relVia\": \"\"\n },\n \"lockInfo\": {\n \"lockedBy\": \"\",\n \"lockedWith\": \"\",\n \"lockTime\": \"\"\n }\n}"}],"_postman_id":"25515926-b29f-4d97-9552-3132e69f640b"},{"name":"Update Loan With Xml","id":"71c60aab-9d0c-4729-8385-ab2fa38267f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"CorrelationId","value":"","type":"text"},{"key":"ProfileId","value":"","type":"text"},{"key":"LenderSetupId","value":"","type":"text"},{"key":"PropertyState","value":"","type":"text"},{"key":"OrderFormId","value":"","type":"text"},{"key":"ServiceId","value":"","type":"text"},{"key":"InvestorId","value":"","type":"text"},{"key":"LoanPlanId","value":"","type":"text"},{"key":"RedrawInstructions","value":"","type":"text"},{"key":"Script","value":"","type":"text"},{"key":"File","value":"","type":"text"},{"key":"Acknowledgements","value":",","type":"text"},{"key":"CreatePackage","value":"","type":"text"}]},"url":"//api/v1/Loans/:loanId/XML","description":"

Use this endpoint to update a loan that has been created.\nThis endpoint consumes multipart/form-data with one property that is an XML file. All fields are nullable in the request as it is possible for you to complete the API process by either submitting the XML file with all other fields null, provide the individual fields while not providing the XML file, or you can do a combination of both.\nHow this endpoint works is it will read and apply all data consumed in the XML file and then it will consume the other fields. Essentially the update process allows you to submit all data by XML and then you can use the other fields to change a specific data point.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Loans",":loanId","XML"],"host":["/"],"query":[],"variable":[{"id":"c0c8fd21-eb9c-4e07-ae2e-3dcfd0ebaa5d","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"loanId"}]}},"response":[{"id":"a480357c-1e01-46d1-9ce0-63e38eade49b","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"formdata","formdata":[{"key":"CorrelationId","value":"","type":"text"},{"key":"ProfileId","value":"","type":"text"},{"key":"LenderSetupId","value":"","type":"text"},{"key":"PropertyState","value":"","type":"text"},{"key":"OrderFormId","value":"","type":"text"},{"key":"ServiceId","value":"","type":"text"},{"key":"InvestorId","value":"","type":"text"},{"key":"LoanPlanId","value":"","type":"text"},{"key":"RedrawInstructions","value":"","type":"text"},{"key":"Script","value":"","type":"text"},{"key":"File","value":"","type":"text"},{"key":"Acknowledgements","value":",","type":"text"},{"key":"CreatePackage","value":"","type":"text"}]},"url":{"raw":"//api/v1/Loans/:loanId/XML","host":["/"],"path":["api","v1","Loans",":loanId","XML"],"variable":[{"key":"loanId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"apr\": \"\",\n \"archived\": \"\",\n \"baseLoanAmount\": \"\",\n \"borrower\": \"\",\n \"closingCosts\": \"\",\n \"editorUrl\": \"\",\n \"gfNumber\": \"\",\n \"lenderName\": \"\",\n \"lien\": \"Unknown\",\n \"loanId\": \"\",\n \"loanNumber\": \"\",\n \"loanPurpose\": \"Purchase\",\n \"loanType\": \"Agricultural\",\n \"orderForm\": {\n \"category\": \"\",\n \"description\": \"\",\n \"displaySequence\": \"\",\n \"isVisible\": \"\",\n \"name\": \"\",\n \"orderFormId\": \"\",\n \"services\": [\n {\n \"availability\": \"NotAvailable\",\n \"category\": \"DirectDocs\",\n \"description\": \"\",\n \"packageType\": \"\",\n \"serviceId\": \"\",\n \"serviceType\": \"\",\n \"fee\": \"\"\n },\n {\n \"availability\": \"RequireSetup\",\n \"category\": \"Review\",\n \"description\": \"\",\n \"packageType\": \"\",\n \"serviceId\": \"\",\n \"serviceType\": \"\",\n \"fee\": \"\"\n }\n ],\n \"lastUsed\": \"\"\n },\n \"orderFormId\": \"\",\n \"productPrice\": \"\",\n \"propertyAddress\": {\n \"fullAddress\": \"\",\n \"street1\": \"\",\n \"street2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"county\": \"\"\n },\n \"pState\": \"\",\n \"recentEvents\": [\n {\n \"byName\": \"\",\n \"notes\": \"\",\n \"noteType\": \"TechnicalLog\",\n \"timeStamp\": \"\"\n },\n {\n \"byName\": \"\",\n \"notes\": \"\",\n \"noteType\": \"Note\",\n \"timeStamp\": \"\"\n }\n ],\n \"recentNotes\": [\n {\n \"byName\": \"\",\n \"notes\": \"\",\n \"noteType\": \"BorrowerNameChange\",\n \"timeStamp\": \"\"\n },\n {\n \"byName\": \"\",\n \"notes\": \"\",\n \"noteType\": \"Note\",\n \"timeStamp\": \"\"\n }\n ],\n \"serviceId\": \"\",\n \"serviceType\": \"\",\n \"timeCreated\": \"\",\n \"timeModified\": \"\",\n \"losLoanId\": \"\",\n \"loanPlanId\": \"\",\n \"orderNumber\": \"\",\n \"orderStatus\": \"\",\n \"seller\": \"\",\n \"investorId\": \"\",\n \"investorLoanNumber\": \"\",\n \"profileId\": \"\",\n \"lenderSetupId\": \"\",\n \"dataSource\": \"\",\n \"closingDate\": \"\",\n \"fundingDate\": \"\",\n \"rateExpDate\": \"\",\n \"assignedToInvestor\": \"\",\n \"armyn\": \"\",\n \"balloonYn\": \"\",\n \"interestRate\": \"\",\n \"occupancyType\": \"SecondHome\",\n \"statementType\": \"RESPA\",\n \"order\": {\n \"description\": \"\",\n \"orderNumber\": \"\",\n \"orderType\": \"Review\",\n \"recVia\": \"\",\n \"status\": \"\",\n \"submittedBy\": \"\",\n \"timeModified\": \"\",\n \"timeNeeded\": \"\",\n \"timeReceived\": \"\",\n \"totalFee\": \"\",\n \"clientInvoiceNumber\": \"\",\n \"checkerId\": \"\",\n \"operatorId\": \"\",\n \"fulfillerId\": \"\",\n \"timeReleased\": \"\",\n \"relVia\": \"\"\n },\n \"lockInfo\": {\n \"lockedBy\": \"\",\n \"lockedWith\": \"\",\n \"lockTime\": \"\"\n }\n}"}],"_postman_id":"71c60aab-9d0c-4729-8385-ab2fa38267f2"},{"name":"Cancel Loan","id":"3798501d-5fad-4db4-bb9c-862947e0bbd0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/v1/Loans/:loanId/Cancel","description":"

This endpoint is used to cancel an existing loan order after it has been submitted.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Loans",":loanId","Cancel"],"host":["/"],"query":[],"variable":[{"id":"c980cfca-0390-4171-8d1a-1b813081eab7","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"loanId"}]}},"response":[{"id":"84b6175c-8558-43de-a355-00f0b0b20147","name":"No Content","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"reason\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//api/v1/Loans/:loanId/Cancel","host":["/"],"path":["api","v1","Loans",":loanId","Cancel"],"variable":[{"key":"loanId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"e8673e9d-e43b-4757-8c27-ef4c8c46fe0e","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"reason\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//api/v1/Loans/:loanId/Cancel","host":["/"],"path":["api","v1","Loans",":loanId","Cancel"],"variable":[{"key":"loanId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}"}],"_postman_id":"3798501d-5fad-4db4-bb9c-862947e0bbd0"}],"id":"15eb3eaa-d8e9-4f94-a7bf-86323c30931c","description":"

There are a couple of ways to create a new loan. You can post basic loan information or you can post the xml data from your Loan Origination System (LOS). You can access created loans using the lender's loan number. You have the option to update the loan as needed up until the loan is submitted. Once submitted, you will be locked out of the loan while we are working on it. Some services are synchronous. In other words, the package information will be returned in the response. All full service however are asynchronous. We will return the order number and notify the user when the product is ready. You can then call GetLoanDetails to download the results via the API.

\n

Submitting a loan requires a valid order form identifier and service identifier. To get these values, please use the GetServiceOptions endpoint. The loan must also have a valid loan plan identifier which is available at the GetPrograms endpoint. If you often order the same product, you can send these values along with the xml payload when creating the loan. The values can also be embedded in the xml payload. Please see our xml payload guide for more information.

\n

Our preconfigured postman calls will not have example XML bodies as the only users expected to use those are organizations that already have extensive experience with our various accepted XML formats. Users who do not already use the accepted XML formats should use the equivalent calls that accept JSON bodies.

\n

Every interaction with the loan will trigger an automatic audit. The audit result is included in the loan detail response. All audit exceptions must be cleared or acknowledged prior to submitting a loan for processing. You can include the audit acknowledgements in the SubmitLoan request call. Please beware that some audits cannot be acknowledged due to its severity and the loan information must be amended before submitting again.

\n

A submitted loan has an order number. The order number can be used to upload attachments or add notes. The status and other information about the order is also available at GetOrderDetails.

\n

Loan corrections and redraws are unavoidable. In most cases, you can resubmit the changes to get a new package. Some services however require a formal request to redraw. This request can be submitted via the API. If approved, you can update the loan with new information by sending updated loan data. Attempting to submit changes without approval will return a bad request.

\n

All LoanDetailResponse objects will include a URL for the user to navigate to PPDocs.com to further edit the loan prior to submitting.

\n

Payload Guide

\n

Currently, our API supports the following XML payloads\nMISMO 3.5 DEAL with or without REQUEST Wrapper

\n

MISMO 2.6 Loan with MESSAGES for LE and CD\nIf you are interested in adding your extensions to this list, please contact us at support@ppdocs.com

\n

We support an optional wrapper to facilitate the data mapping. The wrapper has a collection of simple key/value pairs where you can provide additional (overriding) data. The optional request wrapper is

\n
<REQUEST_GROUP xmlns:xlink=\"http://www.w3.org/1999/xlink\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" MISMOVersionID=\"3.5\">\n  <REQUEST RequestDatetime=\"{ISO 8601 DATE}\">\n      <KEY _Name=\"{key name}\" _Value=\"{key value}\"/>\n      <KEY _Name=\"{key name}\" _Value=\"{key value}\"/>\n      <KEY _Name=\"{key name}\" _Value=\"{key value}\"/>\n      <REQUEST_DATA>\n      ... MESSAGE(3.X Current) ...\n      ... MESSAGE(3.X LE) ...\n      </REQUEST_DATA>\n  </REQUEST>\n</REQUEST_GROUP>\n

When sending a request for closing documents, we need to also know how the loan was disclosed (LE). Please send the LE as a separate message element in the REQUEST_DATA or as a second LOAN under LOANS i.e. MESSAGE/DEAL_SETS/DEAL_SET/DEALS/DEAL/LOANS[1..2].

\n

Mapping can be challenging. We have a Staging environment available for you to test your payloads. Please contact our API integration specialist to get an api key for QA testing.

\n

Order Of Operation

\n

There are several ways to provide data to the API beyond the XML payload. These values can override the values in the XML payload. Because there are more than 1 way to pass this data, it is important to understand the order of operation.

\n

The order of operation is as follows:

\n

XML => Request (key/value) pairs => Request Script => Request Properties

\n

It is a last-in-win stategy. So, if you have a value in the XML payload, and you also have a value in the Request Script, the value in the Request Script will be used.

\n","_postman_id":"15eb3eaa-d8e9-4f94-a7bf-86323c30931c","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}}},{"name":"OrderForms","item":[{"name":"Get Order Form List","id":"5da01c97-be29-4b77-a132-62537cb41e91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/OrderForms?propertyState=","description":"

Returns the a list of order forms with an optional filter by property state

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","OrderForms"],"host":["/"],"query":[{"key":"propertyState","value":""}],"variable":[]}},"response":[{"id":"ab8cb428-0bc2-493a-9c82-f8c7a143388d","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/OrderForms?propertyState=","host":["/"],"path":["api","v1","OrderForms"],"query":[{"key":"propertyState","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"category\": \"\",\n \"description\": \"\",\n \"displaySequence\": \"\",\n \"isVisible\": \"\",\n \"name\": \"\",\n \"orderFormId\": \"\",\n \"services\": [\n {\n \"availability\": \"Call\",\n \"category\": \"Unknown\",\n \"description\": \"\",\n \"packageType\": \"\",\n \"serviceId\": \"\",\n \"serviceType\": \"\",\n \"fee\": \"\"\n },\n {\n \"availability\": \"Available\",\n \"category\": \"FullServiceDocPrep\",\n \"description\": \"\",\n \"packageType\": \"\",\n \"serviceId\": \"\",\n \"serviceType\": \"\",\n \"fee\": \"\"\n }\n ],\n \"lastUsed\": \"\"\n },\n {\n \"category\": \"\",\n \"description\": \"\",\n \"displaySequence\": \"\",\n \"isVisible\": \"\",\n \"name\": \"\",\n \"orderFormId\": \"\",\n \"services\": [\n {\n \"availability\": \"Disabled\",\n \"category\": \"FullServiceDocPrep\",\n \"description\": \"\",\n \"packageType\": \"\",\n \"serviceId\": \"\",\n \"serviceType\": \"\",\n \"fee\": \"\"\n },\n {\n \"availability\": \"Discontinued\",\n \"category\": \"FulfillmentService\",\n \"description\": \"\",\n \"packageType\": \"\",\n \"serviceId\": \"\",\n \"serviceType\": \"\",\n \"fee\": \"\"\n }\n ],\n \"lastUsed\": \"\"\n }\n]"}],"_postman_id":"5da01c97-be29-4b77-a132-62537cb41e91"}],"id":"136ce0e1-c873-4bae-bc80-d6527445dc03","description":"

This API is meant for retrieving and order forms.

\n","_postman_id":"136ce0e1-c873-4bae-bc80-d6527445dc03","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}}},{"name":"Orders","item":[{"name":"Get Order","id":"106e2c79-dd21-4a82-a251-59118a97a8bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/Orders/:ordernumber","description":"

This endpoint will return the order information for the order number provided.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Orders",":ordernumber"],"host":["/"],"query":[],"variable":[{"id":"39be2cc2-155a-4b1b-99e3-d444c37e61d3","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"ordernumber"}]}},"response":[{"id":"becd4729-6d5a-4288-9623-ff327154af3d","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/Orders/:ordernumber","host":["/"],"path":["api","v1","Orders",":ordernumber"],"variable":[{"key":"ordernumber"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"attachments\": [\n {\n \"attachDate\": \"\",\n \"attachmentId\": \"\",\n \"fileName\": \"\",\n \"size\": \"\",\n \"downloadUrl\": \"\"\n },\n {\n \"attachDate\": \"\",\n \"attachmentId\": \"\",\n \"fileName\": \"\",\n \"size\": \"\",\n \"downloadUrl\": \"\"\n }\n ],\n \"description\": \"\",\n \"invoices\": [\n {\n \"city\": \"\",\n \"company\": \"\",\n \"contact\": \"\",\n \"description\": \"\",\n \"due\": \"\",\n \"email\": \"\",\n \"invoiceAmount\": \"\",\n \"invoiceDate\": \"\",\n \"invoiceNumber\": \"\",\n \"invoiceTo\": \"\",\n \"invoiceType\": \"Fulfillment\",\n \"paid\": \"\",\n \"phone\": \"\",\n \"state\": \"\",\n \"status\": \"Processing\",\n \"street1\": \"\",\n \"timeModified\": \"\",\n \"zip\": \"\",\n \"street2\": \"\",\n \"ext\": \"\"\n },\n {\n \"city\": \"\",\n \"company\": \"\",\n \"contact\": \"\",\n \"description\": \"\",\n \"due\": \"\",\n \"email\": \"\",\n \"invoiceAmount\": \"\",\n \"invoiceDate\": \"\",\n \"invoiceNumber\": \"\",\n \"invoiceTo\": \"\",\n \"invoiceType\": \"AttorneyInvoice\",\n \"paid\": \"\",\n \"phone\": \"\",\n \"state\": \"\",\n \"status\": \"Canceled\",\n \"street1\": \"\",\n \"timeModified\": \"\",\n \"zip\": \"\",\n \"street2\": \"\",\n \"ext\": \"\"\n }\n ],\n \"notes\": [\n {\n \"byName\": \"\",\n \"notes\": \"\",\n \"noteType\": \"TechnicalLog\",\n \"timeStamp\": \"\"\n },\n {\n \"byName\": \"\",\n \"notes\": \"\",\n \"noteType\": \"SystemLog\",\n \"timeStamp\": \"\"\n }\n ],\n \"orderNumber\": \"\",\n \"orderType\": \"ExpressDocs\",\n \"recVia\": \"\",\n \"services\": [\n {\n \"description\": \"\",\n \"fee\": \"\",\n \"orderDetailId\": \"\",\n \"serviceId\": \"\"\n },\n {\n \"description\": \"\",\n \"fee\": \"\",\n \"orderDetailId\": \"\",\n \"serviceId\": \"\"\n }\n ],\n \"status\": \"\",\n \"submittedBy\": \"\",\n \"timeModified\": \"\",\n \"timeNeeded\": \"\",\n \"timeReceived\": \"\",\n \"totalFee\": \"\",\n \"clientInvoiceNumber\": \"\",\n \"checkerId\": \"\",\n \"operatorId\": \"\",\n \"fulfillerId\": \"\",\n \"timeReleased\": \"\",\n \"relVia\": \"\"\n}"}],"_postman_id":"106e2c79-dd21-4a82-a251-59118a97a8bc"},{"name":"Get Orders","id":"744cc8c0-4608-463c-bb1d-5a3ed7446940","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/Orders?ModifiedSince=&SubmittedSince=&ServiceId=&OrderFormId=&Status=Hold&PageNumber=&PageSize=&SortDirection=&SortBy=","description":"

This endpoint will return a list of orders that match the criteria provided. The response is paginated.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Orders"],"host":["/"],"query":[{"key":"ModifiedSince","value":""},{"key":"SubmittedSince","value":""},{"key":"ServiceId","value":""},{"key":"OrderFormId","value":""},{"key":"Status","value":"Hold"},{"key":"PageNumber","value":""},{"key":"PageSize","value":""},{"key":"SortDirection","value":""},{"key":"SortBy","value":""}],"variable":[]}},"response":[{"id":"9689dcbb-69e7-442a-9f8b-1fe6caf3ea42","name":"Bad Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/Orders?ModifiedSince=&SubmittedSince=&ServiceId=&OrderFormId=&Status=Hold&PageNumber=&PageSize=&SortDirection=&SortBy=","host":["/"],"path":["api","v1","Orders"],"query":[{"key":"ModifiedSince","value":""},{"key":"SubmittedSince","value":""},{"key":"ServiceId","value":""},{"key":"OrderFormId","value":""},{"key":"Status","value":"Hold"},{"key":"PageNumber","value":""},{"key":"PageSize","value":""},{"key":"SortDirection","value":""},{"key":"SortBy","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}"}],"_postman_id":"744cc8c0-4608-463c-bb1d-5a3ed7446940"},{"name":"Add Note","id":"baecfe13-a009-4d27-8e2e-3f73276570bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"note\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/v1/Orders/:ordernumber/Notes","description":"

This endpoint can be used to add notes to a given order. This is useful for providing extra information that the user feels will be required or helpful to facilitate us completing our services for the order.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Orders",":ordernumber","Notes"],"host":["/"],"query":[],"variable":[{"id":"fea66403-3e87-4db9-b31c-eb51ebe69478","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"ordernumber"}]}},"response":[{"id":"a9dddbc6-260f-4c4b-9351-533c4cb0b42c","name":"No Content","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"note\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//api/v1/Orders/:ordernumber/Notes","host":["/"],"path":["api","v1","Orders",":ordernumber","Notes"],"variable":[{"key":"ordernumber"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"1cf82591-379f-417b-8340-b164488313f5","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"note\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//api/v1/Orders/:ordernumber/Notes","host":["/"],"path":["api","v1","Orders",":ordernumber","Notes"],"variable":[{"key":"ordernumber"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}"},{"id":"fa20b4bc-697e-4c08-bb56-e7223c6c6c96","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"note\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//api/v1/Orders/:ordernumber/Notes","host":["/"],"path":["api","v1","Orders",":ordernumber","Notes"],"variable":[{"key":"ordernumber"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}"}],"_postman_id":"baecfe13-a009-4d27-8e2e-3f73276570bc"},{"name":"Add Attachment","id":"36793bf4-3fbc-46d9-bf00-0e3d9e9558ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"key":"files","value":"","type":"text"}]},"url":"//api/v1/Orders/:ordernumber/Attachments","description":"

This endpoint facilitates the uploading of support documents for a given order. If you run this request straight from postman without adding a file it will fail as the \"files\" PDF form data is required and we have not included any so that you can provide your own.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Orders",":ordernumber","Attachments"],"host":["/"],"query":[],"variable":[{"id":"33efa37b-11cf-4ba4-b6ca-e3b83d6958ad","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"ordernumber"}]}},"response":[{"id":"855b902c-11e4-47ae-9078-4ed1158999e9","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"formdata","formdata":[{"key":"files","value":"","type":"text"}]},"url":{"raw":"//api/v1/Orders/:ordernumber/Attachments","host":["/"],"path":["api","v1","Orders",":ordernumber","Attachments"],"variable":[{"key":"ordernumber"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"36793bf4-3fbc-46d9-bf00-0e3d9e9558ee"},{"name":"Get Attachment","id":"4aeaac2f-1672-4a56-bd85-5d12c3b04476","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/Orders/:ordernumber/Attachments/:attachmentId?includeDownloadUrl=","description":"

This endpoint retrieves details on an attachment. Query with IncludeDownloadUrl=true to include the temporary url in the response.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Orders",":ordernumber","Attachments",":attachmentId"],"host":["/"],"query":[{"key":"includeDownloadUrl","value":""}],"variable":[{"id":"1258ab81-ba14-415d-b619-8e3fc3538cb1","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"ordernumber"},{"id":"ddf87a9a-b08f-49a6-be20-c1c7d0a8f17f","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"attachmentId"}]}},"response":[{"id":"b6187127-08ec-4b23-81f9-33ba72f4c697","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/Orders/:ordernumber/Attachments/:attachmentId?includeDownloadUrl=","host":["/"],"path":["api","v1","Orders",":ordernumber","Attachments",":attachmentId"],"query":[{"key":"includeDownloadUrl","value":""}],"variable":[{"key":"ordernumber"},{"key":"attachmentId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"4aeaac2f-1672-4a56-bd85-5d12c3b04476"}],"id":"fd19e7f9-a834-4b8a-bd7a-86115375db50","description":"

This API provides access to endpoints that can provide details relating to an order or to edit an order in various ways.

\n","_postman_id":"fd19e7f9-a834-4b8a-bd7a-86115375db50","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}}},{"name":"Packages","item":[{"name":"Get Packages","id":"2f3fb6e6-641e-4b3b-abd2-56731213ef6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/Packages?LoanId=&Description=&CreatedBefore=&CreatedAfter=&PageNumber=&PageSize=&SortDirection=&SortBy=","description":"

This endpoint returns a list of all packages associated with an account. The request is paginated and can be filtered down through the various query string parameters.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Packages"],"host":["/"],"query":[{"key":"LoanId","value":""},{"key":"Description","value":""},{"key":"CreatedBefore","value":""},{"key":"CreatedAfter","value":""},{"key":"PageNumber","value":""},{"key":"PageSize","value":""},{"key":"SortDirection","value":""},{"key":"SortBy","value":""}],"variable":[]}},"response":[{"id":"0a34f419-ae02-4c6a-b729-d5d277de729b","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/Packages?LoanId=&Description=&CreatedBefore=&CreatedAfter=&PageNumber=&PageSize=&SortDirection=&SortBy=","host":["/"],"path":["api","v1","Packages"],"query":[{"key":"LoanId","value":""},{"key":"Description","value":""},{"key":"CreatedBefore","value":""},{"key":"CreatedAfter","value":""},{"key":"PageNumber","value":""},{"key":"PageSize","value":""},{"key":"SortDirection","value":""},{"key":"SortBy","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"currentPage\": \"\",\n \"hasNextPage\": \"\",\n \"hasPreviousPage\": \"\",\n \"items\": [\n {\n \"description\": \"\",\n \"packageId\": \"\",\n \"packageSize\": \"\",\n \"timeCreated\": \"\",\n \"loanId\": \"\"\n },\n {\n \"description\": \"\",\n \"packageId\": \"\",\n \"packageSize\": \"\",\n \"timeCreated\": \"\",\n \"loanId\": \"\"\n }\n ],\n \"totalItems\": \"\",\n \"totalPages\": \"\"\n}"}],"_postman_id":"2f3fb6e6-641e-4b3b-abd2-56731213ef6a"},{"name":"Get Package Details","id":"06e3f95f-7d2d-4eb2-b886-1ee056199918","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/Packages/:packageId?includeDownloadUrl=","description":"

This endpoint retrieves details on a specific package. Query with IncludeDownloadUrl=true to include the temporary url in the response

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Packages",":packageId"],"host":["/"],"query":[{"key":"includeDownloadUrl","value":""}],"variable":[{"id":"7bafc0c1-6638-473a-9195-d29c7d354c32","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"packageId"}]}},"response":[{"id":"5085e36a-a17c-41ac-a389-a6034b6f995f","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/Packages/:packageId?includeDownloadUrl=","host":["/"],"path":["api","v1","Packages",":packageId"],"query":[{"key":"includeDownloadUrl","value":""}],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"createdBy\": \"\",\n \"deliveries\": [\n {\n \"delivered\": \"\",\n \"dest\": \"\",\n \"sender\": \"\",\n \"senderName\": \"\",\n \"status\": \"\",\n \"timeSubmit\": \"\",\n \"trackingNumber\": \"\",\n \"timeSent\": \"\",\n \"timeRecv\": \"\"\n },\n {\n \"delivered\": \"\",\n \"dest\": \"\",\n \"sender\": \"\",\n \"senderName\": \"\",\n \"status\": \"\",\n \"timeSubmit\": \"\",\n \"trackingNumber\": \"\",\n \"timeSent\": \"\",\n \"timeRecv\": \"\"\n }\n ],\n \"eSigns\": [\n {\n \"archived\": \"\",\n \"dateCreated\": \"\",\n \"dateSubmitted\": \"\",\n \"eSignId\": \"\",\n \"recipient\": \"\",\n \"senderEmail\": \"\",\n \"senderName\": \"\",\n \"status\": \"\",\n \"statusDate\": \"\",\n \"timeModified\": \"\"\n },\n {\n \"archived\": \"\",\n \"dateCreated\": \"\",\n \"dateSubmitted\": \"\",\n \"eSignId\": \"\",\n \"recipient\": \"\",\n \"senderEmail\": \"\",\n \"senderName\": \"\",\n \"status\": \"\",\n \"statusDate\": \"\",\n \"timeModified\": \"\"\n }\n ],\n \"packageId\": \"\",\n \"packageSize\": \"\",\n \"packageType\": \"Supplemental\",\n \"tableOfContent\": [\n {\n \"document\": {\n \"description\": \"\",\n \"docType\": \"\",\n \"documentId\": \"\",\n \"mismotype\": \"\",\n \"title\": \"\"\n },\n \"pageNumber\": \"\"\n },\n {\n \"document\": {\n \"description\": \"\",\n \"docType\": \"\",\n \"documentId\": \"\",\n \"mismotype\": \"\",\n \"title\": \"\"\n },\n \"pageNumber\": \"\"\n }\n ],\n \"timeCreated\": \"\",\n \"description\": \"\",\n \"loanId\": \"\",\n \"downloadUrl\": \"\"\n}"}],"_postman_id":"06e3f95f-7d2d-4eb2-b886-1ee056199918"},{"name":"Get E Sign Details","id":"27828a81-38e5-4b2e-87f1-10b94ca178b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/Packages/:packageId/ESigns/:ESignId","description":"

This endpoint retrieves details on requested electronic signatures.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Packages",":packageId","ESigns",":ESignId"],"host":["/"],"query":[],"variable":[{"id":"ef4eb9d7-75bc-4de3-a43c-b7a8cfe64134","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"packageId"},{"id":"ad5d6fdd-66d1-4bec-89b2-12d3c86e39be","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"ESignId"}]}},"response":[{"id":"5a7ded9a-0408-4002-8a69-52bfd74f5271","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/Packages/:packageId/ESigns/:ESignId","host":["/"],"path":["api","v1","Packages",":packageId","ESigns",":ESignId"],"variable":[{"key":"packageId"},{"key":"ESignId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"accountId\": \"\",\n \"archived\": \"\",\n \"checkIdyn\": \"\",\n \"dateCreated\": \"\",\n \"envelopeId\": \"\",\n \"eSignId\": \"\",\n \"loanNumber\": \"\",\n \"orderNumber\": \"\",\n \"packageId\": \"\",\n \"senderEmail\": \"\",\n \"senderName\": \"\",\n \"signers\": [\n {\n \"email\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"requireSignatureYn\": \"\",\n \"signerNumber\": \"\",\n \"accessCode\": \"\",\n \"sentDate\": \"\",\n \"deliveredDate\": \"\",\n \"signedDate\": \"\",\n \"declinedDate\": \"\",\n \"failedDate\": \"\"\n },\n {\n \"email\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"requireSignatureYn\": \"\",\n \"signerNumber\": \"\",\n \"accessCode\": \"\",\n \"sentDate\": \"\",\n \"deliveredDate\": \"\",\n \"signedDate\": \"\",\n \"declinedDate\": \"\",\n \"failedDate\": \"\"\n }\n ],\n \"status\": \"\",\n \"statusDate\": \"\",\n \"enableDate\": \"\",\n \"certificate\": \"\"\n}"}],"_postman_id":"27828a81-38e5-4b2e-87f1-10b94ca178b2"},{"name":"Post Signature Request","id":"44a87e42-6fe8-4e21-af46-9417dde2ee72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"body\": \"\",\n \"checkIdyn\": \"\",\n \"loanNumber\": \"\",\n \"orderNumber\": \"\",\n \"packageId\": \"\",\n \"recipients\": [\n {\n \"accessCode\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"requireSignatureYn\": \"\"\n },\n {\n \"accessCode\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"requireSignatureYn\": \"\"\n }\n ],\n \"senderEmail\": \"\",\n \"senderName\": \"\",\n \"subject\": \"\",\n \"envelopeId\": \"\",\n \"thirdPartyYn\": \"\",\n \"eClosingEnvelopeId\": \"\",\n \"enableDate\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/v1/Packages/:packageId/ESigns","description":"

This endpoint allows a user to submit a signature request for electronic signatures. For more information, please see https://www.ppdocs.com/products/edisclosure.aspx

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Packages",":packageId","ESigns"],"host":["/"],"query":[],"variable":[{"id":"2fd10eaf-142f-4243-a177-53a5fc2f2f2e","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"packageId"}]}},"response":[{"id":"e7fcb050-a30f-4a35-98ed-8e8f24ebec15","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"body\": \"\",\n \"checkIdyn\": \"\",\n \"loanNumber\": \"\",\n \"orderNumber\": \"\",\n \"packageId\": \"\",\n \"recipients\": [\n {\n \"accessCode\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"requireSignatureYn\": \"\"\n },\n {\n \"accessCode\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"requireSignatureYn\": \"\"\n }\n ],\n \"senderEmail\": \"\",\n \"senderName\": \"\",\n \"subject\": \"\",\n \"envelopeId\": \"\",\n \"thirdPartyYn\": \"\",\n \"eClosingEnvelopeId\": \"\",\n \"enableDate\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//api/v1/Packages/:packageId/ESigns","host":["/"],"path":["api","v1","Packages",":packageId","ESigns"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"accountId\": \"\",\n \"archived\": \"\",\n \"checkIdyn\": \"\",\n \"dateCreated\": \"\",\n \"envelopeId\": \"\",\n \"eSignId\": \"\",\n \"loanNumber\": \"\",\n \"orderNumber\": \"\",\n \"packageId\": \"\",\n \"senderEmail\": \"\",\n \"senderName\": \"\",\n \"signers\": [\n {\n \"email\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"requireSignatureYn\": \"\",\n \"signerNumber\": \"\",\n \"accessCode\": \"\",\n \"sentDate\": \"\",\n \"deliveredDate\": \"\",\n \"signedDate\": \"\",\n \"declinedDate\": \"\",\n \"failedDate\": \"\"\n },\n {\n \"email\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"requireSignatureYn\": \"\",\n \"signerNumber\": \"\",\n \"accessCode\": \"\",\n \"sentDate\": \"\",\n \"deliveredDate\": \"\",\n \"signedDate\": \"\",\n \"declinedDate\": \"\",\n \"failedDate\": \"\"\n }\n ],\n \"status\": \"\",\n \"statusDate\": \"\",\n \"enableDate\": \"\",\n \"certificate\": \"\"\n}"}],"_postman_id":"44a87e42-6fe8-4e21-af46-9417dde2ee72"},{"name":"Get Delivery Details","id":"52c6c475-cde4-4979-bdb2-ae70ca4d1436","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/Packages/:packageId/Deliveries/:trackingNumber","description":"

This endpoint retrieves details associated with a given delivery.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Packages",":packageId","Deliveries",":trackingNumber"],"host":["/"],"query":[],"variable":[{"id":"5e75506f-5ed6-4aee-8c76-095ebac02a9c","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"packageId"},{"id":"60afc277-d26b-474a-b108-f262ad405820","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"trackingNumber"}]}},"response":[{"id":"6e6ec95c-ee5a-4e1a-be85-b6204ecce4f2","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/Packages/:packageId/Deliveries/:trackingNumber","host":["/"],"path":["api","v1","Packages",":packageId","Deliveries",":trackingNumber"],"variable":[{"key":"packageId"},{"key":"trackingNumber"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"borrower\": \"\",\n \"dest\": \"\",\n \"gfNumber\": \"\",\n \"groupId\": \"\",\n \"loanNumber\": \"\",\n \"msg\": \"\",\n \"orderNumber\": \"\",\n \"replyTo\": \"\",\n \"sender\": \"\",\n \"senderName\": \"\",\n \"status\": \"\",\n \"trackingNumber\": \"\"\n}"}],"_postman_id":"52c6c475-cde4-4979-bdb2-ae70ca4d1436"},{"name":"Post Delivery Request","id":"9577d019-0399-4241-bed4-3b450da184e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"attachFileType\": \"\",\n \"borrower\": \"\",\n \"dest\": \"\",\n \"gfNumber\": \"\",\n \"groupId\": \"\",\n \"loanNumber\": \"\",\n \"msg\": \"\",\n \"orderNumber\": \"\",\n \"packageId\": \"\",\n \"replyTo\": \"\",\n \"senderEmail\": \"\",\n \"senderName\": \"\",\n \"status\": \"\",\n \"senderCostCode\": \"\",\n \"docDate\": \"\",\n \"includeLink\": \"\",\n \"plainText\": \"\",\n \"toConfDelivery\": \"\",\n \"toConfView\": \"\",\n \"password\": \"\",\n \"securityQuestion\": \"\",\n \"securityAnswer\": \"\",\n \"protectionOption\": \"\",\n \"notifyXhours\": \"\",\n \"expiredDays\": \"\",\n \"eClosingEnvelopeId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/v1/Packages/:packageId/Deliveries","description":"

This endpoint allows a user to request package delivery. For more information, please see https://www.ppdocs.com/products/DeliveryDemo.aspx

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Packages",":packageId","Deliveries"],"host":["/"],"query":[],"variable":[{"id":"e83d57d7-e00a-431d-952a-e3edd77d7598","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"packageId"}]}},"response":[{"id":"ac88126c-41dd-407b-a52c-2f681d324444","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"attachFileType\": \"\",\n \"borrower\": \"\",\n \"dest\": \"\",\n \"gfNumber\": \"\",\n \"groupId\": \"\",\n \"loanNumber\": \"\",\n \"msg\": \"\",\n \"orderNumber\": \"\",\n \"packageId\": \"\",\n \"replyTo\": \"\",\n \"senderEmail\": \"\",\n \"senderName\": \"\",\n \"status\": \"\",\n \"senderCostCode\": \"\",\n \"docDate\": \"\",\n \"includeLink\": \"\",\n \"plainText\": \"\",\n \"toConfDelivery\": \"\",\n \"toConfView\": \"\",\n \"password\": \"\",\n \"securityQuestion\": \"\",\n \"securityAnswer\": \"\",\n \"protectionOption\": \"\",\n \"notifyXhours\": \"\",\n \"expiredDays\": \"\",\n \"eClosingEnvelopeId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//api/v1/Packages/:packageId/Deliveries","host":["/"],"path":["api","v1","Packages",":packageId","Deliveries"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"borrower\": \"\",\n \"dest\": \"\",\n \"gfNumber\": \"\",\n \"groupId\": \"\",\n \"loanNumber\": \"\",\n \"msg\": \"\",\n \"orderNumber\": \"\",\n \"replyTo\": \"\",\n \"sender\": \"\",\n \"senderName\": \"\",\n \"status\": \"\",\n \"trackingNumber\": \"\"\n}"}],"_postman_id":"9577d019-0399-4241-bed4-3b450da184e1"},{"name":"Retract Delivery Request","id":"d8cfcb34-db7a-4f4c-ba5d-276f648a8636","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"trackingNumber\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//api/v1/Packages/:packageId/Deliveries/:trackingNumber/Retract","description":"

This endpoint is used to cancel an existing delivery request.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Packages",":packageId","Deliveries",":trackingNumber","Retract"],"host":["/"],"query":[],"variable":[{"id":"86b78900-9fb5-49ba-b1ad-2b670ccf0bd7","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"packageId"},{"id":"ee72c187-7f43-477d-8a13-b36eb94f6cd6","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"trackingNumber"}]}},"response":[{"id":"d6ebe1cf-6c35-4742-892e-db27382d6c5c","name":"No Content","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"trackingNumber\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//api/v1/Packages/:packageId/Deliveries/:trackingNumber/Retract","host":["/"],"path":["api","v1","Packages",":packageId","Deliveries",":trackingNumber","Retract"],"variable":[{"key":"packageId"},{"key":"trackingNumber"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"f1f4bf9c-6ac0-4b11-80de-1eb765e12e6f","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"trackingNumber\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//api/v1/Packages/:packageId/Deliveries/:trackingNumber/Retract","host":["/"],"path":["api","v1","Packages",":packageId","Deliveries",":trackingNumber","Retract"],"variable":[{"key":"packageId"},{"key":"trackingNumber"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}"},{"id":"679c5787-9268-4429-b662-02d0a09a9617","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"trackingNumber\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"//api/v1/Packages/:packageId/Deliveries/:trackingNumber/Retract","host":["/"],"path":["api","v1","Packages",":packageId","Deliveries",":trackingNumber","Retract"],"variable":[{"key":"packageId"},{"key":"trackingNumber"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}"}],"_postman_id":"d8cfcb34-db7a-4f4c-ba5d-276f648a8636"}],"id":"63245835-c958-4a69-b8a0-d456956d793d","description":"

API for consuming and providing information about various forms of deliveries.

\n","_postman_id":"63245835-c958-4a69-b8a0-d456956d793d","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}}},{"name":"Services","item":[{"name":"Get Service","id":"b3c9c385-20b1-4a3a-b840-f3366bd11db2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/Services/:serviceId","description":"

This endpoint retrieves the service details associated with a specific product package.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Services",":serviceId"],"host":["/"],"query":[],"variable":[{"id":"6da1ca82-3bc8-4d56-9350-b66934313bd4","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"serviceId"}]}},"response":[{"id":"a3be44bb-705c-4c81-b0dd-b37fff4e48a2","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/Services/:serviceId","host":["/"],"path":["api","v1","Services",":serviceId"],"variable":[{"key":"serviceId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"availability\": \"RequireSetup\",\n \"category\": \"FulfillmentService\",\n \"description\": \"\",\n \"details\": \"\",\n \"packageType\": \"\",\n \"serviceId\": \"\",\n \"serviceType\": \"\",\n \"fee\": \"\"\n}"},{"id":"92572db3-aa66-407a-8432-d516afb410b0","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/Services/:serviceId","host":["/"],"path":["api","v1","Services",":serviceId"],"variable":[{"key":"serviceId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}"},{"id":"23fd37ba-c8d2-4ef9-9d02-82138c797c22","name":"Error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"//api/v1/Services/:serviceId","host":["/"],"path":["api","v1","Services",":serviceId"],"variable":[{"key":"serviceId"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}"}],"_postman_id":"b3c9c385-20b1-4a3a-b840-f3366bd11db2"},{"name":"Get Services","id":"99e9ef7d-ffbd-4bb1-81eb-fbce8ed1716c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"//api/v1/Services","description":"

This endpoint retrieves all services we provide to our customers.

\n","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}},"urlObject":{"path":["api","v1","Services"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"c72b643f-e004-4f52-8857-5aca8c5eedb9","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":"//api/v1/Services"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"availability\": \"Discontinued\",\n \"category\": \"eSign\",\n \"description\": \"\",\n \"packageType\": \"\",\n \"serviceId\": \"\",\n \"serviceType\": \"\",\n \"fee\": \"\"\n },\n {\n \"availability\": \"RequireSetup\",\n \"category\": \"DirectDocs\",\n \"description\": \"\",\n \"packageType\": \"\",\n \"serviceId\": \"\",\n \"serviceType\": \"\",\n \"fee\": \"\"\n }\n]"}],"_postman_id":"99e9ef7d-ffbd-4bb1-81eb-fbce8ed1716c"}],"id":"6b1e8404-1492-4242-b645-953bb47c05db","description":"

Use this API to retrieve information about the services we have available for users.

\n","_postman_id":"6b1e8404-1492-4242-b645-953bb47c05db","auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","id":"a3c32ef9-489e-495c-ac04-ccbde68c1b0e","name":"PPDocs Documentation","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"}},"variable":[{"id":"2b12743f-5c80-442c-9607-bb5d964977cd","key":"baseUrl","value":"/"}]}